Represents custom symbol text data
More...

Inheritance diagram for NXOpen::Annotations::CustomSymbolTextData:

Public Member Functions
int	ControlTextIndex ()
	Returns the control text index.

std::vector< NXString >	GetText ()
	Returns the text.

int	IntegerValue ()
	Returns the integer value.

double	RealValue ()
	Returns the real value.

void	SetControlTextIndex (int index)
	Sets the control text index.

void	SetIntegerValue (int intValue)
	Sets the integer value.

void	SetRealValue (double realValue)
	Sets the real value.

void	SetText (std::vector< NXString > &lines)
	Sets the text.

NXString	StringValue ()
	Returns the string value.

NXOpen::Annotations::TextType	TextType ()
	Returns the text type

virtual	~CustomSymbolTextData ()
	Frees the object from memory.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

Detailed Description

Represents custom symbol text data

Deprecated:: Deprecated in NX9.0.0.

Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

Constructor & Destructor Documentation

virtual NXOpen::Annotations::CustomSymbolTextData::~CustomSymbolTextData ( )

virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

Member Function Documentation

int NXOpen::Annotations::CustomSymbolTextData::ControlTextIndex ( )

Returns the control text index.

Valid for the text type Annotations::TextTypeControlled .

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

std::vector<NXString> NXOpen::Annotations::CustomSymbolTextData::GetText ( )

Returns the text.

Valid for the text type Annotations::TextTypeArbitrary and Annotations::TextTypePartiallyControlled .

Returns: List of lines

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

int NXOpen::Annotations::CustomSymbolTextData::IntegerValue ( )

Returns the integer value.

Valid for the text type Annotations::TextTypeInteger .

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::CustomSymbolTextData::RealValue ( )

Returns the real value.

Valid for the text type Annotations::TextTypeReal .

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

void NXOpen::Annotations::CustomSymbolTextData::SetControlTextIndex ( int index )

Sets the control text index.

Valid for the text type Annotations::TextTypeControlled .

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

Parameters

index New control text index

void NXOpen::Annotations::CustomSymbolTextData::SetIntegerValue ( int intValue )

Sets the integer value.

Valid for the text type Annotations::TextTypeInteger .

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

Parameters

intValue New integer value

void NXOpen::Annotations::CustomSymbolTextData::SetRealValue ( double realValue )

Sets the real value.

Valid for the text type Annotations::TextTypeReal .

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

Parameters

realValue New real value

void NXOpen::Annotations::CustomSymbolTextData::SetText ( std::vector< NXString > & lines )

Sets the text.

Valid for the text type Annotations::TextTypeArbitrary and Annotations::TextTypePartiallyControlled .

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

Parameters

lines List of lines

NXString NXOpen::Annotations::CustomSymbolTextData::StringValue ( )

Returns the string value.

Valid for the text type Annotations::TextTypeControlled and Annotations::TextTypePartiallyControlled .

Deprecated:: Deprecated in NX9.0.0. Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::TextType NXOpen::Annotations::CustomSymbolTextData::TextType ( )

Returns the text type

Deprecated:: Deprecated in NX9.0.0.

Use Annotations::MasterSymbolListItemBuilder instead. Use Annotations::BaseCustomSymbolBuilder::Texts to query list of custom symbol texts.

Created in NX4.0.0.

License requirements : None

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

Annotations_CustomSymbolTextData.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation