NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Types | Public Member Functions | Properties | List of all members
NXOpen.BlockStyler.Tree Class Reference

Represents the Tree block in block styler automation. More...

Inheritance diagram for NXOpen.BlockStyler.Tree:
NXOpen.BlockStyler.UIBlock NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

class  _TreeAskEditControlCallbackAdapter
 
class  _TreeColumnSortCallbackAdapter
 
class  _TreeIsDragAllowedCallbackAdapter
 
class  _TreeIsDropAllowedCallbackAdapter
 
class  _TreeOnBeginLabelEditCallbackAdapter
 
class  _TreeOnDefaultActionCallbackAdapter
 
class  _TreeOnDeleteNodeCallbackAdapter
 
class  _TreeOnDropCallbackAdapter
 
class  _TreeOnDropMenuCallbackAdapter
 
class  _TreeOnEditOptionSelectedCallbackAdapter
 
class  _TreeOnEndLabelEditCallbackAdapter
 
class  _TreeOnExpandCallbackAdapter
 
class  _TreeOnInsertColumnCallbackAdapter
 
class  _TreeOnInsertNodeCallbackAdapter
 
class  _TreeOnMenuCallbackAdapter
 
class  _TreeOnMenuSelectionCallbackAdapter
 
class  _TreeOnPreSelectCallbackAdapter
 
class  _TreeOnSelectCallbackAdapter
 
class  _TreeOnStateChangeCallbackAdapter
 
class  _TreeStateIconNameCallbackAdapter
 
class  _TreeToolTipTextCallbackAdapter
 

Public Types

enum  BeginLabelEditState { Allow, Disallow }
 Represents the state to allow/disallow the node label edit. More...
 
enum  ColumnDisplay { Text, Icon }
 Represents the column display type. More...
 
enum  ColumnResizePolicy { ConstantWidth, ResizeWithContents, ResizeWithTree }
 Represents column resize policy. More...
 
enum  ColumnSortOption { Unsorted, Ascending, Descending }
 Represents the column sort option. More...
 
enum  ControlType { None, ComboBox, ListBox }
 Represents the type of edit options. More...
 
enum  EditControlOption { Accept, Reject }
 Represents the options to accept or reject the changed value. More...
 
enum  EndLabelEditState { AcceptText, RejectText }
 Represents the state to accept/reject the edited label of node. More...
 
enum  NodeInsertOption {
  First, Last, Sort, AlwaysFirst,
  AlwaysLast
}
 Represents the node insert option which is used while inserting the node in tree. More...
 

Public Member Functions

delegate
NXOpen.BlockStyler.Tree.ControlType 
AskEditControlCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID)
 Represents the callback which gets called when edit is attempted on any cell. More...
 
delegate int ColumnSortCallback (NXOpen.BlockStyler.Tree tree, int columnID, NXOpen.BlockStyler.Node node1, NXOpen.BlockStyler.Node node2)
 Represents the callback which gets called when column sort is attempted. More...
 
unsafe NXOpen.BlockStyler.Node CopyNode (NXOpen.BlockStyler.Node sourceNode)
 Copies the existing BlockStyler.Node . More...
 
unsafe
NXOpen.BlockStyler.TreeListMenu 
CreateMenu ()
 Creates the menu. More...
 
unsafe NXOpen.BlockStyler.Node CreateNode (string displayText)
 Creates the node but does not insert it. More...
 
unsafe void DeleteNode (NXOpen.BlockStyler.Node node)
 Deletes the node from tree. More...
 
unsafe
NXOpen.BlockStyler.Tree.ColumnDisplay 
GetColumnDisplayType (int columnID)
 Gets the display type of the column. More...
 
unsafe int GetColumnId (int columnPosition)
 Gets the column Id for the provided column position. More...
 
unsafe int GetColumnPosition (int columnID)
 Gets column position. More...
 
unsafe
NXOpen.BlockStyler.Tree.ColumnResizePolicy 
GetColumnResizePolicy (int columnID)
 Gets the column resize policy. More...
 
unsafe bool GetColumnSortable (int columnID)
 Gets the flag indicating whether the column is sortable. More...
 
unsafe
NXOpen.BlockStyler.Tree.ColumnSortOption 
GetColumnSortOption (int columnID)
 Gets the column sort option. More...
 
unsafe string GetColumnTitle (int columnID)
 Gets the column title. More...
 
unsafe bool GetColumnVisible (int columnID)
 Gets the flag indicating whether the column is visible. More...
 
unsafe int GetColumnWidth (int columnID)
 Gets column width More...
 
unsafe NXOpen.BlockStyler.Node[] GetSelectedNodes ()
 Gets the selected nodes. More...
 
unsafe string[] GetSelectionModeMembers ()
 Gets the SelectionMode More...
 
unsafe int InsertColumn (int columnID, string columnTitle, int columnWidth)
 Inserts a column. More...
 
unsafe void InsertNode (NXOpen.BlockStyler.Node newNode, NXOpen.BlockStyler.Node parentNode, NXOpen.BlockStyler.Node afterNode, NXOpen.BlockStyler.Tree.NodeInsertOption nodeInsertOption)
 Inserts the node. More...
 
delegate
NXOpen.BlockStyler.Node.DragType 
IsDragAllowedCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID)
 Represents the callback which gets called when node is dragged. More...
 
delegate
NXOpen.BlockStyler.Node.DropType 
IsDropAllowedCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID, NXOpen.BlockStyler.Node targetNode, int targetColumnID)
 Represents the callback which gets called when an attempt is made to drop the node on any target node. More...
 
