Class Tree
Assembly: NXOpenUI.dll
Syntax
public class Tree : UIBlock, IMessageSink
Constructors
Tree()
Declaration
Properties
CanStretchHeight
Declaration
public bool CanStretchHeight { get; set; }
Property Value
CanStretchWidth
Declaration
public bool CanStretchWidth { get; set; }
Property Value
FirstSelectedNode
Declaration
public Node FirstSelectedNode { get; }
Property Value
Height
Declaration
public int Height { get; set; }
Property Value
Localize
Declaration
public bool Localize { get; set; }
Property Value
MaximumHeight
Declaration
public int MaximumHeight { get; set; }
Property Value
MaximumWidth
Declaration
public int MaximumWidth { get; set; }
Property Value
MinimumHeight
Declaration
public int MinimumHeight { get; set; }
Property Value
MinimumWidth
Declaration
public int MinimumWidth { get; set; }
Property Value
NumberOfColumns
Declaration
public int NumberOfColumns { get; }
Property Value
RootNode
Declaration
public Node RootNode { get; }
Property Value
Declaration
public int ScrollFrozenColumn { get; set; }
Property Value
Declaration
public int ScrollLineNumber { get; set; }
Property Value
SelectionModeAsString
Declaration
public string SelectionModeAsString { get; set; }
Property Value
ShowExpandCollapseMarker
Declaration
public bool ShowExpandCollapseMarker { get; set; }
Property Value
Declaration
public bool ShowHeader { get; set; }
Property Value
ShowMultipleColumns
Declaration
public bool ShowMultipleColumns { get; set; }
Property Value
Declaration
public bool ShowToolTips { get; set; }
Property Value
SortRootNodes
Declaration
public bool SortRootNodes { get; set; }
Property Value
Width
Declaration
public int Width { get; set; }
Property Value
Methods
CopyNode(Node)
Declaration
public Node CopyNode(Node sourceNode)
Parameters
Type |
Name |
Description |
Node |
sourceNode |
|
Returns
Declaration
public TreeListMenu CreateMenu()
Returns
CreateNode(string)
Declaration
public Node CreateNode(string displayText)
Parameters
Type |
Name |
Description |
string |
displayText |
|
Returns
DeleteNode(Node)
Declaration
public void DeleteNode(Node node)
Parameters
Type |
Name |
Description |
Node |
node |
|
GetColumnDisplayType(int)
Declaration
public Tree.ColumnDisplay GetColumnDisplayType(int columnID)
Parameters
Type |
Name |
Description |
int |
columnID |
|
Returns
GetColumnId(int)
Declaration
public int GetColumnId(int columnPosition)
Parameters
Type |
Name |
Description |
int |
columnPosition |
|
Returns
GetColumnPosition(int)
Declaration
public int GetColumnPosition(int columnID)
Parameters
Type |
Name |
Description |
int |
columnID |
|
Returns
GetColumnResizePolicy(int)
Declaration
public Tree.ColumnResizePolicy GetColumnResizePolicy(int columnID)
Parameters
Type |
Name |
Description |
int |
columnID |
|
Returns
GetColumnSortOption(int)
Declaration
public Tree.ColumnSortOption GetColumnSortOption(int columnID)
Parameters
Type |
Name |
Description |
int |
columnID |
|
Returns
GetColumnSortable(int)
Declaration
public bool GetColumnSortable(int columnID)
Parameters
Type |
Name |
Description |
int |
columnID |
|
Returns
GetColumnTitle(int)
Declaration
public string GetColumnTitle(int columnID)
Parameters
Type |
Name |
Description |
int |
columnID |
|
Returns
GetColumnVisible(int)
Declaration
public bool GetColumnVisible(int columnID)
Parameters
Type |
Name |
Description |
int |
columnID |
|
Returns
GetColumnWidth(int)
Declaration
public int GetColumnWidth(int columnID)
Parameters
Type |
Name |
Description |
int |
columnID |
|
Returns
GetSelectedNodes()
Declaration
public Node[] GetSelectedNodes()
Returns
GetSelectionModeMembers()
Declaration
public string[] GetSelectionModeMembers()
Returns
InsertColumn(int, string, int)
Declaration
public int InsertColumn(int columnID, string columnTitle, int columnWidth)
Parameters
Type |
Name |
Description |
int |
columnID |
|
string |
columnTitle |
|
int |
columnWidth |
|
Returns
InsertNode(Node, Node, Node, NodeInsertOption)
Declaration
public void InsertNode(Node newNode, Node parentNode, Node afterNode, Tree.NodeInsertOption nodeInsertOption)
Parameters
Redraw(bool)
Declaration
public void Redraw(bool redraw)
Parameters
Type |
Name |
Description |
bool |
redraw |
|
SelectNode(Node, bool, bool)
Declaration
public void SelectNode(Node node, bool isSelect, bool isOtherNodeAffected)
Parameters
Type |
Name |
Description |
Node |
node |
|
bool |
isSelect |
|
bool |
isOtherNodeAffected |
|
SelectNodes(Node[], bool, bool)
Declaration
public void SelectNodes(Node[] node, bool isSelect, bool isOtherNodeAffected)
Parameters
Type |
Name |
Description |
Node[] |
node |
|
bool |
isSelect |
|
bool |
isOtherNodeAffected |
|
SetAskEditControlHandler(AskEditControlCallback)
Declaration
public void SetAskEditControlHandler(Tree.AskEditControlCallback cb)
Parameters
SetColumnDisplayType(int, ColumnDisplay)
Declaration
public void SetColumnDisplayType(int columnID, Tree.ColumnDisplay displayType)
Parameters
SetColumnResizePolicy(int, ColumnResizePolicy)
Declaration
public void SetColumnResizePolicy(int columnID, Tree.ColumnResizePolicy resizePolicy)
Parameters
SetColumnSortHandler(ColumnSortCallback)
Declaration
public void SetColumnSortHandler(Tree.ColumnSortCallback cb)
Parameters
SetColumnSortOption(int, ColumnSortOption)
Declaration
public void SetColumnSortOption(int columnID, Tree.ColumnSortOption sortOption)
Parameters
SetColumnSortable(int, bool)
Declaration
public void SetColumnSortable(int columnID, bool isSortable)
Parameters
Type |
Name |
Description |
int |
columnID |
|
bool |
isSortable |
|
SetColumnTitle(int, string)
Declaration
public void SetColumnTitle(int columnID, string columnHeaderTitle)
Parameters
Type |
Name |
Description |
int |
columnID |
|
string |
columnHeaderTitle |
|
SetColumnVisible(int, bool)
Declaration
public void SetColumnVisible(int columnID, bool isVisible)
Parameters
Type |
Name |
Description |
int |
columnID |
|
bool |
isVisible |
|
SetColumnWidth(int, int)
Declaration
public void SetColumnWidth(int columnID, int columnWidth)
Parameters
Type |
Name |
Description |
int |
columnID |
|
int |
columnWidth |
|
SetEditOptions(string[], int)
Declaration
public void SetEditOptions(string[] stringArray, int defaultIndex)
Parameters
Type |
Name |
Description |
string[] |
stringArray |
|
int |
defaultIndex |
|
SetIsDragAllowedHandler(IsDragAllowedCallback)
Declaration
public void SetIsDragAllowedHandler(Tree.IsDragAllowedCallback cb)
Parameters
SetIsDropAllowedHandler(IsDropAllowedCallback)
Declaration
public void SetIsDropAllowedHandler(Tree.IsDropAllowedCallback cb)
Parameters
Declaration
public void SetMenu(TreeListMenu menu)
Parameters
SetOnBeginLabelEditHandler(OnBeginLabelEditCallback)
Declaration
public void SetOnBeginLabelEditHandler(Tree.OnBeginLabelEditCallback cb)
Parameters
SetOnDefaultActionHandler(OnDefaultActionCallback)
Declaration
public void SetOnDefaultActionHandler(Tree.OnDefaultActionCallback cb)
Parameters
SetOnDeleteNodeHandler(OnDeleteNodeCallback)
Declaration
public void SetOnDeleteNodeHandler(Tree.OnDeleteNodeCallback cb)
Parameters
SetOnDropHandler(OnDropCallback)
Declaration
public void SetOnDropHandler(Tree.OnDropCallback cb)
Parameters
SetOnDropMenuHandler(OnDropMenuCallback)
Declaration
public void SetOnDropMenuHandler(Tree.OnDropMenuCallback cb)
Parameters
SetOnEditOptionSelectedHandler(OnEditOptionSelectedCallback)
Declaration
public void SetOnEditOptionSelectedHandler(Tree.OnEditOptionSelectedCallback cb)
Parameters
SetOnEndLabelEditHandler(OnEndLabelEditCallback)
Declaration
public void SetOnEndLabelEditHandler(Tree.OnEndLabelEditCallback cb)
Parameters
SetOnExpandHandler(OnExpandCallback)
Declaration
public void SetOnExpandHandler(Tree.OnExpandCallback cb)
Parameters
SetOnInsertColumnHandler(OnInsertColumnCallback)
Declaration
public void SetOnInsertColumnHandler(Tree.OnInsertColumnCallback cb)
Parameters
SetOnInsertNodeHandler(OnInsertNodeCallback)
Declaration
public void SetOnInsertNodeHandler(Tree.OnInsertNodeCallback cb)
Parameters
SetOnMenuHandler(OnMenuCallback)
Declaration
public void SetOnMenuHandler(Tree.OnMenuCallback cb)
Parameters
SetOnMenuSelectionHandler(OnMenuSelectionCallback)
Declaration
public void SetOnMenuSelectionHandler(Tree.OnMenuSelectionCallback cb)
Parameters
SetOnPreSelectHandler(OnPreSelectCallback)
Declaration
public void SetOnPreSelectHandler(Tree.OnPreSelectCallback cb)
Parameters
SetOnSelectHandler(OnSelectCallback)
Declaration
public void SetOnSelectHandler(Tree.OnSelectCallback cb)
Parameters
SetOnStateChangeHandler(OnStateChangeCallback)
Declaration
public void SetOnStateChangeHandler(Tree.OnStateChangeCallback cb)
Parameters
SetPreSelectionTimeOut(double)
Declaration
public void SetPreSelectionTimeOut(double timeOut)
Parameters
Type |
Name |
Description |
double |
timeOut |
|
SetStateIconNameHandler(StateIconNameCallback)
Declaration
public void SetStateIconNameHandler(Tree.StateIconNameCallback cb)
Parameters
SetToolTipTextHandler(ToolTipTextCallback)
Declaration
public void SetToolTipTextHandler(Tree.ToolTipTextCallback cb)
Parameters
TestColumnInserted(int, string, int)
Declaration
public int TestColumnInserted(int columnID, string columnTitle, int columnWidth)
Parameters
Type |
Name |
Description |
int |
columnID |
|
string |
columnTitle |
|
int |
columnWidth |
|
Returns
TestColumnSort(int, Node, Node, ColumnSortOption)
Declaration
public void TestColumnSort(int columnID, Node node1, Node node2, Tree.ColumnSortOption sortOption)
Parameters
Declaration
public void TestContextMenu(Node node, int columnID)
Parameters
Type |
Name |
Description |
Node |
node |
|
int |
columnID |
|
TestDefaultAction(Node, int)
Declaration
public void TestDefaultAction(Node node, int columnID)
Parameters
Type |
Name |
Description |
Node |
node |
|
int |
columnID |
|
Declaration
public void TestDropMenu(Node node, int columnID, Node targetNode, int targetColumnID)
Parameters
Type |
Name |
Description |
Node |
node |
|
int |
columnID |
|
Node |
targetNode |
|
int |
targetColumnID |
|
TestLabelEdit(Node, int, string)
Declaration
public void TestLabelEdit(Node node, int columnID, string editedText)
Parameters
Declaration
public void TestMenuAction(Node node, int command)
Parameters
Type |
Name |
Description |
Node |
node |
|
int |
command |
|
TestNodeDeleted(Node)
Declaration
public void TestNodeDeleted(Node node)
Parameters
Type |
Name |
Description |
Node |
node |
|
TestNodeDrop(Node, int, Node, int, int)
Declaration
public void TestNodeDrop(Node node, int columnID, Node targetNode, int targetColumnID, int command)
Parameters
Type |
Name |
Description |
Node |
node |
|
int |
columnID |
|
Node |
targetNode |
|
int |
targetColumnID |
|
int |
command |
|
TestNodeExpanded(Node, ExpandOption)
Declaration
public void TestNodeExpanded(Node node, Node.ExpandOption expandOption)
Parameters
TestNodeInserted(Node, Node, Node, NodeInsertOption)
Declaration
public void TestNodeInserted(Node newNode, Node parentNode, Node afterNode, Tree.NodeInsertOption nodeInsertOption)
Parameters
TestNodePreselection(Node, int)
Declaration
public void TestNodePreselection(Node node, int columnID)
Parameters
Type |
Name |
Description |
Node |
node |
|
int |
columnID |
|
TestNodeSelected(Node, bool, bool)
Declaration
public void TestNodeSelected(Node node, bool isSelect, bool isOtherNodeAffected)
Parameters
Type |
Name |
Description |
Node |
node |
|
bool |
isSelect |
|
bool |
isOtherNodeAffected |
|
TestStateChanged(Node, int)
Declaration
public void TestStateChanged(Node node, int state)
Parameters
Type |
Name |
Description |
Node |
node |
|
int |
state |
|
Implements
System.Runtime.Remoting.Messaging.IMessageSink