NXOpen .NET Reference
12.0.0
|
Represents an object that manages annotation and PMI (Product and Manufacturing Information) display instance objects. More...
Represents an object that manages annotation and PMI (Product and Manufacturing Information) display instance objects.
This class contains the collection objects for creating and iterating over annotations and PMI display instances.
To obtain an instance of this class, refer to NXOpen.BasePart
Created in NX3.0.0
unsafe NXOpen.Annotations.Gdt NXOpen.Annotations.AnnotationManager.ConvertToGdt | ( | NXOpen.Annotations.SimpleDraftingAid | draftingAid, |
bool | keepDraftingAid, | ||
NXOpen.Annotations.LeaderBundle | leader | ||
) |
Converts a simple drafting aid into a GDT by creating a new GDT using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Created in NX3.0.0
License requirements: drafting ("DRAFTING")
draftingAid | the drafting aid to convert |
keepDraftingAid | whether to keep the drafting aid. If false, the drafting aid will be deleted |
leader | specifies the leaders for the new GDT |
unsafe NXOpen.Annotations.SimpleDraftingAid NXOpen.Annotations.AnnotationManager.ConvertToIdSymbol | ( | NXOpen.Annotations.SimpleDraftingAid | draftingAid, |
bool | keepDraftingAid, | ||
NXOpen.Annotations.LeaderBundle | leader | ||
) |
Converts a simple drafting aid into an ID symbol by creating a new ID symbol using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Created in NX4.0.0
License requirements: drafting ("DRAFTING")
draftingAid | the drafting aid to convert |
keepDraftingAid | whether to keep the drafting aid. If false, the drafting aid will be deleted |
leader | specifies the leaders for the new ID Symbol |
unsafe NXOpen.Annotations.Label NXOpen.Annotations.AnnotationManager.ConvertToLabel | ( | NXOpen.Annotations.SimpleDraftingAid | draftingAid, |
bool | keepDraftingAid, | ||
NXOpen.Annotations.LeaderBundle | leader | ||
) |
Converts a simple drafting aid into a label by creating a new label using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Created in NX3.0.0
License requirements: drafting ("DRAFTING")
draftingAid | the drafting aid to convert |
keepDraftingAid | whether to keep the drafting aid. If false, the drafting aid will be deleted |
leader | specifies the leaders for the new label. The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead. |
unsafe NXOpen.Annotations.LineWeld NXOpen.Annotations.AnnotationManager.ConvertToLineWeld | ( | NXOpen.Annotations.LineWeld | draftingAid, |
bool | keepDraftingAid, | ||
NXOpen.Annotations.LeaderBundle | leader | ||
) |
Converts a simple drafting aid into a line weld by creating a new line weld using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a line weld that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Created in NX3.0.0
License requirements: drafting ("DRAFTING")
draftingAid | the drafting aid to convert |
keepDraftingAid | whether to keep the drafting aid. If false, the drafting aid will be deleted |
leader | specifies the leaders for the new label. The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead. |
unsafe NXOpen.Annotations.Note NXOpen.Annotations.AnnotationManager.ConvertToNote | ( | NXOpen.Annotations.SimpleDraftingAid | draftingAid, |
bool | keepDraftingAid | ||
) |
Converts a simple drafting aid into a note by creating a new note using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Created in NX3.0.0
License requirements: drafting ("DRAFTING")
draftingAid | the drafting aid to convert |
keepDraftingAid | whether to keep the drafting aid. If false, the drafting aid will be deleted |
unsafe NXOpen.Annotations.AssociateDimensionBuilder NXOpen.Annotations.AnnotationManager.CreateAssociateDimensionBuilder | ( | NXOpen.Annotations.Dimension | dimension | ) |
Creates the Dimension Associativity builder
Created in NX5.0.0
License requirements: None.
dimension | NXOpen.Annotations.Dimension to be edited |
unsafe NXOpen.Annotations.AssociativeText NXOpen.Annotations.AnnotationManager.CreateAssociativeText | ( | ) |
Creates a NXOpen.Annotations.AssociativeText .
The NXOpen.Annotations.AssociativeText instance must be deleted after its use.
Created in NX8.0.0
License requirements: None.
unsafe NXOpen.Annotations.AssociativityBuilder NXOpen.Annotations.AnnotationManager.CreateAssociativityBuilder | ( | NXOpen.Annotations.Dimension | dimension, |
int | assocIndex | ||
) |
Creates the Dimension Associativity builder
Created in NX5.0.0
License requirements: None.
dimension | NXOpen.Annotations.Dimension to be edited |
assocIndex | Associativity index |
unsafe NXOpen.Annotations.ComponentData NXOpen.Annotations.AnnotationManager.CreateComponentData | ( | NXOpen.Annotations.Annotation | annotationTag | ) |
Creates a NXOpen.Annotations.ComponentData for an annotation.
Created in NX6.0.2
License requirements: None.
annotationTag | the annotation whose component data will be available with this object |
unsafe NXOpen.Annotations.CompoundDatumReferenceBuilder NXOpen.Annotations.AnnotationManager.CreateCompoundDatumReferenceBuilder | ( | ) |
Creates a new compound datum dialog
Created in NX5.0.0
License requirements: geometric_tol ("GDT")
unsafe NXOpen.Annotations.DatumReferenceBuilder NXOpen.Annotations.AnnotationManager.CreateDatumReferenceBuilder | ( | NXOpen.Annotations.FcfDatumReference | datumReference | ) |
Creates a NXOpen.Annotations.DatumReferenceBuilder
Created in NX6.0.0
License requirements: None.
datumReference | the datum reference to be edited, if a null reference (Nothing in Visual Basic), then create an fcf symbol |
unsafe NXOpen.Annotations.DraftingDatumTargetBuilder NXOpen.Annotations.AnnotationManager.CreateDraftingDatumTargetBuilder | ( | NXOpen.Annotations.DraftingDatumTarget | datumTarget | ) |
Creates a NXOpen.Annotations.DraftingDatumTargetBuilder
Created in NX6.0.0
License requirements: None.
datumTarget | Datum to edit |
unsafe NXOpen.Annotations.DraftingFeatureControlFrameBuilder NXOpen.Annotations.AnnotationManager.CreateDraftingFeatureControlFrameBuilder | ( | NXOpen.Annotations.Gdt | fcf | ) |
Creates a NXOpen.Annotations.DraftingFeatureControlFrameBuilder
Created in NX6.0.0
License requirements: None.
fcf | the fcf symbol to be edited, if a null reference (Nothing in Visual Basic), then create an fcf symbol |
unsafe NXOpen.Annotations.DraftingNoteBuilder NXOpen.Annotations.AnnotationManager.CreateDraftingNoteBuilder | ( | NXOpen.Annotations.SimpleDraftingAid | annotation | ) |
Creates a NXOpen.Annotations.DraftingNoteBuilder
Created in NX6.0.0
License requirements: None.
annotation | NXOpen.Annotations.SimpleDraftingAid to be edited |
unsafe NXOpen.Annotations.EditLeaderBuilder NXOpen.Annotations.AnnotationManager.CreateEditLeaderBuilder | ( | NXOpen.DisplayableObject | tableTag | ) |
Creates a NXOpen.Annotations.EditLeaderBuilder
Created in NX6.0.1
License requirements: drafting ("DRAFTING")
tableTag | the table object to edit |
unsafe NXOpen.Annotations.DatumReferenceBuilder NXOpen.Annotations.AnnotationManager.CreateEmptyDatumReferenceBuilder | ( | ) |
Creates a new empty datum reference builder
Created in NX9.0.0
License requirements: None.
unsafe NXOpen.Annotations.FeatureControlFrameDataBuilder NXOpen.Annotations.AnnotationManager.CreateFeatureControlFrameDataBuilder | ( | NXOpen.Annotations.FeatureControlFrameData | frame | ) |
Creates a NXOpen.Annotations.FeatureControlFrameDataBuilder
Created in NX6.0.0
License requirements: None.
frame | the fcf symbol to be edited, if a null reference (Nothing in Visual Basic), then create an fcf symbol |
unsafe NXOpen.Annotations.FeatureControlFrameIndicatorBuilder NXOpen.Annotations.AnnotationManager.CreateFeatureControlFrameIndicatorBuilder | ( | ) |
Creates a NXOpen.Annotations.FeatureControlFrameIndicatorBuilder
Created in NX12.0.0
License requirements: None.
unsafe NXOpen.Annotations.Gdt NXOpen.Annotations.AnnotationManager.CreateGdt | ( | string[] | textLines, |
NXOpen.Point3d | origin, | ||
NXOpen.Annotations.LetteringPreferences | letteringPreferences, | ||
NXOpen.Annotations.UserSymbolPreferences | userSymbolPreferences, | ||
NXOpen.Annotations.LineAndArrowPreferences | lineArrowPreferences, | ||
bool | alwaysVertical, | ||
NXOpen.Annotations.LeaderBundle | leader | ||
) |
Creates a GDT symbol
Created in NX3.0.0
License requirements: drafting ("DRAFTING")
textLines | text for the GDT |
origin | origin for the GDT |
letteringPreferences | lettering preferences. If a null reference (Nothing in Visual Basic), the global lettering preferences will be used |
userSymbolPreferences | user symbol preferences. If a null reference (Nothing in Visual Basic), the scale and aspect ratio will be set to 1.0 |
lineArrowPreferences | line and arrow preferences. If a null reference (Nothing in Visual Basic), the global line and arrow preferences will be used |
alwaysVertical | |
leader | specifies the leaders for the GDT. The following leader types are not valid for GDT symbols: PlainNostub and AlignedNostub |
unsafe NXOpen.Annotations.Label NXOpen.Annotations.AnnotationManager.CreateLabel | ( | string[] | textLines, |
NXOpen.Point3d | origin, | ||
NXOpen.Annotations.LetteringPreferences | letteringPreferences, | ||
NXOpen.Annotations.UserSymbolPreferences | userSymbolPreferences, | ||
NXOpen.Annotations.LineAndArrowPreferences | lineArrowPreferences, | ||
NXOpen.Annotations.LeaderBundle | leader | ||
) |
Creates a label.
The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead.
Created in NX3.0.0
License requirements: drafting ("DRAFTING")
textLines | text for the label |
origin | origin for the label |
letteringPreferences | lettering preferences. If a null reference (Nothing in Visual Basic), the global lettering preferences will be used |
userSymbolPreferences | user symbol preferences. If a null reference (Nothing in Visual Basic), the scale and aspect ratio will be set to 1.0 |
lineArrowPreferences | line and arrow preferences. If a null reference (Nothing in Visual Basic), the global line and arrow preferences will be used |
leader | specifies the leaders for the label |
unsafe NXOpen.Annotations.LeaderData NXOpen.Annotations.AnnotationManager.CreateLeaderData | ( | ) |
unsafe NXOpen.Annotations.Note NXOpen.Annotations.AnnotationManager.CreateNote | ( | string[] | textLines, |
NXOpen.Point3d | origin, | ||
NXOpen.AxisOrientation | orientation, | ||
NXOpen.Annotations.LetteringPreferences | letteringPreferences, | ||
NXOpen.Annotations.UserSymbolPreferences | userSymbolPreferences | ||
) |
Creates a note
Created in NX3.0.0
License requirements: drafting ("DRAFTING")
textLines | text for the note |
origin | origin for the note |
orientation | determines whether the note will be horizontal or vertical |
letteringPreferences | lettering preferences. If a null reference (Nothing in Visual Basic), the global lettering preferences will be used |
userSymbolPreferences | user symbol preferences. If a null reference (Nothing in Visual Basic), the scale and aspect ratio will be set to 1.0 |
unsafe NXOpen.Annotations.PmiDatumTargetBuilder NXOpen.Annotations.AnnotationManager.CreatePmiDatumTargetBuilder | ( | NXOpen.Annotations.DatumTarget | datumTarget | ) |
Creates a NXOpen.Annotations.PmiDatumTargetBuilder
Created in NX6.0.0
License requirements: None.
datumTarget | Datum to edit |
unsafe NXOpen.Annotations.PmiFeatureControlFrameBuilder NXOpen.Annotations.AnnotationManager.CreatePmiFeatureControlFrameBuilder | ( | NXOpen.Annotations.Fcf | fcf | ) |
Creates a NXOpen.Annotations.PmiFeatureControlFrameBuilder
Created in NX6.0.0
License requirements: None.
fcf | the fcf symbol to be edited, if a null reference (Nothing in Visual Basic), then create an fcf symbol |
unsafe NXOpen.Annotations.PmiNoteBuilder NXOpen.Annotations.AnnotationManager.CreatePmiNoteBuilder | ( | NXOpen.Annotations.SimpleDraftingAid | annotation | ) |
Creates a NXOpen.Annotations.PmiNoteBuilder
Created in NX6.0.0
License requirements: None.
annotation | NXOpen.Annotations.SimpleDraftingAid to be edited |
unsafe NXOpen.Annotations.PmiTrackingPropertiesBuilder NXOpen.Annotations.AnnotationManager.CreatePmiTrackingPropertiesBuilder | ( | ) |
Creates a NXOpen.Annotations.PmiTrackingPropertiesBuilder .
Created in NX10.0.0
License requirements: drafting ("DRAFTING")
unsafe NXOpen.Annotations.QueryPmiBuilder NXOpen.Annotations.AnnotationManager.CreateQueryPmiBuilder | ( | ) |
Creates the Query PMI builder
Created in NX5.0.0
License requirements: geometric_tol ("GDT")
unsafe NXOpen.ModelingView NXOpen.Annotations.AnnotationManager.CreateQueryView | ( | NXOpen.Annotations.Annotation[] | pmiSymbols | ) |
Creates a model view displaying the given PMI symbols.
This method would ordinarily be invoked with the PMI symbols resulting from a call to NXOpen.Annotations.AnnotationManager.QueryPmiFromGeometry .
Created in NX5.0.0
License requirements: geometric_tol ("GDT")
pmiSymbols | List of PMI symbols, ordinarily from a geometry query |
unsafe NXOpen.Xform NXOpen.Annotations.AnnotationManager.GetDefaultAnnotationPlane | ( | NXOpen.Annotations.PmiDefaultPlane | jaDefaultPlane | ) |
Returns the default annotation plane for the specified part
Created in NX4.0.0
License requirements: None.
jaDefaultPlane |
unsafe string NXOpen.Annotations.AnnotationManager.GetStandardSymbolTextFont | ( | ) |
Returns the font to use for displaying symbols with standard fonts.
Created in NX8.5.0
License requirements: None.
unsafe NXOpen.SymbolFont NXOpen.Annotations.AnnotationManager.LoadSymbolFontFromSbfFile | ( | string | symbolName, |
out double | symbolWidth, | ||
out double | symbolHeight | ||
) |
Loads a symbol font from the current symbol font definition file
Created in NX3.0.0
License requirements: None.
symbolName | name of the symbol |
symbolWidth | |
symbolHeight |
unsafe void NXOpen.Annotations.AnnotationManager.MakePmi | ( | NXOpen.Annotations.Annotation | annotation | ) |
Flag the annotation as PMI object.
Once flagged, the annotation particiaptes in all PMI specific behaviors, so you can manage it from Part Navigator, inherit on a drawing view, control its display in different model views etc..
Created in NX6.0.0
License requirements: geometric_tol ("GDT")
annotation | NXOpen.Annotations.Annotation to be edited |
unsafe NXOpen.Annotations.AppendedText NXOpen.Annotations.AnnotationManager.NewAppendedText | ( | ) |
Creates a new AppendedText object
Created in NX4.0.0
License requirements: None.
unsafe NXOpen.Annotations.Associativity NXOpen.Annotations.AnnotationManager.NewAssociativity | ( | ) |
Creates a new Associativity object
Created in NX4.0.0
License requirements: None.
unsafe NXOpen.Annotations.DatumReference NXOpen.Annotations.AnnotationManager.NewDatumReference | ( | ) |
Creates a new DatumReference object
Created in NX4.0.0
License requirements: None.
unsafe NXOpen.Annotations.DimensionData NXOpen.Annotations.AnnotationManager.NewDimensionData | ( | ) |
Creates new DimensionData object
Created in NX4.0.0
License requirements: None.
unsafe NXOpen.Annotations.FcfFrame NXOpen.Annotations.AnnotationManager.NewFcfFrame | ( | ) |
Creates a new FcfFrame object
Created in NX4.0.0
License requirements: None.
unsafe NXOpen.Annotations.FcfFrameData NXOpen.Annotations.AnnotationManager.NewFcfFrameData | ( | ) |
Creates a new Fcf Frame Data object
Created in NX5.0.0
License requirements: None.
unsafe NXOpen.Annotations.LeaderBundle NXOpen.Annotations.AnnotationManager.NewLeaderBundle | ( | ) |
Constructs a new LeaderBundle object
Created in NX3.0.0
License requirements: None.
unsafe NXOpen.Annotations.MasterCustomSymbolData NXOpen.Annotations.AnnotationManager.NewMasterCustomSymbolData | ( | ) |
Creates a new MasterCustomSymbolData object
Created in NX6.0.0
Deprecated in NX9.0.0. Use NXOpen.Annotations.MasterSymbolBuilder instead.
License requirements: None.
unsafe NXOpen.Annotations.PmiData NXOpen.Annotations.AnnotationManager.NewPmiData | ( | ) |
Creates a new PmiData object
Created in NX4.0.0
License requirements: None.
unsafe NXOpen.Annotations.UserSymbolPreferences NXOpen.Annotations.AnnotationManager.NewUserSymbolPreferences | ( | NXOpen.Annotations.UserSymbolPreferences.SizeType | type, |
double | lengthOrScale, | ||
double | heightOrAspectRatio | ||
) |
Constructs a new UserSymbolPreferences object
Created in NX3.0.0
License requirements: None.
type | Whether to use length and height or scale and aspect ratio |
lengthOrScale | Length or scale |
heightOrAspectRatio | Height or aspect ratio |
unsafe NXOpen.Annotations.Annotation [] NXOpen.Annotations.AnnotationManager.QueryPmiFromGeometry | ( | NXOpen.DisplayableObject[] | geom | ) |
Finds all PMI symbols that reference the given geometry as an associated object.
The geometry types supported are limited to those supported by NXOpen.Annotations.AssociatedObject .
Created in NX5.0.0
License requirements: geometric_tol ("GDT")
geom | Geometry to be searched |
unsafe string [] NXOpen.Annotations.AnnotationManager.ReadAllSymbolNamesFromSbfFile | ( | ) |
Reads the names of all symbol fonts in the current symbol font definition file
Created in NX3.0.0
License requirements: None.
unsafe void NXOpen.Annotations.AnnotationManager.RemovePmi | ( | NXOpen.Annotations.Annotation | annotation | ) |
Remove PMI flag from annotation.
After the flag is removed, the annotation can't be managed as PMI. However it retains all its properties.
Created in NX6.0.0
License requirements: geometric_tol ("GDT")
annotation | NXOpen.Annotations.Annotation to be edited |
unsafe void NXOpen.Annotations.AnnotationManager.SaveUserSymbolPart | ( | NXOpen.Annotations.MasterCustomSymbolData | symData | ) |
Save a new master Custom Symbol file.
Use builder class NXOpen.Annotations.MasterSymbolBuilder methods instead of this method.
Created in NX6.0.0
Deprecated in NX7.5.2. Use NXOpen.Annotations.MasterSymbolBuilder instead.
License requirements: None.
symData | New master part data |
unsafe void NXOpen.Annotations.AnnotationManager.SetMasterSymbolNameInQaf | ( | ) |
This method writes master custom symbol name to the predefined quick access folder and saves the part.
The given part should correspond to the part file of native symbol part file otherwise error will be raised.
Created in NX7.5.0
License requirements: drafting ("DRAFTING")
unsafe void NXOpen.Annotations.AnnotationManager.SetParallelToScreen | ( | bool | parallelToScreen, |
NXOpen.Annotations.Annotation[] | annotations | ||
) |
Sets the parallel to screen status on each input annotation.
Created in NX11.0.1
License requirements: geometric_tol ("GDT")
parallelToScreen | Parallel to Screen Setting |
annotations | Annotations to be set |
unsafe void NXOpen.Annotations.AnnotationManager.SetStandardSymbolTextFont | ( | string | symbolTextFontName | ) |
Created in NX8.5.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
symbolTextFontName | The name of the text font to use for displaying a symbol when using a standard font. |
|
get |
Bend Table collection
Created in NX9.0.0
|
get |
BusinessModifier collection
Created in NX3.0.0
|
get |
Centerlines collection
Created in NX3.0.0
|
getset |
Returns or sets the symbol font definition file.
LoadSymbolFontFromSbfFile will read from this file
Created in NX3.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
CustomSymbol collection
Created in NX3.0.0
|
get |
Datum collection
Created in NX3.0.0
|
get |
DatumTarget collection
Created in NX3.0.0
|
get |
DimensionSet collection
Created in NX3.0.0
|
get |
DraftingDatumTarget collection
Created in NX8.0.1
|
get |
Drafting Image collection
Created in NX9.0.0
|
get |
Drafting surface finish collection
Created in NX7.5.0
|
get |
Fcf collection
Created in NX3.0.0
|
get |
Frame bar collection
Created in NX8.0.0
|
get |
Hatch collection
Created in NX3.0.0
|
get |
Hole Table collection
Created in NX9.0.0
|
get |
IdSymbol collection
Created in NX3.0.0
|
get |
IntersectionSymbol collection
Created in NX3.0.0
|
get |
OffsetCenterPoint collection
Created in NX3.0.0
|
get |
OrdinateMargin collection
Created in NX3.0.0
|
get |
Part Symbol Folder collection
Created in NX7.5.0
|
get |
PmiFilter collection
Created in NX3.0.0
|
get |
PMI Table collection
Created in NX12.0.0
|
get |
Global annotation preferences
Created in NX3.0.0
|
get |
Library Symbol collection
Created in NX8.0.0
|
get |
Table collection
Created in NX8.0.0
|
get |
Table section collection
Created in NX8.0.0
|
get |
Returns the tag of this object.
|
get |
TargetPoint collection
Created in NX3.0.0
|
get |
Weld collection
Created in NX3.0.0
|
getset |
Returns or sets the weld standard for the part file.
Created in NX7.5.4
License requirements to get this property: None.
License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")