delegate
NXOpen.BlockStyler.Tree.BeginLabelEditState 
OnBeginLabelEditCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID)
 Represents the callback which gets called when label edit is attempted on any column. More...
 
delegate void OnDefaultActionCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID)
 Represents the callback which gets called when double clicked is performed on the node. More...
 
delegate void OnDeleteNodeCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node)
 Represents the callback which gets called when the node is deleted from tree. More...
 
delegate bool OnDropCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node[] node, int columnID, NXOpen.BlockStyler.Node targetNode, int targetColumnID, NXOpen.BlockStyler.Node.DropType dropType, int dropMenuItemId)
 Represents the callback which gets called when nodes are dropped on any target node. More...
 
delegate void OnDropMenuCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID, NXOpen.BlockStyler.Node targetNode, int targetColumnID)
 Represents the callback to show the menu when nodes are dragged using MB3 or right mouse click, and dropped on any target node. More...
 
delegate
NXOpen.BlockStyler.Tree.EditControlOption 
OnEditOptionSelectedCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID, int selectedOptionID, string selectedOptionText, NXOpen.BlockStyler.Tree.ControlType type)
 Represents the callback which gets called when user selects an option in edit-control set by BlockStyler. More...
 
delegate
NXOpen.BlockStyler.Tree.EndLabelEditState 
OnEndLabelEditCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID, string editedText)
 Represents the callback which gets called when label edit is completed on any column. More...
 
delegate void OnExpandCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node)
 Represents the callback which gets called when the node is expanded. More...
 
delegate void OnInsertColumnCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID)
 Represents the callback which gets called for each node when the column is inserted using BlockStyler.Tree.InsertColumn . More...
 
delegate void OnInsertNodeCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node)
 Represents the callback which gets called when the node is inserted. More...
 
delegate void OnMenuCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID)
 Represents the callback which gets called when MB3 or right click is attempted on node or tree. More...
 
delegate void OnMenuSelectionCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int menuItemID)
 Represents the callback which gets called when one of the menu option is selected. More...
 
delegate void OnPreSelectCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID, bool selected)
 Represents the callback which gets called when pre selection is attempted on node. More...
 
delegate void OnSelectCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID, bool selected)
 Represents the callback which gets called when the node is selected. More...
 
delegate void OnStateChangeCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int state)
 Represents the callback which gets called when the state icon is clicked. More...
 
unsafe void Redraw (bool redraw)
 Freezes the tree if the value is set to False which implies that no changes would occur in the tree after this point. More...
 
unsafe void SelectNode (NXOpen.BlockStyler.Node node, bool isSelect, bool isOtherNodeAffected)
 Selects the provided node. More...
 
unsafe void SelectNodes (NXOpen.BlockStyler.Node[] node, bool isSelect, bool isOtherNodeAffected)
 Selects the provided nodes. More...
 
unsafe void SetAskEditControlHandler (NXOpen.BlockStyler.Tree.AskEditControlCallback cb)
 Sets the node-edit-control callback More...
 
unsafe void SetColumnDisplayType (int columnID, NXOpen.BlockStyler.Tree.ColumnDisplay displayType)
 Sets the display type of the column. More...
 
unsafe void SetColumnResizePolicy (int columnID, NXOpen.BlockStyler.Tree.ColumnResizePolicy resizePolicy)
 Sets the column resize policy. More...
 
unsafe void SetColumnSortable (int columnID, bool isSortable)
 Sets the flag indicating whether the column is sortable. More...
 
unsafe void SetColumnSortHandler (NXOpen.BlockStyler.Tree.ColumnSortCallback cb)
 Sets the column sort callback. More...
 
unsafe void SetColumnSortOption (int columnID, NXOpen.BlockStyler.Tree.ColumnSortOption sortOption)
 Sets the column sort option. More...
 
unsafe void SetColumnTitle (int columnID, string columnHeaderTitle)
 Sets the column title. More...
 
unsafe void SetColumnVisible (int columnID, bool isVisible)
 Sets the flag indicating whether the column is visible More...
 
unsafe void SetColumnWidth (int columnID, int columnWidth)
 Sets the column width More...
 
unsafe void SetEditOptions (string[] stringArray, int defaultIndex)
 Sets the options in edit-control. More...
 
unsafe void SetIsDragAllowedHandler (NXOpen.BlockStyler.Tree.IsDragAllowedCallback cb)
 Sets the callback handler for node drag More...
 
unsafe void SetIsDropAllowedHandler (NXOpen.BlockStyler.Tree.IsDropAllowedCallback cb)
 Sets the callback handler for node drop More...
 
unsafe void SetMenu (NXOpen.BlockStyler.TreeListMenu menu)
 Sets the menu, resulting the menu to appear on the screen. More...
 
unsafe void SetOnBeginLabelEditHandler (NXOpen.BlockStyler.Tree.OnBeginLabelEditCallback cb)
 Sets the on-begin-label-edit callback More...
 
unsafe void SetOnDefaultActionHandler (NXOpen.BlockStyler.Tree.OnDefaultActionCallback cb)
 Sets the on select node callback More...
 
unsafe void SetOnDeleteNodeHandler (NXOpen.BlockStyler.Tree.OnDeleteNodeCallback cb)
 Sets on delete node callback More...
 
unsafe void SetOnDropHandler (NXOpen.BlockStyler.Tree.OnDropCallback cb)
 Sets the callback handler for node drop More...
 
unsafe void SetOnDropMenuHandler (NXOpen.BlockStyler.Tree.OnDropMenuCallback cb)
 Sets the callback handler for on drop menu. More...
 
unsafe void SetOnEditOptionSelectedHandler (NXOpen.BlockStyler.Tree.OnEditOptionSelectedCallback cb)
 Sets the on-end-label-edit callback More...
 
