Table Class¶
-
class
NXOpen.Annotations.
Table
¶ Bases:
NXOpen.DisplayableObject
Represents a
NXOpen.Annotations.Table
.This class represents a tabular note.
This is an abstract class, and cannot be instantiated.
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
Color | Returns or sets the color of the object. |
IsBlanked | Returns the blank status of this object. |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Layer | Returns or sets the layer that the object is in. |
LineFont | Returns or sets the line font of the object. |
LineWidth | Returns or sets the line width of the object. |
Name | Returns the custom name of the object. |
NameLocation | Returns the location of the object’s name. |
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 |
---|---|
Blank | Blanks the object. |
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 |
DoUpdate | Update tabular note |
EditCellText | Edit Cell Text |
EvaluateRulesAndUpdate | Evalute rules and update tabular note |
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. |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
Highlight | Highlights the object. |
InsertColumns | Insert Columns |
InsertHeaderRow | Insert Header Row |
InsertRows | Insert Rows |
IsRowLocked | Check Row Lock/Unlock Status |
LockUnlockRows | Lock or Unlock Rows |
Prints a representation of this object to the system log file. | |
RedisplayObject | Redisplays the object in all views. |
RemoveViewDependency | Remove dependency on all views from an object. |
ResizeRowsCols | Resize rows and columns |
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. |
SetNameLocation | Sets the location of the object’s name. |
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. |
Unblank | Unblanks the object. |
Unhighlight | Unhighlights the object. |
Enumerations¶
TableInsertColumnsType Enumeration | Represents mode of insertion of a column |
TableInsertRowsType Enumeration | Represents mode of insertion of a row |
Property Detail¶
IsOccurrence¶
-
Table.
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¶
-
Table.
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¶
-
Table.
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¶
-
Table.
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¶
-
Table.
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¶
-
Table.
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.
Method Detail¶
DoUpdate¶
-
Table.
DoUpdate
¶ Update tabular note
Signature
DoUpdate()
New in version NX8.0.0.
License requirements: None.
EditCellText¶
-
Table.
EditCellText
¶ Edit Cell Text
Signature
EditCellText(tableCell, text)
Parameters: - tableCell (
NXOpen.DisplayableObject
) – Table cell object to edit cell text. - text (str) – Text to edit cell text of table cell object.
New in version NX12.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
- tableCell (
EvaluateRulesAndUpdate¶
-
Table.
EvaluateRulesAndUpdate
¶ Evalute rules and update tabular note
Signature
EvaluateRulesAndUpdate()
New in version NX8.5.0.
License requirements: None.
FindObject¶
-
Table.
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.
InsertColumns¶
-
Table.
InsertColumns
¶ Insert Columns
Signature
InsertColumns(selectedColumns, insertColumnsInTabularNote)
Parameters: - selectedColumns (list of
NXOpen.DisplayableObject
) – array of selected table column object to insert new rows. - insertColumnsInTabularNote (
NXOpen.Annotations.TableInsertColumnsType
) – position of table column to be inserted in the table.
New in version NX12.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
- selectedColumns (list of
InsertHeaderRow¶
-
Table.
InsertHeaderRow
¶ Insert Header Row
Signature
InsertHeaderRow()
New in version NX12.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
InsertRows¶
-
Table.
InsertRows
¶ Insert Rows
Signature
InsertRows(selectedRows, insertRowsInTabularNote)
Parameters: - selectedRows (list of
NXOpen.DisplayableObject
) – array of selected table row object to insert new rows. - insertRowsInTabularNote (
NXOpen.Annotations.TableInsertRowsType
) – position of table row to be inserted in the table.
New in version NX12.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
- selectedRows (list of
IsRowLocked¶
-
Table.
IsRowLocked
¶ Check Row Lock/Unlock Status
Signature
IsRowLocked(row)
Parameters: row ( NXOpen.DisplayableObject
) –Returns: Return type: bool New in version NX12.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
LockUnlockRows¶
-
Table.
LockUnlockRows
¶ Lock or Unlock Rows
Signature
LockUnlockRows(rows)
Parameters: rows (list of NXOpen.DisplayableObject
) – Array of table row object to lock or unlock.New in version NX12.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Print¶
-
Table.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
ResizeRowsCols¶
-
Table.
ResizeRowsCols
¶ Resize rows and columns
Signature
ResizeRowsCols(rowsOrColumns, resizeValue)
Parameters: - rowsOrColumns (list of
NXOpen.DisplayableObject
) – Table row or column object to resize. - resizeValue (float) – Value to resize row or column.
New in version NX12.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
- rowsOrColumns (list of
SetName¶
-
Table.
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.