ITreeGridNode interface
Namespace: NextDesign.Core
Description
This is an object that accesses node information of a tree grid.
Area you belong to
Name | Description |
---|---|
Editor | A group of APIs to access the editor. |
Inherit Base
Name | Description |
---|---|
IEditorElement | Access object to the editor element. |
Property
Name | Description |
---|---|
Cells | Cells of this node |
Children | Child nodes in the tree The order is the same as the display order of child elements on the UI. |
IsExpanded | Is this node expanded |
Parent | Parent node of tree |
Method
Name | Description |
---|---|
GetCellDisplayValues | Get all cell display strings for this node. Cells with no value return an empty string. See GetCellValueString() for the strings that can be retrieved. |
GetCellValue | Gets the value of the cell in the specified column of this node. Returns null if the cell value does not exist. The actual type of value you can retrieve depends on the data type of the column. - bool type: bool value - numeric type: number - string type: string - enumeration type: IEnumLiteral object - rich text type: plain Text - Class type (model reference): IModelCollection object (returns a collection even with elements with multiplicity 1) |
GetCellValueAt | Gets the value of the cell at the specified index on this node. Returns null if the cell value does not exist. See GetCellValue() for the actual types of values that can be retrieved. |
GetCellValueString | Gets the value of the cell in the specified column of this node in string format. Returns an empty string if the cell has no value. The strings that can be retrieved depend on the data type of the column. - bool type: "True" or "False" - numeric type: string representation of a number - string type: string - enumeration type: literal string - Rich text type: Plain text - Class type (model reference): Model display name (separated by spaces if there are multiple models) [Model display name ] The display name of the model will be in the following format, similar to the display on the UI. {Parent element name}/${Model name} (Example) Use case/driver |
GetCellValueStringAt | Gets the value of the cell at the specified index on this node in string format. Returns an empty string if the cell has no value. See GetCellValueString() for the strings that can be retrieved. |
GetSelectedCells | Get the selected cells on this node. |
HasCellValue | Checks whether a value exists for the cell in the specified column in this node. Returns True if the cell value exists. |
HasCellValueAt | Checks if the value of the cell with the specified index exists in this node. Returns True if the cell value exists. |
IsCellSelected | Checks whether the cell in the specified column is selected in this node. Returns True if the cell is selected. |
IsCellSelectedAt | Checks whether the cell with the specified index is selected in this node. Returns True if the cell is selected. |
Annotation
In addition to the underlying constraints, tree grid nodes also do not support the following properties:
・Identifier (Id)
Accessing these properties will throw an exception.