unsafe void SetOnEndLabelEditHandler (NXOpen.BlockStyler.Tree.OnEndLabelEditCallback cb)
 Sets the on-end-label-edit callback More...
 
unsafe void SetOnExpandHandler (NXOpen.BlockStyler.Tree.OnExpandCallback cb)
 Sets the on expand callback to the tree. More...
 
unsafe void SetOnInsertColumnHandler (NXOpen.BlockStyler.Tree.OnInsertColumnCallback cb)
 Sets the on insert column callback to the tree. More...
 
unsafe void SetOnInsertNodeHandler (NXOpen.BlockStyler.Tree.OnInsertNodeCallback cb)
 Sets the on insert node callback. More...
 
unsafe void SetOnMenuHandler (NXOpen.BlockStyler.Tree.OnMenuCallback cb)
 Sets the on menu callback More...
 
unsafe void SetOnMenuSelectionHandler (NXOpen.BlockStyler.Tree.OnMenuSelectionCallback cb)
 Sets the on menu selection callback More...
 
unsafe void SetOnPreSelectHandler (NXOpen.BlockStyler.Tree.OnPreSelectCallback cb)
 Sets on pre select callback More...
 
unsafe void SetOnSelectHandler (NXOpen.BlockStyler.Tree.OnSelectCallback cb)
 Sets the on select node callback More...
 
unsafe void SetOnStateChangeHandler (NXOpen.BlockStyler.Tree.OnStateChangeCallback cb)
 Sets the on state change callback. More...
 
unsafe void SetPreSelectionTimeOut (double timeOut)
 Sets the pre selection time out. More...
 
unsafe void SetStateIconNameHandler (NXOpen.BlockStyler.Tree.StateIconNameCallback cb)
 Sets the state icon name callback. More...
 
unsafe void SetToolTipTextHandler (NXOpen.BlockStyler.Tree.ToolTipTextCallback cb)
 Sets the tool tip callback. More...
 
delegate string StateIconNameCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int state)
 Represents the callback which gets called when the node state is set by BlockStyler.Node.SetState and the corresponding state icon of node state is not known. More...
 
delegate string ToolTipTextCallback (NXOpen.BlockStyler.Tree tree, NXOpen.BlockStyler.Node node, int columnID)
 Represents the callback which gets called when tree seeks the tooltip. More...
 
- Public Member Functions inherited from NXOpen.BlockStyler.UIBlock
unsafe void Focus ()
 Focuses on the block. More...
 
unsafe
NXOpen.BlockStyler.PropertyList 
GetProperties ()
 Returns the properties of the block More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool CanStretchHeight [get, set]
 Returns or sets the CanStretchHeight. More...
 
unsafe bool CanStretchWidth [get, set]
 Returns or sets the CanStretchWidth. More...
 
unsafe NXOpen.BlockStyler.Node FirstSelectedNode [get]
 Returns the first selected node among the available selected nodes. More...
 
unsafe int Height [get, set]
 Returns or sets the Height More...
 
unsafe bool Localize [get, set]
 Returns or sets the Localize More...
 
unsafe int MaximumHeight [get, set]
 Returns or sets the MaximumHeight More...
 
unsafe int MaximumWidth [get, set]
 Returns or sets the MaximumWidth More...
 
unsafe int MinimumHeight [get, set]
 Returns or sets the MinimumHeight More...
 
unsafe int MinimumWidth [get, set]
 Returns or sets the MinimumWidth More...
 
unsafe int NumberOfColumns [get]
 Returns the number of column inserted in the tree. More...
 
unsafe NXOpen.BlockStyler.Node RootNode [get]
 Returns the root node. More...
 
unsafe int ScrollFrozenColumn [get, set]
 Returns or sets the ScrollFrozenColumn. More...
 
unsafe int ScrollLineNumber [get, set]
 Returns or sets the ScrollLineNumber. More...
 
unsafe string SelectionModeAsString [get, set]
 Returns or sets the SelectionMode More...
 
unsafe bool ShowExpandCollapseMarker [get, set]
 Returns or sets the ShowExpandCollapseMarker. More...
 
unsafe bool ShowHeader [get, set]
 Returns or sets the ShowHeader More...
 
unsafe bool ShowMultipleColumns [get, set]
 Returns or sets the ShowMultipleColumns More...
 
unsafe bool ShowToolTips [get, set]
 Returns or sets the ShowToolTips More...
 
unsafe bool SortRootNodes [get, set]
 Returns or sets the SortRootNodes. More...
 
unsafe int Width [get, set]
 Returns or sets the Width More...
 
- Properties inherited from NXOpen.BlockStyler.UIBlock
unsafe bool Enable [get, set]
 Returns or sets the Enable. More...
 
unsafe bool Expanded [get, set]
 Returns or sets the Expanded More...
 
unsafe bool Group [get, set]
 Returns or sets the Group More...
 
unsafe string Label [get, set]
 Returns or sets the Label More...
 
unsafe string Name [get]
 Returns the name of the block or BlockID More...
 
unsafe bool Show [get, set]
 Returns or sets the Visibility of block. More...
 
unsafe string Type [get]
 Returns the type of block More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents the Tree block in block styler automation.

To start utilizing the tree use methods such as BlockStyler.Tree.InsertColumn , BlockStyler.Tree.CreateNode , BlockStyler.Tree.InsertNode etc. It is must to insert the column on the tree before inserting any node. Node can be created but cannot be inserted without the column available on the tree. Note that some of the methods of this class such as BlockStyler.Tree.InsertColumn must be used in or after the BlockStyler.BlockDialog.DialogShown callback after which tree is fully constructed and ready for use.

Created in NX7.5.0

Member Enumeration Documentation

Represents the state to allow/disallow the node label edit.

Use these options in callback BlockStyler.Tree.OnBeginLabelEditCallback.

Enumerator
Allow 

Use this option to allow label edit.

Disallow 

Use this option to disallow label edit.

Represents the column display type.

If the type is BlockStyler.Tree.ColumnDisplay.Icon then the provided text is interpreted as icon.

Enumerator
Text 

Text

Icon 

Icon

Represents column resize policy.

Enumerator
ConstantWidth 

Constant width

ResizeWithContents 

Width resized with contents.

ResizeWithTree 

Width resize with tree window resize.

Represents the column sort option.

Enumerator
Unsorted 

Unsorted

Ascending 

Ascending

Descending 

Descending

Represents the type of edit options.

Use these options in edit control callback

Enumerator
None 

None

ComboBox 

Combo box.

ListBox 

List box.

Represents the options to accept or reject the changed value.

Enumerator
Accept 

Use this option to allow edit.

Reject 

Use this option to disallow edit.

Represents the state to accept/reject the edited label of node.

Use these options in callback BlockStyler.Tree.OnEndLabelEditCallback.

Enumerator
AcceptText 

Use this option to accept the edited text.

RejectText 

Use this option to reject the edited text and retain the previous one.

Represents the node insert option which is used while inserting the node in tree.

Enumerator
First 

Node is placed first in the hierarchy in which it is inserted.

Last 

Node is placed last in the hierarchy in which it is inserted.

Sort 

Node is sorted according to display text and placed accordingly in the hierarchy in which it is inserted

AlwaysFirst 

Node is placed first in the hierarchy in which it is inserted.

This is same as BlockStyler.Tree.NodeInsertOption.First , except that it remains first after a column sort. If there is more than one node beneath a single parent with this option then they will be sorted relative to each other.

AlwaysLast 

Node is placed last in the hierarchy in which it is inserted.

This is same as BlockStyler.Tree.NodeInsertOption.Last , except that it remains last after a column sort. If there is more than one node beneath a single parent with this option then they will be sorted relative to each other.

Member Function Documentation

delegate NXOpen.BlockStyler.Tree.ControlType NXOpen.BlockStyler.Tree.AskEditControlCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID 
)

Represents the callback which gets called when edit is attempted on any cell.

Edit-control is made available on the cell based on control type returned by this callback.

Use BlockStyler.Tree.SetEditOptions in this callback to show the options in the edit-control. Further BlockStyler.Tree.OnEditOptionSelectedCallback is called when option is selected.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode being edited.
columnIDColumn Id of the column on which edit is performed.
delegate int NXOpen.BlockStyler.Tree.ColumnSortCallback ( NXOpen.BlockStyler.Tree  tree,
int  columnID,
NXOpen.BlockStyler.Node  node1,
NXOpen.BlockStyler.Node  node2 
)

Represents the callback which gets called when column sort is attempted.

The possible return values are 0, positive and negative value, suggesting respectively that both nodes are same, first node greater than second, and first node smaller than second.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
columnIDColumn Id of the column on which sort is attempted.
node1First Node for comparision.
node2Second Node for comparision.
unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Tree.CopyNode ( NXOpen.BlockStyler.Node  sourceNode)
inline

Copies the existing BlockStyler.Node .

The tree can copy either its own node or the node of another tree. The copied node can only be inserted into the tree which has copied that node. The column texts are not passed to the copied node.

Created in NX7.5.0

License requirements: None.

Parameters
sourceNodeSource node. Can be node of other tree.
Returns
Copied node.
unsafe NXOpen.BlockStyler.TreeListMenu NXOpen.BlockStyler.Tree.CreateMenu ( )
inline

Creates the menu.

Use BlockStyler.Tree.SetMenu to set the created menu.

Created in NX7.5.0

License requirements: None.

Returns
unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Tree.CreateNode ( string  displayText)
inline

Creates the node but does not insert it.

Use BlockStyler.Tree.InsertNode to insert the node.

Created in NX7.5.0

License requirements: None.

Parameters
displayTextSpecifies the display text of the node.
Returns
Node
unsafe void NXOpen.BlockStyler.Tree.DeleteNode ( NXOpen.BlockStyler.Node  node)
inline

Deletes the node from tree.

Further usage of deleted node is illegal. The last place where node can be used is in BlockStyler.Tree.OnDeleteNodeCallaback callback which gets called when node is deleted.

Created in NX7.5.0

License requirements: None.

Parameters
nodeNode to delete
unsafe NXOpen.BlockStyler.Tree.ColumnDisplay NXOpen.BlockStyler.Tree.GetColumnDisplayType ( int  columnID)
inline

Gets the display type of the column.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
Returns
Display type.
unsafe int NXOpen.BlockStyler.Tree.GetColumnId ( int  columnPosition)
inline

Gets the column Id for the provided column position.

Created in NX7.5.0

License requirements: None.

Parameters
columnPositionColumn position.
Returns
Unique column Id associated with the column.
unsafe int NXOpen.BlockStyler.Tree.GetColumnPosition ( int  columnID)
inline

Gets column position.

Returns -1 if no column is associated with the provided column Id.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
Returns
Column position.
unsafe NXOpen.BlockStyler.Tree.ColumnResizePolicy NXOpen.BlockStyler.Tree.GetColumnResizePolicy ( int  columnID)
inline

Gets the column resize policy.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
Returns
Resize policy.
unsafe bool NXOpen.BlockStyler.Tree.GetColumnSortable ( int  columnID)
inline

