NXOpen::BlockStyler::StringBlock Class Reference

Represents a String block
Created in NX8.5.0. More...

Inheritance diagram for NXOpen::BlockStyler::StringBlock:

Public Member Functions
bool	AllowInternationalTextInput ()
	Returns the AllowInternationalTextInput More...
NXString	BalloonTooltipLayoutAsString ()
	Returns the BalloonTooltipLayout as string Created in NX8.5.0. More...
NXString	Bitmap ()
	Returns the Bitmap Created in NX8.5.0. More...
std::vector< NXString >	GetBalloonTooltipImages ()
	Gets the BalloonTooltipImages. More...
std::vector< NXString >	GetBalloonTooltipLayoutMembers ()
	Gets the BalloonTooltipLayout members. More...
std::vector< NXString >	GetBalloonTooltipTexts ()
	Gets the BalloonTooltipTexts. More...
std::vector< NXString >	GetListItems ()
	Gets the ListItems. More...
std::vector< NXString >	GetPresentationStyleMembers ()
	Gets the PresentationStyle members. More...
std::vector< NXString >	GetWidthMembers ()
	Gets the Width members. More...
bool	IsPassword ()
	Returns the IsPassword. More...
bool	Localize ()
	Returns the Localize Created in NX8.5.0. More...
int	MaxTextLength ()
	Returns the MaxTextLength Created in NX8.5.0. More...
NXString	PresentationStyleAsString ()
	Returns the PresentationStyle as string Created in NX8.5.0. More...
bool	ReadOnlyString ()
	Returns the ReadOnlyString Created in NX8.5.0. More...
bool	RetainValue ()
	Returns the RetainValue Created in NX8.5.0. More...
void	SetAllowInternationalTextInput (bool allow)
	Sets the AllowInternationalTextInput 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	SetBitmap (const NXString &bitmapString)
	Sets the Bitmap Created in NX8.5.0. More...
void	SetBitmap (const char *bitmapString)
	Sets the Bitmap Created in NX8.5.0. More...
void	SetListItems (std::vector< NXString > &itemStrings)
	Sets the ListItems Created in NX8.5.0. More...
void	SetLocalize (bool localize)
	Sets the Localize Created in NX8.5.0. More...
void	SetMaxTextLength (int textLength)
	Sets the MaxTextLength Created in NX8.5.0. More...
void	SetPassword (bool passwrod)
	Sets the IsPassword. 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	SetReadOnlyString (bool readonly)
	Sets the ReadOnlyString Created in NX8.5.0. More...
void	SetRetainValue (bool retain)
	Sets the RetainValue Created in NX8.5.0. More...
void	SetTooltip (const NXString &tooltipString)
	Sets the Tooltip Created in NX8.5.0. More...
void	SetTooltip (const char *tooltipString)
	Sets the Tooltip Created in NX8.5.0. More...
void	SetValue (const NXString &valueString)
	Sets the Value Created in NX8.5.0. More...
void	SetValue (const char *valueString)
	Sets the Value Created in NX8.5.0. More...
void	SetWideValue (const NXString &wideValueString)
	Sets the WideValue. More...
void	SetWideValue (const char *wideValueString)
	Sets the WideValue. More...
void	SetWidthAsString (const NXString &enumString)
	Sets the Width as string Created in NX8.5.0. More...
void	SetWidthAsString (const char *enumString)
	Sets the Width as string Created in NX8.5.0. More...
NXString	Tooltip ()
	Returns the Tooltip Created in NX8.5.0. More...
NXString	Value ()
	Returns the Value Created in NX8.5.0. More...
NXString	WideValue ()
	Returns the WideValue. More...
NXString	WidthAsString ()
	Returns the Width 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::PropertyList *	GetProperties ()
	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 a String block
Created in NX8.5.0.

Member Function Documentation

bool NXOpen::BlockStyler::StringBlock::AllowInternationalTextInput

(

)

Returns the AllowInternationalTextInput

Deprecated:

Deprecated in NX12.0.0.

Not required from NX10 onwards. Internationalization is available by default.

Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::StringBlock::BalloonTooltipLayoutAsString

(

)

Returns the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::StringBlock::Bitmap

(

)

Returns the Bitmap
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::StringBlock::GetBalloonTooltipImages

(

)

Gets the BalloonTooltipImages.

Returns

Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::StringBlock::GetBalloonTooltipLayoutMembers

(

)

Gets the BalloonTooltipLayout members.

Returns

Values to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::StringBlock::GetBalloonTooltipTexts

(

)

Gets the BalloonTooltipTexts.

Returns

Values to get from the property.
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::StringBlock::GetListItems

(

)

Gets the ListItems.

Returns

Values to get from the property
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::StringBlock::GetPresentationStyleMembers

(

)

Gets the PresentationStyle members.

Returns

Values to get from the property.
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::StringBlock::GetWidthMembers

(

)

Gets the Width members.

Returns

Values to get from the property.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::StringBlock::IsPassword

(

)

Returns the IsPassword.

If true, characters will not be readable. They will be displayed as *.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::StringBlock::Localize

(

)

Returns the Localize
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::StringBlock::MaxTextLength

(

)

Returns the MaxTextLength
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::StringBlock::PresentationStyleAsString

(

)

Returns the PresentationStyle as string
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::StringBlock::ReadOnlyString

(

)

Returns the ReadOnlyString
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::StringBlock::RetainValue

(

)

Returns the RetainValue
Created in NX8.5.0.

