Represents a NXOpen.Annotations.TextWithSymbolsBuilder which collects internationalized text strings from the user for processing on an annotation object. More...

Inheritance diagram for NXOpen.Annotations.TextWithSymbolsBuilder:

Public Types
enum	SymbolAlignmentType { None, Top, Middle, Bottom, AnchorPoint }
	Enum for the symbol alignment More...

enum	SymbolPreferencesType { UseCurrent, UseDefinition }
	Enum for the symbol preferences More...

enum	SymbolSizingMethod { ScaleAndAspectRatio, LengthAndHeight }
	sizing method for embedded user-defined symbols More...

Public Member Functions
unsafe void	AddAttributeReference (NXOpen.NXObject ownerTag, string title, bool displayTokens, int lineNo, int cursorPos)
	Adds an attribute reference More...

unsafe void	AddExpressionReference (string expName, string format, int lineNo, int cursorPos)
	Adds an expression reference More...

unsafe void	AddSymbol (NXOpen.NXObject newObject, string name, int lineNo, int cursorPos)
	Adds a symbol More...

unsafe NXOpen.Annotations.BaseCustomSymbol[]	GetEmbeddedCustomSymbols ()
	Retrieves the embedded custom symbols More...

unsafe NXOpen.Annotations.TextWithSymbolsBuilder.SymbolAlignmentType	GetSymbolAlignment (string symbolName)
	Get the alignement of embedded symbol correspoding to symbol name More...

unsafe string[]	GetText ()
	Returns the text of the annotation More...

unsafe void	RemoveSymbol (string path)
	Removes specified symbol More...

unsafe void	SetSymbolAlignment (string symbolName, NXOpen.Annotations.TextWithSymbolsBuilder.SymbolAlignmentType symbolAlignment)
	Set the alignement on embedded symbol correspoding to symbol name More...

unsafe void	SetText (string[] text)
	Sets the text of the annotation More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override 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...

Properties
unsafe double	CustomSymbolScale `[get, set]`
	Returns or sets the scale of the custom symbols More...

unsafe double	SymbolAspectRatio `[get, set]`
	Returns or sets the aspect ratio of the embedded user-defined symbols if the symbol size method is NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod.ScaleAndAspectRatio More...

unsafe double	SymbolHeight `[get, set]`
	Returns or sets the height of the embedded user-defined symbols if the symbol size method is NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod.LengthAndHeight More...

unsafe double	SymbolLength `[get, set]`
	Returns or sets the length of the embedded user-defined symbols if the symbol size method is NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod.LengthAndHeight More...

unsafe NXOpen.Annotations.TextWithSymbolsBuilder.SymbolPreferencesType	SymbolPreferences `[get, set]`
	Returns or sets the symbol preferences More...

unsafe double	SymbolScale `[get, set]`
	Returns or sets the scale of the embedded user-defined symbols if the symbol size method is NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod.ScaleAndAspectRatio More...

unsafe NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod	SymbolSizeMethod `[get, set]`
	Returns or sets the method in which embedded user-defined symbols are scaled More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a NXOpen.Annotations.TextWithSymbolsBuilder which collects internationalized text strings from the user for processing on an annotation object.

This is a sub-builder class and cannot be directly instantiated

Created in NX6.0.0

Member Enumeration Documentation

enum NXOpen.Annotations.TextWithSymbolsBuilder.SymbolAlignmentType

Enum for the symbol alignment

Enumerator
None	None
Top	Top
Middle	Middle
Bottom	Bottom
AnchorPoint	Anchor Point

enum NXOpen.Annotations.TextWithSymbolsBuilder.SymbolPreferencesType

Enum for the symbol preferences

Enumerator
UseCurrent	Use Current
UseDefinition	Use Definition

enum NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod

sizing method for embedded user-defined symbols

Enumerator
ScaleAndAspectRatio	Size using scale and aspect ratio
LengthAndHeight	Size using length and height

Member Function Documentation

unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.AddAttributeReference	(	NXOpen.NXObject	ownerTag,
		string	title,
		bool	displayTokens,
		int	lineNo,
		int	cursorPos
	)

inline

Adds an attribute reference

Created in NX8.0.0

License requirements: drafting ("DRAFTING")

Parameters

ownerTag	object that owns the attribute. If we are trying to reference a part attribute then this should be the part object
title	title of attribute
displayTokens	True to display using TC tokens. False to display as plain text.
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.AddExpressionReference	(	string	expName,
		string	format,
		int	lineNo,
		int	cursorPos
	)

inline

Adds an expression reference

Created in NX8.0.0

License requirements: drafting ("DRAFTING")

Parameters

expName	expression name
format	format to use for displaying an expression. 'A' for displaying the expression formula, or 'm.n' where 'm' is the minimum number of characters displayed and 'n' is the number of decimal places to display
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.AddSymbol	(	NXOpen.NXObject	newObject,
		string	name,
		int	lineNo,
		int	cursorPos
	)

inline

Adds a symbol

Created in NX7.0.0

License requirements: drafting ("DRAFTING")

Parameters

newObject	symbol instance object
name	symbol name
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

unsafe NXOpen.Annotations.BaseCustomSymbol [] NXOpen.Annotations.TextWithSymbolsBuilder.GetEmbeddedCustomSymbols ( )

inline

Retrieves the embedded custom symbols

Created in NX10.0.0

License requirements: None.

Returns

unsafe NXOpen.Annotations.TextWithSymbolsBuilder.SymbolAlignmentType NXOpen.Annotations.TextWithSymbolsBuilder.GetSymbolAlignment ( string symbolName )

inline

Get the alignement of embedded symbol correspoding to symbol name

Created in NX11.0.1

License requirements: None.

Parameters

symbolName Symbol Name

Returns: Symbol Alignment

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

inline

Returns the text of the annotation

Created in NX6.0.0

License requirements: None.

Returns

unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.RemoveSymbol ( string path )

inline

Removes specified symbol

Created in NX7.0.0

License requirements: drafting ("DRAFTING")

Parameters

path	Symbol name

unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.SetSymbolAlignment	(	string	symbolName,
		NXOpen.Annotations.TextWithSymbolsBuilder.SymbolAlignmentType	symbolAlignment
	)

inline

Set the alignement on embedded symbol correspoding to symbol name

Created in NX11.0.1

License requirements: drafting ("DRAFTING")

Parameters

symbolName	Symbol Name
symbolAlignment	Symbol Alignment

unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.SetText ( string[] text )

inline

Sets the text of the annotation

Created in NX6.0.0

License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

text

unsafe bool NXOpen.Annotations.TextWithSymbolsBuilder.Validate ( )

inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe double NXOpen.Annotations.TextWithSymbolsBuilder.CustomSymbolScale

getset

Returns or sets the scale of the custom symbols

Created in NX7.5.0