Gets the flag indicating whether the column is sortable.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
Returns
Flag indicating whether the column is sortable.
unsafe NXOpen.BlockStyler.Tree.ColumnSortOption NXOpen.BlockStyler.Tree.GetColumnSortOption ( int  columnID)
inline

Gets the column sort option.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
Returns
Column sort option.
unsafe string NXOpen.BlockStyler.Tree.GetColumnTitle ( int  columnID)
inline

Gets the column title.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
Returns
Column header title.
unsafe bool NXOpen.BlockStyler.Tree.GetColumnVisible ( int  columnID)
inline

Gets the flag indicating whether the column is visible.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
Returns
Flag indicating whether the column is visible.
unsafe int NXOpen.BlockStyler.Tree.GetColumnWidth ( int  columnID)
inline

Gets column width

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
Returns
Column width.
unsafe NXOpen.BlockStyler.Node [] NXOpen.BlockStyler.Tree.GetSelectedNodes ( )
inline

Gets the selected nodes.

Created in NX7.5.0

License requirements: None.

Returns
Selected nodes.
unsafe string [] NXOpen.BlockStyler.Tree.GetSelectionModeMembers ( )
inline

Gets the SelectionMode

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property
unsafe int NXOpen.BlockStyler.Tree.InsertColumn ( int  columnID,
string  columnTitle,
int  columnWidth 
)
inline

Inserts a column.

Inserts a column with following defaults:

The new column is placed after the last available column. If no column is available then the inserted one becomes the first column of the tree.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column. Any further interaction with the column is done with this column Id.
columnTitleColumn header title.
columnWidthProviding value less than zero will set the default width of 0 for the column.
Returns
Absolute column position.
unsafe void NXOpen.BlockStyler.Tree.InsertNode ( NXOpen.BlockStyler.Node  newNode,
NXOpen.BlockStyler.Node  parentNode,
NXOpen.BlockStyler.Node  afterNode,
NXOpen.BlockStyler.Tree.NodeInsertOption  nodeInsertOption 
)
inline

Inserts the node.

Subsequently BlockStyler.Tree.OnInsertNodeCallback is called. Reinserting the node in same or different tree is not allowed.

Created in NX7.5.0

License requirements: None.

Parameters
newNodeNew Node.
parentNodeParent node under which new node is supposed to be placed. To add the first node, pass as NXOpen.BlockStyler.Node.Null
afterNodeNew node placed after this node. If there is mismatch between parent-node and after-node then former is honoured. To add the first node, pass as NXOpen.BlockStyler.Node.Null
nodeInsertOptionNode insert option. Provide the value if after node is a null reference (Nothing in Visual Basic). This value is not considered if a valid after-node is supplied.
delegate NXOpen.BlockStyler.Node.DragType NXOpen.BlockStyler.Tree.IsDragAllowedCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID 
)

Represents the callback which gets called when node is dragged.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode being dragged.
columnIDColumn Id of the column where drag is attempted.
delegate NXOpen.BlockStyler.Node.DropType NXOpen.BlockStyler.Tree.IsDropAllowedCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID,
NXOpen.BlockStyler.Node  targetNode,
int  targetColumnID 
)

Represents the callback which gets called when an attempt is made to drop the node on any target node.

If multiple nodes are selected and dragged then this callback is invoked for each of the selected nodes.

If node is dragged using MB3 then the callback BlockStyler.Tree.OnDropMenuCallback is invoked which is expected to provide and show the menu. Subsequently, BlockStyler.Tree.OnDropCallback might get invoked.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode being dragged and dropped on target node.
columnIDColumn Id of the column from where node is dragged.
targetNodeTarget node on which node is dropped.
targetColumnIDColumn Id of the column where node is dropped.
delegate NXOpen.BlockStyler.Tree.BeginLabelEditState NXOpen.BlockStyler.Tree.OnBeginLabelEditCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID 
)

Represents the callback which gets called when label edit is attempted on any column.

The label edit is allowed/disallowed based on return value of this callback.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode being edited.
columnIDColumn Id of the column on which label edit is performed.
delegate void NXOpen.BlockStyler.Tree.OnDefaultActionCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID 
)

Represents the callback which gets called when double clicked is performed on the node.

Created in NX7.5.2

License requirements: None.

Parameters
treeTree.
nodeNode on which Double Click is performed.
columnIDColumn Id of the column on which double click is performed.
delegate void NXOpen.BlockStyler.Tree.OnDeleteNodeCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node 
)

Represents the callback which gets called when the node is deleted from tree.

It is expected to perform only clean-up operation related to the deleted node such as clean-up of Node Data.

Avoid operations such as node insert, node delete etc, and avoid calling any methods of tree. This is particularly severe when dialog is closed (through Ok, dialog-reset etc) because by then tree is unavailable and any usage of tree method would raise exception. As the callback is called for each node, the exception would be raised number of times equaling number of nodes available on tree.

Created in NX6.0.0

License requirements: None.

Parameters
treeTree
nodeDeleted node.
delegate bool NXOpen.BlockStyler.Tree.OnDropCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node[]  node,
int  columnID,
NXOpen.BlockStyler.Node  targetNode,
int  targetColumnID,
NXOpen.BlockStyler.Node.DropType  dropType,
int  dropMenuItemId 
)

Represents the callback which gets called when nodes are dropped on any target node.

