NXOpen .NET Reference
12.0.0
|
Represents a NXOpen.Annotations.TextWithSymbolsBuilder which collects internationalized text strings from the user for processing on an annotation object. More...
Public Types | |
enum | SymbolSizingMethod { ScaleAndAspectRatio, LengthAndHeight } |
sizing method for embedded user-defined symbols More... | |
enum | SymbolPreferencesType { UseCurrent, UseDefinition } |
Enum for the symbol preferences More... | |
enum | SymbolAlignmentType { None, Top, Middle, Bottom, AnchorPoint } |
Enum for the symbol alignment More... | |
Public Member Functions | |
unsafe string[] | GetText () |
Returns the text of the annotation More... | |
unsafe void | SetText (string[] text) |
Sets the text of the annotation More... | |
unsafe void | AddSymbol (NXOpen.NXObject newObject, string name, int lineNo, int cursorPos) |
Adds a symbol More... | |
unsafe void | RemoveSymbol (string path) |
Removes specified 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 void | SetSymbolAlignment (string symbolName, NXOpen.Annotations.TextWithSymbolsBuilder.SymbolAlignmentType symbolAlignment) |
Set the alignement on embedded symbol correspoding to symbol name More... | |
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 bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. 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... | |
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
unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.AddAttributeReference | ( | NXOpen.NXObject | ownerTag, |
string | title, | ||
bool | displayTokens, | ||
int | lineNo, | ||
int | cursorPos | ||
) |
Adds an attribute reference
Created in NX8.0.0
License requirements: drafting ("DRAFTING")
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 | ||
) |
Adds an expression reference
Created in NX8.0.0
License requirements: drafting ("DRAFTING")
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 | ||
) |
Adds a symbol
Created in NX7.0.0
License requirements: drafting ("DRAFTING")
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 | ( | ) |
Retrieves the embedded custom symbols
Created in NX10.0.0
License requirements: None.
unsafe NXOpen.Annotations.TextWithSymbolsBuilder.SymbolAlignmentType NXOpen.Annotations.TextWithSymbolsBuilder.GetSymbolAlignment | ( | string | symbolName | ) |
Get the alignement of embedded symbol correspoding to symbol name
Created in NX11.0.1
License requirements: None.
symbolName | Symbol Name |
unsafe string [] NXOpen.Annotations.TextWithSymbolsBuilder.GetText | ( | ) |
Returns the text of the annotation
Created in NX6.0.0
License requirements: None.
unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.RemoveSymbol | ( | string | path | ) |
Removes specified symbol
Created in NX7.0.0
License requirements: drafting ("DRAFTING")
path | Symbol name |
unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.SetSymbolAlignment | ( | string | symbolName, |
NXOpen.Annotations.TextWithSymbolsBuilder.SymbolAlignmentType | symbolAlignment | ||
) |
Set the alignement on embedded symbol correspoding to symbol name
Created in NX11.0.1
License requirements: drafting ("DRAFTING")
symbolName | Symbol Name |
symbolAlignment | Symbol Alignment |
unsafe void NXOpen.Annotations.TextWithSymbolsBuilder.SetText | ( | string[] | text | ) |
Sets the text of the annotation
Created in NX6.0.0
License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT")
text |
unsafe bool NXOpen.Annotations.TextWithSymbolsBuilder.Validate | ( | ) |
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.
Implements NXOpen.GeometricUtilities.IComponentBuilder.
|
getset |
Returns or sets the scale of the custom symbols
Created in NX7.5.0
License requirements to get this property: None.
License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")
|
getset |
Returns or sets the aspect ratio of the embedded user-defined symbols if the symbol size method is NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod.ScaleAndAspectRatio
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")
|
getset |
Returns or sets the height of the embedded user-defined symbols if the symbol size method is NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod.LengthAndHeight
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")
|
getset |
Returns or sets the length of the embedded user-defined symbols if the symbol size method is NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod.LengthAndHeight
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")
|
getset |
Returns or sets the symbol preferences
Created in NX8.0.0
License requirements to get this property: None.
License requirements to set this property: drafting ("DRAFTING")
|
getset |
Returns or sets the scale of the embedded user-defined symbols if the symbol size method is NXOpen.Annotations.TextWithSymbolsBuilder.SymbolSizingMethod.ScaleAndAspectRatio
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")
|
getset |
Returns or sets the method in which embedded user-defined symbols are scaled
Created in NX6.0.0
License requirements to get this property: None.
License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")