NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.Annotations.AnnotationManager Class Reference

Represents an object that manages annotation and PMI (Product and Manufacturing Information) display instance objects. More...

Inheritance diagram for NXOpen.Annotations.AnnotationManager:

Public Member Functions

unsafe NXOpen.Annotations.Note CreateNote (string[] textLines, NXOpen.Point3d origin, NXOpen.AxisOrientation orientation, NXOpen.Annotations.LetteringPreferences letteringPreferences, NXOpen.Annotations.UserSymbolPreferences userSymbolPreferences)
 Creates a note More...
 
unsafe NXOpen.Annotations.LineWeld 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. More...
 
unsafe NXOpen.Annotations.Note 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. More...
 
unsafe NXOpen.Annotations.Label 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. More...
 
unsafe NXOpen.Annotations.Gdt 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. More...
 
unsafe
NXOpen.Annotations.SimpleDraftingAid 
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. More...
 
unsafe NXOpen.Annotations.Label 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. More...
 
unsafe NXOpen.Annotations.Gdt 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 More...
 
unsafe
NXOpen.Annotations.UserSymbolPreferences 
NewUserSymbolPreferences (NXOpen.Annotations.UserSymbolPreferences.SizeType type, double lengthOrScale, double heightOrAspectRatio)
 Constructs a new UserSymbolPreferences object More...
 
unsafe
NXOpen.Annotations.LeaderBundle 
NewLeaderBundle ()
 Constructs a new LeaderBundle object More...
 
unsafe NXOpen.SymbolFont LoadSymbolFontFromSbfFile (string symbolName, out double symbolWidth, out double symbolHeight)
 Loads a symbol font from the current symbol font definition file More...
 
unsafe string[] ReadAllSymbolNamesFromSbfFile ()
 Reads the names of all symbol fonts in the current symbol font definition file More...
 
unsafe void SaveUserSymbolPart (NXOpen.Annotations.MasterCustomSymbolData symData)
 Save a new master Custom Symbol file. More...
 
unsafe NXOpen.Annotations.PmiData NewPmiData ()
 Creates a new PmiData object More...
 
unsafe
NXOpen.Annotations.AppendedText 
NewAppendedText ()
 Creates a new AppendedText object More...
 
unsafe
NXOpen.Annotations.DimensionData 
NewDimensionData ()
 Creates new DimensionData object More...
 
unsafe
NXOpen.Annotations.Associativity 
NewAssociativity ()
 Creates a new Associativity object More...
 
unsafe NXOpen.Annotations.FcfFrame NewFcfFrame ()
 Creates a new FcfFrame object More...
 
unsafe
NXOpen.Annotations.DatumReference 
NewDatumReference ()
 Creates a new DatumReference object More...
 
unsafe
NXOpen.Annotations.MasterCustomSymbolData 
NewMasterCustomSymbolData ()
 Creates a new MasterCustomSymbolData object More...
 
unsafe NXOpen.Xform GetDefaultAnnotationPlane (NXOpen.Annotations.PmiDefaultPlane jaDefaultPlane)
 Returns the default annotation plane for the specified part More...
 
unsafe
NXOpen.Annotations.QueryPmiBuilder 
CreateQueryPmiBuilder ()
 Creates the Query PMI builder More...
 
unsafe
NXOpen.Annotations.Annotation[] 
QueryPmiFromGeometry (NXOpen.DisplayableObject[] geom)
 Finds all PMI symbols that reference the given geometry as an associated object. More...
 
unsafe NXOpen.ModelingView CreateQueryView (NXOpen.Annotations.Annotation[] pmiSymbols)
 Creates a model view displaying the given PMI symbols. More...
 
unsafe
NXOpen.Annotations.FcfFrameData 
NewFcfFrameData ()
 Creates a new Fcf Frame Data object More...
 
unsafe
NXOpen.Annotations.AssociativityBuilder 
CreateAssociativityBuilder (NXOpen.Annotations.Dimension dimension, int assocIndex)
 Creates the Dimension Associativity builder More...
 
unsafe
NXOpen.Annotations.AssociateDimensionBuilder 
CreateAssociateDimensionBuilder (NXOpen.Annotations.Dimension dimension)
 Creates the Dimension Associativity builder More...
 
