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

Represents an Enumeration block
Created in NX8.5.0. More...

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

Public Member Functions

bool AllowShortcuts ()
 Returns the AllowShortcuts. More...
 
NXString BalloonTooltipLayoutAsString ()
 Returns the BalloonTooltipLayout as string
Created in NX8.5.0. More...
 
bool BorderVisibility ()
 Returns the BorderVisibility
Created in NX8.5.0. More...
 
std::vector< NXStringGetBalloonTooltipImages ()
 Gets the BalloonTooltipImages. More...
 
std::vector< NXStringGetBalloonTooltipLayoutMembers ()
 Gets the BalloonTooltipLayout members. More...
 
std::vector< NXStringGetBalloonTooltipTexts ()
 Gets the BalloonTooltipTexts. More...
 
std::vector< NXStringGetBitmaps ()
 Gets the Bitmaps. More...
 
std::vector< NXStringGetEnumMembers ()
 Gets the Enum members. More...
 
std::vector< int > GetEnumSensitivity ()
 Gets EnumSensitivity. More...
 
std::vector< int > GetEnumVisibility ()
 Gets EnumVisibility. More...
 
std::vector< int > GetInitialShortcuts ()
 Gets InitialShortcuts. More...
 
std::vector< NXStringGetLayoutMembers ()
 Gets the Layout members. More...
 
std::vector< NXStringGetPresentationStyleMembers ()
 Gets the PresentationStyle members. More...
 
bool HighQualityBitmap ()
 Returns the HighQualityBitmap
Created in NX8.5.0. More...
 
bool IconsOnly ()
 Returns the IconsOnly. More...
 
bool LabelVisibility ()
 Returns the LabelVisibility
Created in NX8.5.0. More...
 
NXString LayoutAsString ()
 Returns the Layout as string
Created in NX8.5.0. More...
 
bool Localize ()
 Returns the Localize. More...
 
int NumberOfColumns ()
 Returns the NumberOfColumns
Created in NX8.5.0. More...
 
bool PackedColumns ()
 Returns the PackedColumns. More...
 
NXString PresentationStyleAsString ()
 Returns the PresentationStyle as string
Created in NX8.5.0. More...
 
bool RetainValue ()
 Returns the RetainValue
Created in NX8.5.0. More...
 
void SetAllowShortcuts (bool allow)
 Sets the AllowShortcuts. More...
 
void SetBalloonTooltipImages (std::vector< NXString > &imageStrings)
 Sets the BalloonTooltipImages
Created in NX8.5.0. More...
 
void SetBalloonTooltipLayoutAsString (const NXString &enumString)
 Sets the BalloonTooltipLayout as string
Created in NX8.5.0. More...
 
void SetBalloonTooltipLayoutAsString (const char *enumString)
 Sets the BalloonTooltipLayout as string
Created in NX8.5.0. More...
 
void SetBalloonTooltipTexts (std::vector< NXString > &tooltipTextArray)
 Sets the BalloonTooltipTexts
Created in NX8.5.0. More...
 
void SetBitmaps (std::vector< NXString > &bitmapsStrings)
 Sets the Bitmaps
Created in NX8.5.0. More...
 
void SetBorderVisibility (bool visibility)
 Sets the BorderVisibility
Created in NX8.5.0. More...
 
void SetEnumMembers (std::vector< NXString > &memberStrings)
 Sets the Enum members. More...
 
void SetEnumSensitivity (const std::vector< int > &valueVector)
 Sets EnumSensitivity
Created in NX8.5.0. More...
 
void SetEnumVisibility (const std::vector< int > &valueVector)
 Sets EnumVisibility
Created in NX8.5.0. More...
 
void SetHighQualityBitmap (bool highQuality)
 Sets the HighQualityBitmap
Created in NX8.5.0. More...
 
void SetIconsOnly (bool iconsOnly)
 Sets the IconsOnly. More...
 
void SetInitialShortcuts (const std::vector< int > &valueVector)
 Sets InitialShortcuts. More...
 
void SetLabelVisibility (bool visibility)
 Sets the LabelVisibility
Created in NX8.5.0. More...
 
void SetLayoutAsString (const NXString &enumString)
 Sets the Layout as string
Created in NX8.5.0. More...
 
void SetLayoutAsString (const char *enumString)
 Sets the Layout as string
Created in NX8.5.0. More...
 
void SetLocalize (bool localize)
 Sets the Localize. More...
 
void SetNumberOfColumns (int numColumn)
 Sets the NumberOfColumns
Created in NX8.5.0. More...
 
void SetPackedColumns (bool packedColumns)
 Sets the PackedColumns. More...
 
