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

Inheritance diagram for NXOpen::BlockStyler::Node:

Public Types
enum	DragType { DragTypeNone, DragTypeAll }
	Represents the drag type. More...

enum	DropType { DropTypeNone, DropTypeOn, DropTypeBefore, DropTypeAfter, DropTypeBeforeAndAfter }
	Represents the drop type. More...

enum	ExpandOption { ExpandOptionCollapse, ExpandOptionExpand, ExpandOptionToggle }
	Represents the Expand/Collapse option. More...

enum	Scroll { ScrollCenter, ScrollLeastScroll, ScrollMostScroll }
	Represents the scroll position to be applied on node. More...

Public Member Functions
bool	CrossSelection ()
	Returns the flag indicating whether cross section is allowed. More...

NXString	DisplayIcon ()
	Returns the display icon. More...

NXString	DisplayText ()
	Returns the display text of node. More...

void	Expand (NXOpen::BlockStyler::Node::ExpandOption expandOption)
	Expands/collapses the node Created in NX7.5.0. More...

NXOpen::BlockStyler::Node *	FirstChildNode ()
	Returns the first child node. More...

int	ForegroundColor ()
	Returns the text color of the node. More...

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

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

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

bool	IsExpanded ()
	Returns the flag indicating whether the node is in expanded state Created in NX7.5.3. More...

bool	IsInserted ()
	Returns the flag indicating whether the node is inserted in BlockStyler::Tree Created in NX7.5.0. More...

bool	IsSelected ()
	Returns the flag indicating whether the node is in selected state Created in NX7.5.3. More...

NXOpen::BlockStyler::Node *	NextNode ()
	Returns the next node which might not belong to the same hierarchy. More...

NXOpen::BlockStyler::Node *	NextSelectedNode ()
	Returns the next selected node in the whole tree hierarchy. More...

NXOpen::BlockStyler::Node *	NextSiblingNode ()
	Returns the next node which belongs to the same hierarchy. More...

NXOpen::BlockStyler::Node *	ParentNode ()
	Returns the parent node. More...

NXOpen::BlockStyler::Node *	PreviousNode ()
	Returns the previous node which might not belong to the same hierarchy. More...

NXOpen::BlockStyler::Node *	PreviousSelectedNode ()
	Returns the previous selected node in the whole tree hierarchy. More...

NXOpen::BlockStyler::Node *	PreviousSiblingNode ()
	Returns the previous node which belongs to the same hierarchy. More...

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...

NXString	SelectedIcon ()
	Returns the selected icon. More...

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

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

void	SetCrossSelection (bool crossSelection)
	Sets the flag indicating whether cross section is allowed. More...

void	SetDisplayIcon (const NXString &icon)
	Sets the display icon. More...

void	SetDisplayIcon (const char *icon)
	Sets the display icon. More...

void	SetDisplayText (const NXString &displayTest)
	Sets the display text of node. More...

void	SetDisplayText (const char *displayTest)
	Sets the display text of node. More...

void	SetForegroundColor (int nodeForgroundColor)
	Sets the text color of the node. More...

void	SetSelectedIcon (const NXString &icon)
	Sets the selected icon. More...

void	SetSelectedIcon (const char *icon)
	Sets the selected icon. More...

void	SetState (int state)
	Sets the node state which is associated with node state icon. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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
DragTypeNone	No drag.
DragTypeAll	Drag allowed to any level in the same tree.

enum NXOpen::BlockStyler::Node::DropType

Represents the drop type.

Enumerator
DropTypeNone	Drop not permitted.
DropTypeOn	Drop permitted on the target node.
DropTypeBefore	Drop permitted before the target node.
DropTypeAfter	Drop permitted after the target node.
DropTypeBeforeAndAfter	Drop permitted before and after the target node.

enum NXOpen::BlockStyler::Node::ExpandOption

Represents the Expand/Collapse option.

Enumerator

ExpandOptionCollapse

Use this option to collapse the node.

ExpandOptionExpand

Use this option to expand the node.

The child node state is unaltered.

ExpandOptionToggle

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
ScrollCenter	Scrolls the tree to bring the node at the center of the tree window.
ScrollLeastScroll	Scrolls the tree to minimal to make the node appear in tree window.
ScrollMostScroll	Scrolls the tree to maximum to make the node appear in tree window.

Member Function Documentation

bool NXOpen::BlockStyler::Node::CrossSelection ( )

Returns 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 : None

NXString NXOpen::BlockStyler::Node::DisplayIcon ( )

Returns 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 : None

NXString NXOpen::BlockStyler::Node::DisplayText ( )

Returns 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 : None

void NXOpen::BlockStyler::Node::Expand ( NXOpen::BlockStyler::Node::ExpandOption expandOption )

Expands/collapses the node
Created in NX7.5.0.

License requirements : None

Parameters

expandOption Expand option

NXOpen::BlockStyler::Node* NXOpen::BlockStyler::Node::FirstChildNode ( )

Returns the first child node.

Returns NULL if child node is not present.
Created in NX7.5.0.

License requirements : None

int NXOpen::BlockStyler::Node::ForegroundColor ( )

Returns the text color of the node.