This callback is invoked irrespective of case whether nodes are dragged using MB1 or MB3. If nodes are dragged using MB3 then BlockStyler.Tree.OnDropMenuCallback is called prior to the invocation of this callback.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNodes dropped on any target node. The number of nodes might not be same as number of selected nodes as some of the selected node might disallow to drop itself on target node.
columnIDColumn Id of the column from where nodes are dragged.
targetNodeTarget node on which dragged nodes are dropped.
targetColumnIDColumn Id of the column where nodes are dropped.
dropTypeIndicates whether the nodes are dropped On, Before or After target node
dropMenuItemIdMenu item Id representing the selected menu item. This menu Id corresponds to the menu item added to the BlockStyler.TreeListMenu using BlockStyler.TreeListMenu.AddMenuItem . Refer to callback BlockStyler.Tree.OnDropMenuCallback to make available the menu while node drop.
delegate void NXOpen.BlockStyler.Tree.OnDropMenuCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID,
NXOpen.BlockStyler.Node  targetNode,
int  targetColumnID 
)

Represents the callback to show the menu when nodes are dragged using MB3 or right mouse click, and dropped on any target node.

The menu can be made available using two methods BlockStyler.Tree.CreateMenu and BlockStyler.Tree.SetMenu . Subsequently, menu is shown and selected menu option is passed as paremeter in the callback BlockStyler.Tree.OnDropCallback

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode on which drag initiated.
columnIDColumn Id of the column from where drag initiated
targetNodeTarget node on which dragged node is dropped.
targetColumnIDColumn Id of the column where nodes are dropped.
delegate NXOpen.BlockStyler.Tree.EditControlOption NXOpen.BlockStyler.Tree.OnEditOptionSelectedCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID,
int  selectedOptionID,
string  selectedOptionText,
NXOpen.BlockStyler.Tree.ControlType  type 
)

Represents the callback which gets called when user selects an option in edit-control set by BlockStyler.

Tree.AskEditControlCallback. If returned BlockStyler.Tree.EditControlOption.Accept then the edited option/text is accepted else it is rejected and old option/text remains.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode being edited.
columnIDColumn Id of the column on which edit is performed.
selectedOptionIDIndex of the selected option. -1 value suggests that edited text is not among the available options in edit-control; particularly useful when edit-control type is BlockStyler.Tree.ControlType.ListBox .
selectedOptionTextThe text being edited.
typeEdit-control type
delegate NXOpen.BlockStyler.Tree.EndLabelEditState NXOpen.BlockStyler.Tree.OnEndLabelEditCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID,
string  editedText 
)

Represents the callback which gets called when label edit is completed on any column.

The edited label is accepted/rejected based on return value of this callback.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode being edited.
columnIDColumn Id of the column on which label edit is performed.
editedTextText after edit.
delegate void NXOpen.BlockStyler.Tree.OnExpandCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node 
)

Represents the callback which gets called when the node is expanded.

This is called only once.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode.
delegate void NXOpen.BlockStyler.Tree.OnInsertColumnCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID 
)

Represents the callback which gets called for each node when the column is inserted using BlockStyler.Tree.InsertColumn .

This callback in not invoked if no node is available on the tree.

In this callback it is expected to provide column text for individual node.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode.
columnIDColumn id of the newly inserted column.
delegate void NXOpen.BlockStyler.Tree.OnInsertNodeCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node 
)

Represents the callback which gets called when the node is inserted.

Created in NX6.0.0

License requirements: None.

Parameters
treeTree.
nodeNewly inserted node
delegate void NXOpen.BlockStyler.Tree.OnMenuCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID 
)

Represents the callback which gets called when MB3 or right click is attempted on node or tree.

Value of Node parameter is a null reference (Nothing in Visual Basic) if MB3 is attempted on area other than node. This distinction allows to have separate menu for node and tree.

The menu can be made available using two methods BlockStyler.Tree.CreateMenu and BlockStyler.Tree.SetMenu . Subsequently BlockStyler.Tree.OnMenuSelectionCallback is invoked after the menu item is selected.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode on which MB3 is attempted or menu is invoked. a null reference (Nothing in Visual Basic) if MB3 is attempted on area other than node.
columnIDColumn Id of the column on which MB3 is attempted
delegate void NXOpen.BlockStyler.Tree.OnMenuSelectionCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  menuItemID 
)

Represents the callback which gets called when one of the menu option is selected.

Refer to callback BlockStyler.Tree.OnMenuCallback to make available the menu.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode on which MB3 is attempted or menu is invoked. a null reference (Nothing in Visual Basic) if MB3 is attempted on area other than node.
menuItemIDMenu item Id representing the selected menu item. This menu Id corresponds to the menu item added to the BlockStyler.TreeListMenu using BlockStyler.TreeListMenu.AddMenuItem .
delegate void NXOpen.BlockStyler.Tree.OnPreSelectCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID,
bool  selected 
)

Represents the callback which gets called when pre selection is attempted on node.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode.
columnIDColumn id of the column on which pre-selection is attempted.
selectedSelect/Deselect flag.
delegate void NXOpen.BlockStyler.Tree.OnSelectCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID,
bool  selected 
)

Represents the callback which gets called when the node is selected.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode.
columnIDColumn Id of the column on which selection is made.
selectedSelect/Deselect flag.
delegate void NXOpen.BlockStyler.Tree.OnStateChangeCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  state 
)

Represents the callback which gets called when the state icon is clicked.

This callback does not get called when state is changed using the method BlockStyler.Node.SetState . The node state can be changed in this callback using BlockStyler.Node.SetState , e.g., node can be changed from checked state to unchecked state and vice-versa.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode.
stateCurrent node state.
unsafe void NXOpen.BlockStyler.Tree.Redraw ( bool  redraw)
inline

Freezes the tree if the value is set to False which implies that no changes would occur in the tree after this point.

The tree remains in that state until the value is set to True, after which the tree completely updates itself with the changes performed on it in between the two calls. Use this method to efficiently utilize the tree when it is subjected to enourmous changes.

