UserInput Class¶
-
class
NXOpen.Report.UserInput¶ Bases:
NXOpen.TaggedObject,NXOpen.INXObjectRepresents a user input in command.
Not support KF.
New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| InputType | Returns or sets the user input type. |
| IsOccurrence | Returns whether this object is an occurrence or not. |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| Name | Returns the custom name of the object. |
| OwningComponent | Returns the owning component, if this object is an occurrence. |
| OwningPart | Returns the owning part of this object |
| Prototype | Returns the prototype of this object if it is an occurrence. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
| GetHint | Gets the user input hint. |
| Prints a representation of this object to the system log file. | |
| SetHint | Sets the user input hint. |
| SetName | Sets the custom name of the object. |
Enumerations¶
| UserInputType Enumeration | Represents the user input type |
Property Detail¶
InputType¶
-
UserInput.InputType¶ Returns or sets the user input type.
-------------------------------------Getter Method
Signature
InputTypeReturns: Return type: NXOpen.Report.UserInputTypeNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
InputTypeParameters: inputType ( NXOpen.Report.UserInputType) –New in version NX11.0.0.
License requirements: None.
IsOccurrence¶
-
UserInput.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrenceReturns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
UserInput.JournalIdentifier¶ 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.
-------------------------------------Getter Method
Signature
JournalIdentifierReturns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
UserInput.Name¶ Returns the custom name of the object.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
UserInput.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponentReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
UserInput.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPartReturns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
UserInput.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
PrototypeReturns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
UserInput.FindObject¶ Finds the
NXOpen.NXObjectwith 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.
Signature
FindObject(journalIdentifier)Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
GetHint¶
-
UserInput.GetHint¶ Gets the user input hint.
Signature
GetHint()Returns: Return type: list of str New in version NX11.0.0.
License requirements: None.
Print¶
-
UserInput.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetHint¶
-
UserInput.SetHint¶ Sets the user input hint.
Signature
SetHint(inputHint)Parameters: inputHint (list of str) – New in version NX11.0.0.
License requirements: None.
SetName¶
-
UserInput.SetName¶ 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.
Signature
SetName(name)Parameters: name (str) – New in version NX3.0.0.
License requirements: None.