ITreeGridNode Interface
Namespace: NextDesign.Core
Description
Access object to node information of tree grid.
Belonging Area
Name | Description |
---|---|
Editor | A group of APIs to access editors. |
Inherit Base
Name | Description |
---|---|
IEditorElement | Access object to editor element. |
Property
Name | Description |
---|---|
Cells | Cells of this node |
Children | Child nodes of the tree The order is the same as the order in which child elements are displayed on the UI. |
IsExpanded | Whether this node is expanded |
Parent | Parent node of the tree |
Method
Name | Description |
---|---|
GetCellDisplayValues | Gets the display strings of all cells of this node. Cells without values return an empty string. See GetCellValueString() for the strings that can be obtained. |
GetCellValue | Gets the value of the cell at the specified column of this node. Returns null if the cell value does not exist. The actual type of the value you can get depends on the data type of the column. - bool type: bool value - number type: number - string type: string - enumeration type: IEnumLiteral object - rich text type: plain text - class type (model reference): IModelCollection object (elements with multiplicity 1 also return a collection) |
GetCellValueAt | Gets the value of the cell at the specified index of this node. Returns null if the cell value does not exist. See GetCellValue() for the actual type of the value you can get. |
GetCellValueString | Gets the cell value of the specified column of this node in string format. If there is no cell value, returns an empty string. The string that can be retrieved depends on the data type of the column. - bool type: "True" or "False" - Number type: String representation of the number - String type: String - Enumeration type: Literal string - Rich text type: Plain text - Class type (Model reference): Display name of the model (separated by spaces in case of multiple models) [Model display name] The display name of the model will be in the following format, the same as how it is displayed in the UI. \{Parent element name\}/$\{Model name\} (Example) Use case/Driver |
GetCellValueStringAt | Gets the cell value at the specified index of this node in string format. If the cell value does not exist, returns an empty string. For the strings that can be retrieved, see GetCellValueString(). |
GetSelectedCells | Gets the cells selected at this node. |
HasCellValue | Checks whether a cell value exists at the specified column of this node. Returns True if a cell value exists. |
HasCellValueAt | Checks whether a cell value exists at the specified index of this node. Returns True if the cell value exists. |
IsCellSelected | Checks if a cell in the specified column is selected on this node. Returns True if the cell is selected. |
IsCellSelectedAt | Checks if a cell at the specified index is selected on this node. Returns True if the cell is selected. |
Annotation
In addition to the underlying constraints, the following properties are also not supported by tree grid nodes:
- Identifier (Id)
If these properties are accessed, an exception is thrown.