License requirements : None

void NXOpen::BlockStyler::StringBlock::SetAllowInternationalTextInput

(

bool

allow

)

Sets the AllowInternationalTextInput

Deprecated:

Deprecated in NX12.0.0.

Not required from NX10 onwards. Internationalization is available by default.

Created in NX8.5.0.

License requirements : None

Parameters

allow

allow

void NXOpen::BlockStyler::StringBlock::SetBalloonTooltipImages

(

std::vector< NXString > &

imageStrings

)

Sets the BalloonTooltipImages
Created in NX8.5.0.

License requirements : None

Parameters

imageStrings

image strings

void NXOpen::BlockStyler::StringBlock::SetBalloonTooltipLayoutAsString

(

const NXString &

enumString

)

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString

enumstring

void NXOpen::BlockStyler::StringBlock::SetBalloonTooltipLayoutAsString

(

const char *

enumString

)

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString

enumstring

void NXOpen::BlockStyler::StringBlock::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::StringBlock::SetBitmap

(

const NXString &

bitmapString

)

Sets the Bitmap
Created in NX8.5.0.

License requirements : None

Parameters

bitmapString

bitmap string

void NXOpen::BlockStyler::StringBlock::SetBitmap

(

const char *

bitmapString

)

Sets the Bitmap
Created in NX8.5.0.

License requirements : None

Parameters

bitmapString

bitmap string

void NXOpen::BlockStyler::StringBlock::SetListItems

(

std::vector< NXString > &

itemStrings

)

Sets the ListItems
Created in NX8.5.0.

License requirements : None

Parameters

itemStrings

Value to set to the property

void NXOpen::BlockStyler::StringBlock::SetLocalize

(

bool

localize

)

Sets the Localize
Created in NX8.5.0.

License requirements : None

Parameters

localize

localize

void NXOpen::BlockStyler::StringBlock::SetMaxTextLength

(

int

textLength

)

Sets the MaxTextLength
Created in NX8.5.0.

License requirements : None

Parameters

textLength

text length

void NXOpen::BlockStyler::StringBlock::SetPassword

(

bool

passwrod

)

Sets the IsPassword.

If true, characters will not be readable. They will be displayed as *.
Created in NX8.5.0.

License requirements : None

Parameters

passwrod

passwrod

void NXOpen::BlockStyler::StringBlock::SetPresentationStyleAsString

(

const NXString &

enumString

)

Sets the PresentationStyle as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString

enumstring

void NXOpen::BlockStyler::StringBlock::SetPresentationStyleAsString

(

const char *

enumString

)

Sets the PresentationStyle as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString

enumstring

void NXOpen::BlockStyler::StringBlock::SetReadOnlyString

(

bool

readonly

)

Sets the ReadOnlyString
Created in NX8.5.0.

License requirements : None

Parameters

readonly

readonly

void NXOpen::BlockStyler::StringBlock::SetRetainValue

(

bool

retain

)

Sets the RetainValue
Created in NX8.5.0.

License requirements : None

Parameters

retain

retain

void NXOpen::BlockStyler::StringBlock::SetTooltip

(

const NXString &

tooltipString

)

Sets the Tooltip
Created in NX8.5.0.

License requirements : None

Parameters

tooltipString

tooltip string

void NXOpen::BlockStyler::StringBlock::SetTooltip

(

const char *

tooltipString

)

Sets the Tooltip
Created in NX8.5.0.

License requirements : None

Parameters

tooltipString

tooltip string

void NXOpen::BlockStyler::StringBlock::SetValue

(

const NXString &

valueString

)

Sets the Value
Created in NX8.5.0.

License requirements : None

Parameters

valueString

value string

void NXOpen::BlockStyler::StringBlock::SetValue

(

const char *

valueString

)

Sets the Value
Created in NX8.5.0.

License requirements : None

Parameters

valueString

value string

void NXOpen::BlockStyler::StringBlock::SetWideValue

(

const NXString &

wideValueString

)

Sets the WideValue.

Specifies the International text. This property accepts international characters supported by NX.

Deprecated:

Deprecated in NX12.0.0. Use 'Value' instead which supports Internationalization.

Created in NX8.5.0.

License requirements : None

Parameters

wideValueString

wide value string

void NXOpen::BlockStyler::StringBlock::SetWideValue

(

const char *

wideValueString

)

Sets the WideValue.

Specifies the International text. This property accepts international characters supported by NX.

Deprecated:

Deprecated in NX12.0.0. Use 'Value' instead which supports Internationalization.

Created in NX8.5.0.

License requirements : None

Parameters

wideValueString

wide value string

void NXOpen::BlockStyler::StringBlock::SetWidthAsString

(

const NXString &

enumString

)

Sets the Width as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString

enumstring

void NXOpen::BlockStyler::StringBlock::SetWidthAsString

(

const char *

enumString

)

Sets the Width as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString

enumstring

NXString NXOpen::BlockStyler::StringBlock::Tooltip

(

)

Returns the Tooltip
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::StringBlock::Value

(

)

Returns the Value
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::StringBlock::WideValue

(

)

Returns the WideValue.

Specifies the International text. This property accepts international characters supported by NX.

Deprecated:

Deprecated in NX12.0.0. Use 'Value' instead which supports Internationalization.

Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::StringBlock::WidthAsString

(

)

Returns the Width as string
Created in NX8.5.0.

License requirements : None

---

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

• BlockStyler_StringBlock.hxx