Skip to main content
A newer version of this page is available. .

XtraSchedulerReport Methods

Represents the base class for a report in the XtraScheduler Suite.
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.
BeginInit() For internal use. Starts the XtraReport‘s initialization. Initialization occurs at runtime. Inherited from XtraReport.
BeginUpdate() Starts the XtraReport‘s runtime initialization. Inherited from XtraReport.
BringToFront() Brings the control to the front of the z-order. Inherited from XRControl.
CollectParameters(IList<Parameter>, Predicate<Parameter>) For internal use. Collects all report parameters that satisfy the specified conditions. Inherited from XtraReport.
CreateBand(BandKind) static Creates a band of the specified type. Inherited from XtraReportBase.
CreateDocument() Creates a document from the XtraReport object, so it can be displayed or printed. Inherited from XtraReport.
CreateDocument(Boolean) Creates a document so that it 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.
CreateLayoutViewDocument() For internal use. Creates a report document for editing using a Silverlight Report Designer. Inherited from XtraReport.
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. Inherited from XtraReport.
Dispose() Releases all resources used by the Component. Inherited from Component.
EndInit() For internal use. Ends the XtraReport‘s initialization. Inherited from XtraReport.
EndUpdate() Ends the XtraReport‘s runtime initialization. Inherited from XtraReport.
EnsureStaticConstructor() static This method is intended for internal use only. Normally, you don’t need to use it. Inherited from XtraReport.
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 using the specified CSV-specific options. Inherited from XtraReport.
ExportToCsv(Stream) Exports a report to the specified stream in CSV format. Inherited from XtraReport.
ExportToCsv(String, CsvExportOptions) Exports a report to the specified file path in CSV format using the specified CSV-specific options. Inherited from XtraReport.
ExportToCsv(String) Exports a report to the specified file path in CSV format. Inherited from XtraReport.
ExportToDocx(Stream, DocxExportOptions) Exports a report to the specified stream in DOCX format using the defined DOCX-specific options. Inherited from XtraReport.
ExportToDocx(Stream) Exports a report to the specified stream in DOCX format. Inherited from XtraReport.
ExportToDocx(String, DocxExportOptions) Exports a report to the specified file path in DOCX format using the specified DOCX-specific options. Inherited from XtraReport.
ExportToDocx(String) Exports a report to the specified file path in DOCX format. Inherited from XtraReport.
ExportToHtml(Stream, HtmlExportOptions) Exports a report to the specified stream in HTML format using the specified HTML-specific options. Inherited from XtraReport.
ExportToHtml(Stream) Exports a report to the specified stream in HTML format. Inherited from XtraReport.
ExportToHtml(String, HtmlExportOptions) Exports a report to the specified file path in HTML format using the specified HTML-specific options. Inherited from XtraReport.
ExportToHtml(String) Exports a report to the specified file path in HTML format. Inherited from XtraReport.
ExportToImage(Stream, ImageExportOptions) Exports a report to the specified stream in Image format using the specified Image-specific options. Inherited from XtraReport.
ExportToImage(Stream, ImageFormat) Exports a report to the specified stream in the specified Image format. Inherited from XtraReport.
ExportToImage(Stream) Exports a report to the specified stream in Image format. Inherited from XtraReport.
ExportToImage(String, ImageExportOptions) Exports a report to the specified file path in Image format using the specified Image-specific options. Inherited from XtraReport.
ExportToImage(String, ImageFormat) Exports a report to the specified file path using the specified image format. Inherited from XtraReport.
ExportToImage(String) Exports a report to the specified file path in Image format. Inherited from XtraReport.
ExportToMail() Exports a document to HTML and then inserts it into a specified e-mail. Inherited from XtraReport.
ExportToMail(MailMessageExportOptions, String, String, String) Exports a document to HTML and then inserts it into a specified e-mail. Inherited from XtraReport.
ExportToMail(MailMessageExportOptions) Exports a document to HTML and then inserts it into a specified e-mail. Inherited from XtraReport.
ExportToMail(String, String, String) Exports a document to HTML and then inserts it into a specified e-mail. Inherited from XtraReport.
ExportToMht(Stream, MhtExportOptions) Exports a report to the specified stream in MHT format using the specified MHT-specific options. Inherited from XtraReport.
ExportToMht(Stream) Exports a report to the specified stream in MHT format. Inherited from XtraReport.
ExportToMht(String, MhtExportOptions) Exports a report to the specified file path in MHT format using the specified MHT-specific options. Inherited from XtraReport.
ExportToMht(String) Exports a report to the specified file path in MHT format. Inherited from XtraReport.
ExportToPdf(Stream, PdfExportOptions) Exports a report to the specified stream in PDF using the specified PDF-specific options. Inherited from XtraReport.
ExportToPdf(Stream) Exports a report to the specified stream in PDF. Inherited from XtraReport.
ExportToPdf(String, PdfExportOptions) Exports a report to the specified file path in PDF using the specified PDF-specific options. Inherited from XtraReport.
ExportToPdf(String) Exports a report to the specified file path in PDF. Inherited from XtraReport.
ExportToRtf(Stream, RtfExportOptions) Exports a document to the specified file path in RTF format. Inherited from XtraReport.
ExportToRtf(Stream) Exports a report to the specified stream in RTF format. Inherited from XtraReport.
ExportToRtf(String, RtfExportOptions) Exports a document to the specified file path in RTF format. Inherited from XtraReport.
ExportToRtf(String) Exports a report to the specified file path in RTF format. Inherited from XtraReport.
ExportToText(Stream, TextExportOptions) Exports a report to the specified stream in Text format using the specified Text-specific options. Inherited from XtraReport.
ExportToText(Stream) Exports a report to the specified stream in Text format. Inherited from XtraReport.
ExportToText(String, TextExportOptions) Exports a report to the specified file path in Text format using the specified Text-specific options. Inherited from XtraReport.
ExportToText(String) Exports a report to the specified file path in Text format. Inherited from XtraReport.
ExportToXls(Stream, XlsExportOptions) Exports a report to the specified file path in XLS format.This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats. Inherited from XtraReport.
ExportToXls(Stream) Exports a report to the specified stream in XLS format. This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats. Inherited from XtraReport.
ExportToXls(String, XlsExportOptions) Exports a report to the specified file path in XLS format using the specified XLS-specific options.This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats. Inherited from XtraReport.
ExportToXls(String) Exports a report to the specified file path in XLS format. This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats. Inherited from XtraReport.
ExportToXlsx(Stream, XlsxExportOptions) Exports a report to the specified file path in XLSX format using the specified XLSX-specific options.This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats. Inherited from XtraReport.
ExportToXlsx(Stream) Exports a report to the specified stream in XLSX format.This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats. Inherited from XtraReport.
ExportToXlsx(String, XlsxExportOptions) Exports a report to the specified stream in XLSX format using the specified XLS-specific options.This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats. Inherited from XtraReport.
ExportToXlsx(String) Exports a report to the specified file path in XLSX format.This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats. Inherited from XtraReport.
FillDataSource() Populates a data source, which is assigned to a report’s XtraReportBase.DataSource property. 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. Inherited from XtraReport.
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. Inherited from XtraReport.
GetCurrentColumnValue(String) Gets the current value of the specified column in the report’s XtraReportBase.DataSource. Inherited from XtraReportBase.
GetCurrentColumnValue<T>(String) Gets the current value (strongly typed) of the specified column in the report’s XtraReportBase.DataSource. Inherited from XtraReportBase.
GetCurrentRow() Returns the current data row in the report’s data source. 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.
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 next value of the specified column in the report’s XtraReportBase.DataSource. 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 XtraReportBase.DataSource. Inherited from XtraReportBase.
GetPreviousRow() Returns the previous data row in the report’s data source. Inherited from XtraReportBase.
GetResourceColorSchema(Resource) Gets colors used to paint cells associated with a specified resource.
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. Inherited from XtraReport.
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 the report’s definition (layout and configuration) from a Stream object in the REPX format. Inherited from XtraReport.
LoadLayout(String) Loads the report’s definition (layout and configuration) from a file in the REPX format. Inherited from XtraReport.
LoadLayoutFromXml(Stream, Boolean) Inherited from XtraReport.
LoadLayoutFromXml(String) Restores the report from its XML definition residing in the specified file. Inherited from XtraReport.
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. Inherited from XtraReport.
PerformLayout() Forces the control to apply layout logic to itself and all its child controls. Inherited from XRControl.
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.
SaveLayout(Stream, Boolean) Saves the report’s definition (layout and configuration) to a Stream object in the REPX data format, with an exception thrown if an error occurs. Inherited from XtraReport.
SaveLayout(Stream) Saves the report’s definition (layout and configuration) to a Stream object in the REPX data format. Inherited from XtraReport.
SaveLayout(String, Boolean) Saves the report’s definition (layout and configuration) to a file in the REPX format, with an exception thrown if an error occurs. Inherited from XtraReport.
SaveLayout(String) Saves the report’s definition (layout and configuration) to a file in the REPX format. Inherited from XtraReport.
SaveLayoutToXml(Stream) Save the report in XML format to the specified stream. Inherited from XtraReport.
SaveLayoutToXml(String) Save the report in XML format to the specified file. Inherited from XtraReport.
SendToBack() Sends the control to the back of the z-order. Inherited from XRControl.
StopPageBuilding() Interrupts the process of document creation. Inherited from XtraReport.
SuspendLayout() Temporarily suspends the layout logic for the control. Inherited from XRControl.
ToImage() Replaces the XRControl.ToImage method. Inherited from Band.
ToImage(TextRenderingHint) Replaces the XRControl.ToImage method. 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. Inherited from XtraReport.
ValidateScripts() Validates report scripts. Inherited from XtraReport.
See Also