void SetPresentationStyleAsString (const NXString &enumString)
 Sets the PresentationStyle as string
Created in NX8.5.0. More...
 
void SetPresentationStyleAsString (const char *enumString)
 Sets the PresentationStyle as string
Created in NX8.5.0. More...
 
void SetRetainValue (bool retain)
 Sets the RetainValue
Created in NX8.5.0. More...
 
void SetValueAsString (const NXString &enumString)
 Sets the Value as string. More...
 
void SetValueAsString (const char *enumString)
 Sets the Value as string. More...
 
NXString ValueAsString ()
 Returns the Value as string. 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

Represents an Enumeration block
Created in NX8.5.0.


Member Function Documentation

bool NXOpen::BlockStyler::Enumeration::AllowShortcuts ( )

Returns the AllowShortcuts.

If true, the 'Show Shortcuts' option is available.
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::Enumeration::BalloonTooltipLayoutAsString ( )

Returns the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::Enumeration::BorderVisibility ( )

Returns the BorderVisibility
Created in NX8.5.0.



License requirements : None

std::vector<NXString> NXOpen::BlockStyler::Enumeration::GetBalloonTooltipImages ( )

Gets the BalloonTooltipImages.

Returns

Created in NX8.5.0.

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::Enumeration::GetBalloonTooltipLayoutMembers ( )

Gets the BalloonTooltipLayout members.

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

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::Enumeration::GetBalloonTooltipTexts ( )

Gets the BalloonTooltipTexts.

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

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::Enumeration::GetBitmaps ( )

Gets the Bitmaps.

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

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::Enumeration::GetEnumMembers ( )

Gets the Enum members.

Returns
Array of member names
Created in NX8.5.0.

License requirements : None
std::vector<int> NXOpen::BlockStyler::Enumeration::GetEnumSensitivity ( )

Gets EnumSensitivity.

Returns
Array of integers with the value 0 or 1. If 1 then the corresponding enum member is sensitive otherwise it is insensitive.
Created in NX8.5.0.

License requirements : None
std::vector<int> NXOpen::BlockStyler::Enumeration::GetEnumVisibility ( )

Gets EnumVisibility.

Returns
Array of integers with the value 0 or 1. If 1 then the corresponding enum member is visible otherwise it is hidden.
Created in NX8.5.0.

License requirements : None
std::vector<int> NXOpen::BlockStyler::Enumeration::GetInitialShortcuts ( )

Gets InitialShortcuts.

Specifies the set of shortcuts that are displayed when the dialog is initially shown. Valid only if AllowShortcuts property is true.

Returns
Array of integers with length between 0 and N-1, where N is the number of enumeration options
Created in NX8.5.0.

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::Enumeration::GetLayoutMembers ( )

Gets the Layout members.

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

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::Enumeration::GetPresentationStyleMembers ( )

Gets the PresentationStyle members.

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

License requirements : None
bool NXOpen::BlockStyler::Enumeration::HighQualityBitmap ( )

Returns the HighQualityBitmap
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::Enumeration::IconsOnly ( )

Returns the IconsOnly.

If true, the enumeration options are shown as bitmaps only
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::Enumeration::LabelVisibility ( )

Returns the LabelVisibility
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::Enumeration::LayoutAsString ( )

Returns the Layout as string
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::Enumeration::Localize ( )

Returns the Localize.

If true, the Label is translated to current locale language.
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::Enumeration::NumberOfColumns ( )

Returns the NumberOfColumns
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::Enumeration::PackedColumns ( )

Returns the PackedColumns.

If true, each column takes up as much space as required for labels in that column. If false, the longest label amongst all options dictates the width of all columns.
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::Enumeration::PresentationStyleAsString ( )

Returns the PresentationStyle as string
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::Enumeration::RetainValue ( )

Returns the RetainValue
Created in NX8.5.0.



License requirements : None

void NXOpen::BlockStyler::Enumeration::SetAllowShortcuts ( bool  allow)

Sets the AllowShortcuts.

If true, the 'Show Shortcuts' option is available.
Created in NX8.5.0.

License requirements : None

Parameters
allowallow
void NXOpen::BlockStyler::Enumeration::SetBalloonTooltipImages ( std::vector< NXString > &  imageStrings)

Sets the BalloonTooltipImages
Created in NX8.5.0.



License requirements : None

Parameters
imageStringsimage strings
void NXOpen::BlockStyler::Enumeration::SetBalloonTooltipLayoutAsString ( const NXString enumString)

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::Enumeration::SetBalloonTooltipLayoutAsString ( const char *  enumString)

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::Enumeration::SetBalloonTooltipTexts ( std::vector< NXString > &  tooltipTextArray)

