ReportDesign Class
The ReportDesign class determines the contents of a report.
Syntax
class ReportDesign extends TreeNode
Run On
Called
Methods
| Method | Description | |
|---|---|---|
.gif "Public method") |
addProgrammableSection | |
|
addSection | Adds a report section to a design. |
|
addSectionGroup | Adds a section group to a design. |
|
AOTadd | Creates a subnode to the tree node in the Application Object Tree (AOT). (Inherited from TreeNode.) |
|
AOTaddExtendedDataType | This method is not supported in Microsoft Dynamics AX. If you need to add a subnode of this type, use the instead. (Inherited from TreeNode.) |
|
AOTaddRelation | This method is not supported in Microsoft Dynamics AX. If you need to add a subnode of this type, use the instead. (Inherited from TreeNode.) |
|
AOTaddSubNode | Creates subnodes for extended data types and relations. (Inherited from TreeNode.) |
|
AOTaddXref | (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 | Compiles this node and its subnodes. (Inherited from TreeNode.) |
|
AOTconfigure | (Inherited from TreeNode.) |
|
AOTdelete | Deletes the tree node in the development layer that you are currently working in. (Inherited from TreeNode.) |
|
AOTDrop | 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.) |
|
AOTendXref | (Inherited from TreeNode.) |
|
AOTfindChild | 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.) |
|
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.) |
|
AOTgetPropertiesExt | (Inherited from TreeNode.) |
|
AOTgetProperty | (Inherited from TreeNode.) |
|
AOTgetSource | Returns the source code of this node. (Inherited from TreeNode.) |
|
AOTIncludeInCompare | (Inherited from TreeNode.) |
|
AOTinsert | 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.) |
|
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.) |
|
AOTmessageLine | Writes text to the Application Object Tree (AOT) Message window. (Inherited from TreeNode.) |
|
AOTMove | (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 | (Inherited from TreeNode.) |
|
AOTrestore | Reloads this node from the disk, if applicable. (Inherited from TreeNode.) |
|
AOTrun | Compiles this node and its subtree in the Application Object Tree (AOT). (Inherited from TreeNode.) |
|
AOTsave | Saves an Application Object Tree (AOT) node. (Inherited from TreeNode.) |
|
AOTSetModel | (Inherited from TreeNode.) |
|
AOTsetProperties | (Inherited from TreeNode.) |
|
AOTsetPropertiesExt | (Inherited from TreeNode.) |
|
AOTsetProperty | (Inherited from TreeNode.) |
|
AOTsetSource | Sets the source code of this node. (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.) |
|
arrange | |
|
arrangeWhen | |
|
autoDeclaration | Determines whether the system can declare a member variable that has the same name as the control. |
|
autoDesignSpecs | |
|
autoSection | |
|
autoSectionControlCount | |
|
autoSectionControlNumber | |
|
autoSectionCount | |
|
autoSectionNumber | |
|
bold | Gets or sets the weight of font that is used to output text in the control. |
|
bottomMargin | |
|
bottomMarginMode | |
|
bottomMarginStr | |
|
bottomMarginUnit | |
|
bottomMarginValue | |
|
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
|
caption | Gets or set the caption of the control. |
|
characterSet | Gets or sets the character set of the font. |
|
collate | |
|
colorScheme | Gets or sets the color scheme of the control. |
|
control | Finds a control in the generated design, based on the control's table and dataField properties. |
|
controlCount | |
|
controlName | Finds a control in the generated design, based on the control's Name property. |
|
controlNumber | |
|
copies | |
|
delete | Deletes the node from the AOT. |
|
deleteDiskSettings | |
|
description | |
|
deviceName | |
|
driverName | |
|
edit | |
|
emptyReportPrompt | |
|
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
|
fitToPage | |
|
font | Gets or sets the name of the font for the control to use. |
|
fontSize | Gets or sets the size of the font for the control to use. |
|
foregroundColor | Gets or sets the text color for the control to use. |
|
from | |
|
generateDesign | |
|
getNodeInLayer | Retrieves a version of the tree node from a specified layer. (Inherited from TreeNode.) |
|
getNumberOfPrinters | |
|
getPrinter | |
|
getTarget | Returns the print medium target for the report. |
|
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
|
handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
|
hashKey | (Inherited from TreeNode.) |
|
hideBorder | |
|
italic | |
|
jobType | |
|
language | |
|
languageID | |
|
leftMargin | |
|
leftMarginMode | |
|
leftMarginStr | |
|
leftMarginUnit | |
|
leftMarginValue | |
|
loadDiskSettings | |
|
localWebMenu | |
|
lookupCaption | |
|
lookupLabel | |
|
makeAutoSection | |
|
makeCopy | (Inherited from TreeNode.) |
|
name | Gets or sets the name that is used in code to identify a form, report, table, query, or another Microsoft Dynamics AX application object. |
|
new | Initializes a new instance of the TreeNode class. (Inherited from TreeNode.) |
|
newObjectName | Returns a string that contains the name of the new element. (Inherited from TreeNode.) |
|
notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
|
notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
|
objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
|
orientation | |
|
owner | Returns the instance that owns the object. (Inherited from Object.) |
|
pack | Serializes the current instance of the ReportDesign class. |
|
packPageSettings | |
|
packPrinterSettings | |
|
packPrintJobSettings | |
|
pageFormatting | |
|
paperOrientation | |
|
paperTray | |
|
printerAttributes | |
|
printerAveragePPM | |
|
printerComment | |
|
printerDatatype | |
|
printerDefaultPriority | |
|
printerDriverName | |
|
printerLocation | |
|
printerPageHeight | |
|
printerPageWidth | |
|
printerPaper | |
|
printerParameters | |
|
printerPortName | |
|
printerPrinterName | |
|
printerPrintProcessor | |
|
printerPriority | |
|
printerQueuedJobs | |
|
printerSepFile | |
|
printerServerName | |
|
printerSettings | |
|
printerShareName | |
|
printerStartTime | |
|
printerStatus | |
|
printerUntilTime | |
|
printFormName | |
|
printJobSettings | |
|
removeRedundantFooters | |
|
removeRepeatedFooters | |
|
removeRepeatedHeaders | |
|
reportTemplate | |
|
resolutionX | |
|
resolutionXStr | |
|
resolutionXUnit | |
|
resolutionY | |
|
resolutionYStr | |
|
resolutionYUnit | |
|
rightMargin | |
|
rightMarginMode | |
|
rightMarginStr | |
|
rightMarginUnit | |
|
rightMarginValue | |
|
ruler | |
|
saveDiskSettings | |
|
section | Finds a section below the generated design node. |
|
sectionCount | |
|
sectionGroup | Finds a reportSectionGroup object below a reportDesign object. |
|
sectionName | |
|
sectionNumber | |
|
setTarget | Sets the print medium target for the report. |
|
setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
|
to | |
|
topMargin | |
|
topMarginMode | |
|
topMarginStr | |
|
topMarginUnit | |
|
topMarginValue | |
|
toString | Returns a string that contains the class handle and name. (Overrides the toString Method.) |
|
treeNodeExport | 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.) |
|
underline | |
|
unpackPageSettings | |
|
unpackPrinterSettings | |
|
unpackPrintJobSettings | |
|
updateNodePermissions | (Inherited from TreeNode.) |
|
usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
|
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 | (Inherited from TreeNode.) |
|
wait | Pauses a process. (Inherited from Object.) |
|
xml | Returns an XML string that represents the current object. (Inherited from Object.) |
Top
Remarks
A ReportDesign object is a collection of ReportSection objects or SectionTemplate objects that determines the contents of a report.
Each report contains a ReportDesign node in the Microsoft Dynamics AX Application Object Tree (AOT), below the Designs node. The ReportDesign node always contains a node that is named AutoDesignSpecs, and it can contain a node that is named Design, which is referred to as the generated design.
A ReportDesign node should contain either one or more SectionTemplate nodes (below the AutoDesignSpecs node) or a generated design. If it contains both, only the generated design is used.
This class lets you create, read, update, and delete X++ code and metadata. Make sure that the user has access to the development security key (SysDevelopment) before this API is called.
A report that does not have a generated design offers more flexibility to the end user than a report that has a generated design. For example, a user who is running a report that does not have a generated design can decide in the query which sums to include in the report. A generated design is then created during the execution of the report, and it will contain footer sections that correspond to the user's choice.
If a report has a generated design, the existence of footer sections in the generated design controls which sums are printed in the report.
Examples
The following example creates a simple report that is not present in the AOT.
static void test(args a)
{
report r;
reportDesign rd;
reportSection rs;
reportRun rr;
r = new report();
rd = r.addDesign("myDesign");
// Add a section triggered by execute(1).
rs = rd.addProgrammableSection(1);
rs.addTextControl("Hello world");
// Run the report.
rr = new reportRun(r);
// Run the sysPrintForm form.
if (rr.prompt())
{
// Execute the programmableSection.
rr.execute(1);
// Print the report to the target, such as printer or screen.
rr.print();
}
}
Inheritance Hierarchy
Object Class
TreeNode Class
ReportDesign Class