Represents the node created and utilized by BlockStyler.Tree . More...

Inheritance diagram for NXOpen.BlockStyler.Node:

Public Types
enum	DragType { None, All }
	Represents the drag type More...

enum	DropType { None, On, Before, After, BeforeAndAfter }
	Represents the drop type More...

enum	ExpandOption { Collapse, Expand, Toggle }
	Represents the Expand/Collapse option More...

enum	Scroll { Center, LeastScroll, MostScroll }
	Represents the scroll position to be applied on node. More...

Public Member Functions
unsafe void	Expand (NXOpen.BlockStyler.Node.ExpandOption expandOption)
	Expands/collapses the node More...

unsafe string	GetColumnDisplayText (int columnID)
	Gets the column text for the given columnId. More...

unsafe NXOpen.DataContainer	GetNodeData ()
	Gets node data which contains the data in the form of unique name-value pairs. More...

unsafe int	GetState ()
	Gets the node state associated with node state icon. More...

unsafe void	ScrollTo (int columnID, NXOpen.BlockStyler.Node.Scroll visibleOption)
	Scrolls horizontally and vertically to make the specific column of node appear on the tree window. More...

unsafe void	SetColumnDisplayText (int columnID, string columnDisplayText)
	Sets the text in the column which corresponds to given columnId. More...

unsafe void	SetState (int state)
	Sets the node state which is associated with node state icon. 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	CrossSelection `[get, set]`
	Returns or sets the flag indicating whether cross section is allowed. More...

unsafe string	DisplayIcon `[get, set]`
	Returns or sets the display icon. More...

unsafe string	DisplayText `[get, set]`
	Returns or sets the display text of node. More...

unsafe NXOpen.BlockStyler.Node	FirstChildNode `[get]`
	Returns the first child node. More...

unsafe int	ForegroundColor `[get, set]`
	Returns or sets the text color of the node. More...

unsafe bool	IsExpanded `[get]`
	Returns the flag indicating whether the node is in expanded state More...

unsafe bool	IsInserted `[get]`
	Returns the flag indicating whether the node is inserted in BlockStyler.Tree More...

unsafe bool	IsSelected `[get]`
	Returns the flag indicating whether the node is in selected state More...

unsafe NXOpen.BlockStyler.Node	NextNode `[get]`
	Returns the next node which might not belong to the same hierarchy. More...

unsafe NXOpen.BlockStyler.Node	NextSelectedNode `[get]`
	Returns the next selected node in the whole tree hierarchy. More...

unsafe NXOpen.BlockStyler.Node	NextSiblingNode `[get]`
	Returns the next node which belongs to the same hierarchy. More...

unsafe NXOpen.BlockStyler.Node	ParentNode `[get]`
	Returns the parent node. More...

unsafe NXOpen.BlockStyler.Node	PreviousNode `[get]`
	Returns the previous node which might not belong to the same hierarchy. More...

unsafe NXOpen.BlockStyler.Node	PreviousSelectedNode `[get]`
	Returns the previous selected node in the whole tree hierarchy. More...

unsafe NXOpen.BlockStyler.Node	PreviousSiblingNode `[get]`
	Returns the previous node which belongs to the same hierarchy. More...

unsafe string	SelectedIcon `[get, set]`
	Returns or sets the selected icon. 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 node created and utilized by BlockStyler.Tree .

The node represents the single row of the tree.

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.BlockStyler.Node.DragType

Represents the drag type

Enumerator
None	No drag
All	Drag allowed to any level in the same tree

enum NXOpen.BlockStyler.Node.DropType

Represents the drop type

Enumerator
None	Drop not permitted
On	Drop permitted on the target node
Before	Drop permitted before the target node
After	Drop permitted after the target node
BeforeAndAfter	Drop permitted before and after the target node

enum NXOpen.BlockStyler.Node.ExpandOption

Represents the Expand/Collapse option

Enumerator

Collapse

Use this option to collapse the node.

Expand

Use this option to expand the node.

The child node state is unaltered.

Toggle

Use this option to collapse the expanded node or expand the collapsed node.

enum NXOpen.BlockStyler.Node.Scroll

Represents the scroll position to be applied on node.

Use one of these options to make the node appear in tree window.

Enumerator
Center	Scrolls the tree to bring the node at the center of the tree window
LeastScroll	Scrolls the tree to minimal to make the node appear in tree window
MostScroll	Scrolls the tree to maximum to make the node appear in tree window

Member Function Documentation

unsafe void NXOpen.BlockStyler.Node.Expand ( NXOpen.BlockStyler.Node.ExpandOption expandOption )

inline

Expands/collapses the node

Created in NX7.5.0

License requirements: None.

Parameters

expandOption Expand option

unsafe string NXOpen.BlockStyler.Node.GetColumnDisplayText ( int columnID )

inline

Gets the column text for the given columnId.

The text is interpreted as icon if the column display type is BlockStyler.Tree.ColumnDisplay.Icon .

Created in NX7.5.0

License requirements: None.

Parameters

columnID Unique column id of the column.

Returns: Text associated with column.

unsafe NXOpen.DataContainer NXOpen.BlockStyler.Node.GetNodeData ( )

inline

Gets node data which contains the data in the form of unique name-value pairs.

