NXOpen .NET Reference Guide
1899
|
Represents Parameter More...
Public Member Functions | |
unsafe NXOpen.ParamLibParameter | Copy (NXOpen.NXObject partObject) |
Creates new (copied) parameter with same properties as the original parameter. More... | |
unsafe NXOpen.ParamLibParameter | CopyLibParamToPart (NXOpen.NXObject partObject) |
Copies a library parameter to a part. More... | |
unsafe NXOpen.ParamLibParameter | CopyLibParamToPart (NXOpen.NXObject partObject, bool editable) |
Copies a library parameter to a part. More... | |
unsafe void | Delete () |
Deletes a parameter from the part. More... | |
unsafe void | DeleteOrphanedUserParameterModels () |
Deletes Orphaned User Parameter (UPARAM) Models and Properties from a parameter. More... | |
unsafe void | DeleteUserParameterModels () |
Deletes User Parameter (UPARAM) Model Property Values from a parameter. More... | |
unsafe string | GetAlternatename () |
Returns the parameter alternate name. More... | |
unsafe string | GetCategory () |
Returns the parameter category. More... | |
unsafe string | GetDescription () |
Returns the parameter description. More... | |
unsafe int | GetId () |
Returns the parameter id. More... | |
unsafe string | GetLibraryName () |
Returns the library name if the parameter was loaded from a library. More... | |
unsafe string | GetLibraryType () |
Returns the parameter library type this parameter belogns to. More... | |
unsafe string | GetParameterCategory () |
Returns the parameter category using international character set. More... | |
unsafe bool | GetParameterEditable () |
Returns whether the parameter can be modified or not. More... | |
unsafe int | GetParameterType () |
Returns the parameter type. More... | |
unsafe void | GetParentlibraryparameter (out string parentName, out string parentLibraryName) |
Returns the parent libary parameter information. More... | |
unsafe NXOpen.ParamLibParameter | GetParentparameter () |
Returns the parent parameter that the parameter was copied from. More... | |
unsafe NXOpen.BasePropertyTable | GetPropTable () |
Returns the property table that contains the properties for this parameter. More... | |
unsafe string | GetSubcategory () |
Returns the parameter sub-category. More... | |
unsafe string | GetTeamcenterParameterItem () |
Returns the Teamcenter item if the parameter was loaded from Teamcenter. More... | |
unsafe void | GetUsage (out NXOpen.NXObject[] objects) |
Finds the objects using this parameter. More... | |
unsafe string | GetVersion () |
Returns the parameter version . More... | |
unsafe bool | HasParentlibraryparameter () |
Returns whether the parameter was copied from a library parameter. More... | |
unsafe bool | HasParentparameter () |
Returns whether the parameter was copied from another parameter. More... | |
unsafe void | InfoParameter () |
Displays the property values for the parameter in the information window. More... | |
unsafe void | InfoParameterToFile (bool bOverride, string pcFileName) |
Writes the property values for the parameter to a file. More... | |
unsafe bool | IsLoadedLibraryParameter () |
Returns true if the parameter is loaded from a library (not Teamcenter). More... | |
unsafe bool | IsLoadedTeamcenterParameterItem () |
Returns true if the parameter is loaded from Teamcenter. More... | |
unsafe bool | IsNonlibraryParameter () |
Returns true if the parameter is locally defined (not a library/Teamcenter parameter). More... | |
unsafe void | ResyncWithLibraryDefinition () |
Re-synchronizes a loaded library parameter to match its latest library definition. More... | |
unsafe void | SetAlternatename (string parameterAlternatename) |
Sets the parameter alternate name. More... | |
unsafe void | SetCategory (string parameterCategory) |
Sets the parameter category. More... | |
unsafe void | SetDescription (string parameterDescription) |
Sets the parameter description. More... | |
unsafe void | SetId (int parameterId) |
Sets the parameter id. More... | |
unsafe void | SetParameterCategory (string parameterCategory) |
Sets the parameter category using international character set. More... | |
unsafe void | SetParameterEditable (bool isEditable) |
Sets whether a parameter can be modified or not. More... | |
unsafe void | SetSubcategory (string parameterSubcategory) |
Sets the parameter sub-category. More... | |
unsafe void | UnassignAllObjects () |
Removes the parameter assignment from all the objects that has it currently assigned. More... | |
unsafe void | UpdateParameterProperties () |
Re-synchronizes a parameter with its definition. 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 | |
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... | |
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 Parameter
Created in NX1847.0.0
|
inline |
Creates new (copied) parameter with same properties as the original parameter.
The name of the new (copied) parameter will be unique and based on the name of the original parameter.
Created in NX1847.0.0
License requirements: None.
partObject | object in part where to copy parameter to |
|
inline |
Copies a library parameter to a part.
Created in NX1847.0.0
License requirements: None.
partObject | object in part where to copy parameter to |
|
inline |
Copies a library parameter to a part.
The copied (local) parameter can either be set to be editable or non-editable which determines whether the parameter can be modified or not.
Created in NX1847.0.0
License requirements: None.
partObject | object in part where to copy parameter to |
editable | when true, creates a local parameter ready for user editting. When false, it creates an exact copy of a loaded library parameter. The difference between loading and copying with this set to false is loading will get the latest library version whereas if the library parameter passed in is not synchronized with the latest version, the copy will also not be synchronized with the latest version. |
|
inline |
Deletes a parameter from the part.
Created in NX1847.0.0
License requirements: None.
|
inline |
Deletes Orphaned User Parameter (UPARAM) Models and Properties from a parameter.
A model or property is considered orphaned if it exists on the parameter, but doesn't exist in the current environment.
Created in NX1847.0.0
License requirements: None.
|
inline |
Deletes User Parameter (UPARAM) Model Property Values from a parameter.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parameter alternate name.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parameter category.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parameter description.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parameter id.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the library name if the parameter was loaded from a library.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parameter library type this parameter belogns to.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parameter category using international character set.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns whether the parameter can be modified or not.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parameter type.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parent libary parameter information.
Created in NX1847.0.0
License requirements: None.
parentName | |
parentLibraryName |
|
inline |
Returns the parent parameter that the parameter was copied from.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the property table that contains the properties for this parameter.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the parameter sub-category.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns the Teamcenter item if the parameter was loaded from Teamcenter.
Created in NX1847.0.0
License requirements: None.
|
inline |
Finds the objects using this parameter.
Created in NX1847.0.0
License requirements: None.
objects | the objects using the parameter |
|
inline |
Returns the parameter version .
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns whether the parameter was copied from a library parameter.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns whether the parameter was copied from another parameter.
Created in NX1847.0.0
License requirements: None.
|
inline |
Displays the property values for the parameter in the information window.
Created in NX1847.0.0
License requirements: None.
|
inline |
Writes the property values for the parameter to a file.
Created in NX1847.0.0
License requirements: None.
bOverride | if the file already exists, true override the file, false append to the file |
pcFileName | the full path including filename of file where the information should be written |
|
inline |
Returns true if the parameter is loaded from a library (not Teamcenter).
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns true if the parameter is loaded from Teamcenter.
Created in NX1847.0.0
License requirements: None.
|
inline |
Returns true if the parameter is locally defined (not a library/Teamcenter parameter).
Created in NX1847.0.0
License requirements: None.
|
inline |
Re-synchronizes a loaded library parameter to match its latest library definition.
Created in NX1847.0.0
License requirements: None.
|
inline |
Sets the parameter alternate name.
Created in NX1847.0.0
License requirements: None.
parameterAlternatename | the alternate name for the parameter |
|
inline |
Sets the parameter category.
Created in NX1847.0.0
License requirements: None.
parameterCategory | the category for the parameter |
|
inline |
Sets the parameter description.
Created in NX1847.0.0
License requirements: None.
parameterDescription | the description for the parameter |
|
inline |
Sets the parameter id.
Created in NX1847.0.0
License requirements: None.
parameterId | the id for the parameter |
|
inline |
Sets the parameter category using international character set.
Created in NX1847.0.0
License requirements: None.
parameterCategory | the category for the parameter |
|
inline |
Sets whether a parameter can be modified or not.
Note: library parameters cannot be set to be able to be modified.
Created in NX1847.0.0
License requirements: None.
isEditable |
|
inline |
Sets the parameter sub-category.
Created in NX1847.0.0
License requirements: None.
parameterSubcategory | the subcategory for the parameter |
|
inline |
Removes the parameter assignment from all the objects that has it currently assigned.
Created in NX1847.0.0
License requirements: None.
|
inline |
Re-synchronizes a parameter with its definition.
The definition could be a library definition or a parent parameter's (from a copy) definition.
Created in NX1847.0.0
License requirements: None.