Created in NX7.5.0

License requirements: None.

Parameters
redrawFlag corresponds to freeze/unfreeze of tree changes.
unsafe void NXOpen.BlockStyler.Tree.SelectNode ( NXOpen.BlockStyler.Node  node,
bool  isSelect,
bool  isOtherNodeAffected 
)
inline

Selects the provided node.

Created in NX7.5.0

License requirements: None.

Parameters
nodeNode to be selected
isSelectSelect/Deselect flag. If true, the provided node is selected, else deselected.
isOtherNodeAffectedFlag indicating whether selection of other nodes is affected. If true, all the previous selected nodes are deselected, else unaffected.
unsafe void NXOpen.BlockStyler.Tree.SelectNodes ( NXOpen.BlockStyler.Node[]  node,
bool  isSelect,
bool  isOtherNodeAffected 
)
inline

Selects the provided nodes.

Created in NX7.5.0

License requirements: None.

Parameters
nodeNodes to be selected
isSelectSelect/Deselect flag. If true, the provided nodes are selected, else deselected.
isOtherNodeAffectedFlag indicating whether selection of other nodes is affected. If true, all the previous selected nodes are deselected, else remain so.
unsafe void NXOpen.BlockStyler.Tree.SetAskEditControlHandler ( NXOpen.BlockStyler.Tree.AskEditControlCallback  cb)
inline

Sets the node-edit-control callback

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetColumnDisplayType ( int  columnID,
NXOpen.BlockStyler.Tree.ColumnDisplay  displayType 
)
inline

Sets the display type of the column.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
displayTypeDisplay type.
unsafe void NXOpen.BlockStyler.Tree.SetColumnResizePolicy ( int  columnID,
NXOpen.BlockStyler.Tree.ColumnResizePolicy  resizePolicy 
)
inline

Sets the column resize policy.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column
resizePolicyResize policy
unsafe void NXOpen.BlockStyler.Tree.SetColumnSortable ( int  columnID,
bool  isSortable 
)
inline

Sets the flag indicating whether the column is sortable.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
isSortableFlag indicating whether the column is sortable.
unsafe void NXOpen.BlockStyler.Tree.SetColumnSortHandler ( NXOpen.BlockStyler.Tree.ColumnSortCallback  cb)
inline

Sets the column sort callback.

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetColumnSortOption ( int  columnID,
NXOpen.BlockStyler.Tree.ColumnSortOption  sortOption 
)
inline

Sets the column sort option.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
sortOptionColumn sort option.
unsafe void NXOpen.BlockStyler.Tree.SetColumnTitle ( int  columnID,
string  columnHeaderTitle 
)
inline

Sets the column title.

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
columnHeaderTitleColumn header title.
unsafe void NXOpen.BlockStyler.Tree.SetColumnVisible ( int  columnID,
bool  isVisible 
)
inline

Sets the flag indicating whether the column is visible

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column
isVisibleFlag indicating whether the column is visible
unsafe void NXOpen.BlockStyler.Tree.SetColumnWidth ( int  columnID,
int  columnWidth 
)
inline

Sets the column width

Created in NX7.5.0

License requirements: None.

Parameters
columnIDUnique column Id associated with the column.
columnWidthColumn width.
unsafe void NXOpen.BlockStyler.Tree.SetEditOptions ( string[]  stringArray,
int  defaultIndex 
)
inline

Sets the options in edit-control.

This method must be used in BlockStyler.Tree.AskEditControlCallback to make available the options in edit-control.

Created in NX7.5.0

License requirements: None.

Parameters
stringArrayOptions to be made availabe in edit-control
defaultIndexIndex for default selection. This is zero based, for instance if it is set to 1 then 2nd option is selected by default during edit operation.
unsafe void NXOpen.BlockStyler.Tree.SetIsDragAllowedHandler ( NXOpen.BlockStyler.Tree.IsDragAllowedCallback  cb)
inline

Sets the callback handler for node drag

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetIsDropAllowedHandler ( NXOpen.BlockStyler.Tree.IsDropAllowedCallback  cb)
inline

Sets the callback handler for node drop

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetMenu ( NXOpen.BlockStyler.TreeListMenu  menu)
inline

Sets the menu, resulting the menu to appear on the screen.

This method must be used in callback which is intended to create menu, such as BlockStyler.Tree.OnMenuCallback

Created in NX7.5.0

License requirements: None.

Parameters
menuMenu.
unsafe void NXOpen.BlockStyler.Tree.SetOnBeginLabelEditHandler ( NXOpen.BlockStyler.Tree.OnBeginLabelEditCallback  cb)
inline

Sets the on-begin-label-edit callback

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetOnDefaultActionHandler ( NXOpen.BlockStyler.Tree.OnDefaultActionCallback  cb)
inline

Sets the on select node callback

Created in NX7.5.2

License requirements: None.

Parameters
cbCallback.
unsafe void NXOpen.BlockStyler.Tree.SetOnDeleteNodeHandler ( NXOpen.BlockStyler.Tree.OnDeleteNodeCallback  cb)
inline

Sets on delete node callback

Created in NX6.0.0

License requirements: None.

Parameters
cbCallback.
unsafe void NXOpen.BlockStyler.Tree.SetOnDropHandler ( NXOpen.BlockStyler.Tree.OnDropCallback  cb)
inline

Sets the callback handler for node drop

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetOnDropMenuHandler ( NXOpen.BlockStyler.Tree.OnDropMenuCallback  cb)
inline

Sets the callback handler for on drop menu.

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetOnEditOptionSelectedHandler ( NXOpen.BlockStyler.Tree.OnEditOptionSelectedCallback  cb)
inline

Sets the on-end-label-edit callback

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetOnEndLabelEditHandler ( NXOpen.BlockStyler.Tree.OnEndLabelEditCallback  cb)
inline

Sets the on-end-label-edit callback

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetOnExpandHandler ( NXOpen.BlockStyler.Tree.OnExpandCallback  cb)
inline

Sets the on expand callback to the tree.

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetOnInsertColumnHandler ( NXOpen.BlockStyler.Tree.OnInsertColumnCallback  cb)
inline

Sets the on insert column callback to the tree.

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback.
unsafe void NXOpen.BlockStyler.Tree.SetOnInsertNodeHandler ( NXOpen.BlockStyler.Tree.OnInsertNodeCallback  cb)
inline

Sets the on insert node callback.

Created in NX6.0.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetOnMenuHandler ( NXOpen.BlockStyler.Tree.OnMenuCallback  cb)
inline

Sets the on menu callback

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback.
unsafe void NXOpen.BlockStyler.Tree.SetOnMenuSelectionHandler ( NXOpen.BlockStyler.Tree.OnMenuSelectionCallback  cb)
inline

Sets the on menu selection callback

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback.
unsafe void NXOpen.BlockStyler.Tree.SetOnPreSelectHandler ( NXOpen.BlockStyler.Tree.OnPreSelectCallback  cb)
inline

Sets on pre select callback

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetOnSelectHandler ( NXOpen.BlockStyler.Tree.OnSelectCallback  cb)
inline

Sets the on select node callback

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback.
unsafe void NXOpen.BlockStyler.Tree.SetOnStateChangeHandler ( NXOpen.BlockStyler.Tree.OnStateChangeCallback  cb)
inline

Sets the on state change callback.

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback
unsafe void NXOpen.BlockStyler.Tree.SetPreSelectionTimeOut ( double  timeOut)
inline

Sets the pre selection time out.

BlockStyler.Tree.OnPreSelectCallback is called based on this value.

Created in NX7.5.0

License requirements: None.

Parameters
timeOutTime in millisecond
unsafe void NXOpen.BlockStyler.Tree.SetStateIconNameHandler ( NXOpen.BlockStyler.Tree.StateIconNameCallback  cb)
inline

Sets the state icon name callback.

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback.
unsafe void NXOpen.BlockStyler.Tree.SetToolTipTextHandler ( NXOpen.BlockStyler.Tree.ToolTipTextCallback  cb)
inline

Sets the tool tip callback.

Created in NX7.5.0

License requirements: None.

Parameters
cbCallback.
delegate string NXOpen.BlockStyler.Tree.StateIconNameCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  state 
)

Represents the callback which gets called when the node state is set by BlockStyler.Node.SetState and the corresponding state icon of node state is not known.

This callback is expected to provide the icon name for the node state used in the application. This callback is called only once for any given node state.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode.
stateNode state for which callback is expected to return state icon name.
delegate string NXOpen.BlockStyler.Tree.ToolTipTextCallback ( NXOpen.BlockStyler.Tree  tree,
NXOpen.BlockStyler.Node  node,
int  columnID 
)

Represents the callback which gets called when tree seeks the tooltip.

Created in NX7.5.0

License requirements: None.

Parameters
treeTree.
nodeNode for which tooltip is sought.
columnIDColumn Id of the column for which tooltip is sought.

Property Documentation

unsafe bool NXOpen.BlockStyler.Tree.CanStretchHeight
getset

Returns or sets the CanStretchHeight.

If true, height of list box will change.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Tree.CanStretchWidth
getset

Returns or sets the CanStretchWidth.

If true, width of TreeList block will change.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Tree.FirstSelectedNode
get

Returns the first selected node among the available selected nodes.

Returns a null reference (Nothing in Visual Basic) if no node is selected.

Created in NX7.5.0

License requirements: None.

unsafe int NXOpen.BlockStyler.Tree.Height
getset

Returns or sets the Height

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Tree.Localize
getset

Returns or sets the Localize

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.Tree.MaximumHeight
getset

Returns or sets the MaximumHeight

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.Tree.MaximumWidth
getset

Returns or sets the MaximumWidth

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.Tree.MinimumHeight
getset

Returns or sets the MinimumHeight

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.Tree.MinimumWidth
getset

Returns or sets the MinimumWidth

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.Tree.NumberOfColumns
get

Returns the number of column inserted in the tree.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Tree.RootNode
get

Returns the root node.

If more than one root node is available in top hierarchy then the first root node is returned.

Created in NX7.5.0

License requirements: None.

unsafe int NXOpen.BlockStyler.Tree.ScrollFrozenColumn
getset

Returns or sets the ScrollFrozenColumn.

It specifies the number of columns to freeze while scrolling.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.Tree.ScrollLineNumber
getset

Returns or sets the ScrollLineNumber.

It specifies the number of lines to scroll when the mouse wheel rotates.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.Tree.SelectionModeAsString
getset

Returns or sets the SelectionMode

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Tree.ShowExpandCollapseMarker
getset

Returns or sets the ShowExpandCollapseMarker.

If true, displays a sign as a marker alongside first node of the tree indicating if it is expanded or collapsed.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Tree.ShowHeader
getset

Returns or sets the ShowHeader

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Tree.ShowMultipleColumns
getset

Returns or sets the ShowMultipleColumns

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Tree.ShowToolTips
getset

Returns or sets the ShowToolTips

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Tree.SortRootNodes
getset

Returns or sets the SortRootNodes.

If true, sorting of root nodes is allowed.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.Tree.Width
getset

Returns or sets the Width

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.