NXOpen .NET Reference
12.0.0
|
Represents a base custom symbol More...
Public Member Functions | |
unsafe NXOpen.Annotations.CustomSymbolData | GetSymbolData () |
Returns the custom symbol data More... | |
unsafe void | SetSymbolData (NXOpen.Annotations.CustomSymbolData data) |
Sets the custom symbol data. More... | |
unsafe void | FlipSymbol (NXOpen.Annotations.FlipOption flipOption) |
Flips the custom symbol horizontally/vertically. More... | |
unsafe void | UpdateSymbolGeometry (NXOpen.Point3d origin, double scale, double angle) |
Sets the origin, scale and angle for a custom symbol instance and updates the leaders (if any) as needed. More... | |
unsafe void | AddLeader (NXOpen.Annotations.LeaderBundle leader) |
Adds leaders to the custom symbol. More... | |
unsafe void | RemoveLeader (int nthLeader) |
Removes leader from the custom symbol. More... | |
unsafe void | SynchronizeSymbol () |
Synchronize associative custom symbol. More... | |
unsafe void | ReplaceSymbol (string name, string path, bool isPartSymbol) |
Replace custom symbol with the given master symbol name and path. More... | |
unsafe NXOpen.Point | GetAnchor () |
Returns the master custom symbol anchor point More... | |
unsafe void | SetAnchor (NXOpen.Point anchorPoint) |
Sets the master custom symbol anchor point. More... | |
unsafe void | UpdateFromRule () |
Updates the specified symbol from the KF rule. More... | |
unsafe NXOpen.Annotations.BusinessModifier[] | GetBusinessModifiers () |
Returns the business modifiers More... | |
unsafe void | SetBusinessModifiers (NXOpen.Annotations.BusinessModifier[] businessModifiers) |
Sets the business modifiers. More... | |
unsafe void | AddBusinessModifiers (NXOpen.Annotations.BusinessModifier[] businessModifiers) |
Adds the business modifiers. More... | |
unsafe NXOpen.Annotations.AssociatedObject | GetAssociatedObject () |
Returns the associated object More... | |
unsafe NXOpen.Annotations.AssociatedObject | GetSharedAssociatedObject () |
Returns the shared associated objects More... | |
unsafe void | SetAssociatedObject (NXOpen.Annotations.AssociatedObject assocObj) |
Sets the associated object. More... | |
Properties | |
unsafe string | SymbolName [get] |
Returns the symbol name. More... | |
unsafe int | Index [get, set] |
Returns or sets the index. More... | |
unsafe bool | IsMirrored [get] |
Returns a flag indicating whether the annotation is mirrored More... | |
Properties inherited from NXOpen.Annotations.IPmi | |
int | Index [get, set] |
Returns or sets the index. More... | |
bool | IsMirrored [get] |
Returns a flag indicating whether the annotation is mirrored More... | |
Properties inherited from NXOpen.INXObject | |
bool | IsOccurrence [get] |
Returns whether this object is an occurrence or not. More... | |
string | JournalIdentifier [get] |
Returns the identifier that would be recorded in a journal for this object. More... | |
string | Name [get] |
Returns the custom name of the object. More... | |
NXOpen.Assemblies.Component | OwningComponent [get] |
Returns the owning component, if this object is an occurrence. More... | |
NXOpen.BasePart | OwningPart [get] |
Returns the owning part of this object More... | |
NXOpen.INXObject | Prototype [get] |
Returns the prototype of this object if it is an occurrence. More... | |
Additional Inherited Members | |
Public Types inherited from NXOpen.DisplayableObject | |
enum | ObjectWidth { Normal, Thick, Thin, One = 5, Two, Three, Four, Five, Six, Seven, Eight, Nine } |
specifies object width for objects such as lines and text More... | |
enum | ObjectFont { Solid = 1, Dashed, Phantom, Centerline, Dotted, LongDashed, DottedDashed } |
specifies the object font for objects such as lines More... | |
Represents a base custom symbol
This is an abstract class and cannot be directly instantiated
Created in NX4.0.0
unsafe void NXOpen.Annotations.BaseCustomSymbol.AddBusinessModifiers | ( | NXOpen.Annotations.BusinessModifier[] | businessModifiers | ) |
Adds the business modifiers.
Created in NX12.0.0
License requirements: geometric_tol ("GDT")
businessModifiers | List of new business modifiers |
Implements NXOpen.Annotations.IPmi.
unsafe void NXOpen.Annotations.BaseCustomSymbol.AddLeader | ( | NXOpen.Annotations.LeaderBundle | leader | ) |
Adds leaders to the custom symbol.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
leader | Specifies the leaders to add |
unsafe void NXOpen.Annotations.BaseCustomSymbol.FlipSymbol | ( | NXOpen.Annotations.FlipOption | flipOption | ) |
Flips the custom symbol horizontally/vertically.
This is only available when editing. This option is unavailable for symbols with leaders. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX4.0.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
flipOption | New flip option |
unsafe NXOpen.Point NXOpen.Annotations.BaseCustomSymbol.GetAnchor | ( | ) |
Returns the master custom symbol anchor point
Created in NX4.0.0
License requirements: None.
unsafe NXOpen.Annotations.AssociatedObject NXOpen.Annotations.BaseCustomSymbol.GetAssociatedObject | ( | ) |
Returns the associated object
Created in NX4.0.0
License requirements: None.
Implements NXOpen.Annotations.IPmi.
unsafe NXOpen.Annotations.BusinessModifier [] NXOpen.Annotations.BaseCustomSymbol.GetBusinessModifiers | ( | ) |
Returns the business modifiers
Created in NX4.0.0
License requirements: None.
Implements NXOpen.Annotations.IPmi.
unsafe NXOpen.Annotations.AssociatedObject NXOpen.Annotations.BaseCustomSymbol.GetSharedAssociatedObject | ( | ) |
Returns the shared associated objects
Created in NX8.5.0
License requirements: None.
Implements NXOpen.Annotations.IPmi.
unsafe NXOpen.Annotations.CustomSymbolData NXOpen.Annotations.BaseCustomSymbol.GetSymbolData | ( | ) |
Returns the custom symbol data
Created in NX4.0.0
Deprecated in NX9.0.0. Use NXOpen.Annotations.DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen.Annotations.PmiCustomSymbolBuilder for PMI Custom Symbol objects.
License requirements: None.
unsafe void NXOpen.Annotations.BaseCustomSymbol.RemoveLeader | ( | int | nthLeader | ) |
Removes leader from the custom symbol.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX5.0.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
nthLeader | Specifies which leader to remove |
unsafe void NXOpen.Annotations.BaseCustomSymbol.ReplaceSymbol | ( | string | name, |
string | path, | ||
bool | isPartSymbol | ||
) |
Replace custom symbol with the given master symbol name and path.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX8.0.0
License requirements: drafting ("DRAFTING")
name | Master symbol name |
path | Master symbol path |
isPartSymbol | true if part symbol else false |
unsafe void NXOpen.Annotations.BaseCustomSymbol.SetAnchor | ( | NXOpen.Point | anchorPoint | ) |
Sets the master custom symbol anchor point.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX4.0.0
License requirements: None.
anchorPoint | Custom Symbol Anchor Point |
unsafe void NXOpen.Annotations.BaseCustomSymbol.SetAssociatedObject | ( | NXOpen.Annotations.AssociatedObject | assocObj | ) |
Sets the associated object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX4.0.0
License requirements: geometric_tol ("GDT")
assocObj | New associated object |
Implements NXOpen.Annotations.IPmi.
unsafe void NXOpen.Annotations.BaseCustomSymbol.SetBusinessModifiers | ( | NXOpen.Annotations.BusinessModifier[] | businessModifiers | ) |
Sets the business modifiers.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX4.0.0
License requirements: geometric_tol ("GDT")
businessModifiers | List of new business modifiers |
Implements NXOpen.Annotations.IPmi.
unsafe void NXOpen.Annotations.BaseCustomSymbol.SetSymbolData | ( | NXOpen.Annotations.CustomSymbolData | data | ) |
Sets the custom symbol data.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX4.0.0
Deprecated in NX9.0.0. Use NXOpen.Annotations.DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen.Annotations.PmiCustomSymbolBuilder for PMI Custom Symbol objects.
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
data | New custom symbol data |
unsafe void NXOpen.Annotations.BaseCustomSymbol.SynchronizeSymbol | ( | ) |
Synchronize associative custom symbol.
Created in NX8.0.0
License requirements: drafting ("DRAFTING")
unsafe void NXOpen.Annotations.BaseCustomSymbol.UpdateFromRule | ( | ) |
Updates the specified symbol from the KF rule.
The changes are not applied till an update is performed by calling Update.DoUpdate .
Created in NX8.0.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
unsafe void NXOpen.Annotations.BaseCustomSymbol.UpdateSymbolGeometry | ( | NXOpen.Point3d | origin, |
double | scale, | ||
double | angle | ||
) |
Sets the origin, scale and angle for a custom symbol instance and updates the leaders (if any) as needed.
Created in NX5.0.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
origin | New origin |
scale | New scale |
angle | New angle |
|
getset |
Returns or sets the index.
It is a unique integer assigned to a PMI object.
NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX4.0.0
License requirements to get this property: None.
License requirements to set this property: geometric_tol ("GDT")
|
get |
Returns a flag indicating whether the annotation is mirrored
Created in NX8.5.0
License requirements: None.
|
get |
Returns the symbol name.
Created in NX6.0.0
License requirements: None.