`ProjectTreeFilter`

Inheritance

The ProjectTreeFilter object is derived from the Object object.

Usage locations

The ProjectTreeFilter object can be accessed from the following locations:

Properties
- MainWindow object has property TreeFilter.

Property List

Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Property List (internal only)

ErrorItems: (Read/Write boolean)
HiddenItems: (Read/Write boolean)
LabelFilter: (Read/Write string)
LocalMeshSettingsFilter: (Read/Write boolean)
LocalMeshSettingsToFilterWith: (Read/Write MeshSettings)
LocalMeshSize: (Read/Write boolean)
MediumFilter: (Read/Write boolean)
MediumToFilterWith: (Read/Write Medium)
Path: (Read only string)
SuspectItems: (Read/Write boolean)
VariableFilter: (Read/Write boolean)
VariableToFilterWith: (Read/Write Variable)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Property Details (internal only)

ErrorItems

Type: boolean
Access: Read/Write

HiddenItems

Type: boolean
Access: Read/Write

LabelFilter

Type: string
Access: Read/Write

LocalMeshSettingsFilter

Type: boolean
Access: Read/Write

LocalMeshSettingsToFilterWith

Type: MeshSettings
Access: Read/Write

LocalMeshSize

Type: boolean
Access: Read/Write

MediumFilter

Type: boolean
Access: Read/Write

MediumToFilterWith

Type: Medium
Access: Read/Write

Path

Type: string
Access: Read only

SuspectItems

Type: boolean
Access: Read/Write

VariableFilter

Type: boolean
Access: Read/Write

VariableToFilterWith

Type: Variable
Access: Read/Write

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.