Report Class¶
-
class
NXOpen.Report.
Report
¶ Bases:
NXOpen.NXObject
Represents a report.
Not support KF.
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
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. |
ReportCollection | Returns the report collection object. |
Tag | Returns the Tag for this object. |
TemplateFile | Returns or sets the template document file. |
Methods¶
Method | Description |
---|---|
ClearTemplateItems | Clears all template items in Report.Report . |
CopyUserItem | Copy an user item to the Report.Report . |
CreateAttributeIterator | Create an attribute iterator |
CreateUserItem | Creates a user item and adds it to the report. |
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 |
DeleteUserItems | Deletes all user items in Report.Report . |
Export | Exports the report contents to a document. |
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. |
GetTemplateItems | Gets all template items. |
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. |
GetUserItems | Gets all user items in the report. |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
HideTempalteItemsWithoutInput | Hide template items without user input in Report.Report . |
MoveUserItems | Moves the user items to the new position. |
Prints a representation of this object to the system log file. | |
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. |
SynchronizeWithCommands | Synchronize the Report.Report with commands. |
Enumerations¶
ReportMoveItemLocation Enumeration | Represents the moving item location. |
Property Detail¶
IsOccurrence¶
-
Report.
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¶
-
Report.
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¶
-
Report.
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¶
-
Report.
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¶
-
Report.
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¶
-
Report.
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.
ReportCollection¶
-
Report.
ReportCollection
¶ Returns the report collection object.
-------------------------------------
Getter Method
Signature
ReportCollection
Returns: Return type: NXOpen.Report.IReportCollection
New in version NX11.0.0.
License requirements: None.
TemplateFile¶
-
Report.
TemplateFile
¶ Returns or sets the template document file.
-------------------------------------
Getter Method
Signature
TemplateFile
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TemplateFile
Parameters: templateFile (str) – Template file name with full path New in version NX11.0.0.
License requirements: None.
Method Detail¶
ClearTemplateItems¶
-
Report.
ClearTemplateItems
¶ Clears all template items in
Report.Report
.Signature
ClearTemplateItems()
New in version NX11.0.0.
License requirements: None.
CopyUserItem¶
-
Report.
CopyUserItem
¶ Copy an user item to the
Report.Report
.Signature
CopyUserItem(userItem)
Parameters: userItem ( NXOpen.Report.IUserItem
) – input user itemReturns: the copy of the input user item Return type: NXOpen.Report.IUserItem
New in version NX11.0.0.
License requirements: None.
CreateUserItem¶
-
Report.
CreateUserItem
¶ Creates a user item and adds it to the report.
Signature
CreateUserItem(inputType)
Parameters: inputType ( NXOpen.Report.UserInputType
) –Returns: Return type: NXOpen.Report.IUserItem
New in version NX11.0.0.
License requirements: None.
DeleteUserItems¶
-
Report.
DeleteUserItems
¶ Deletes all user items in
Report.Report
.Signature
DeleteUserItems()
New in version NX11.0.0.
License requirements: None.
Export¶
-
Report.
Export
¶ Exports the report contents to a document.
Signature
Export(reportDocument, listError)
Parameters: - reportDocument (str) –
- listError (bool) – list error information in listing window
New in version NX11.0.0.
License requirements: None.
FindObject¶
-
Report.
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.
GetTemplateItems¶
-
Report.
GetTemplateItems
¶ Gets all template items.
Signature
GetTemplateItems()
Returns: Return type: list of NXOpen.Report.TemplateItem
New in version NX11.0.0.
License requirements: None.
GetUserItems¶
-
Report.
GetUserItems
¶ Gets all user items in the report.
Signature
GetUserItems()
Returns: Return type: list of NXOpen.Report.IUserItem
New in version NX11.0.0.
License requirements: None.
HideTempalteItemsWithoutInput¶
-
Report.
HideTempalteItemsWithoutInput
¶ Hide template items without user input in
Report.Report
.Signature
HideTempalteItemsWithoutInput(hideTemplateItemsWithoutInput)
Parameters: hideTemplateItemsWithoutInput (bool) – New in version NX11.0.0.
License requirements: None.
MoveUserItems¶
-
Report.
MoveUserItems
¶ Moves the user items to the new position.
Signature
MoveUserItems(userItems, newLocation, referencedItem)
Parameters: - userItems (list of
NXOpen.Report.IUserItem
) – - newLocation (
NXOpen.Report.ReportMoveItemLocation
) – - referencedItem (
NXOpen.Report.IUserItem
) – the target reference user item
New in version NX11.0.0.
License requirements: None.
- userItems (list of
Print¶
-
Report.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetName¶
-
Report.
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.