ReportRun Class

Definition

Namespace:

Dynamics.AX.Application

Assembly:

Microsoft.Dynamics.AX.Xpp.Support.dll

The ReportRun class generates and prints a report or previews a report on the screen.

public ref class ReportRun : Dynamics::AX::Application::ObjectRun

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

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

Public Class ReportRun
Inherits ObjectRun

Inheritance

Microsoft.Dynamics.AX.KernelInterop.ProxyBase

XppObjectBase

ObjectRun

ReportRun

Attributes

KernelClassAttribute Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnlyAttribute

Remarks

As opposed to the , which defines the structure of a report, a ReportRun object contains the runtime characteristics of the report. A ReportRun object can be created by using one of the following arguments:

• An Args object where the name and optionally designName parameters are specified.
• A created container, by using the for example.
• The report name and an optional design name.

The section template node type allows the sections to be defined once and reuse them many times in different reports. A typical example of this would be a check or a giro.

The following example runs the Customer design of the existing Cust report:

static void testReportRun(args a) 
{  
    reportRun rr; 
    args aa = new args("Cust"); 
    aa.designName("Customer"); 
    rr = new reportRun(aa); 
    rr.run(); 
}

Constructors

ReportRun()

ReportRun(IntPtr)

ReportRun(Object)

ReportRun(Object, String)

ReportRun(Object, String, Boolean)

Fields

__k_ReportRunId
kernelClass	(Inherited from XppObjectBase)

Methods

