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

Inheritance diagram for NXOpen::BlockStyler::Enumeration:

Public Member Functions
bool	AllowShortcuts ()
	Returns the AllowShortcuts.

NXString	BalloonTooltipLayoutAsString ()
	Returns the BalloonTooltipLayout as string Created in NX8.5.0.

bool	BorderVisibility ()
	Returns the BorderVisibility Created in NX8.5.0.

std::vector< NXString >	GetBalloonTooltipImages ()
	Gets the BalloonTooltipImages.

std::vector< NXString >	GetBalloonTooltipLayoutMembers ()
	Gets the BalloonTooltipLayout members.

std::vector< NXString >	GetBalloonTooltipTexts ()
	Gets the BalloonTooltipTexts.

std::vector< NXString >	GetBitmaps ()
	Gets the Bitmaps.

std::vector< NXString >	GetEnumMembers ()
	Gets the Enum members.

std::vector< int >	GetEnumSensitivity ()
	Gets EnumSensitivity.

std::vector< int >	GetEnumVisibility ()
	Gets EnumVisibility.

std::vector< int >	GetInitialShortcuts ()
	Gets InitialShortcuts.

std::vector< NXString >	GetLayoutMembers ()
	Gets the Layout members.

std::vector< NXString >	GetPresentationStyleMembers ()
	Gets the PresentationStyle members.

bool	HighQualityBitmap ()
	Returns the HighQualityBitmap Created in NX8.5.0.

bool	IconsOnly ()
	Returns the IconsOnly.

bool	LabelVisibility ()
	Returns the LabelVisibility Created in NX8.5.0.

NXString	LayoutAsString ()
	Returns the Layout as string Created in NX8.5.0.

bool	Localize ()
	Returns the Localize.

int	NumberOfColumns ()
	Returns the NumberOfColumns Created in NX8.5.0.

bool	PackedColumns ()
	Returns the PackedColumns.

NXString	PresentationStyleAsString ()
	Returns the PresentationStyle as string Created in NX8.5.0.

bool	RetainValue ()
	Returns the RetainValue Created in NX8.5.0.

void	SetAllowShortcuts (bool allow)
	Sets the AllowShortcuts.

void	SetBalloonTooltipImages (std::vector< NXString > &imageStrings)
	Sets the BalloonTooltipImages Created in NX8.5.0.

void	SetBalloonTooltipLayoutAsString (const NXString &enumString)
	Sets the BalloonTooltipLayout as string Created in NX8.5.0.

void	SetBalloonTooltipLayoutAsString (const char *enumString)
	Sets the BalloonTooltipLayout as string Created in NX8.5.0.

void	SetBalloonTooltipTexts (std::vector< NXString > &tooltipTextArray)
	Sets the BalloonTooltipTexts Created in NX8.5.0.

void	SetBitmaps (std::vector< NXString > &bitmapsStrings)
	Sets the Bitmaps Created in NX8.5.0.

void	SetBorderVisibility (bool visibility)
	Sets the BorderVisibility Created in NX8.5.0.

void	SetEnumMembers (std::vector< NXString > &memberStrings)
	Sets the Enum members.

void	SetEnumSensitivity (const std::vector< int > &valueVector)
	Sets EnumSensitivity Created in NX8.5.0.

void	SetEnumVisibility (const std::vector< int > &valueVector)
	Sets EnumVisibility Created in NX8.5.0.

void	SetHighQualityBitmap (bool highQuality)
	Sets the HighQualityBitmap Created in NX8.5.0.

void	SetIconsOnly (bool iconsOnly)
	Sets the IconsOnly.

void	SetInitialShortcuts (const std::vector< int > &valueVector)
	Sets InitialShortcuts.

void	SetLabelVisibility (bool visibility)
	Sets the LabelVisibility Created in NX8.5.0.

void	SetLayoutAsString (const NXString &enumString)
	Sets the Layout as string Created in NX8.5.0.