unsafe
NXOpen.Annotations.LeaderData 
CreateLeaderData ()
 Creates a NXOpen.Annotations.LeaderData More...
 
unsafe void MakePmi (NXOpen.Annotations.Annotation annotation)
 Flag the annotation as PMI object. More...
 
unsafe void RemovePmi (NXOpen.Annotations.Annotation annotation)
 Remove PMI flag from annotation. More...
 
unsafe
NXOpen.Annotations.DraftingNoteBuilder 
CreateDraftingNoteBuilder (NXOpen.Annotations.SimpleDraftingAid annotation)
 Creates a NXOpen.Annotations.DraftingNoteBuilder More...
 
unsafe
NXOpen.Annotations.PmiNoteBuilder 
CreatePmiNoteBuilder (NXOpen.Annotations.SimpleDraftingAid annotation)
 Creates a NXOpen.Annotations.PmiNoteBuilder More...
 
unsafe
NXOpen.Annotations.DraftingFeatureControlFrameBuilder 
CreateDraftingFeatureControlFrameBuilder (NXOpen.Annotations.Gdt fcf)
 Creates a NXOpen.Annotations.DraftingFeatureControlFrameBuilder More...
 
unsafe
NXOpen.Annotations.DraftingDatumTargetBuilder 
CreateDraftingDatumTargetBuilder (NXOpen.Annotations.DraftingDatumTarget datumTarget)
 Creates a NXOpen.Annotations.DraftingDatumTargetBuilder More...
 
unsafe
NXOpen.Annotations.PmiDatumTargetBuilder 
CreatePmiDatumTargetBuilder (NXOpen.Annotations.DatumTarget datumTarget)
 Creates a NXOpen.Annotations.PmiDatumTargetBuilder More...
 
unsafe
NXOpen.Annotations.PmiFeatureControlFrameBuilder 
CreatePmiFeatureControlFrameBuilder (NXOpen.Annotations.Fcf fcf)
 Creates a NXOpen.Annotations.PmiFeatureControlFrameBuilder More...
 
unsafe
NXOpen.Annotations.FeatureControlFrameDataBuilder 
CreateFeatureControlFrameDataBuilder (NXOpen.Annotations.FeatureControlFrameData frame)
 Creates a NXOpen.Annotations.FeatureControlFrameDataBuilder More...
 
unsafe
NXOpen.Annotations.DatumReferenceBuilder 
CreateDatumReferenceBuilder (NXOpen.Annotations.FcfDatumReference datumReference)
 Creates a NXOpen.Annotations.DatumReferenceBuilder More...
 
unsafe
NXOpen.Annotations.DatumReferenceBuilder 
CreateEmptyDatumReferenceBuilder ()
 Creates a new empty datum reference builder More...
 
unsafe
NXOpen.Annotations.CompoundDatumReferenceBuilder 
CreateCompoundDatumReferenceBuilder ()
 Creates a new compound datum dialog More...
 
unsafe
NXOpen.Annotations.EditLeaderBuilder 
CreateEditLeaderBuilder (NXOpen.DisplayableObject tableTag)
 Creates a NXOpen.Annotations.EditLeaderBuilder More...
 
unsafe
NXOpen.Annotations.ComponentData 
CreateComponentData (NXOpen.Annotations.Annotation annotationTag)
 Creates a NXOpen.Annotations.ComponentData for an annotation. More...
 
unsafe void SetMasterSymbolNameInQaf ()
 This method writes master custom symbol name to the predefined quick access folder and saves the part. More...
 
unsafe
NXOpen.Annotations.AssociativeText 
CreateAssociativeText ()
 Creates a NXOpen.Annotations.AssociativeText . More...
 
unsafe string GetStandardSymbolTextFont ()
 Returns the font to use for displaying symbols with standard fonts. More...
 
unsafe void SetStandardSymbolTextFont (string symbolTextFontName)
  More...
 
unsafe
NXOpen.Annotations.PmiTrackingPropertiesBuilder 
CreatePmiTrackingPropertiesBuilder ()
 Creates a NXOpen.Annotations.PmiTrackingPropertiesBuilder . More...
 
unsafe void SetParallelToScreen (bool parallelToScreen, NXOpen.Annotations.Annotation[] annotations)
 Sets the parallel to screen status on each input annotation. More...
 
unsafe
NXOpen.Annotations.FeatureControlFrameIndicatorBuilder 
CreateFeatureControlFrameIndicatorBuilder ()
 Creates a NXOpen.Annotations.FeatureControlFrameIndicatorBuilder More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
NXOpen.Preferences.AnnotationPreferences Preferences [get]
 Global annotation preferences More...
 
NXOpen.Annotations.PmiFilterCollection PmiFilters [get]
 PmiFilter collection More...
 
NXOpen.Annotations.FcfCollection Fcfs [get]
 Fcf collection More...
 
NXOpen.Annotations.GdtDatumCollection Datums [get]
 Datum collection More...
 
NXOpen.Annotations.DatumTargetCollection DatumTargets [get]
 DatumTarget collection More...
 
NXOpen.Annotations.DraftingDatumTargetCollection DraftingDatumTargets [get]
 DraftingDatumTarget collection More...
 
NXOpen.Annotations.WeldCollection Welds [get]
 Weld collection More...
 
NXOpen.Annotations.CustomSymbolCollection CustomSymbols [get]
 CustomSymbol collection More...
 
NXOpen.Annotations.IdSymbolCollection IdSymbols [get]
 IdSymbol collection More...
 
NXOpen.Annotations.BusinessModifierCollection BusinessModifiers [get]
 BusinessModifier collection More...
 
NXOpen.Annotations.OrdinateMarginCollection OrdinateMargins [get]
 OrdinateMargin collection More...
 
NXOpen.Annotations.DimensionSetCollection DimensionSets [get]
 DimensionSet collection More...
 
NXOpen.Annotations.CenterlineCollection Centerlines [get]
 Centerlines collection More...
 
NXOpen.Annotations.IntersectionSymbolCollection IntersectionSymbols [get]
 IntersectionSymbol collection More...
 
NXOpen.Annotations.TargetPointCollection TargetPoints [get]
 TargetPoint collection More...
 
NXOpen.Annotations.OffsetCenterPointCollection OffsetCenterPoints [get]
 OffsetCenterPoint collection More...
 
NXOpen.Annotations.HatchCollection Hatches [get]
 Hatch collection More...
 
NXOpen.Annotations.DraftingSurfaceFinishCollection DraftingSurfaceFinishSymbols [get]
 Drafting surface finish collection More...
 
NXOpen.Annotations.PartSymbolFolderCollection PartSymbolFolders [get]
 Part Symbol Folder collection More...
 
NXOpen.Annotations.TableSectionCollection TableSections [get]
 Table section collection More...
 
NXOpen.Annotations.TableCollection Tables [get]
 Table collection More...
 
NXOpen.Annotations.HoleTableCollection HoleTables [get]
 Hole Table collection More...
 
NXOpen.Annotations.PmiTableSectionCollection PmiTableSections [get]
 PMI Table collection More...
 
NXOpen.Annotations.FrameBarCollection FrameBars [get]
 Frame bar collection More...
 
NXOpen.Annotations.SymbolFileCollection SymbolFiles [get]
 Library Symbol collection More...
 
NXOpen.Annotations.DraftingImageCollection DraftingImages [get]
 Drafting Image collection More...
 
NXOpen.Annotations.BendTableCollection BendTables [get]
 Bend Table collection More...
 
unsafe string CurrentSbfFile [get, set]
 Returns or sets the symbol font definition file. More...
 
unsafe
NXOpen.Annotations.WeldStandard 
WeldStandard [get, set]
 Returns or sets the weld standard for the part file. More...
 

Detailed Description

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

Member Function Documentation

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")

Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
leaderspecifies the leaders for the new GDT
Returns
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")

Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
leaderspecifies the leaders for the new ID Symbol
Returns
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")

Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
leaderspecifies 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.
Returns
the new label
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")

Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
leaderspecifies 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.
Returns
the new line weld
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")

Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
Returns
the new note
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.

Parameters
dimensionNXOpen.Annotations.Dimension to be edited
Returns
AssociateDimensionBuilder object
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.

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

Parameters
dimensionNXOpen.Annotations.Dimension to be edited
assocIndexAssociativity index
Returns
AssociateDimensionBuilder object
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.

Parameters
annotationTagthe annotation whose component data will be available with this object
Returns
unsafe NXOpen.Annotations.CompoundDatumReferenceBuilder NXOpen.Annotations.AnnotationManager.CreateCompoundDatumReferenceBuilder ( )

Creates a new compound datum dialog

Created in NX5.0.0

License requirements: geometric_tol ("GDT")

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

Parameters
datumReferencethe datum reference to be edited, if a null reference (Nothing in Visual Basic), then create an fcf symbol
Returns
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.

Parameters
datumTargetDatum to edit
Returns
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.

Parameters
fcfthe fcf symbol to be edited, if a null reference (Nothing in Visual Basic), then create an fcf symbol
Returns
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.

Parameters
annotationNXOpen.Annotations.SimpleDraftingAid to be edited
Returns
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")

Parameters
tableTagthe table object to edit
Returns
unsafe NXOpen.Annotations.DatumReferenceBuilder NXOpen.Annotations.AnnotationManager.CreateEmptyDatumReferenceBuilder ( )

Creates a new empty datum reference builder

Created in NX9.0.0

License requirements: None.

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

Parameters
framethe fcf symbol to be edited, if a null reference (Nothing in Visual Basic), then create an fcf symbol
Returns
unsafe NXOpen.Annotations.FeatureControlFrameIndicatorBuilder NXOpen.Annotations.AnnotationManager.CreateFeatureControlFrameIndicatorBuilder ( )

Creates a NXOpen.Annotations.FeatureControlFrameIndicatorBuilder

Created in NX12.0.0

License requirements: None.

Returns
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")

Parameters
textLinestext for the GDT
originorigin for the GDT
letteringPreferenceslettering preferences. If a null reference (Nothing in Visual Basic), the global lettering preferences will be used
userSymbolPreferencesuser symbol preferences. If a null reference (Nothing in Visual Basic), the scale and aspect ratio will be set to 1.0
lineArrowPreferencesline and arrow preferences. If a null reference (Nothing in Visual Basic), the global line and arrow preferences will be used
alwaysVertical
leaderspecifies the leaders for the GDT. The following leader types are not valid for GDT symbols: PlainNostub and AlignedNostub
Returns
the new GDT
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")

Parameters
textLinestext for the label
originorigin for the label
letteringPreferenceslettering preferences. If a null reference (Nothing in Visual Basic), the global lettering preferences will be used
userSymbolPreferencesuser symbol preferences. If a null reference (Nothing in Visual Basic), the scale and aspect ratio will be set to 1.0
lineArrowPreferencesline and arrow preferences. If a null reference (Nothing in Visual Basic), the global line and arrow preferences will be used
leaderspecifies the leaders for the label
Returns
the new label
unsafe NXOpen.Annotations.LeaderData NXOpen.Annotations.AnnotationManager.CreateLeaderData ( )

Creates a NXOpen.Annotations.LeaderData

Created in NX6.0.0

License requirements: None.

Returns
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")

Parameters
textLinestext for the note
originorigin for the note
orientationdetermines whether the note will be horizontal or vertical
letteringPreferenceslettering preferences. If a null reference (Nothing in Visual Basic), the global lettering preferences will be used
userSymbolPreferencesuser symbol preferences. If a null reference (Nothing in Visual Basic), the scale and aspect ratio will be set to 1.0
Returns
the new note
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.

Parameters
datumTargetDatum to edit
Returns
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.

Parameters
fcfthe fcf symbol to be edited, if a null reference (Nothing in Visual Basic), then create an fcf symbol
Returns
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.

Parameters
annotationNXOpen.Annotations.SimpleDraftingAid to be edited
Returns
unsafe NXOpen.Annotations.PmiTrackingPropertiesBuilder NXOpen.Annotations.AnnotationManager.CreatePmiTrackingPropertiesBuilder ( )

Creates a NXOpen.Annotations.PmiTrackingPropertiesBuilder .

Created in NX10.0.0

License requirements: drafting ("DRAFTING")

Returns
PmiTrackingPropertiesBuilder object
unsafe NXOpen.Annotations.QueryPmiBuilder NXOpen.Annotations.AnnotationManager.CreateQueryPmiBuilder ( )

Creates the Query PMI builder

Created in NX5.0.0

License requirements: geometric_tol ("GDT")

Returns
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")

Parameters
pmiSymbolsList of PMI symbols, ordinarily from a geometry query
Returns
Model view displaying the given PMI symbols
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.

Parameters
jaDefaultPlane
Returns
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.

Returns
The name of the text font to use for displaying a symbol when using a standard font.
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.

Parameters
symbolNamename of the symbol
symbolWidth
symbolHeight
Returns
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")

Parameters
annotationNXOpen.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.

Returns
New AppendedText object
unsafe NXOpen.Annotations.Associativity NXOpen.Annotations.AnnotationManager.NewAssociativity ( )

Creates a new Associativity object

Created in NX4.0.0

License requirements: None.

Returns
New Associativity object
unsafe NXOpen.Annotations.DatumReference NXOpen.Annotations.AnnotationManager.NewDatumReference ( )

Creates a new DatumReference object

Created in NX4.0.0

License requirements: None.

Returns
New DatumReference object
unsafe NXOpen.Annotations.DimensionData NXOpen.Annotations.AnnotationManager.NewDimensionData ( )

Creates new DimensionData object

Created in NX4.0.0

License requirements: None.

Returns
New DimensionData object
unsafe NXOpen.Annotations.FcfFrame NXOpen.Annotations.AnnotationManager.NewFcfFrame ( )

Creates a new FcfFrame object

Created in NX4.0.0

License requirements: None.

Returns
New FcfFrame object
unsafe NXOpen.Annotations.FcfFrameData NXOpen.Annotations.AnnotationManager.NewFcfFrameData ( )

Creates a new Fcf Frame Data object

Created in NX5.0.0

License requirements: None.

Returns
New Fcf Frame Data object
unsafe NXOpen.Annotations.LeaderBundle NXOpen.Annotations.AnnotationManager.NewLeaderBundle ( )

Constructs a new LeaderBundle object

Created in NX3.0.0

License requirements: None.

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

Returns
New MasterCustomSymbolData object
unsafe NXOpen.Annotations.PmiData NXOpen.Annotations.AnnotationManager.NewPmiData ( )

Creates a new PmiData object

Created in NX4.0.0

License requirements: None.

Returns
New PMIData object
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.

Parameters
typeWhether to use length and height or scale and aspect ratio
lengthOrScaleLength or scale
heightOrAspectRatioHeight or aspect ratio
Returns
the new object
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")

Parameters
geomGeometry to be searched
Returns
PMI symbols that reference the geometry
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.

Returns
array of names of all symbol fonts in the file
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")

Parameters
annotationNXOpen.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.

Parameters
symDataNew 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")

Parameters
parallelToScreenParallel to Screen Setting
annotationsAnnotations to be set
unsafe void NXOpen.Annotations.AnnotationManager.SetStandardSymbolTextFont ( string  symbolTextFontName)

Created in NX8.5.0

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

Parameters
symbolTextFontNameThe name of the text font to use for displaying a symbol when using a standard font.

Property Documentation

NXOpen.Annotations.BendTableCollection NXOpen.Annotations.AnnotationManager.BendTables
get

Bend Table collection

Created in NX9.0.0

NXOpen.Annotations.BusinessModifierCollection NXOpen.Annotations.AnnotationManager.BusinessModifiers
get

BusinessModifier collection

Created in NX3.0.0

NXOpen.Annotations.CenterlineCollection NXOpen.Annotations.AnnotationManager.Centerlines
get

Centerlines collection

Created in NX3.0.0

unsafe string NXOpen.Annotations.AnnotationManager.CurrentSbfFile
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.

NXOpen.Annotations.CustomSymbolCollection NXOpen.Annotations.AnnotationManager.CustomSymbols
get

CustomSymbol collection

Created in NX3.0.0

