|
NXOpen .NET Reference Guide
|
|
NXOpen .NET Reference Guide
|
Represents the class for object participating in the smart save operation. More...
Public Types | |
| enum | OperationType { None = -1, Create, Revise, SaveAs, Save, Delete } |
| Specifies operation type. More... | |
 Public Types inherited from NXOpen.NXObject | |
| enum | AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 } |
| Specifies attribute type. More... | |
| enum | DateAndTimeFormat { Numeric, Textual } |
| Specifies the format of the date and time attribute. More... | |
Public Member Functions | |
| unsafe NXOpen.PDM.SmartSaveObject.OperationType | GetCurrentOperationType () |
| Returns the current operation type NXOpen.PDM.SmartSaveObject.OperationType for this smart save object. More... | |
| unsafe string | GetEffectivityFormula () |
| Returns the current effectivity formula for this object. More... | |
| unsafe string | GetModificationReason () |
| Returns the modification reason for this smart save object. More... | |
| unsafe string | GetTeamcenterObjectType () |
| Returns the Teamcenter object type for this object. More... | |
| unsafe NXOpen.PDM.SmartSaveObject.OperationType[] | GetValidOperationTypes () |
| Returns the valid operation types (array of NXOpen.PDM.SmartSaveObject.OperationType ) for this object. More... | |
| unsafe bool | HasAddContentPrivilege () |
| This is applicable only for 4G components. More... | |
| unsafe bool | HasRemoveContentPrivilege () |
| This is applicable only for 4G components. More... | |
| unsafe bool | IsCheckedOutByAnotherUser () |
| Returns if the object is currently checkedout by another user. More... | |
| unsafe bool | IsDisplayedOnTheSaveDialog () |
| Returns if this object is currently being shown on the save dialog. More... | |
| unsafe bool | IsExplicitCheckOutNeeded () |
| Returns if the object being saved need to be explicitly checked out. More... | |
| unsafe bool | IsFrozenByStatus () |
| Returns the state of object in Teamcenter. More... | |
| unsafe bool | IsMajorRevisable () |
| Returns if the object is major revisable in Teamcenter. More... | |
| unsafe bool | IsModifiable () |
| Returns if this object is modifiable by the current user. More... | |
| unsafe bool | IsNonMaster () |
| Returns if this part is a non-master. More... | |
| unsafe bool | IsReleased () |
| Returns if the object being saved has status applied in Teamcenter. More... | |
| unsafe void | SetAsDisplayedOnTheSaveDialog (bool markDisplayedOnDialog) |
| Set whether this object is to be shown on the dialog (i. More... | |
| unsafe void | SetCurrentOperationType (NXOpen.PDM.SmartSaveObject.OperationType newOperationType) |
| Sets the new operation type NXOpen.PDM.SmartSaveObject.OperationType for this smart save object. More... | |
| unsafe void | SetEffectivityFormula (string effectivityFormula, string effectivityDisplayString) |
| Sets the new effectivity formula to be applied on this object. More... | |
| unsafe void | SetValidOperationTypes (NXOpen.PDM.SmartSaveObject.OperationType[] newValidOperationTypes) |
| Sets the new valid operation types for this 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from NXOpen.TaggedObject | |
| new void | initialize () |
| <exclude> 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... | |
Represents the class for object participating in the smart save operation.
It is an object that wraps actual NXObject that is modified in the session and processes it to be able to display in Save dialog's table. Refer to technical documentation to know more about Save Management.
Instances of this class can be accessed through smart save builder.
Created in NX11.0.0
|
inline |
Returns the current operation type NXOpen.PDM.SmartSaveObject.OperationType for this smart save object.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns the current effectivity formula for this object.
Created in NX11.0.0
License requirements: None.
|
inline |
Returns the modification reason for this smart save object.
This reason is used to calculate valid and current operation/s to be performed.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns the Teamcenter object type for this object.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns the valid operation types (array of NXOpen.PDM.SmartSaveObject.OperationType ) for this object.
Created in NX12.0.1
License requirements: None.
|
inline |
This is applicable only for 4G components.
Returns if the current user can add new components to the Product.
Created in NX12.0.1
License requirements: None.
|
inline |
This is applicable only for 4G components.
Returns if the current user can remove components to the Product.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns if the object is currently checkedout by another user.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns if this object is currently being shown on the save dialog.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns if the object being saved need to be explicitly checked out.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns the state of object in Teamcenter.
An object state is considered frozen if the released status on this object marks it to be final.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns if the object is major revisable in Teamcenter.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns if this object is modifiable by the current user.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns if this part is a non-master.
For non-part objects this will return false.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns if the object being saved has status applied in Teamcenter.
Created in NX12.0.1
License requirements: None.
|
inline |
Set whether this object is to be shown on the dialog (i.
e. valid for user interaction). Setting this to false will remove the object from the Save dialog's table but it will still be processed for set operation.
Created in NX12.0.1
License requirements: None.
| markDisplayedOnDialog |
|
inline |
Sets the new operation type NXOpen.PDM.SmartSaveObject.OperationType for this smart save object.
This operation should be from among the valid operation types or else the operation will fail.
Created in NX12.0.1
License requirements: None.
| newOperationType |
|
inline |
Sets the new effectivity formula to be applied on this object.
Created in NX11.0.0
License requirements: nx_4gd_integration ("4th Generation Design")
| effectivityFormula | |
| effectivityDisplayString |
|
inline |
Sets the new valid operation types for this object.
These operations should be from among the ones returned by NXOpen.PDM.SmartSaveObject.GetValidOperationTypes or they might be invalid.
Created in NX12.0.1
License requirements: None.
| newValidOperationTypes |