The color is applicable for whole row.
Created in NX7.5.0.

License requirements : None

NXString NXOpen::BlockStyler::Node::GetColumnDisplayText ( int columnID )

Gets the column text for the given columnId.

The text is interpreted as icon if the column display type is BlockStyler::Tree::ColumnDisplayIcon .

Returns: Text associated with column.
Created in NX7.5.0.

License requirements : None

Parameters

columnID Unique column id of the column.

NXOpen::DataContainer* NXOpen::BlockStyler::Node::GetNodeData ( )

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.

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

License requirements : None

int NXOpen::BlockStyler::Node::GetState ( )

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.

Returns: Node state
Created in NX7.5.0.

License requirements : None

bool NXOpen::BlockStyler::Node::IsExpanded ( )

Returns the flag indicating whether the node is in expanded state
Created in NX7.5.3.

License requirements : None

bool NXOpen::BlockStyler::Node::IsInserted ( )

Returns the flag indicating whether the node is inserted in BlockStyler::Tree
Created in NX7.5.0.

License requirements : None

bool NXOpen::BlockStyler::Node::IsSelected ( )

Returns the flag indicating whether the node is in selected state
Created in NX7.5.3.

License requirements : None

NXOpen::BlockStyler::Node* NXOpen::BlockStyler::Node::NextNode ( )

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 NULL if next node is not present
Created in NX7.5.0.

License requirements : None

NXOpen::BlockStyler::Node* NXOpen::BlockStyler::Node::NextSelectedNode ( )

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 NULL if none of the next nodes are selected.
Created in NX7.5.0.

License requirements : None

NXOpen::BlockStyler::Node* NXOpen::BlockStyler::Node::NextSiblingNode ( )

Returns the next node which belongs to the same hierarchy.

Returns NULL null if next sibling node is not present.
Created in NX7.5.0.

License requirements : None

NXOpen::BlockStyler::Node* NXOpen::BlockStyler::Node::ParentNode ( )

Returns the parent node.

Returns NULL if parent node is not present
Created in NX7.5.0.

License requirements : None

NXOpen::BlockStyler::Node* NXOpen::BlockStyler::Node::PreviousNode ( )

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

Returns NULL null if previous node is not present
Created in NX7.5.0.

License requirements : None

NXOpen::BlockStyler::Node* NXOpen::BlockStyler::Node::PreviousSelectedNode ( )

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 NULL if none of the previous nodes are selected.
Created in NX7.5.0.

License requirements : None

NXOpen::BlockStyler::Node* NXOpen::BlockStyler::Node::PreviousSiblingNode ( )

Returns the previous node which belongs to the same hierarchy.

Returns NULL if previous sibling node is not present.
Created in NX7.5.0.

License requirements : None

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

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.

NXString NXOpen::BlockStyler::Node::SelectedIcon ( )

Returns the selected icon.

This icon appears on node selection and is positioned before the node text replacing the BlockStyler::Node::DisplayIcon and BlockStyler::Node::SetDisplayIcon .
Created in NX7.5.0.

License requirements : None

void NXOpen::BlockStyler::Node::SetColumnDisplayText	(	int	columnID,
		const NXString &	columnDisplayText
	)

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

License requirements : None

Parameters

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

void NXOpen::BlockStyler::Node::SetColumnDisplayText	(	int	columnID,
		const char *	columnDisplayText
	)

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

License requirements : None

Parameters

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

void NXOpen::BlockStyler::Node::SetCrossSelection ( bool crossSelection )

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 : None

Parameters

crossSelection Flag indicating whether cross selection is allowed.

void NXOpen::BlockStyler::Node::SetDisplayIcon ( const NXString & icon )

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 : None

Parameters

icon Icon.

void NXOpen::BlockStyler::Node::SetDisplayIcon ( const char * icon )

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 : None

Parameters

icon Icon.

void NXOpen::BlockStyler::Node::SetDisplayText ( const NXString & displayTest )

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 : None

Parameters

displayTest Display text

void NXOpen::BlockStyler::Node::SetDisplayText ( const char * displayTest )

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 : None

Parameters

displayTest Display text

void NXOpen::BlockStyler::Node::SetForegroundColor ( int nodeForgroundColor )

Sets the text color of the node.

The color is applicable for whole row.
Created in NX7.5.0.

License requirements : None

Parameters

nodeForgroundColor Foreground color.

void NXOpen::BlockStyler::Node::SetSelectedIcon ( const NXString & icon )

Sets the selected icon.

This icon appears on node selection and is positioned before the node text replacing the BlockStyler::Node::DisplayIcon and BlockStyler::Node::SetDisplayIcon .
Created in NX7.5.0.

License requirements : None

Parameters

icon Icon.

void NXOpen::BlockStyler::Node::SetSelectedIcon ( const char * icon )

Sets the selected icon.

This icon appears on node selection and is positioned before the node text replacing the BlockStyler::Node::DisplayIcon and BlockStyler::Node::SetDisplayIcon .
Created in NX7.5.0.

License requirements : None

Parameters

icon Icon.

void NXOpen::BlockStyler::Node::SetState ( int state )

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

The documentation for this class was generated from the following file:

BlockStyler_Node.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation