NXOpen .NET Reference Guide
1899
|
Represents an annotation / PMI (Product and Manufacturing Information) display instance object. More...
Classes | |
struct | _AssociativeOriginData |
Describes the geometry that an annotation's origin is associated with | |
struct | AssociativeOriginData |
Describes the geometry that an annotation's origin is associated with More... | |
Public Member Functions | |
unsafe NXOpen.Annotations.Annotation.AssociativeOriginData | GetAssociativeOrigin (out NXOpen.Point3d origin) |
Gets data that specifies the origin's associativity More... | |
unsafe NXOpen.Annotations.Associativity | GetAssociativity (int associativityIndex) |
Returns the associativity at specified index. More... | |
unsafe NXOpen.Xform | GetInferredAnnotationPlane (NXOpen.Annotations.PmiDefaultPlane jaDefaultPlane) |
Returns the inferred annotation plane More... | |
unsafe NXOpen.Annotations.LetteringPreferences | GetLetteringPreferences () |
Returns the lettering preferences for the annotation More... | |
unsafe NXOpen.Annotations.LineAndArrowPreferences | GetLineAndArrowPreferences () |
Returns the line and arrow preferences for the annotation More... | |
unsafe NXOpen.Annotations.SymbolPreferences | GetSymbolPreferences () |
Returns the symbol preferences for the annotation More... | |
unsafe NXOpen.View[] | GetViews () |
Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects. More... | |
unsafe void | InsertIntoStack (NXOpen.Annotations.Annotation stack, NXOpen.Annotations.StackAlignmentPosition position) |
Inserts the annotation into a stack. More... | |
unsafe void | RemoveFromStack () |
Removes the annotation from a stack. More... | |
unsafe void | SetAssociativeOrigin (NXOpen.Annotations.Annotation.AssociativeOriginData assocOrigin, NXOpen.Point3d origin) |
Associates the annotation's origin to the specified geometry. More... | |
unsafe void | SetAssociativity (int associativityIndex, NXOpen.Annotations.Associativity associativity) |
Sets the associativity at specified index. More... | |
unsafe void | SetLetteringPreferences (NXOpen.Annotations.LetteringPreferences letteringPrefs) |
Sets the lettering preferences for the annotation. More... | |
unsafe void | SetLineAndArrowPreferences (NXOpen.Annotations.LineAndArrowPreferences lineArrowPrefs) |
Sets the line and arrow preferences for the annotation. More... | |
unsafe void | SetSymbolPreferences (NXOpen.Annotations.SymbolPreferences symbolPrefs) |
Sets the symbol preferences for the annotation. More... | |
unsafe void | SetViews (NXOpen.View[] modelViews) |
Sets the views that the PMI display instance object is displayed in. More... | |
Public Member Functions inherited from NXOpen.DisplayableObject | |
unsafe void | Blank () |
Blanks the object. More... | |
unsafe void | Highlight () |
Highlights the object. More... | |
unsafe void | RedisplayObject () |
Redisplays the object in all views. More... | |
unsafe void | RemoveViewDependency () |
Remove dependency on all views from an object. More... | |
unsafe void | SetNameLocation (NXOpen.Point3d location) |
Sets the location of the object's name. More... | |
unsafe void | Unblank () |
Unblanks the object. More... | |
unsafe void | Unhighlight () |
Unhighlights the object. More... | |
Public Member Functions inherited from NXOpen.NXObject | |
unsafe NXOpen.AttributeIterator | CreateAttributeIterator () |
Create an attribute iterator More... | |
unsafe void | DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type) |
Deletes all attributes of a specific type. More... | |
unsafe void | DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option) |
Deletes all attributes of a specific type with the option to update or not. More... | |
unsafe void | DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title) |
Deletes an attribute by type and title. More... | |
unsafe void | DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option) |
Deletes an attribute by type and title with the option to update or not. More... | |
unsafe void | DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option) |
Deletes the first attribute encountered with the given Type, Title. More... | |
unsafe void | DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option) |
Deletes the attributes on the object, if any, that satisfy the given iterator More... | |
unsafe void | DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option) |
Deletes the attributes encountered with the given Type with option to update or not. More... | |
unsafe NXOpen.INXObject | FindObject (string journalIdentifier) |
Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type) |
Gets all the attribute titles of a specific type. More... | |
unsafe bool | GetBooleanUserAttribute (string title, int index) |
Gets a boolean attribute by Title and array Index. More... | |
unsafe NXOpen.NXObject.ComputationalTime | GetComputationalTimeUserAttribute (string title, int index) |
Gets a time attribute by Title and array Index. More... | |
unsafe int | GetIntegerAttribute (string title) |
Gets an integer attribute by title. More... | |
unsafe int | GetIntegerUserAttribute (string title, int index) |
Gets an integer attribute by Title and array Index. More... | |
unsafe bool | GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info) |
Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More... | |
unsafe string | GetPdmReferenceAttributeValue (string attributeTitle) |
Gets the value of PDM Reference attribute for given object. More... | |
unsafe double | GetRealAttribute (string title) |
Gets a real attribute by title. More... | |
unsafe double | GetRealUserAttribute (string title, int index) |
Gets a real attribute by Title and array Index. More... | |
unsafe string | GetReferenceAttribute (string title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More... | |
unsafe string | GetStringAttribute (string title) |
Gets a string attribute value by title. More... | |
unsafe string | GetStringUserAttribute (string title, int index) |
Gets a string attribute by Title and array Index. More... | |
unsafe string | GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title) |
Gets a time attribute by title. More... | |
unsafe string | GetTimeUserAttribute (string title, int index) |
Gets a time attribute by Title and array Index. More... | |
unsafe NXOpen.NXObject.AttributeInformation | GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type) |
Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More... | |
unsafe string | GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given title, type and array index. More... | |
unsafe int | GetUserAttributeCount (NXOpen.AttributeIterator iterator) |
Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
unsafe int | GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute) |
Gets the count of set attributes on the object, if any, that satisfy the given iterator. More... | |
unsafe int | GetUserAttributeCount (NXOpen.NXObject.AttributeType type) |
Gets the count of set attributes on the object, if any, of the given type. More... | |
unsafe int | GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute) |
Gets the count of attributes on the object, if any, of the given type. More... | |
unsafe bool | GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type) |
Determine the lock of the given attribute. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (NXOpen.AttributeIterator iterator) |
Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes () |
Gets all the attributes that have been set on the given object. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset) |
Gets all the attributes of the given object. More... | |
unsafe NXOpen.NXObject.AttributeInformation[] | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes of the given object. More... | |
unsafe string[] | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. More... | |
unsafe int | GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type) |
Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More... | |
unsafe NXOpen.NXObject[] | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. More... | |
unsafe bool | HasUserAttribute (NXOpen.AttributeIterator iterator) |
Determines if an attribute exists on the object, that satisfies the given iterator More... | |
unsafe bool | HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index) |
Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More... | |
unsafe void | Print () |
Prints a representation of this object to the system log file. More... | |
unsafe void | SetAttribute (string title, int value) |
Creates or modifies an integer attribute. More... | |
unsafe void | SetAttribute (string title, int value, NXOpen.Update.Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title, double value) |
Creates or modifies a real attribute. More... | |
unsafe void | SetAttribute (string title, double value, NXOpen.Update.Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title, string value) |
Creates or modifies a string attribute. More... | |
unsafe void | SetAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
unsafe void | SetAttribute (string title) |
Creates or modifies a null attribute which is an attribute with a title and no value. More... | |
unsafe void | SetAttribute (string title, NXOpen.Update.Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
unsafe void | SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option) |
Creates or modifies a boolean attribute with the option to update or not. More... | |
unsafe void | SetName (string name) |
Sets the custom name of the object. More... | |
unsafe void | SetPdmReferenceAttribute (string attributeTitle, string attributeValue) |
Sets the value of PDM Reference attribute on the object. More... | |
unsafe void | SetReferenceAttribute (string title, string value) |
Creates or modifies a string attribute which uses a reference string. More... | |
unsafe void | SetReferenceAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute which uses a reference string, with the option to update or not. More... | |
unsafe void | SetTimeAttribute (string title, string value) |
Creates or modifies a time attribute. More... | |
unsafe void | SetTimeAttribute (string title, string value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe void | SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe void | SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option) |
Creates or modifies an attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
unsafe void | SetUserAttribute (string title, int index, NXOpen.Update.Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
unsafe void | SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock) |
Lock or unlock the given attribute. 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 NXOpen.Point3d | AnnotationOrigin [get, set] |
Returns or sets the origin (location) of the annotation. More... | |
unsafe NXOpen.Xform | AnnotationPlane [get, set] |
Returns or sets the annotation plane. More... | |
unsafe bool | HasAssociativeOrigin [get] |
Returns a flag indicating whether the origin is associative More... | |
unsafe bool | IsOutOfDate [get] |
Returns the flag indicating whether the annotation is out of date More... | |
unsafe bool | IsRetained [get] |
Returns a flag indicating whether the annotation is retained More... | |
unsafe NXOpen.Annotations.LeaderOrientation | LeaderOrientation [get, set] |
Returns or sets the leader orientation for the annotation. More... | |
unsafe int | NumberOfAssociativities [get] |
Returns the number of associativities for the annotation. More... | |
unsafe bool | ParallelToScreen [get, set] |
Returns or sets the PMI parallel to screen setting More... | |
unsafe bool | Suppressed [get] |
Returns the flag indicating whether the annotation is suppressed More... | |
Properties inherited from NXOpen.DisplayableObject | |
unsafe int | Color [get, set] |
Returns or sets the color of the object. More... | |
unsafe bool | IsBlanked [get] |
Returns the blank status of this object. More... | |
unsafe int | Layer [get, set] |
Returns or sets the layer that the object is in. More... | |
unsafe NXOpen.DisplayableObject.ObjectFont | LineFont [get, set] |
Returns or sets the line font of the object. More... | |
unsafe NXOpen.DisplayableObject.ObjectWidth | LineWidth [get, set] |
Returns or sets the line width of the object. More... | |
unsafe NXOpen.Point3d | NameLocation [get] |
Returns the location of the object's name. More... | |
Properties inherited from NXOpen.NXObject | |
unsafe bool | IsOccurrence [get] |
Returns whether this object is an occurrence or not. More... | |
unsafe string | JournalIdentifier [get] |
Returns the identifier that would be recorded in a journal for this object. More... | |
unsafe string | Name [get] |
Returns the custom name of the object. More... | |
unsafe NXOpen.Assemblies.Component | OwningComponent [get] |
Returns the owning component, if this object is an occurrence. More... | |
unsafe NXOpen.BasePart | OwningPart [get] |
Returns the owning part of this object More... | |
unsafe NXOpen.INXObject | Prototype [get] |
Returns the prototype of this object if it is an occurrence. 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... | |
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 | ObjectFont { Solid = 1, Dashed, Phantom, Centerline, Dotted, LongDashed, DottedDashed, Eight = 11, Nine, Ten, Eleven } |
specifies the object font for objects such as lines More... | |
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... | |
Protected Member Functions inherited from NXOpen.TaggedObject | |
new void | initialize () |
<exclude> More... | |
Represents an annotation / PMI (Product and Manufacturing Information) display instance object.
Creation of drafting annotation objects is controlled by drafting license.
Creation of PMI display instance objects is controlled by geometric_tol license.
In all edit methods, the changes are not applied to the system until an update is performed. An update can be performed by calling Update.DoUpdate ().
This is an abstract class.
Created in NX3.0.0
|
inline |
Gets data that specifies the origin's associativity
Created in NX3.0.0
License requirements: None.
origin | coordinates of the origin |
|
inline |
Returns the associativity at specified index.
The index starts from 1, and is less than or equal to the return value from NXOpen.Annotations.Annotation.NumberOfAssociativities .
Created in NX4.0.0
License requirements: None.
associativityIndex | Associativity index |
|
inline |
Returns the inferred annotation plane
Created in NX4.0.0
License requirements: None.
jaDefaultPlane |
|
inline |
Returns the lettering preferences for the annotation
Created in NX3.0.0
License requirements: None.
|
inline |
Returns the line and arrow preferences for the annotation
Created in NX3.0.0
License requirements: None.
|
inline |
Returns the symbol preferences for the annotation
Created in NX5.0.0
License requirements: None.
|
inline |
Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects.
This method will return an empty view list for non-PMI display instance objects. This method will return an empty view list if the PMI object is displayed in all views.
Created in NX4.0.0
License requirements: None.
|
inline |
Inserts the annotation into a stack.
Annotations that already reside within a stack cannot be inserted into another stack (or the same stack) without first being removed from the stack they are in (attempting to do so will result in no changes to the annotation). The "position" parameter controls where in the stack the annotation will be inserted relative to the "stack" parameter. It is important to note that stacks have a primary column of members. Each member in the primary column can have up to three children (left, right, and below). If you stack an annotation above an existing stack member, the existing member becomes a child of the newly added member. The top most element in the primary column is the "owner" of the stack and all other annotations in the stack move relative to it. 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 NX6.0.1
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
stack | Annotation in the stack |
position | Alignment position |
|
inline |
Removes the annotation from a stack.
Annotations that do not reside within a stack are ignored.
Created in NX11.0.1
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
|
inline |
Associates the annotation's origin to the specified geometry.
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 NX3.0.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
assocOrigin | associativity data |
origin | coordinates of the origin |
|
inline |
Sets the associativity at specified index.
The index starts from 1, and is less than or equal to the return value from NXOpen.Annotations.Annotation.NumberOfAssociativities . 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")
associativityIndex | Associativity index |
associativity | Associativity object |
|
inline |
Sets the lettering preferences for the annotation.
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 NX3.0.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
letteringPrefs |
|
inline |
Sets the line and arrow preferences for the annotation.
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 NX3.0.0
License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")
lineArrowPrefs |
|
inline |
Sets the symbol preferences for the annotation.
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")
symbolPrefs |
|
inline |
Sets the views that the PMI display instance object is displayed in.
NOTE: This method is only valid for PMI display instance objects. 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")
modelViews | List of new views to display PMI display instance object in |
|
getset |
Returns or sets the origin (location) of the annotation.
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 NX3.0.0
License requirements to get this property: None.
License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")
|
getset |
Returns or sets the annotation plane.
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 origin is associative
Created in NX3.0.0
License requirements: None.
|
get |
Returns the flag indicating whether the annotation is out of date
Created in NX1847.0.0
License requirements: None.
|
get |
Returns a flag indicating whether the annotation is retained
Created in NX3.0.0
License requirements: None.
|
getset |
Returns or sets the leader orientation for the annotation.
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 NX3.0.0
License requirements to get this property: None.
License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")
|
get |
Returns the number of associativities for the annotation.
Created in NX4.0.0
License requirements: None.
|
getset |
Returns or sets the PMI parallel to screen setting
Created in NX11.0.1
License requirements to get this property: None.
License requirements to set this property: geometric_tol ("GDT")
|
get |
Returns the flag indicating whether the annotation is suppressed
Created in NX12.0.0
License requirements: None.