void	SetLayoutAsString (const char *enumString)
	Sets the Layout as string Created in NX8.5.0.

void	SetLocalize (bool localize)
	Sets the Localize.

void	SetNumberOfColumns (int numColumn)
	Sets the NumberOfColumns Created in NX8.5.0.

void	SetPackedColumns (bool packedColumns)
	Sets the PackedColumns.

void	SetPresentationStyleAsString (const NXString &enumString)
	Sets the PresentationStyle as string Created in NX8.5.0.

void	SetPresentationStyleAsString (const char *enumString)
	Sets the PresentationStyle as string Created in NX8.5.0.

void	SetRetainValue (bool retain)
	Sets the RetainValue Created in NX8.5.0.

void	SetValueAsString (const NXString &enumString)
	Sets the Value as string.

void	SetValueAsString (const char *enumString)
	Sets the Value as string.

NXString	ValueAsString ()
	Returns the Value as string.

Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool	Enable ()
	Returns the Enable.

bool	Expanded ()
	Returns the Expanded Created in NX8.5.0.

void	Focus ()
	Focuses on the block.

NXOpen::BlockStyler::PropertyList *	GetProperties ()
	Returns the properties of the block.

bool	Group ()
	Returns the Group Created in NX8.5.0.

NXString	Label ()
	Returns the Label Created in NX8.5.0.

NXString	Name ()
	Returns the name of the block or BlockID Created in NX6.0.0.

void	SetEnable (bool enable)
	Sets the Enable.

void	SetExpanded (bool expanded)
	Sets the Expanded Created in NX8.5.0.

void	SetGroup (bool group)
	Sets the Group Created in NX8.5.0.

void	SetLabel (const NXString &label)
	Sets the Label Created in NX8.5.0.

void	SetLabel (const char *label)
	Sets the Label Created in NX8.5.0.

void	SetShow (bool show)
	Sets the Visibility of block.

bool	Show ()
	Returns the Visibility of block.

NXString	Type ()
	Returns the type of block Created in NX6.0.0.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

allow allow

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

Sets the BalloonTooltipImages
Created in NX8.5.0.

License requirements : None

Parameters

imageStrings image strings

void NXOpen::BlockStyler::Enumeration::SetBalloonTooltipLayoutAsString ( const NXString & enumString )

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

Sets the BalloonTooltipTexts
Created in NX8.5.0.

License requirements : None

Parameters

tooltipTextArray Value 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

bitmapsStrings Value to set for the property.

void NXOpen::BlockStyler::Enumeration::SetBorderVisibility ( bool visibility )

Sets the BorderVisibility
Created in NX8.5.0.

License requirements : None

Parameters

visibility visibility

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

Sets the Enum members.

Created in NX8.5.0.

License requirements : None

Parameters

memberStrings Array of member names

void NXOpen::BlockStyler::Enumeration::SetEnumSensitivity ( const std::vector< int > & valueVector )

Sets EnumSensitivity
Created in NX8.5.0.

License requirements : None

Parameters

valueVector Array 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

valueVector Array 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

highQuality high 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

iconsOnly icons 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

valueVector Array 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

visibility visibility

void NXOpen::BlockStyler::Enumeration::SetLayoutAsString ( const NXString & enumString )

Sets the Layout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

Sets the Layout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

localize localize

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

Sets the NumberOfColumns
Created in NX8.5.0.

License requirements : None

Parameters

numColumn num 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

packedColumns packed columns

void NXOpen::BlockStyler::Enumeration::SetPresentationStyleAsString ( const NXString & enumString )

Sets the PresentationStyle as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

Sets the PresentationStyle as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

Sets the RetainValue
Created in NX8.5.0.

License requirements : None

Parameters

retain retain

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

enumString enumstring

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

enumString enumstring

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:

BlockStyler_Enumeration.hxx

Public Member Functions

Detailed Description

Member Function Documentation