NXOpen.Annotations.GdtDatumCollection NXOpen.Annotations.AnnotationManager.Datums
get

Datum collection

Created in NX3.0.0

NXOpen.Annotations.DatumTargetCollection NXOpen.Annotations.AnnotationManager.DatumTargets
get

DatumTarget collection

Created in NX3.0.0

NXOpen.Annotations.DimensionSetCollection NXOpen.Annotations.AnnotationManager.DimensionSets
get

DimensionSet collection

Created in NX3.0.0

NXOpen.Annotations.DraftingDatumTargetCollection NXOpen.Annotations.AnnotationManager.DraftingDatumTargets
get

DraftingDatumTarget collection

Created in NX8.0.1

NXOpen.Annotations.DraftingImageCollection NXOpen.Annotations.AnnotationManager.DraftingImages
get

Drafting Image collection

Created in NX9.0.0

NXOpen.Annotations.DraftingSurfaceFinishCollection NXOpen.Annotations.AnnotationManager.DraftingSurfaceFinishSymbols
get

Drafting surface finish collection

Created in NX7.5.0

NXOpen.Annotations.FcfCollection NXOpen.Annotations.AnnotationManager.Fcfs
get

Fcf collection

Created in NX3.0.0

NXOpen.Annotations.FrameBarCollection NXOpen.Annotations.AnnotationManager.FrameBars
get

Frame bar collection

Created in NX8.0.0

NXOpen.Annotations.HatchCollection NXOpen.Annotations.AnnotationManager.Hatches
get

Hatch collection

Created in NX3.0.0

NXOpen.Annotations.HoleTableCollection NXOpen.Annotations.AnnotationManager.HoleTables
get

Hole Table collection

Created in NX9.0.0

NXOpen.Annotations.IdSymbolCollection NXOpen.Annotations.AnnotationManager.IdSymbols
get

IdSymbol collection

Created in NX3.0.0

NXOpen.Annotations.IntersectionSymbolCollection NXOpen.Annotations.AnnotationManager.IntersectionSymbols
get

IntersectionSymbol collection

Created in NX3.0.0

NXOpen.Annotations.OffsetCenterPointCollection NXOpen.Annotations.AnnotationManager.OffsetCenterPoints
get

OffsetCenterPoint collection

Created in NX3.0.0

NXOpen.Annotations.OrdinateMarginCollection NXOpen.Annotations.AnnotationManager.OrdinateMargins
get

OrdinateMargin collection

Created in NX3.0.0

NXOpen.Annotations.PartSymbolFolderCollection NXOpen.Annotations.AnnotationManager.PartSymbolFolders
get

Part Symbol Folder collection

Created in NX7.5.0

NXOpen.Annotations.PmiFilterCollection NXOpen.Annotations.AnnotationManager.PmiFilters
get

PmiFilter collection

Created in NX3.0.0

NXOpen.Annotations.PmiTableSectionCollection NXOpen.Annotations.AnnotationManager.PmiTableSections
get

PMI Table collection

Created in NX12.0.0

NXOpen.Preferences.AnnotationPreferences NXOpen.Annotations.AnnotationManager.Preferences
get

Global annotation preferences

Created in NX3.0.0

NXOpen.Annotations.SymbolFileCollection NXOpen.Annotations.AnnotationManager.SymbolFiles
get

Library Symbol collection

Created in NX8.0.0

NXOpen.Annotations.TableCollection NXOpen.Annotations.AnnotationManager.Tables
get

Table collection

Created in NX8.0.0

NXOpen.Annotations.TableSectionCollection NXOpen.Annotations.AnnotationManager.TableSections
get

Table section collection

Created in NX8.0.0

Tag NXOpen.Annotations.AnnotationManager.Tag
get

Returns the tag of this object.

NXOpen.Annotations.TargetPointCollection NXOpen.Annotations.AnnotationManager.TargetPoints
get

TargetPoint collection

Created in NX3.0.0

NXOpen.Annotations.WeldCollection NXOpen.Annotations.AnnotationManager.Welds
get

Weld collection

Created in NX3.0.0

unsafe NXOpen.Annotations.WeldStandard NXOpen.Annotations.AnnotationManager.WeldStandard
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")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.