Report Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The Report class lets users use reports that are present in the Finance and Operations Application Object Tree (AOT) and report creation by using code instead of the AOT.
public ref class Report : Dynamics::AX::Application::TreeNode[Microsoft.Dynamics.Ax.Xpp.KernelClass]
[Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly]
public class Report : Dynamics.AX.Application.TreeNode[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
[<Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly>]
type Report = class
inherit TreeNodePublic Class Report
Inherits TreeNode- Inheritance
- Attributes
-
KernelClassAttribute Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnlyAttribute
Remarks
A Report object contains a query and zero or more designs. Each design is a definition of the layout of a report that can be displayed on screen or printed. A Report object also has ReportRun methods that can be overridden. This class enables you to create, read, update, and delete X++ code and metadata.
The following code example creates and runs a report that is not present in the AOT.
static void test(args a)
{
report r;
reportDesign rd;
reportSection rs;
reportRun rr;
// Creates a simple report that is not present in
// the AOT.
r = new report();
rd = r.addDesign("myDesign");
// Adds a section that is triggered by execute(1).
rs = rd.addProgrammableSection(1);
rs.addTextControl("Hello world");
// Runs the report.
rr = new reportRun(r);
// Runs the SysPrintForm form.
if (rr.prompt())
{
// Executes the programmable section.
rr.execute(1);
// Prints the report to the target selected
// during the previous prompt call.
rr.print();
}
}
Constructors
| Report() | |
| Report(IntPtr) | |
| Report(Object, Object) | |
| Report(Object) |
Fields
| __k_ReportId | |
| kernelClass | (Inherited from XppObjectBase) |
Methods
| __shouldCallNew(Type) | |
| addDesign() |
Creates a reportDesign that belongs to a report. |
| addDesign(String, Object[]) | |
| addDesign(String) | |
| addXppProxyReference(Type, Object) | (Inherited from XppObjectBase) |
| allowCheck() | |
| allowCheck(Boolean) | |
| AOTadd(String) | (Inherited from TreeNode) |
| AOTaddExtendedDataType(String, Types) | (Inherited from TreeNode) |
| AOTaddRelation() | (Inherited from TreeNode) |
| AOTaddSubNode(Int32) | (Inherited from TreeNode) |
| AOTaddXref(String, xRefKind, Int32, Int32, XRefReference, Int32) | (Inherited from TreeNode) |
| AOTaddXref(String, xRefKind, Int32, Int32, XRefReference) | (Inherited from TreeNode) |
| AOTaddXref(String, xRefKind, Int32, Int32) | (Inherited from TreeNode) |
| AOTAllowEdit() | (Inherited from TreeNode) |
| AOTbitmapId() |
Returns the resource ID of the bitmap of the tree node. (Inherited from TreeNode) |
| AOTchildNodeCount() |
Counts the number of child nodes that a given tree node has. (Inherited from TreeNode) |
| AOTcompile() | (Inherited from TreeNode) |
| AOTcompile(Int32, Boolean, Boolean) | (Inherited from TreeNode) |
| AOTcompile(Int32, Boolean) | (Inherited from TreeNode) |
| AOTcompile(Int32) | (Inherited from TreeNode) |
| AOTconfigure() | (Inherited from TreeNode) |
| AOTdelete() | (Inherited from TreeNode) |
| AOTDrop(TreeNode, TreeNode) | (Inherited from TreeNode) |
| AOTDrop(TreeNode) |
Creates a copy of a specified tree node as a child to the TreeNode object. (Inherited from TreeNode) |
| AOTDuplicate() | (Inherited from TreeNode) |
| AOTedit() |
Opens the appropriate editor for this node. (Inherited from TreeNode) |
| AOTedit(Int32, Int32) | (Inherited from TreeNode) |
| AOTedit(Int32) | (Inherited from TreeNode) |
| AOTendXref() | (Inherited from TreeNode) |
| AOTfindChild(String, Int32) | (Inherited from TreeNode) |
| AOTfindChild(String) |
Finds the specified child node of this node. (Inherited from TreeNode) |
| AOTfirstChild() |
Retrieves the first child of the tree node. (Inherited from TreeNode) |
| AOTfirstChildEx() | (Inherited from TreeNode) |
| AOTfirstChildEx(Boolean) | (Inherited from TreeNode) |
| AOTgetExecutableLineCount() |
Returns the number of executable lines of code for this node. (Inherited from TreeNode) |
| AOTgetExecutableLines() |
Returns the executable lines of code for this node. (Inherited from TreeNode) |
| AOTGetModel() | (Inherited from TreeNode) |
| AOTgetProperties() |
Returns a string containing the properties of the tree node. (Inherited from TreeNode) |
| AOTgetProperties(Boolean, Boolean, Boolean) | (Inherited from TreeNode) |
| AOTgetProperties(Boolean, Boolean) | (Inherited from TreeNode) |
| AOTgetProperties(Boolean) | (Inherited from TreeNode) |
| AOTgetPropertiesExt() | (Inherited from TreeNode) |
| AOTgetPropertiesExt(String) | (Inherited from TreeNode) |
| AOTgetProperty(String) | (Inherited from TreeNode) |
| AOTgetSource() |
Returns the source code of this node. (Inherited from TreeNode) |
| AOTIncludeInCompare() | (Inherited from TreeNode) |
| AOTinsert(TreeNode, TreeNode, Boolean) | (Inherited from TreeNode) |
| AOTinsert(TreeNode, TreeNode) | (Inherited from TreeNode) |
| AOTinsert(TreeNode) |
Inserts a node among the subnodes of this node. (Inherited from TreeNode) |
| AOTIsDirty() | (Inherited from TreeNode) |
| AOTIsOld() |
Indicates whether this node is from a file found in the old model store. (Inherited from TreeNode) |
| AOTIsPersisted() |
Indicates whether this node has been persisted in the model store. (Inherited from TreeNode) |
| AOTIsProxyNode() | (Inherited from TreeNode) |
| AOTiterator() |
Returns an object which can be used to iterate the child nodes of the tree node. (Inherited from TreeNode) |
| AOTKernelHelpType() | (Inherited from TreeNode) |
| AOTLayer() |
Returns the layer of the tree node. (Inherited from TreeNode) |
| AOTLayers() |
Returns a collection of the layers the tree node is defined in. (Inherited from TreeNode) |
| AOTLayers(Boolean) | (Inherited from TreeNode) |
| AOTload() |
Ensures that the object is loaded. (Inherited from TreeNode) |
| AOTmakeXref() |
Compiles this node and its subtree in the AOT, updating the cross-reference system. (Inherited from TreeNode) |
| AOTmakeXref(Int32, Boolean) | (Inherited from TreeNode) |
| AOTmakeXref(Int32) | (Inherited from TreeNode) |
| AOTmessageLine(String, Int32) |
Writes text to the Application Object Tree (AOT) Message window. (Inherited from TreeNode) |
| AOTMove(TreeNode, TreeNode) | (Inherited from TreeNode) |
| AOTMove(TreeNode) | (Inherited from TreeNode) |
| AOTname() |
Returns the value of the name property of the node. (Inherited from TreeNode) |
| AOTnewWindow() |
Opens a new AOT tree window with the tree node as the root. (Inherited from TreeNode) |
| AOTnextSibling() |
Returns the next node on the same level as the tree node. (Inherited from TreeNode) |
| AOTObjectNode() |
Indicates whether the node is an application object. (Inherited from TreeNode) |
| AOToverlayBitmapId() |
Returns the resource ID of the overlay in the AOT associated with this node. (Inherited from TreeNode) |
| AOTparent() |
Returns the parent node of the tree node. (Inherited from TreeNode) |
| AOTprevious() |
Returns the previous sibling of this tree node. (Inherited from TreeNode) |
| AOTrefresh() |
Refreshes the node with the latest changes to the .aod file. (Inherited from TreeNode) |
| AOTregenerate() | (Inherited from TreeNode) |
| AOTRename(String) | (Inherited from TreeNode) |
| AOTrestore() |
Reloads this node from the disk, if applicable. (Inherited from TreeNode) |
| AOTrestore(Boolean) | (Inherited from TreeNode) |
| AOTrun() |
Compiles this node and its subtree in the Application Object Tree (AOT). (Inherited from TreeNode) |
| AOTrun(xArgs) | (Inherited from TreeNode) |
| AOTsave() | (Inherited from TreeNode) |
| AOTSetModel(Int32) | (Inherited from TreeNode) |
| AOTsetProperties(String) | (Inherited from TreeNode) |
| AOTsetPropertiesExt(Struct) | (Inherited from TreeNode) |
| AOTsetProperty(String, Object) | (Inherited from TreeNode) |
| AOTsetSource(String, Boolean) | (Inherited from TreeNode) |
| AOTsetSource(String) | (Inherited from TreeNode) |
| AOTshowProperties() |
Opens the property sheet (if not already open) and shows the properties for this node. (Inherited from TreeNode) |
| AOTtoolTip() |
Returns the tool tip associated with the tree node. (Inherited from TreeNode) |
| AOTToString() | (Inherited from TreeNode) |
| AOTtypeStr() |
Returns the internal string code for the element type used in XPO files. (Inherited from TreeNode) |
| AOTUtilFileType() |
Retrieves the value of the UtilFileType enumeration type for the TreeNode object. The UtilFileType indicates which kind of file the application object is stored in. (Inherited from TreeNode) |
| applObjectId() |
Returns the application object ID, if applicable. (Inherited from TreeNode) |
| applObjectLayerMask() |
Returns a bitmask that specifies which layers contain this element. (Inherited from TreeNode) |
| applObjectOldLayerMask() |
Returns a bitmask that specifies which layers contain this element in the baseline model store. (Inherited from TreeNode) |
| autoJoin() | |
| autoJoin(Boolean) | |
| Call(String, Object[], Type[], Object[]) | (Inherited from XppObjectBase) |
| cancelTimeOut(Int32) | (Inherited from XppObjectBase) |
| changedBy() |
Gets or sets the name of the user who last changed the application object. |
| changedBy(String) | |
| changedDate() |
Gets or sets the date an application object was last changed. |
| changedDate(Date) | |
| changedTime() |
Gets or sets the time an application object was last changed. |
| changedTime(String) | |
| createdBy() |
Gets or sets the name of the user who created the application object. |
| createdBy(String) | |
| createKernelClass(Object[], Type[], Object[]) | (Inherited from XppObjectBase) |
| creationDate() |
Gets or sets the date an application object was created. |
| creationDate(Date) | |
| creationTime() | |
| creationTime(String) | |
| design() |
Retrieves an existing design. |
| design(String) | |
| designCount() |
Retrieves the number of designs in a given report. |
| designNumber() |
Gets an existing design. |
| designNumber(Int32) | |
| dump() |
Writes an overview of the report's contents to the Infolog. |
| equal(XppObjectBase) | (Inherited from XppObjectBase) |
| finalize() | (Inherited from XppObjectBase) |
| GetIntPtr() | (Inherited from XppObjectBase) |
| GetKernelInstanceUniqueId() | (Inherited from XppObjectBase) |
| getNodeInLayer(UtilEntryLevel, Boolean) | (Inherited from TreeNode) |
| getNodeInLayer(UtilEntryLevel) |
Retrieves a version of the tree node from a specified layer. (Inherited from TreeNode) |
| getTimeOutTimerHandle() | (Inherited from XppObjectBase) |
| getXppProxyReference(Type) | (Inherited from XppObjectBase) |
| handle() | |
| hashKey() | (Inherited from TreeNode) |
| interactive() | |
| interactive(Boolean) | |
| IsManagedValid() | (Inherited from XppObjectBase) |
| kernelhandle() | |
| KernelInstanceDisposed() | (Inherited from XppObjectBase) |
| makeCopy() | (Inherited from TreeNode) |
| MakeReflectionCall(String, Object[]) | (Inherited from XppObjectBase) |
| name() |
Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object. |
| name(String) | |
| newmethod() |
Initializes a new instance of the TreeNode class. |
| newmethod(Object, Object) | |
| newmethod(Object) | |
| newObjectName() |
Returns a string that contains the name of the new element. (Inherited from TreeNode) |
| newObjectName(String) | (Inherited from TreeNode) |
| notify() | (Inherited from XppObjectBase) |
| notifyAll() | (Inherited from XppObjectBase) |
| objectOnServer() |
Obsolete.
(Inherited from XppObjectBase)
|
| origin() | |
| origin(Guid) | |
| pack() |
Serializes the current instance of the Report class. |
| query() | |
| query(Query) | |
| saved() |
Indicates whether the report has been saved to disk. |
| setTimeOut(String, Int32, Boolean) |
Obsolete.
(Inherited from XppObjectBase)
|
| setTimeOut(String, Int32) |
Obsolete.
(Inherited from XppObjectBase)
|
| ToString() |
Returns a string that represents the current object. (Inherited from TreeNode) |
| treeNodeExport(String, Int32) | (Inherited from TreeNode) |
| treeNodeExport(String) |
Exports this node and its subtree from the Application Object Tree (AOT). (Inherited from TreeNode) |
| treeNodeName() |
Returns the name of the tree node. (Inherited from TreeNode) |
| treeNodePath() |
Returns the unique path to the tree node within the Application Object Tree (AOT). (Inherited from TreeNode) |
| treeNodeRelease() |
Releases the tree node explicitly. (Inherited from TreeNode) |
| treeNodeType() |
Retrieves an instance of a TreeNodeType class that provides reflection information for the tree node. (Inherited from TreeNode) |
| updateNodePermissions(Boolean) | (Inherited from TreeNode) |
| usageCount() | (Inherited from XppObjectBase) |
| utilElement() |
Returns a UtilElements record that is related to the node. (Inherited from TreeNode) |
| utilIdElement() |
Returns a UtilIdElements record that is related to the node. (Inherited from TreeNode) |
| validateNameCharacters(String) | (Inherited from TreeNode) |
| VerifyKernelClass() | (Inherited from XppObjectBase) |
| wait() | (Inherited from XppObjectBase) |
| Xml() | (Inherited from XppObjectBase) |
| Xml(Int32) | (Inherited from XppObjectBase) |