NXOpen .NET Reference
12.0.0
|
Represents an abstract command argument. More...
Public Types | |
enum | Type { Integer, Double, String, Enumeration } |
Represents the argument type. More... | |
Public Member Functions | |
unsafe NXOpen.INXObject | FindObject (string journalIdentifier) |
Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More... | |
unsafe void | Print () |
Prints a representation of this object to the system log file. More... | |
unsafe void | SetName (string name) |
Sets the custom name of the object. More... | |
Properties | |
unsafe string | DisplayName [get, set] |
Returns or sets the argument display name More... | |
unsafe string | Hint [get, set] |
Returns or sets the argument hint. More... | |
unsafe bool | Optional [get, set] |
Returns or sets a value that indicates whether this argument is optional or not. More... | |
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.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... | |
Represents an abstract command argument.
Not support KF.
Created in NX11.0.0
unsafe NXOpen.INXObject NXOpen.Report.BaseArgument.FindObject | ( | string | journalIdentifier | ) |
Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Created in NX3.0.0
License requirements: None.
journalIdentifier | Journal identifier of the object |
Implements NXOpen.INXObject.
unsafe void NXOpen.Report.BaseArgument.Print | ( | ) |
Prints a representation of this object to the system log file.
Created in NX3.0.0
License requirements: None.
Implements NXOpen.INXObject.
unsafe void NXOpen.Report.BaseArgument.SetName | ( | string | name | ) |
Sets the custom name of the 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 NX3.0.0
License requirements: None.
name |
Implements NXOpen.INXObject.
|
getset |
Returns or sets the argument display name
Created in NX11.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the argument hint.
Created in NX11.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns whether this object is an occurrence or not.
Created in NX3.0.0
License requirements: None.
|
get |
Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
Created in NX3.0.0
License requirements: None.
|
get |
Returns the custom name of the object.
Created in NX3.0.0
License requirements: None.
|
getset |
Returns or sets a value that indicates whether this argument is optional or not.
Created in NX11.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns the owning component, if this object is an occurrence.
Created in NX3.0.0
License requirements: None.
|
get |
Returns the owning part of this object
Created in NX3.0.0
License requirements: None.
|
get |
Returns the prototype of this object if it is an occurrence.
Created in NX3.0.0
License requirements: None.