NXOpen.Annotations.CustomSymbolTextData Class Reference

Represents custom symbol text data More...

Inheritance diagram for NXOpen.Annotations.CustomSymbolTextData:

Public Member Functions
unsafe string[]	GetText ()
	Returns the text. More...
unsafe void	SetText (string[] lines)
	Sets the text. More...
Public Member Functions inherited from NXOpen.TransientObject
void	Dispose ()
	Frees the object from memory. More...
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
new string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Protected Member Functions
override void	FreeResource ()
	Frees the object from memory. More...

Properties
unsafe int	ControlTextIndex [get, set]
	Returns or sets the control text index. More...
unsafe int	IntegerValue [get, set]
	Returns or sets the integer value. More...
unsafe double	RealValue [get, set]
	Returns or sets the real value. More...
unsafe string	StringValue [get]
	Returns the string value. More...
unsafe NXOpen.Annotations.TextType	TextType [get]
	Returns the text type More...
Properties inherited from NXOpen.TransientObject
IntPtr	Handle [get]
	Handle of the internal object represented by this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Detailed Description

Represents custom symbol text data

Created in NX4.0.0

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

Member Function Documentation

override void NXOpen.Annotations.CustomSymbolTextData.FreeResource ( )

inlineprotectedvirtual

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.

Created in NX4.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe string [] NXOpen.Annotations.CustomSymbolTextData.GetText ( )

inline

Returns the text.

Valid for the text type NXOpen.Annotations.TextType.Arbitrary and NXOpen.Annotations.TextType.PartiallyControlled .

Created in NX4.0.0

License requirements: None.

Returns

List of lines

unsafe void NXOpen.Annotations.CustomSymbolTextData.SetText ( string[]  lines )

inline

Sets the text.

Valid for the text type NXOpen.Annotations.TextType.Arbitrary and NXOpen.Annotations.TextType.PartiallyControlled .

Created in NX4.0.0

License requirements: None.

Parameters

lines

List of lines

Property Documentation

unsafe int NXOpen.Annotations.CustomSymbolTextData.ControlTextIndex

getset

Returns or sets the control text index.

Valid for the text type NXOpen.Annotations.TextType.Controlled .

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Annotations.CustomSymbolTextData.IntegerValue

getset

Returns or sets the integer value.

Valid for the text type NXOpen.Annotations.TextType.Integer .

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Annotations.CustomSymbolTextData.RealValue

getset

Returns or sets the real value.

Valid for the text type NXOpen.Annotations.TextType.Real .

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Annotations.CustomSymbolTextData.StringValue

get

Returns the string value.

Valid for the text type NXOpen.Annotations.TextType.Controlled and NXOpen.Annotations.TextType.PartiallyControlled .

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.Annotations.TextType NXOpen.Annotations.CustomSymbolTextData.TextType

get

Returns the text type

Created in NX4.0.0

License requirements: None.

---

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

• Annotations_CustomSymbolTextData.cs