ReportDesign Class

Definition

Namespace:

Dynamics.AX.Application

Assembly:

Microsoft.Dynamics.AX.Xpp.Support.dll

The ReportDesign class determines the contents of a report.

public ref class ReportDesign : Dynamics::AX::Application::TreeNode

[Microsoft.Dynamics.Ax.Xpp.KernelClass]
[Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly]
public class ReportDesign : Dynamics.AX.Application.TreeNode

[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
[<Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly>]
type ReportDesign = class
    inherit TreeNode

Public Class ReportDesign
Inherits TreeNode

Inheritance

Microsoft.Dynamics.AX.KernelInterop.ProxyBase

XppObjectBase

TreeNode

ReportDesign

Attributes

KernelClassAttribute Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnlyAttribute

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 Finance and Operations 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.

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();    
    } 
}

Constructors

ReportDesign()

ReportDesign(IntPtr)

Fields

__k_ReportDesignId
kernelClass	(Inherited from XppObjectBase)

Methods

__shouldCallNew(Type)	(Inherited from TreeNode)
addProgrammableSection(Int32)
addSection(ReportBlockType)	Adds a report section to a design.
addSection(ReportBlockType, Int32)
addSection(ReportBlockType, Int32, Int32)
addSectionGroup(Int32)	Adds a section group to a design.
addSectionGroup(Int32, Int32)
addXppProxyReference(Type, Object)	(Inherited from XppObjectBase)
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)	(Inherited from TreeNode)
AOTaddXref(String, xRefKind, Int32, Int32, XRefReference)	(Inherited from TreeNode)
AOTaddXref(String, xRefKind, Int32, Int32, XRefReference, 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)	(Inherited from TreeNode)
AOTcompile(Int32, Boolean)	(Inherited from TreeNode)
AOTcompile(Int32, Boolean, Boolean)	(Inherited from TreeNode)
AOTconfigure()	(Inherited from TreeNode)
AOTdelete()	(Inherited from TreeNode)
AOTDrop(TreeNode)	Creates a copy of a specified tree node as a child to the TreeNode object. (Inherited from TreeNode)
AOTDrop(TreeNode, TreeNode)	(Inherited from TreeNode)
AOTDuplicate()	(Inherited from TreeNode)
AOTedit()	Opens the appropriate editor for this node. (Inherited from TreeNode)
AOTedit(Int32)	(Inherited from TreeNode)
AOTedit(Int32, Int32)	(Inherited from TreeNode)
AOTendXref()	(Inherited from TreeNode)
AOTfindChild(String)	Finds the specified child node of this node. (Inherited from TreeNode)
AOTfindChild(String, Int32)	(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)	(Inherited from TreeNode)
AOTgetProperties(Boolean, Boolean)	(Inherited from TreeNode)
AOTgetProperties(Boolean, Boolean, 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)	Inserts a node among the subnodes of this node. (Inherited from TreeNode)
AOTinsert(TreeNode, TreeNode)	(Inherited from TreeNode)
AOTinsert(TreeNode, TreeNode, Boolean)	(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)	(Inherited from TreeNode)
AOTmakeXref(Int32, Boolean)	(Inherited from TreeNode)
AOTmessageLine(String, Int32)	Writes text to the Application Object Tree (AOT) Message window. (Inherited from TreeNode)
AOTMove(TreeNode)	(Inherited from TreeNode)
AOTMove(TreeNode, 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)	(Inherited from TreeNode)
AOTsetSource(String, Boolean)	(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()
arrangeWhen(Int32)
autoDeclaration()	Determines whether the system can declare a member variable that has the same name as the control.
autoDeclaration(Boolean)
autoDesignSpecs()
autoSection(Int32)
autoSection(Int32, Int32)
autoSectionControlCount()
autoSectionControlNumber(Int32)
autoSectionCount()
autoSectionNumber(Int32)
bold()	Gets or sets the weight of font that is used to output text in the control.
bold(Int32)
bottomMargin(Decimal, Units)
bottomMarginMode()
bottomMarginMode(Int32)
bottomMarginStr()
bottomMarginStr(String)
bottomMarginUnit()
bottomMarginUnit(Units)
bottomMarginValue()
bottomMarginValue(Decimal)
Call(String, Object[], Type[], Object[])	(Inherited from XppObjectBase)
cancelTimeOut(Int32)	(Inherited from XppObjectBase)
caption()	Gets or set the caption of the control.
caption(String)
characterSet()	Gets or sets the character set of the font.
characterSet(Int32)
collate()
collate(Boolean)
colorScheme()	Gets or sets the color scheme of the control.
colorScheme(Int32)
control(Int32, Int32)	Finds a control in the generated design, based on the control's table and dataField properties.
controlCount()
controlName(String)	Finds a control in the generated design, based on the control's Name property.
controlNumber(Int32)
copies()
copies(Int32)
createKernelClass(Object[], Type[], Object[])	(Inherited from XppObjectBase)
delete()	Deletes the node from the AOT.
deleteDiskSettings()
deleteDiskSettings(Boolean)
description()
description(String)
deviceName()
deviceName(String)
driverName()
edit()
emptyReportPrompt()
emptyReportPrompt(String)
equal(XppObjectBase)	(Inherited from XppObjectBase)
finalize()	(Inherited from XppObjectBase)
fitToPage()
fitToPage(Int32)
font()	Gets or sets the name of the font for the control to use.
font(String)
fontSize()	Gets or sets the size of the font for the control to use.
fontSize(Int32)
foregroundColor()	Gets or sets the text color for the control to use.
foregroundColor(Int32)
from()
from(Int32)
generateDesign()
GetIntPtr()	(Inherited from XppObjectBase)
GetKernelInstanceUniqueId()	(Inherited from XppObjectBase)
getNodeInLayer(UtilEntryLevel)	Retrieves a version of the tree node from a specified layer. (Inherited from TreeNode)
getNodeInLayer(UtilEntryLevel, Boolean)	(Inherited from TreeNode)
getNumberOfPrinters()
getPrinter(Int32)
getTarget()	Returns the print medium target for the report.
getTimeOutTimerHandle()	(Inherited from XppObjectBase)
getXppProxyReference(Type)	(Inherited from XppObjectBase)
handle()
hashKey()	(Inherited from TreeNode)
hideBorder()
hideBorder(Boolean)
IsManagedValid()	(Inherited from XppObjectBase)
italic()
italic(Boolean)
jobType()
jobType(String)
kernelhandle()
KernelInstanceDisposed()	(Inherited from XppObjectBase)
language()
language(Int32)
languageID()
languageID(String)
leftMargin(Decimal, Units)
leftMarginMode()
leftMarginMode(Int32)
leftMarginStr()
leftMarginStr(String)
leftMarginUnit()
leftMarginUnit(Units)
leftMarginValue()
leftMarginValue(Decimal)
loadDiskSettings()
localWebMenu()
localWebMenu(String)
lookupCaption()
lookupCaption(String)
lookupLabel(String)
lookupLabel(String, String)
makeAutoSection()
makeAutoSection(Query)
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. (Inherited from TreeNode)
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)
orientation()
orientation(Int32)
pack()	Serializes the current instance of the ReportDesign class.
packPageSettings()
packPrinterSettings()
packPrintJobSettings()
pageFormatting()
paperOrientation()
paperOrientation(PrinterOrientation)
paperTray()
paperTray(Int32)
printerAttributes()
printerAveragePPM()
printerComment()
printerDatatype()
printerDefaultPriority()
printerDriverName()
printerLocation()
printerPageHeight()
printerPageWidth()
printerPaper()
printerParameters()
printerPortName()
printerPrinterName()
printerPrintProcessor()
printerPriority()
printerQueuedJobs()
printerSepFile()
printerServerName()
printerSettings()
printerSettings(ReportRun)
printerSettings(ReportRun, Int32)
printerShareName()
printerStartTime()
printerStatus()
printerUntilTime()
printFormName()
printFormName(String)
printJobSettings()
removeRedundantFooters()
removeRedundantFooters(Boolean)
removeRepeatedFooters()
removeRepeatedFooters(Boolean)
removeRepeatedHeaders()
removeRepeatedHeaders(Boolean)
reportTemplate()
reportTemplate(String)
resolutionX()
resolutionX(String)
resolutionXStr(String)
resolutionXUnit()
resolutionXUnit(Units)
resolutionY()
resolutionY(String)
resolutionYStr(String)
resolutionYUnit()
resolutionYUnit(Units)
rightMargin(Decimal, Units)
rightMarginMode()
rightMarginMode(Int32)
rightMarginStr()
rightMarginStr(String)
rightMarginUnit()
rightMarginUnit(Units)
rightMarginValue()
rightMarginValue(Decimal)
ruler()
ruler(Int32)
saveDiskSettings(Object[])
section(Int32)	Finds a section below the generated design node.
sectionCount()
sectionGroup(Int32)	Finds a reportSectionGroup object below a reportDesign object.
sectionGroup(Int32, Int32)
sectionName(String)
sectionNumber(Int32)
setTarget(PrintMedium)	Sets the print medium target for the report.
setTimeOut(String, Int32)	Obsolete. (Inherited from XppObjectBase)
setTimeOut(String, Int32, Boolean)	Obsolete. (Inherited from XppObjectBase)
to()
to(Int32)
topMargin(Decimal, Units)
topMarginMode()
topMarginMode(Int32)
topMarginStr()
topMarginStr(String)
topMarginUnit()
topMarginUnit(Units)
topMarginValue()
topMarginValue(Decimal)
ToString()	Returns a string that contains the class handle and name.
treeNodeExport(String)	Exports this node and its subtree from the Application Object Tree (AOT). (Inherited from TreeNode)
treeNodeExport(String, Int32)	(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()
underline(Boolean)
unpackPageSettings(Object[])
unpackPrinterSettings(Object[])
unpackPrintJobSettings(Object[])
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)