Share via


ReportDesign Class

The ReportDesign class determines the contents of a report.

Syntax

class ReportDesign extends TreeNode

Run On

Called

Methods

  Method Description
Gg944380.pubmethod(en-us,AX.60).gif addProgrammableSection
Gg944380.pubmethod(en-us,AX.60).gif addSection Adds a report section to a design.
Gg944380.pubmethod(en-us,AX.60).gif addSectionGroup Adds a section group to a design.
Gg944380.pubmethod(en-us,AX.60).gif AOTadd Creates a subnode to the tree node in the Application Object Tree (AOT). (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif 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.)
Gg944380.pubmethod(en-us,AX.60).gif 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.)
Gg944380.pubmethod(en-us,AX.60).gif AOTaddSubNode Creates subnodes for extended data types and relations. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTaddXref (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTAllowEdit (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTbitmapId Returns the resource ID of the bitmap of the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTchildNodeCount Counts the number of child nodes that a given tree node has. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTcompile Compiles this node and its subnodes. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTconfigure (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTdelete Deletes the tree node in the development layer that you are currently working in. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTDrop Creates a copy of a specified tree node as a child to the TreeNode object. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTDuplicate (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTedit Opens the appropriate editor for this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTendXref (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTfindChild Finds the specified child node of this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTfirstChild Retrieves the first child of the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTfirstChildEx (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTgetExecutableLineCount Returns the number of executable lines of code for this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTgetExecutableLines Returns the executable lines of code for this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTGetModel (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTgetProperties Returns a string containing the properties of the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTgetPropertiesExt (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTgetProperty (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTgetSource Returns the source code of this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTIncludeInCompare (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTinsert Inserts a node among the subnodes of this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTIsDirty (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTIsOld Indicates whether this node is from a file found in the old model store. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTIsPersisted Indicates whether this node has been persisted in the model store. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTIsProxyNode (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTiterator Returns an object which can be used to iterate the child nodes of the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTKernelHelpType (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTLayer Returns the layer of the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTLayers Returns a collection of the layers the tree node is defined in. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTload Ensures that the object is loaded. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTmakeXref Compiles this node and its subtree in the AOT, updating the cross-reference system. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTmessageLine Writes text to the Application Object Tree (AOT) Message window. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTMove (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTname Returns the value of the name property of the node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTnewWindow Opens a new AOT tree window with the tree node as the root. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTnextSibling Returns the next node on the same level as the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTObjectNode Indicates whether the node is an application object. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOToverlayBitmapId Returns the resource ID of the overlay in the AOT associated with this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTparent Returns the parent node of the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTprevious Returns the previous sibling of this tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTrefresh Refreshes the node with the latest changes to the .aod file. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTregenerate (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTRename (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTrestore Reloads this node from the disk, if applicable. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTrun Compiles this node and its subtree in the Application Object Tree (AOT). (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTsave Saves an Application Object Tree (AOT) node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTSetModel (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTsetProperties (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTsetPropertiesExt (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTsetProperty (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTsetSource Sets the source code of this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTshowProperties Opens the property sheet (if not already open) and shows the properties for this node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTtoolTip Returns the tool tip associated with the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTToString (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif AOTtypeStr Returns the internal string code for the element type used in XPO files. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif 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.)
Gg944380.pubmethod(en-us,AX.60).gif applObjectId Returns the application object ID, if applicable. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif applObjectLayerMask Returns a bitmask that specifies which layers contain this element. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif applObjectOldLayerMask Returns a bitmask that specifies which layers contain this element in the baseline model store. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif arrange
Gg944380.pubmethod(en-us,AX.60).gif arrangeWhen
Gg944380.pubmethod(en-us,AX.60).gif autoDeclaration Determines whether the system can declare a member variable that has the same name as the control.
Gg944380.pubmethod(en-us,AX.60).gif autoDesignSpecs
Gg944380.pubmethod(en-us,AX.60).gif autoSection
Gg944380.pubmethod(en-us,AX.60).gif autoSectionControlCount
Gg944380.pubmethod(en-us,AX.60).gif autoSectionControlNumber
Gg944380.pubmethod(en-us,AX.60).gif autoSectionCount
Gg944380.pubmethod(en-us,AX.60).gif autoSectionNumber
Gg944380.pubmethod(en-us,AX.60).gif bold Gets or sets the weight of font that is used to output text in the control.
Gg944380.pubmethod(en-us,AX.60).gif bottomMargin
Gg944380.pubmethod(en-us,AX.60).gif bottomMarginMode
Gg944380.pubmethod(en-us,AX.60).gif bottomMarginStr
Gg944380.pubmethod(en-us,AX.60).gif bottomMarginUnit
Gg944380.pubmethod(en-us,AX.60).gif bottomMarginValue
Gg944380.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif caption Gets or set the caption of the control.
Gg944380.pubmethod(en-us,AX.60).gif characterSet Gets or sets the character set of the font.
Gg944380.pubmethod(en-us,AX.60).gif collate
Gg944380.pubmethod(en-us,AX.60).gif colorScheme Gets or sets the color scheme of the control.
Gg944380.pubmethod(en-us,AX.60).gif control Finds a control in the generated design, based on the control's table and dataField properties.
Gg944380.pubmethod(en-us,AX.60).gif controlCount
Gg944380.pubmethod(en-us,AX.60).gif controlName Finds a control in the generated design, based on the control's Name property.
Gg944380.pubmethod(en-us,AX.60).gif controlNumber
Gg944380.pubmethod(en-us,AX.60).gif copies
Gg944380.pubmethod(en-us,AX.60).gif delete Deletes the node from the AOT.
Gg944380.pubmethod(en-us,AX.60).gif deleteDiskSettings
Gg944380.pubmethod(en-us,AX.60).gif description
Gg944380.pubmethod(en-us,AX.60).gif deviceName
Gg944380.pubmethod(en-us,AX.60).gif driverName
Gg944380.pubmethod(en-us,AX.60).gif edit
Gg944380.pubmethod(en-us,AX.60).gif emptyReportPrompt
Gg944380.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif fitToPage
Gg944380.pubmethod(en-us,AX.60).gif font Gets or sets the name of the font for the control to use.
Gg944380.pubmethod(en-us,AX.60).gif fontSize Gets or sets the size of the font for the control to use.
Gg944380.pubmethod(en-us,AX.60).gif foregroundColor Gets or sets the text color for the control to use.
Gg944380.pubmethod(en-us,AX.60).gif from
Gg944380.pubmethod(en-us,AX.60).gif generateDesign
Gg944380.pubmethod(en-us,AX.60).gif getNodeInLayer Retrieves a version of the tree node from a specified layer. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif getNumberOfPrinters
Gg944380.pubmethod(en-us,AX.60).gif getPrinter
Gg944380.pubmethod(en-us,AX.60).gif getTarget Returns the print medium target for the report.
Gg944380.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif hashKey (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif hideBorder
Gg944380.pubmethod(en-us,AX.60).gif italic
Gg944380.pubmethod(en-us,AX.60).gif jobType
Gg944380.pubmethod(en-us,AX.60).gif language
Gg944380.pubmethod(en-us,AX.60).gif languageID
Gg944380.pubmethod(en-us,AX.60).gif leftMargin
Gg944380.pubmethod(en-us,AX.60).gif leftMarginMode
Gg944380.pubmethod(en-us,AX.60).gif leftMarginStr
Gg944380.pubmethod(en-us,AX.60).gif leftMarginUnit
Gg944380.pubmethod(en-us,AX.60).gif leftMarginValue
Gg944380.pubmethod(en-us,AX.60).gif loadDiskSettings
Gg944380.pubmethod(en-us,AX.60).gif localWebMenu
Gg944380.pubmethod(en-us,AX.60).gif lookupCaption
Gg944380.pubmethod(en-us,AX.60).gif lookupLabel
Gg944380.pubmethod(en-us,AX.60).gif makeAutoSection
Gg944380.pubmethod(en-us,AX.60).gif makeCopy (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif 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.
Gg944380.pubmethod(en-us,AX.60).gif new Initializes a new instance of the TreeNode class. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif newObjectName Returns a string that contains the name of the new element. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif orientation
Gg944380.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif pack Serializes the current instance of the ReportDesign class.
Gg944380.pubmethod(en-us,AX.60).gif packPageSettings
Gg944380.pubmethod(en-us,AX.60).gif packPrinterSettings
Gg944380.pubmethod(en-us,AX.60).gif packPrintJobSettings
Gg944380.pubmethod(en-us,AX.60).gif pageFormatting
Gg944380.pubmethod(en-us,AX.60).gif paperOrientation
Gg944380.pubmethod(en-us,AX.60).gif paperTray
Gg944380.pubmethod(en-us,AX.60).gif printerAttributes
Gg944380.pubmethod(en-us,AX.60).gif printerAveragePPM
Gg944380.pubmethod(en-us,AX.60).gif printerComment
Gg944380.pubmethod(en-us,AX.60).gif printerDatatype
Gg944380.pubmethod(en-us,AX.60).gif printerDefaultPriority
Gg944380.pubmethod(en-us,AX.60).gif printerDriverName
Gg944380.pubmethod(en-us,AX.60).gif printerLocation
Gg944380.pubmethod(en-us,AX.60).gif printerPageHeight
Gg944380.pubmethod(en-us,AX.60).gif printerPageWidth
Gg944380.pubmethod(en-us,AX.60).gif printerPaper
Gg944380.pubmethod(en-us,AX.60).gif printerParameters
Gg944380.pubmethod(en-us,AX.60).gif printerPortName
Gg944380.pubmethod(en-us,AX.60).gif printerPrinterName
Gg944380.pubmethod(en-us,AX.60).gif printerPrintProcessor
Gg944380.pubmethod(en-us,AX.60).gif printerPriority
Gg944380.pubmethod(en-us,AX.60).gif printerQueuedJobs
Gg944380.pubmethod(en-us,AX.60).gif printerSepFile
Gg944380.pubmethod(en-us,AX.60).gif printerServerName
Gg944380.pubmethod(en-us,AX.60).gif printerSettings
Gg944380.pubmethod(en-us,AX.60).gif printerShareName
Gg944380.pubmethod(en-us,AX.60).gif printerStartTime
Gg944380.pubmethod(en-us,AX.60).gif printerStatus
Gg944380.pubmethod(en-us,AX.60).gif printerUntilTime
Gg944380.pubmethod(en-us,AX.60).gif printFormName
Gg944380.pubmethod(en-us,AX.60).gif printJobSettings
Gg944380.pubmethod(en-us,AX.60).gif removeRedundantFooters
Gg944380.pubmethod(en-us,AX.60).gif removeRepeatedFooters
Gg944380.pubmethod(en-us,AX.60).gif removeRepeatedHeaders
Gg944380.pubmethod(en-us,AX.60).gif reportTemplate
Gg944380.pubmethod(en-us,AX.60).gif resolutionX
Gg944380.pubmethod(en-us,AX.60).gif resolutionXStr
Gg944380.pubmethod(en-us,AX.60).gif resolutionXUnit
Gg944380.pubmethod(en-us,AX.60).gif resolutionY
Gg944380.pubmethod(en-us,AX.60).gif resolutionYStr
Gg944380.pubmethod(en-us,AX.60).gif resolutionYUnit
Gg944380.pubmethod(en-us,AX.60).gif rightMargin
Gg944380.pubmethod(en-us,AX.60).gif rightMarginMode
Gg944380.pubmethod(en-us,AX.60).gif rightMarginStr
Gg944380.pubmethod(en-us,AX.60).gif rightMarginUnit
Gg944380.pubmethod(en-us,AX.60).gif rightMarginValue
Gg944380.pubmethod(en-us,AX.60).gif ruler
Gg944380.pubmethod(en-us,AX.60).gif saveDiskSettings
Gg944380.pubmethod(en-us,AX.60).gif section Finds a section below the generated design node.
Gg944380.pubmethod(en-us,AX.60).gif sectionCount
Gg944380.pubmethod(en-us,AX.60).gif sectionGroup Finds a reportSectionGroup object below a reportDesign object.
Gg944380.pubmethod(en-us,AX.60).gif sectionName
Gg944380.pubmethod(en-us,AX.60).gif sectionNumber
Gg944380.pubmethod(en-us,AX.60).gif setTarget Sets the print medium target for the report.
Gg944380.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif to
Gg944380.pubmethod(en-us,AX.60).gif topMargin
Gg944380.pubmethod(en-us,AX.60).gif topMarginMode
Gg944380.pubmethod(en-us,AX.60).gif topMarginStr
Gg944380.pubmethod(en-us,AX.60).gif topMarginUnit
Gg944380.pubmethod(en-us,AX.60).gif topMarginValue
Gg944380.pubmethod(en-us,AX.60).gif toString Returns a string that contains the class handle and name. (Overrides the toString Method.)
Gg944380.pubmethod(en-us,AX.60).gif treeNodeExport Exports this node and its subtree from the Application Object Tree (AOT). (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif treeNodeName Returns the name of the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif treeNodePath Returns the unique path to the tree node within the Application Object Tree (AOT). (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif treeNodeRelease Releases the tree node explicitly. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif treeNodeType Retrieves an instance of a TreeNodeType class that provides reflection information for the tree node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif underline
Gg944380.pubmethod(en-us,AX.60).gif unpackPageSettings
Gg944380.pubmethod(en-us,AX.60).gif unpackPrinterSettings
Gg944380.pubmethod(en-us,AX.60).gif unpackPrintJobSettings
Gg944380.pubmethod(en-us,AX.60).gif updateNodePermissions (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif utilElement Returns a UtilElements record that is related to the node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif utilIdElement Returns a UtilIdElements record that is related to the node. (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif validateNameCharacters (Inherited from TreeNode.)
Gg944380.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg944380.pubmethod(en-us,AX.60).gif 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