CompareReportBuilder Class¶
-
class
NXOpen.Drawings.CompareReportBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Drawings.CompareReportBuilderbuilderTo create a new instance of this class, use
NXOpen.DrawingCompareManager.CreateCompareReportBuilder()New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| SummaryStatusLine | Returns the report summary status line |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetChangesSummary | Returns the changes summary of report |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetDetailSummary | Returns the detail summary of report |
| GetObject | Returns the object currently being edited by this builder. |
| GetSummary | Returns the summary |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
Method Detail¶
GetChangesSummary¶
-
CompareReportBuilder.GetChangesSummary¶ Returns the changes summary of report
Signature
GetChangesSummary()Returns: Return type: list of str New in version NX11.0.0.
License requirements: None.
GetDetailSummary¶
-
CompareReportBuilder.GetDetailSummary¶ Returns the detail summary of report
Signature
GetDetailSummary()Returns: Return type: list of str New in version NX11.0.0.
License requirements: None.
GetSummary¶
-
CompareReportBuilder.GetSummary¶ Returns the summary
Signature
GetSummary()Returns: Return type: list of str New in version NX7.5.0.
License requirements: None.
Validate¶
-
CompareReportBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.