Layout Class¶
-
class
NXOpen.
Layout
¶ Bases:
NXOpen.NXObject
Represents a layout.
New in version NX3.0.0.
Properties¶
Property | Description |
---|---|
Definition | Returns the definition of the layout. |
DisplayStatus | Returns whether the layout is the current layout (NXOpen.LayoutCollection.Current() ) of the currently active display part of the session (NXOpen.PartCollection.Display() ). |
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. |
WorkView | Returns the work view of the layout. |
Methods¶
Method | Description |
---|---|
CreateAttributeIterator | Create an attribute iterator |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
GetViews | Returns the :py:class:`NXOpen.View`s of the layout. |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
Open | Opens a layout. |
Prints a representation of this object to the system log file. | |
ReplaceView | Replaces a NXOpen.ModelingView with another one at a specified position. |
Save | Saves a layout. |
SaveAs | Saves a layout with a different name. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetName | Sets the custom name of the object. |
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
Property Detail¶
Definition¶
-
Layout.
Definition
¶ Returns the definition of the layout.
-------------------------------------
Getter Method
Signature
Definition
Returns: Return type: NXOpen.LayoutDefinition
New in version NX3.0.0.
License requirements: None.
DisplayStatus¶
-
Layout.
DisplayStatus
¶ Returns whether the layout is the current layout (
NXOpen.LayoutCollection.Current()
) of the currently active display part of the session (NXOpen.PartCollection.Display()
).-------------------------------------
Getter Method
Signature
DisplayStatus
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
IsOccurrence¶
-
Layout.
IsOccurrence
¶ Returns whether this object is an occurrence or not.
-------------------------------------
Getter Method
Signature
IsOccurrence
Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
Layout.
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
JournalIdentifier
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
Layout.
Name
¶ Returns the custom name of the object.
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
Layout.
OwningComponent
¶ Returns the owning component, if this object is an occurrence.
-------------------------------------
Getter Method
Signature
OwningComponent
Returns: Return type: NXOpen.Assemblies.Component
New in version NX3.0.0.
License requirements: None.
OwningPart¶
-
Layout.
OwningPart
¶ Returns the owning part of this object
-------------------------------------
Getter Method
Signature
OwningPart
Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePart
New in version NX3.0.0.
License requirements: None.
Prototype¶
-
Layout.
Prototype
¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------
Getter Method
Signature
Prototype
Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
WorkView¶
-
Layout.
WorkView
¶ Returns the work view of the layout.
-------------------------------------
Getter Method
Signature
WorkView
Returns: Work view Return type: NXOpen.View
New in version NX12.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
Layout.
FindObject
¶ 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.
Signature
FindObject(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
GetViews¶
-
Layout.
GetViews
¶ Returns the :py:class:`NXOpen.View`s of the layout.
Signature
GetViews()
Returns: Return type: list of NXOpen.View
New in version NX3.0.0.
License requirements: None.
Open¶
-
Layout.
Open
¶ Opens a layout.
The Drafting application does not support this method and if used, throws an exception.
Signature
Open()
New in version NX3.0.0.
License requirements: None.
Print¶
-
Layout.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
ReplaceView¶
-
Layout.
ReplaceView
¶ Overloaded method ReplaceView
ReplaceView(view, row, column, performFitView)
ReplaceView(oldView, newView, performFitView)
-------------------------------------
Replaces a
NXOpen.ModelingView
with another one at a specified position.Signature
ReplaceView(view, row, column, performFitView)
Parameters: - view (
NXOpen.ModelingView
) – New view to replace old view - row (int) – Row of view to be replaced
- column (int) – Column of view to be replaced
- performFitView (bool) – Flag that indicates for the system to perform a fit before displaying the view. Otherwise the system displays the view at the scale at which it was last saved.
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Replaces a
NXOpen.ModelingView
with another one.Signature
ReplaceView(oldView, newView, performFitView)
Parameters: - oldView (
NXOpen.ModelingView
) – Old view to be replaced - newView (
NXOpen.ModelingView
) – New view to replace old view - performFitView (bool) – Flag to indicate for the system to perform a Fit before displaying the view. Otherwise the system will display the view at the scale at which they were last saved.
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Save¶
-
Layout.
Save
¶ Saves a layout.
Drafting does not support this method. If you call this method within the Drafting application or when displaying a drawing sheet, it throws an exception.
Signature
Save()
New in version NX3.0.0.
License requirements: None.
SaveAs¶
-
Layout.
SaveAs
¶ Saves a layout with a different name.
If a name contains lowercase characters, the system converts them to uppercase. Drafting does not support this method. If you call this method within the Drafting application or when displaying a drawing sheet, it throws an exception.
Signature
SaveAs(layoutName)
Parameters: layoutName (str) – Name to save layout as Returns: Return type: NXOpen.Layout
New in version NX3.0.0.
License requirements: None.
SetName¶
-
Layout.
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.