__shouldCallNew(Type)
addPendingSums()	Prints the relevant footers of the report.
addRangeDescription(Int32, Int32, String)
addRangeDescription(Int32, Int32, String, String)
addRangeDescription(Int32, Int32, String, String, Int32)
addXppProxyReference(Type, Object)	(Inherited from XppObjectBase)
allPages()
allPages(Boolean)
args()	Returns the arguments that the object was constructed with. (Inherited from ObjectRun)
arrangeLevelControl()
arrangeLevelGlobal()
arrangeLevelNone()
arrangeLevelSection()
attach()
Call(String, Object[], Type[], Object[])	(Inherited from XppObjectBase)
callMenuFunction(xMenuFunction)
cancelTimeOut(Int32)	(Inherited from XppObjectBase)
caption(String, String, String, String)	Creates a caption when previewing a report, or a document name when printing a report.
clearAllRangeDescriptions()
collate()
collate(Boolean)
columnHeadings()	Provides control of column headings in a report.
columnHeadings(Int32)
control()	Retrieves the control that is being executed.
copies()
copies(Int32)
copiesTotal()	Enables marking copies of reports.
copy()	Returns the number of the copy of a report.
copyDescription()
createKernelClass(Object[], Type[], Object[])	(Inherited from XppObjectBase)
createProgressForm()	Creates the form that contains progress information.
currentYmm100()
design()	Gets or sets the name of the design.
design(Object)
detach()
deviceName()
deviceName(String)
dialog(XppObjectBase)
disableBody()
disableBody(Int32)
disableColumnHeadings()
disableColumnHeadings(Int32)
disablePageFooter()
disableSection(ReportSection)
driverName()	Returns the printer driver name.
enableAllBodies()
enableAllBodies(Boolean)
enableBody()
enableBody(Int32)
enablePageFooter()
enableSection(ReportSection)
equal(XppObjectBase)	(Inherited from XppObjectBase)
execute(Int32)	Prints the programmable sections of a report.
executeBodyColumnHeadings(Int32)	Prints the column headings of a body section in a report.
executeBodyColumnHeadings(Int32, Int32)
executeColumnHeadings(ReportSection)
executeControlColumnHeadings(Int32)	Executes the column headings of a programmable section.
executeFooter()	Execute a footer section.
executeFooter(Int32)
executeFooter(Int32, Int32)
executeHeader()	Executes a header section.
executeHeader(Int32)
executeHeader(Int32, Int32)
executeSection(ReportSection)	Prints the specified section in the report.
fetch()	Executes the report query and calls the send method for the record that is found by the query.
finalize()
footer(ReportSection, Int32, Int32)	Controls the footer.
from()
from(Int32)
generateDesign()
generateDesign(Query)
generateDesign(Query, Int32)
getDeclineOverwrite()
GetIntPtr()	(Inherited from XppObjectBase)
GetKernelInstanceUniqueId()	(Inherited from XppObjectBase)
getNumberOfPrinters()
getPrinter(Int32)
getRangeDescription(Int32)
getReportViewer()
getTarget()
getTimeOutTimerHandle()	(Inherited from XppObjectBase)
getXppProxyReference(Type)	(Inherited from XppObjectBase)
gotoYmm100()
gotoYmm100(Int32)
handle()
hasGeneratedDesign()
header(ReportSection, Int32, Int32)	Controls the header.
headerDescription()
heightOfPageFooters()
indent()
init()
isBodyEnabled(Int32)
isDetached()	Communicates whether an ObjectRun.detach method call has been made on this object. (Inherited from ObjectRun)
IsManagedValid()	(Inherited from XppObjectBase)
jobId()
kernelhandle()
KernelInstanceDisposed()	(Inherited from XppObjectBase)
last(Int32)
MakeReflectionCall(String, Object[])	(Inherited from XppObjectBase)
mm100Left()
mm100PageHeight()
name()	Gets or sets the name that is used in code to identify a form, report, table, query, or another MSDAX application object.
name(String)
newmethod()	(Inherited from XppObjectBase)
newmethod(Object)	Initializes an instance of the ReportRun class.
newmethod(Object, String)
newmethod(Object, String, Boolean)
newPage()
newPage(Boolean)
notify()	(Inherited from XppObjectBase)
notifyAll()	(Inherited from XppObjectBase)
objectOnServer()	Obsolete. (Inherited from XppObjectBase)
pack()	Serializes the current instance of the ReportRun class.
packDesign()
packPageSettings()
packPrinterSettings()
packPrintJobSettings()
packSubtotalSettings()
page()
page(Int32)
pageFormatting()	Displays the printer properties of the printer.
pagesTotal()
passThrough(String)
pixelsLeft()
print()	Sends the generated report to a print medium, such as a printer or the screen.
printerAttributes()
printerAveragePPM()
printerComment()
printerDatatype()
printerDefaultPriority()
printerDriverName()
printerFontInfo()	Indicates which font is used to print the report.
printerLocation()
printerPageHeight()
printerPageWidth()
printerPaper()
printerParameters()
printerPortName()
printerPrinterName()
printerPrintProcessor()
printerPriority()
printerQueuedJobs()
printerSepFile()
printerServerName()
printerSettings()	Enables the user to select printer settings.
printerSettings(Int32)
printerShareName()
printerStartTime()
printerStatus()
printerUntilTime()
printJobSettings()
printJobSettings(Object[])
printSum()
progressForm()
progressForm(xFormRun)
progressInfo(Int32, Int32)	Creates a string that describes how much of the report has been generated during the execution of a report every time that a section is executed.
prompt()	Prompts the user a report is run.
prompt(Boolean)
prompt(Boolean, Boolean)
prompt(Boolean, Boolean, Boolean)
prompt(Boolean, Boolean, Boolean, Boolean)
prompt(Boolean, Boolean, Boolean, Boolean, Boolean)
query()
query(Query)
queryRun()
queryRun(QueryRun)
report()
reportUser()
reportUser(String)
reset()	Enables a single instance of the ReportRun class to create multiple reports.
reset(Boolean)
rulerCM()
rulerINCH()
run()	Runs the report.
screenFontInfo()
section()
sectionsLeft(ReportSection)
send(Common)	Triggers the body sections that belong to a section group.
send(Common, Int32)
send(Common, Int32, Boolean)
send(Common, Int32, Boolean, Boolean)
setEscapeSequence(String)
setTarget(PrintMedium)
setTimeOut(String, Int32)	Obsolete. (Inherited from XppObjectBase)
setTimeOut(String, Int32, Boolean)	Obsolete. (Inherited from XppObjectBase)
showMenuFunction(xMenuFunction)
showMenuReference(WebMenu)
sortInfo(Common)
startDate()
startDateTime()
startMachineDate()
startTime()
sum(Int32, Int32)
sum(Int32, Int32, Int32)
sumControl(String)
sumControl(String, Int32)
sumControlNeg(String)
sumControlNeg(String, Int32)
sumControlPos(String)
sumControlPos(String, Int32)
sumDescription()
sumNeg(Int32, Int32)
sumNeg(Int32, Int32, Int32)
sumPos(Int32, Int32)
sumPos(Int32, Int32, Int32)
suppressReportIsEmptyMessage()
suppressReportIsEmptyMessage(Boolean)
title()	Gets or sets the print job description.
title(String)
to()
to(Int32)
ToString()	Returns a textual description of the class.
unpackDesign(Object[])
unpackPageSettings(Object[])
unpackPrinterSettings(Object[])
unpackPrintJobSettings(Object[])
unpackSubtotalSettings(Object[])
usageCount()	(Inherited from XppObjectBase)
userSelectedOrientation()
VerifyKernelClass()	(Inherited from XppObjectBase)
wait()	(Inherited from XppObjectBase)
Xml()	(Inherited from XppObjectBase)
Xml(Int32)	(Inherited from XppObjectBase)