NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::BlockStyler::CompositeBlock Class Reference

A composite block is a block that contains other blocks
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::BlockStyler::CompositeBlock:
NXOpen::BlockStyler::UIBlock NXOpen::TaggedObject

Public Member Functions

NXString Cue ()
 Returns the Cue
Created in NX8.5.0. More...
 
int DialogSizing ()
 Returns the Dialog Sizing
Created in NX8.5.0. More...
 
NXString DialogSizingAsString ()
 Returns the Dialog Sizing as string
Created in NX8.5.0. More...
 
NXOpen::BlockStyler::UIBlockFindBlock (const NXString &blockName)
 Finds a block contained in the composite block. More...
 
NXOpen::BlockStyler::UIBlockFindBlock (const char *blockName)
 Finds a block contained in the composite block. More...
 
std::vector
< NXOpen::BlockStyler::UIBlock * > 
GetBlocks ()
 Gets all the blocks available in the composite block. More...
 
std::vector< NXStringGetDialogSizingMembers ()
 Gets the Dialog Sizing members. More...
 
std::vector< NXStringGetNavigationStyleMembers ()
 Gets the Navigation Style members. More...
 
NXOpen::BlockStyler::UIBlockLastUpdated ()
 Returns the block contained in the composite block that was last updated. More...
 
int NavigationStyle ()
 Returns the Navigation Style
Created in NX8.5.0. More...
 
NXString NavigationStyleAsString ()
 Returns the Navigation Style as string
Created in NX8.5.0. More...
 
void SetCue (const NXString &cue)
 Sets the Cue
Created in NX8.5.0. More...
 
void SetCue (const char *cue)
 Sets the Cue
Created in NX8.5.0. More...
 
void SetDialogSizing (int enumIndex)
 Sets the Dialog Sizing
Created in NX8.5.0. More...
 
void SetDialogSizingAsString (const NXString &enumString)
 Sets the Dialog Sizing as string
Created in NX8.5.0. More...
 
void SetDialogSizingAsString (const char *enumString)
 Sets the Dialog Sizing as string
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool Enable ()
 Returns the Enable. More...
 
bool Expanded ()
 Returns the Expanded
Created in NX8.5.0. More...
 
void Focus ()
 Focuses on the block. More...
 
NXOpen::BlockStyler::PropertyListGetProperties ()
 Returns the properties of the block. More...
 
bool Group ()
 Returns the Group
Created in NX8.5.0. More...
 
NXString Label ()
 Returns the Label
Created in NX8.5.0. More...
 
NXString Name ()
 Returns the name of the block or BlockID
Created in NX6.0.0. More...
 
void SetEnable (bool enable)
 Sets the Enable. More...
 
void SetExpanded (bool expanded)
 Sets the Expanded
Created in NX8.5.0. More...
 
void SetGroup (bool group)
 Sets the Group
Created in NX8.5.0. More...
 
void SetLabel (const NXString &label)
 Sets the Label
Created in NX8.5.0. More...
 
void SetLabel (const char *label)
 Sets the Label
Created in NX8.5.0. More...
 
void SetShow (bool show)
 Sets the Visibility of block. More...
 
bool Show ()
 Returns the Visibility of block. More...
 
NXString Type ()
 Returns the type of block
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

A composite block is a block that contains other blocks
Created in NX6.0.0.


Member Function Documentation

NXString NXOpen::BlockStyler::CompositeBlock::Cue ( )

Returns the Cue
Created in NX8.5.0.



License requirements : None

int NXOpen::BlockStyler::CompositeBlock::DialogSizing ( )

Returns the Dialog Sizing
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::CompositeBlock::DialogSizingAsString ( )

Returns the Dialog Sizing as string
Created in NX8.5.0.



License requirements : None

NXOpen::BlockStyler::UIBlock* NXOpen::BlockStyler::CompositeBlock::FindBlock ( const NXString blockName)

Finds a block contained in the composite block.

Throws an exception if block not present

Returns

Created in NX6.0.0.

License requirements : None
Parameters
blockNameBlock name
NXOpen::BlockStyler::UIBlock* NXOpen::BlockStyler::CompositeBlock::FindBlock ( const char *  blockName)

Finds a block contained in the composite block.

Throws an exception if block not present

Returns

Created in NX6.0.0.

License requirements : None
Parameters
blockNameBlock name
std::vector<NXOpen::BlockStyler::UIBlock *> NXOpen::BlockStyler::CompositeBlock::GetBlocks ( )

Gets all the blocks available in the composite block.

Returns

Created in NX6.0.0.

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::CompositeBlock::GetDialogSizingMembers ( )

Gets the Dialog Sizing members.

Returns
Value to get from the property
Created in NX8.5.0.

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::CompositeBlock::GetNavigationStyleMembers ( )

Gets the Navigation Style members.

Returns
Value to get from the property
Created in NX8.5.0.

License requirements : None
NXOpen::BlockStyler::UIBlock* NXOpen::BlockStyler::CompositeBlock::LastUpdated ( )

Returns the block contained in the composite block that was last updated.

For example, if the CompositeBlock is an item contained in a SetList and your update handler is notified that the CompositeBlock has been updated, this method returns which block inside the CompositeBlock has been updated.
Created in NX6.0.0.

License requirements : None

int NXOpen::BlockStyler::CompositeBlock::NavigationStyle ( )

Returns the Navigation Style
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::CompositeBlock::NavigationStyleAsString ( )

Returns the Navigation Style as string
Created in NX8.5.0.



License requirements : None

void NXOpen::BlockStyler::CompositeBlock::SetCue ( const NXString cue)

Sets the Cue
Created in NX8.5.0.



License requirements : None

Parameters
cuecue
void NXOpen::BlockStyler::CompositeBlock::SetCue ( const char *  cue)

Sets the Cue
Created in NX8.5.0.



License requirements : None

Parameters
cuecue
void NXOpen::BlockStyler::CompositeBlock::SetDialogSizing ( int  enumIndex)

Sets the Dialog Sizing
Created in NX8.5.0.



License requirements : None

Parameters
enumIndexenumindex
void NXOpen::BlockStyler::CompositeBlock::SetDialogSizingAsString ( const NXString enumString)

Sets the Dialog Sizing as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::CompositeBlock::SetDialogSizingAsString ( const char *  enumString)

Sets the Dialog Sizing as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring

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