In this context unique name is termed as property name. There could me more than one such property name - value pair, but the property name of the primary data should be named "Data" (case-sensitive). For instance, if a BlockStyler.Node represents a feature object then property name should be "Data" and the value should be feature object. The primary data is used by NX for some operations such cross selection.

Initialy the container or list is empty and it is expected that data would be added to it. Additional property name - value pair can be added to the container or list, but it should be made sure that there is no dublicate property name exists in the container or list. The additional data can be seen as book keeping information for node. At any point the node data can be fetched and value can be extracted using the corresponding property name. Refer to NXOpen.DataContainer on how property name-value pair is added to the container or list.

Created in NX7.5.0

License requirements: None.

Returns: Node data which is list of property name - value pair. New property name - value pair can be added to it and existing value can be fetched using corresponding property name.

unsafe int NXOpen.BlockStyler.Node.GetState ( )

inline

Gets the node state associated with node state icon.

Node state is an iconic representation, e.g., checked/unchecked icons for corresponding state. Node state value 1 and 2 represents the standard checked and unchecked state respectively.

Created in NX7.5.0

License requirements: None.

Returns: Node state

unsafe void NXOpen.BlockStyler.Node.ScrollTo	(	int	columnID,
		NXOpen.BlockStyler.Node.Scroll	visibleOption
	)

inline

Scrolls horizontally and vertically to make the specific column of node appear on the tree window.

Created in NX7.5.0

License requirements: None.

Parameters

columnID	ColumnId of the column to which tree window scrolls horizontally.
visibleOption	Option to scroll the tree window vertically.

unsafe void NXOpen.BlockStyler.Node.SetColumnDisplayText	(	int	columnID,
		string	columnDisplayText
	)

inline

Sets the text in the column which corresponds to given columnId.

The text is interpreted as icon if the column display type is BlockStyler.Tree.ColumnDisplay.Icon .

Created in NX7.5.0

License requirements: None.

Parameters

columnID	Unique coulmn id of the column.
columnDisplayText	Text associated with column

unsafe void NXOpen.BlockStyler.Node.SetState ( int state )

inline

Sets the node state which is associated with node state icon.

Node state is an iconic representation, e.g., checked/unchecked state. Setting node state to value other than 1 and 2 calls BlockStyler.Tree.StateIconName callback to fetch the icon name. Node state can be set only after the node has been added to TreeList.

Created in NX7.5.0

License requirements: None.

Parameters

state Node state

Property Documentation

unsafe bool NXOpen.BlockStyler.Node.CrossSelection

getset

Returns or sets the flag indicating whether cross section is allowed.

It is useful when the node contains NXOpen.DisplayableObject as data. If the flag is true then the NXOpen.DisplayableObject is highlighted, else not. The default value is True

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.Node.DisplayIcon

getset

Returns or sets the display icon.

This is normal icon positioned before the node text and is displayed when the node is in unselected state.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.Node.DisplayText

getset

Returns or sets the display text of node.

This is same as 0th column text of this node. Use BlockStyler.Node.SetColumnDisplayText to fetch the text of other column of the same node.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Node.FirstChildNode

get

Returns the first child node.

Returns a null reference (Nothing in Visual Basic) if child node is not present.

Created in NX7.5.0

License requirements: None.

unsafe int NXOpen.BlockStyler.Node.ForegroundColor

getset

Returns or sets the text color of the node.

The color is applicable for whole row.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.Node.IsExpanded

get

Returns the flag indicating whether the node is in expanded state

Created in NX7.5.3

License requirements: None.

unsafe bool NXOpen.BlockStyler.Node.IsInserted

get

Returns the flag indicating whether the node is inserted in BlockStyler.Tree

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.BlockStyler.Node.IsSelected

get

Returns the flag indicating whether the node is in selected state

Created in NX7.5.3

License requirements: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Node.NextNode

get

Returns the next node which might not belong to the same hierarchy.

The next node either is a sibling node or belongs to other root node. Returns a null reference (Nothing in Visual Basic) if next node is not present

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Node.NextSelectedNode

get

Returns the next selected node in the whole tree hierarchy.

The node on which this method is called does not have to be selected. Returns a null reference (Nothing in Visual Basic) if none of the next nodes are selected.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Node.NextSiblingNode

get

Returns the next node which belongs to the same hierarchy.

Returns a null reference (Nothing in Visual Basic) null if next sibling node is not present.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Node.ParentNode

get

Returns the parent node.

Returns a null reference (Nothing in Visual Basic) if parent node is not present

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Node.PreviousNode

get

Returns the previous node which might not belong to the same hierarchy.

Returns a null reference (Nothing in Visual Basic) null if previous node is not present

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Node.PreviousSelectedNode

get

Returns the previous selected node in the whole tree hierarchy.

The node on which this method is called does not have to be selected. Returns a null reference (Nothing in Visual Basic) if none of the previous nodes are selected.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.BlockStyler.Node NXOpen.BlockStyler.Node.PreviousSiblingNode

get

Returns the previous node which belongs to the same hierarchy.

Returns a null reference (Nothing in Visual Basic) if previous sibling node is not present.

Created in NX7.5.0

License requirements: None.

unsafe string NXOpen.BlockStyler.Node.SelectedIcon

getset

Returns or sets the selected icon.

This icon appears on node selection and is positioned before the node text replacing the BlockStyler.Node.DisplayIcon .

Created in NX7.5.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:

BlockStyler_Node.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation