XtraReport Methods

Show Inherited Hide Inherited

A DevExpress report.

Name	Description
AllControls<T>()	Returns a collection that contains all controls found within XRControl (within a report). Inherited from XRControl.
ApplyFiltering()	Applies the filter string assigned to the XtraReportBase.FilterString property, to a report’s data source using the current values of parameters. Inherited from XtraReportBase.
ApplyLocalization(CultureInfo)	Applies values contained in the localized report for the specified culture.
ApplyLocalization(String)	Applies values contained in the localized report for the specified locale.
BeginInit()	For internal use. Starts the XtraReport‘s initialization. Initialization occurs at runtime.
BeginUpdate()	Starts the XtraReport‘s runtime initialization.
BringToFront()	Brings the control to the front of the z-order. Inherited from XRControl.
CollectParameters(IList<Parameter>)
CreateBand(BandKind) static	Creates a band of the specified type. Inherited from XtraReportBase.
CreateDocument()	Creates a document from the report instance to display or print at a later time.
CreateDocument(Boolean)	Creates a document from the XtraReport object, so the report can be displayed or printed. Optionally, the document pages can be generated progressively and accessed as soon as they are created. Document creation is always synchronous and does not occur in a background thread.
CreateDocumentAsync(CancellationToken)	Asynchronously creates a document from an XtraReport to print or display this report.
CreateLayoutViewDocument()	For internal use. Creates a report document for editing using a Silverlight Report Designer.
CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
CreatePrintingSystem() static	Creates a Printing System for the report.
Dispose()	Releases all resources used by the Component. Inherited from Component.
EndInit()	For internal use. Ends the XtraReport‘s initialization.
EndUpdate()	Ends the XtraReport‘s runtime initialization.
EnsureStaticConstructor() static	This method is intended for internal use only. Normally, you don’t need to use it.
Equals(Object, Object) static	Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)	Determines whether the specified object is equal to the current object. Inherited from Object.
ExportToCsv(Stream, CsvExportOptions)	Exports a report to the specified stream in CSV format.
ExportToCsv(String, CsvExportOptions)	Exports a report to the specified file in CSV format.
ExportToCsvAsync(Stream, CsvExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in CSV format.
ExportToCsvAsync(String, CsvExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in CSV format.
ExportToDocx(Stream, DocxExportOptions)	Exports a report to the specified stream in DOCX format.
ExportToDocx(String, DocxExportOptions)	Exports a report to the specified file DOCX format.
ExportToDocxAsync(Stream, DocxExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in DOCX format.
ExportToDocxAsync(String, DocxExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in DOCX format.
ExportToHtml(Stream, HtmlExportOptions)	Exports a report to the specified stream in HTML format.
ExportToHtml(String, HtmlExportOptions)	Exports a report to the specified file in HTML format.
ExportToHtmlAsync(Stream, HtmlExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in HTML format.
ExportToHtmlAsync(String, HtmlExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in HTML format.
ExportToImage(Stream, DXImageFormat)	Exports a report to the specified stream in the specified image format.
ExportToImage(Stream, ImageExportOptions)	Exports a report to the specified stream as an image. Use options to specify an image format.
ExportToImage(String, DXImageFormat)	Exports a report to the specified file in the specified image format.
ExportToImage(String, ImageExportOptions)	Exports a report to the specified file in Image format.
ExportToImageAsync(Stream, ImageExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in image format.
ExportToImageAsync(String, ImageExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in image format.
ExportToMail(MailMessageExportOptions, String, String, String)	Exports a report to HTML and inserts it into a specified e-mail message.
ExportToMail(MailMessageExportOptions)	Exports a report to HTML and inserts it into a specified e-mail message.
ExportToMail(String, String, String)	Exports a report to HTML and inserts it into a specified e-mail message.
ExportToMailAsync(MailMessageExportOptions, String, String, String, CancellationToken)	Asynchronously exports a report to HTML and inserts it into a specified e-mail message.
ExportToMailAsync(MailMessageExportOptions, CancellationToken)	Asynchronously exports a report to HTML and inserts it into a specified e-mail message.
ExportToMailAsync(String, String, String, CancellationToken)	Asynchronously exports a report to HTML and inserts it into a specified e-mail message.
ExportToMht(Stream, MhtExportOptions)	Exports a report to the specified stream in MHT format.
ExportToMht(String, MhtExportOptions)	Exports a report to the specified file in MHT format.
ExportToMhtAsync(Stream, MhtExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in MHT format.
ExportToMhtAsync(String, MhtExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in MHT format.
ExportToPdf(Stream, PdfExportOptions)	Exports a report to the specified stream in PDF format.
ExportToPdf(String, PdfExportOptions)	Exports a report to the specified file in PDF format.
ExportToPdfAsync(Stream, PdfExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in PDF format.
ExportToPdfAsync(String, PdfExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in PDF format.
ExportToRtf(Stream, RtfExportOptions)	Exports a report to the specified stream in RTF format.
ExportToRtf(String, RtfExportOptions)	Exports a report to the specified file in RTF format.
ExportToRtfAsync(Stream, RtfExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in RTF format.
ExportToRtfAsync(String, RtfExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in RTF format.
ExportToText(Stream, TextExportOptions)	Exports a report to the specified stream in text format.
ExportToText(String, TextExportOptions)	Exports a report to the specified file in text format.
ExportToTextAsync(Stream, TextExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in text format.
ExportToTextAsync(String, TextExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in text format.
ExportToXls(Stream, XlsExportOptions)	Exports a report to the specified stream in CSV format. This method exports data in WYSIWYG mode.
ExportToXls(String, XlsExportOptions)	Exports a report to the specified file in XLS format. This method exports data in WYSIWYG mode.
ExportToXlsAsync(Stream, XlsExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in XLS format.
ExportToXlsAsync(String, XlsExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in XLS format.
ExportToXlsx(Stream, XlsxExportOptions)	Exports a report to the specified stream in XLSX format. This method exports data in WYSIWYG mode.
ExportToXlsx(String, XlsxExportOptions)	Exports a report to the specified file in XLSX format. This method exports data in WYSIWYG mode.
ExportToXlsxAsync(Stream, XlsxExportOptions, CancellationToken)	Asynchronously exports a report to the specified stream in XLSX format.
ExportToXlsxAsync(String, XlsxExportOptions, CancellationToken)	Asynchronously exports a report to the specified file in XLSX format.
FillDataSource()	Populates a data source, which is assigned to a report’s XtraReportBase.DataSource property. Inherited from XtraReportBase.
FillDataSourceAsync()	Inherited from XtraReportBase.
FindControl(String, Boolean)	Finds the control that has the specified name in the XRControl.Controls collection. Inherited from XRControl.
FromDisplayName(String)	Obtains the real name of a data field, based on the field’s display name. Inherited from XtraReportBase.
FromFile(String, Boolean) static	Loads the report definition from the specified REPX file.
FromStream(Stream, Boolean) static	Loads the report definition data from the specified stream and creates a report object from it. The created report’s class is also specified in the REPX data format.
FromXmlFile(String, Boolean) static	Loads the serialized report definition from the specified XML file.
FromXmlStream(Stream, Boolean) static	Loads the report definition data from the specified stream and creates a report object from it. The created report’s class is also specified in the XML data format.
GetCurrentColumnValue(String)	Returns the current value of the specified column (field) from a collection assigned to a report’s Data Member property. If the property is not specified, the method returns the current value from a root collection of the report’s Data Source. Inherited from XtraReportBase.
GetCurrentColumnValue<T>(String)	Returns the current value (strongly typed) of the specified column (field) from a collection assigned to a report’s Data Member property. If the property is not specified, the method returns the current value from a root collection of the report’s Data Source. Inherited from XtraReportBase.
GetCurrentRow()	Returns the current data row from a collection assigned to a report’s Data Member property. If the property is not specified, the method returns the current value from a root collection of the report’s Data Source. Inherited from XtraReportBase.
GetCurrentRowIndexInGroup()	Inherited from XtraReportBase.
GetEffectiveBackColor()	Returns the color actually used as the control’s background color. Inherited from XRControl.
GetEffectiveBorderColor()	Returns the color actually used as the control’s border color. Inherited from XRControl.
GetEffectiveBorderDashStyle()	Returns the border dash style that is actually used by the control. Inherited from XRControl.
GetEffectiveBorders()	Returns the borders settings actually used as the control’s borders settings. Inherited from XRControl.
GetEffectiveBorderWidth()	Returns the border width settings actually used as the control’s current settings. Inherited from XRControl.
GetEffectiveFont()	Returns the font actually used as the control’s font. Inherited from XRControl.
GetEffectiveForeColor()	Returns the color actually used as the control’s foreground color. Inherited from XRControl.
GetEffectivePadding()	Returns the padding values actually used as the control’s padding. Inherited from XRControl.
GetEffectiveStyle()	Returns the actual visual style of a control taking into account all formatting rules and odd/even styles applied to the control. Inherited from XRControl.
GetEffectiveTextAlignment()	Returns the text alignment actually used as the control’s text alignment. Inherited from XRControl.
GetGroupIndex(Int32)	Inherited from XtraReportBase.
GetHashCode()	Serves as the default hash function. Inherited from Object.
GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetNextColumnValue(String)	Gets the value of the specified column in the row that follows the current row in the report data source. Inherited from XtraReportBase.
GetNextColumnValue<T>(String)	Gets the next value (strongly typed) of the specified column in the report’s XtraReportBase.DataSource. Inherited from XtraReportBase.
GetNextRow()	Returns the next data row in the report’s data source. Inherited from XtraReportBase.
GetPreviousColumnValue(String)	Gets the previous value of the specified column in the report’s XtraReportBase.DataSource. Inherited from XtraReportBase.
GetPreviousColumnValue<T>(String)	Gets the previous value (strongly typed) of the specified column in the report’s data source. Inherited from XtraReportBase.
GetPreviousRow()	Returns the previous data row in the report’s data source. Inherited from XtraReportBase.
GetService(Type) protected	Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType()	Gets the Type of the current instance. Inherited from Object.
HasExportWarningControls()	Returns a collection of controls for which export warnings exist.
InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
IterateReportsRecursive(Action<XtraReportBase>)	For internal use. Inherited from XtraReportBase.
LoadLayout(Stream)	Loads a report from a Stream that contains XML or CodeDOM-based serialized report.
LoadLayout(String)	Loads a report from a file that contains a report definition, based on XML or CodeDOM serialization.
LoadLayoutFromXml(Stream, Boolean)	Loads a report from a Stream that contains a serialized report in XML format.
LoadLayoutFromXml(String)	Loads a report from a file that contains an XML-serialized report.
MemberwiseClone() protected	Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected	Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ModifyDocument(Action<IDocumentModifier>)	Adds and/or removes the report’s document pages.
PerformLayout()	Forces the control to apply layout logic to itself and all its child controls. Inherited from XRControl.
Print(String)	Sends a report to the specified printer.
PrintAsync(String, CancellationToken)	Asynchronously sends a report to the specified printer.
ReferenceEquals(Object, Object) static	Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveInvalidBindings(Predicate<XRBinding>)	Removes inappropriate bindings assigned to the XRControl‘s properties. Inherited from XRControl.
ResetBackColor()	Resets the XRControl.BackColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderColor()	Resets the XRControl.BorderColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderDashStyle()	Resets the XRControl.BorderDashStyle property to en empty value. Inherited from XRControl.
ResetBorders()	Resets the XRControl.Borders property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderWidth()	Resets the XRControl.BorderWidth property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetFont()	Resets the XRControl.Font property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetForeColor()	Resets the XRControl.ForeColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetPadding()	Resets the XRControl.Padding property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetTextAlignment()	Resets the XRControl.TextAlignment property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResumeLayout()	Resumes normal layout logic for the control. Inherited from XRControl.
SaveDocument(Stream, NativeFormatOptions)	Saves the report document to the specified stream in the XML-based PRNX format.
SaveDocument(String, NativeFormatOptions)	Saves the report document to the specified file in the XML-based PRNX format.
SaveLayout(Stream, Boolean)	Saves the report definition to a Stream object as a Code Document Object Model (CodeDOM) graph, with an exception thrown if an error occurs.
SaveLayout(Stream)	Saves the report definition to a Stream as a Code Document Object Model (CodeDOM) graph.
SaveLayout(String, Boolean)	Saves the report definition to a file as a Code Document Object Model (CodeDOM) graph, with an exception thrown if an error occurs.
SaveLayout(String)	Saves the report definition to a file as a Code Document Object Model (CodeDOM) graph.
SaveLayoutToXml(Stream)	Save the report in XML format to the specified stream.
SaveLayoutToXml(String)	Saves the report in XML format to the specified file.
SendToBack()	Sends the control to the back of the z-order. Inherited from XRControl.
StopPageBuilding()	Interrupts the process of document creation.
SuspendLayout()	Temporarily suspends the layout logic for the control. Inherited from XRControl.
ToImage()	The method is not implemented. Inherited from Band.
ToImage(DXTextRenderingHint)	The method is not implemented. Inherited from Band.
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
UnitToDpi(ReportUnit) static	Obsolete. Converts report measurement units into screen coordinates.
ValidateScripts()	Validates report scripts.