ReportSection Class
The ReportSection class contains a collection of report controls.
Syntax
class ReportSection extends TreeNode
Run On
Called
Methods
| Method | Description | |
|---|---|---|
.gif "Public method") |
addBitmapControl | Adds a bitmap control to a report section. |
|
addBoxControl | Adds a shape control to a report section. |
|
addControl | Adds a report control to a report section. |
|
addDateControl | Adds a date control to a report section. |
|
addDateDisplayControl | Adds a date control to a report section. |
|
addDateTimeControl | |
|
addDateTimeDisplayControl | |
|
addDisplayControl | |
|
addEnumControl | |
|
addEnumDisplayControl | |
|
addFieldGroup | |
|
addGuidControl | |
|
addGuidDisplayControl | |
|
addInt64Control | |
|
addInt64DisplayControl | |
|
addIntegerControl | |
|
addIntegerDisplayControl | |
|
addPromptControl | |
|
addRealControl | |
|
addRealDisplayControl | |
|
addSection | |
|
addShapeControl | |
|
addStringControl | |
|
addStringDisplayControl | |
|
addSumControl | |
|
addSumNameControl | |
|
addTextControl | |
|
addTimeControl | |
|
addTimeDisplayControl | |
|
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 | |
|
arrangeMethod | |
|
arrangeWhen | |
|
autoDeclaration | Determines whether the system can declare a member variable that has the same name as the control. |
|
autoHeader | |
|
bold | Gets or sets the weight of font that is used to output text in the control. |
|
bottom | |
|
bottomMargin | |
|
bottomMarginAndFrame | |
|
bottomMarginMode | |
|
bottomMarginStr | |
|
bottomMarginUnit | |
|
bottomMarginValue | |
|
bottomMode | |
|
bottomStr | |
|
bottomUnit | |
|
bottomValue | |
|
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
|
characterSet | Gets or sets the character set of the font. |
|
colorScheme | Gets or sets the color scheme of the control. |
|
columnHeadingsStrategy | |
|
columns | |
|
columnsMode | |
|
columnspace | |
|
columnspaceMode | |
|
columnspaceStr | |
|
columnspaceUnit | |
|
columnspaceValue | |
|
columnsValue | |
|
control | Finds a control in the section, based on the control’s table and dataField properties. |
|
controlCount | |
|
controlName | Finds a control in a section, based on the control's Name property. |
|
controlNo | |
|
controlNumber | |
|
delete | Deletes the current node from the AOT. |
|
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
|
executeColumnHeadings | |
|
executeSection | Prints the section on the report. |
|
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. |
|
footerText | |
|
foregroundColor | Gets or sets the text color for the control to use. |
|
getNodeInLayer | Retrieves a version of the tree node from a specified layer. (Inherited from TreeNode.) |
|
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
|
grandHeader | |
|
grandTotal | Determines whether the FooterText property value can be displayed. |
|
handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
|
hasButtons | |
|
hashKey | (Inherited from TreeNode.) |
|
headerDetailLevel | |
|
headerDetailLevelMode | |
|
headerDetailLevelValue | |
|
headerText | |
|
height | Gets or sets the height of the control. |
|
height100mm | Gets or sets the height of a section, excluding the height of the border and the top and bottom margins. |
|
heightmm100 | Gets or sets the height of a section, including the height of the border and the top and bottom margins. |
|
heightMode | Gets or sets a calculation mode for the height of the control. |
|
heightStr | |
|
heightUnit | |
|
heightValue | Gets or sets the height of the control. |
|
italic | |
|
label | Gets the description of the section node in the AOT. |
|
labelBottomMargin | |
|
labelBottomMarginMode | |
|
labelBottomMarginStr | |
|
labelBottomMarginUnit | |
|
labelBottomMarginValue | |
|
labelTopMargin | |
|
labelTopMarginMode | |
|
labelTopMarginStr | |
|
labelTopMarginUnit | |
|
labelTopMarginValue | |
|
leftMargin | |
|
leftMarginMode | |
|
leftMarginsEtc | |
|
leftMarginStr | |
|
leftMarginUnit | |
|
leftMarginValue | |
|
lineAbove | |
|
lineBelow | |
|
lineLeft | Gets or sets the type of line that is used as the left border of a section. |
|
lineRight | |
|
makeCopy | (Inherited from TreeNode.) |
|
map | |
|
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.) |
|
noOfHeadingLines | |
|
noOfHeadingLinesMode | |
|
noOfHeadingLinesValue | |
|
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.) |
|
owner | Returns the instance that owns the object. (Inherited from Object.) |
|
resolutionX | |
|
resolutionXStr | |
|
resolutionXUnit | |
|
resolutionY | |
|
resolutionYStr | |
|
resolutionYUnit | |
|
rightMargin | |
|
rightMarginMode | |
|
rightMarginsEtc | |
|
rightMarginStr | |
|
rightMarginUnit | |
|
rightMarginValue | |
|
ruler | |
|
sectionGroup | Finds an existing section group in the generated design. |
|
sectionType | Retrieves the type of a given report section, such as ReportBlockType::Prolog, ReportBlockType::PageHeader, or ReportBlockType::Body. |
|
setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
|
sumDetailLevel | |
|
sumDetailLevelMode | |
|
sumDetailLevelValue | |
|
table | Gets or sets the table ID associated with the object. |
|
thickness | |
|
top | |
|
topMargin | |
|
topMarginAndFrame | |
|
topMarginMode | |
|
topMarginStr | |
|
topMarginUnit | |
|
topMarginValue | |
|
topMode | |
|
topStr | |
|
topUnit | |
|
topValue | |
|
toString | Returns a string that represents the current object. (Inherited from TreeNode.) |
|
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 | |
|
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 section is printed on the report when the query for the report is executed or when the methods of the report are executed.
This class lets you to 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 section can be one of the following types: prologue, page header, header, footer, page footer, epilogue, programmable section, header, body, or footer.
The section template node type lets you define sections one time and then reuse them many times in different reports. A typical example of this is a check or a giro.
Examples
The following example adds a section to a report:
static void test(args a)
{
report r;
reportDesign rd;
reportSection rs;
reportRun rr;
// Create a simple report that is not present in
// the Application Object Tree.
r = new report();
rd = r.addDesign("myDesign");
rs = rd.addProgrammableSection(1);
// Add a section triggered by execute(1).
rs.addTextControl("Hello world");
// Run the report.
rr = new reportRun(r);
if (rr.prompt()) // Run the sysPrintForm form.
{
rr.execute(1); // Execute the programmableSection.
rr.print(); // Print report to the target
// (for example, printer or screen)
// selected during the previous prompt call.
}
}
Inheritance Hierarchy
Object Class
TreeNode Class
ReportSection Class