NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | List of all members
NXOpen.AME.ReportDefinition Class Reference

The Report Definition More...

Inheritance diagram for NXOpen.AME.ReportDefinition:
NXOpen.AME.AMEExtendedObject NXOpen.NXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void AddPageBreakCriteria (string propertyOf, string category, string propertyTitle, int targetDirection)
 Add Page Break Criteria More...
 
unsafe void AddReportSortingCriteria (string propertyOf, string category, string propertyTitle, bool sort)
 Add Sorting Criteria More...
 
unsafe void ChangeReportTemplate (string reportTemplateItemName)
 Change report template More...
 
unsafe void ClearPageBreakCriteria ()
 Clear PageBreak Criteria More...
 
unsafe void ClearReportSortingCriteria ()
 Clear Sorting Criteria More...
 
unsafe void EditSortingProperty (int index, bool isAscending)
 Edit Sorting Property More...
 
unsafe void GenerateReport (out NXOpen.NXObject pageObject, out NXOpen.NXObject pageNode)
 Execute query and get engineering objects as result More...
 
unsafe void GenerateReportAndExportToExcel ()
 Generate report and export it to Excel More...
 
unsafe NXOpen.NXObject GetReportPage ()
 Get report first page More...
 
unsafe void MoveSortingProperty (int index, bool toBeMovedUp)
 Move Sorting Property More...
 
unsafe void RemovePageBreakCriteria (int index)
 Remove Page Break Criteria More...
 
unsafe void RemoveSortingProperty (int index)
 Remove Sorting Property More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Detailed Description

The Report Definition

This object does not need a creator.

Created in NX1847.0.0

Member Function Documentation

unsafe void NXOpen.AME.ReportDefinition.AddPageBreakCriteria ( string  propertyOf,
string  category,
string  propertyTitle,
int  targetDirection 
)
inline

Add Page Break Criteria

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyOf
category
propertyTitle
targetDirection
unsafe void NXOpen.AME.ReportDefinition.AddReportSortingCriteria ( string  propertyOf,
string  category,
string  propertyTitle,
bool  sort 
)
inline

Add Sorting Criteria

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
propertyOf
category
propertyTitle
sort
unsafe void NXOpen.AME.ReportDefinition.ChangeReportTemplate ( string  reportTemplateItemName)
inline

Change report template

Created in NX1847.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
reportTemplateItemName
unsafe void NXOpen.AME.ReportDefinition.ClearPageBreakCriteria ( )
inline

Clear PageBreak Criteria

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe void NXOpen.AME.ReportDefinition.ClearReportSortingCriteria ( )
inline

Clear Sorting Criteria

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe void NXOpen.AME.ReportDefinition.EditSortingProperty ( int  index,
bool  isAscending 
)
inline

Edit Sorting Property

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
index
isAscending
unsafe void NXOpen.AME.ReportDefinition.GenerateReport ( out NXOpen.NXObject  pageObject,
out NXOpen.NXObject  pageNode 
)
inline

Execute query and get engineering objects as result

Created in NX1847.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
pageObject
pageNode
unsafe void NXOpen.AME.ReportDefinition.GenerateReportAndExportToExcel ( )
inline

Generate report and export it to Excel

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

unsafe NXOpen.NXObject NXOpen.AME.ReportDefinition.GetReportPage ( )
inline

Get report first page

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Returns
unsafe void NXOpen.AME.ReportDefinition.MoveSortingProperty ( int  index,
bool  toBeMovedUp 
)
inline

Move Sorting Property

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
index
toBeMovedUp
unsafe void NXOpen.AME.ReportDefinition.RemovePageBreakCriteria ( int  index)
inline

Remove Page Break Criteria

Created in NX1899.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
index
unsafe void NXOpen.AME.ReportDefinition.RemoveSortingProperty ( int  index)
inline

Remove Sorting Property

Created in NX1872.0.0

License requirements: ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
index

The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.