Sets the BalloonTooltipTexts
Created in NX8.5.0.



License requirements : None

Parameters
tooltipTextArrayValue to set for the property.
void NXOpen::BlockStyler::Enumeration::SetBitmaps ( std::vector< NXString > &  bitmapsStrings)

Sets the Bitmaps
Created in NX8.5.0.



License requirements : None

Parameters
bitmapsStringsValue to set for the property.
void NXOpen::BlockStyler::Enumeration::SetBorderVisibility ( bool  visibility)

Sets the BorderVisibility
Created in NX8.5.0.



License requirements : None

Parameters
visibilityvisibility
void NXOpen::BlockStyler::Enumeration::SetEnumMembers ( std::vector< NXString > &  memberStrings)

Sets the Enum members.


Created in NX8.5.0.

License requirements : None

Parameters
memberStringsArray of member names
void NXOpen::BlockStyler::Enumeration::SetEnumSensitivity ( const std::vector< int > &  valueVector)

Sets EnumSensitivity
Created in NX8.5.0.



License requirements : None

Parameters
valueVectorArray of integers with the value 0 or 1. If 1 then the corresponding enum member is sensitive otherwise it is insensitive.
void NXOpen::BlockStyler::Enumeration::SetEnumVisibility ( const std::vector< int > &  valueVector)

Sets EnumVisibility
Created in NX8.5.0.



License requirements : None

Parameters
valueVectorArray of integers with the value 0 or 1. If 1 then the corresponding enum member is visible otherwise it is hidden.
void NXOpen::BlockStyler::Enumeration::SetHighQualityBitmap ( bool  highQuality)

Sets the HighQualityBitmap
Created in NX8.5.0.



License requirements : None

Parameters
highQualityhigh quality
void NXOpen::BlockStyler::Enumeration::SetIconsOnly ( bool  iconsOnly)

Sets the IconsOnly.

If true, the enumeration options are shown as bitmaps only
Created in NX8.5.0.

License requirements : None

Parameters
iconsOnlyicons only
void NXOpen::BlockStyler::Enumeration::SetInitialShortcuts ( const std::vector< int > &  valueVector)

Sets InitialShortcuts.

Specifies the set of shortcuts that are displayed when the dialog is initially shown. Valid only if AllowShortcuts property is true.
Created in NX8.5.0.

License requirements : None

Parameters
valueVectorArray of integers with length between 0 and N-1, where N is the number of enumeration options
void NXOpen::BlockStyler::Enumeration::SetLabelVisibility ( bool  visibility)

Sets the LabelVisibility
Created in NX8.5.0.



License requirements : None

Parameters
visibilityvisibility
void NXOpen::BlockStyler::Enumeration::SetLayoutAsString ( const NXString enumString)

Sets the Layout as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::Enumeration::SetLayoutAsString ( const char *  enumString)

Sets the Layout as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::Enumeration::SetLocalize ( bool  localize)

Sets the Localize.

If true, the Label is translated to current locale language.
Created in NX8.5.0.

License requirements : None

Parameters
localizelocalize
void NXOpen::BlockStyler::Enumeration::SetNumberOfColumns ( int  numColumn)

Sets the NumberOfColumns
Created in NX8.5.0.



License requirements : None

Parameters
numColumnnum column
void NXOpen::BlockStyler::Enumeration::SetPackedColumns ( bool  packedColumns)

Sets the PackedColumns.

If true, each column takes up as much space as required for labels in that column. If false, the longest label amongst all options dictates the width of all columns.
Created in NX8.5.0.

License requirements : None

Parameters
packedColumnspacked columns
void NXOpen::BlockStyler::Enumeration::SetPresentationStyleAsString ( const NXString enumString)

Sets the PresentationStyle as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::Enumeration::SetPresentationStyleAsString ( const char *  enumString)

Sets the PresentationStyle as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::Enumeration::SetRetainValue ( bool  retain)

Sets the RetainValue
Created in NX8.5.0.



License requirements : None

Parameters
retainretain
void NXOpen::BlockStyler::Enumeration::SetValueAsString ( const NXString enumString)

Sets the Value as string.

Represents the currently selected option of enum.
Created in NX8.5.0.

License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::Enumeration::SetValueAsString ( const char *  enumString)

Sets the Value as string.

Represents the currently selected option of enum.
Created in NX8.5.0.

License requirements : None

Parameters
enumStringenumstring
NXString NXOpen::BlockStyler::Enumeration::ValueAsString ( )

Returns the Value as string.

Represents the currently selected option of enum.
Created in NX8.5.0.

License requirements : None


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