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

XtraReport Members

A base class for a report.

Constructors

Name Description
XtraReport() Initializes a new instance of the XtraReport class with the default settings.

Fields

Name Description
DefaultHorizontalContentSplitting static Always HorizontalContentSplitting.Smart.
DefaultPageSize static A Size object representing the default page size (850 by 1100 hundredths of an inch) used for reports.
DefaultPaperKind Represents the default paper type (Letter) used in a report.

Properties

Name Description
AnchorHorizontal Hides the AnchorHorizontal property. Inherited from Band.
AnchorVertical Overrides the XRControl.AnchorVertical property to hide it. Inherited from Band.
BackColor Gets or sets the control’s background color. Inherited from XRControl.
Band Provides access to the owner band, in which the current control is situated. Inherited from XRControl.
Bands Gets the collection of bands contained in a report. Inherited from XtraReportBase.
Bookmark Gets or sets the text shown as a root bookmark in a Document Map.
BookmarkDuplicateSuppress Specifies whether or not to suppress duplicated bookmarks in a final document.
BookmarkParent For internal use. Inherited from Band.
BorderColor Gets or sets the control’s border color. Inherited from XRControl.
BorderDashStyle Specifies the dash style for the control’s border. Inherited from XRControl.
Borders Specifies a set of borders (top, right, bottom, left) that should be visible for the control. Inherited from XRControl.
BorderWidth Specifies the width of cell borders in pixels, as a floating point value. Inherited from XRControl.
Bottom For internal use. Inherited from XRControl.
BottomF For internal use. Inherited from Band.
Bounds For internal use. Inherited from XRControl.
BoundsF For internal use. Inherited from Band.
CalculatedFields Provides access to a report’s collection of calculated fields.
CanGrow For internal use. Inherited from Band.
CanHaveChildren Overrides the XRControl.CanHaveChildren property. Inherited from Band.
CanPublish For internal use. Inherited from Band.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
CanShrink For internal use. Inherited from Band.
ComponentStorage For internal use.
Container Gets the IContainer that contains the Component. Inherited from Component.
Controls For internal use. Inherited from XtraReportBase.
ControlType Gets the assembly-qualified name of the report.
CrossBandControls Provides access to a collection of cross-band controls in the current report.
CurrentRowHierarchyLevel Inherited from XtraReportBase.
CurrentRowIndex Gets the index of the current data row in a report’s XtraReportBase.DataSource. Inherited from XtraReportBase.
DataAdapter Specifies the data adapter that should be used to populate a report’s data source. Inherited from XtraReportBase.
DataBindings For internal use. Inherited from Band.
DataMember Gets or sets a specific list in a report’s data source. Inherited from XtraReportBase.
DataSource Gets or sets a data source object that provides data for a master or detail report, as well as to the charts and pivot grids it contains. Inherited from XtraReportBase.
DataSourceSchema Gets or sets an XML/XSD file, containing a schema of a report’s data source.
DefaultPrinterSettingsUsing Provides access to an object that defines which of the system’s default printer settings should be used when printing an XtraReport.
DesignerOptions Provides access to the options that determine the availability of popup hints and warnings in the Report Designer.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DetailPrintCount Obsolete. For internal use. Inherited from XtraReportBase.
DetailPrintCountOnEmptyDataSource Obsolete. Use the DetailCountOnEmptyDataSource property instead. Inherited from XtraReportBase.
DisplayName Gets or sets the report’s display name. The display name appears in the End-User Designer‘s report tab, and serves as the exported document’s default file name.
Dock Obsolete. For internal use. Inherited from XRControl.
DocumentExportMode For internal use.
Dpi For internal use. Inherited from XRControl.
DrawGrid Gets or sets a value indicating whether to draw the snap grid over the report surface.
DrawWatermark Gets or sets a value indicating whether or not to draw a watermark at design time.
DrillDownKey For internal use. Inherited from XRControl.
EvenStyleName For internal use. Inherited from XtraReportBase.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
EventsInfo For internal use.
EventsScriptManager For internal use.
Expanded For internal use. Overrides the Band.Expanded property, to hide it.
ExportOptions Gets the settings used to specify exporting parameters when exporting a report.
ExpressionBindings Provides access to a control’s collection of expression bindings. Inherited from XRControl.
Extensions Provides access to the report’s extensions.
FilterString Specifies the criteria used to filter data in a report. Inherited from XtraReportBase.
Font Gets or sets the control’s font. Inherited from XRControl.
ForeColor Gets or sets the control’s foreground color. Inherited from XRControl.
FormattingRuleLinks For internal use. Inherited from XRControl.
FormattingRules Provides access to a collection of formatting rules applied to this control. Inherited from XRControl.
FormattingRuleSheet Provides access to a collection of formatting rules stored in a report.
GridSize Obsolete. For internal use.
HasChildren Gets a value indicating whether the control contains other XRControl objects. Inherited from XRControl.
Height For internal use. Inherited from XRControl.
HeightF For internal use. Inherited from XtraReportBase.
HorizontalContentSplitting When the brick dimensions do not fit into the bottom page margin, specifies whether the brick content is split across two pages or moved to a new page.
ImageResources Provides access to a collection of the report’s named images.
Index Gets the zero-based index of this control in its parent’s collection of controls. Inherited from XRControl.
IsDisposed For internal use. Gets a value indicating whether the control has been disposed of. Inherited from XRControl.
IsSingleChild Checks whether the report element (control or band) is a single child of its parent. Inherited from XRControl.
KeepTogether For internal use. Inherited from XtraReportBase.
Landscape Gets or sets a value indicating whether the page orientation is landscape.
Left For internal use. Inherited from XRControl.
LeftF For internal use. Inherited from Band.
Location For internal use. Inherited from XRControl.
LocationF For internal use. Inherited from Band.
LocationFloat For internal use. Inherited from Band.
LockedInUserDesigner For internal use.
Margins Gets or sets the report’s page margins.
MasterReport Gets or sets the XtraReport object which contains the current report as a subreport.
Name Gets or sets a name of the control. Inherited from XRControl.
NavigateUrl For internal use. Inherited from Band.
NullValueText For internal use. Inherited from XRControl.
ObjectStorage For internal use.
OddStyleName For internal use. Inherited from XtraReportBase.
Padding Gets or sets the control’s padding values (measured in report units). Inherited from XRControl.
PageBreak For internal use.
PageColor Gets or sets the fill color of report pages.
PageHeight Gets or sets the height of the report’s pages (measured in report units). This can only be set if the XtraReport.PaperKind is set to Custom.
Pages Gets a collection of pages generated for this report.
PageSize Gets or sets the size of the report’s pages (measured in report units).
PageWidth Gets or sets the width of the report’s pages (measured in report units). This can only be set if the XtraReport.PaperKind is set to Custom.
PaperKind Gets or sets the report’s paper kind.
PaperName Gets or sets the name of the custom paper which is used in the printer that the document is going to be printed on.
Parameters Provides access to a report’s collection of parameters.
Parent Specifies the parent object that contains the current control. Inherited from XRControl.
ParentStyleUsing For internal use. Inherited from XRControl.
PreviewRowCount Obsolete. For internal use.
PrintAcrossBands For internal use. Inherited from Band.
PrinterName Specifies the name of the printer to use for printing the report.
PrintingSystem Returns a report’s Printing System that provides print and export settings.
PrintOnEmptyDataSource Obsolete. Use the PrintOnEmptyDataSource property instead. Inherited from XtraReportBase.
ProcessDuplicates Obsolete. Obsolete. See ProcessDuplicatesMode. Inherited from XRControl.
ProcessDuplicatesMode Specifies how to process report controls with duplicate values. This property is for internal use only. See the list below for properties that override this property. Inherited from XRControl.
ProcessDuplicatesTarget For internal use. Inherited from XRControl.
ProcessNullValues Specifies how to process report controls with null values. This property is for internal use only. See the list below for properties that override this property. Inherited from XRControl.
Report Provides access to the report that contains the control. Inherited from XRControl.
ReportPrintOptions Provides access to options that define a report’s print-out. Inherited from XtraReportBase.
ReportUnit Specifies the system of measurement that is used throughout a report for expressing the values of certain properties (e.g., an element’s location, dimensions and margins).
RequestParameters Specifies whether the report document creation should start after all the report parameters are submitted.
Right For internal use. Inherited from XRControl.
RightF For internal use. Inherited from Band.
RightToLeft Specifies the content orientation of the XtraReport‘s controls.
RightToLeftLayout Specifies the position of controls within report bands.
RollPaper Specifies whether the document is supposed to be printed on roll paper (i.e., as a single uninterrupted page).
RootReport Provides access to the report to which the control belongs. Inherited from XRControl.
RowCount Gets the total amount of data rows in a report’s XtraReportBase.DataSource. Inherited from XtraReportBase.
ScriptLanguage Gets or sets the scripting language of all the scripts used in this XtraReport object.
ScriptReferences Specifies the collection of file names (with full paths, or file names only if the assemblies are located in GAC) of the assemblies used by the scripts in a report.
ScriptReferencesString Gets or sets the string containing all script references represented by the XtraReport.ScriptReferences property.
Scripts Provides access to an object that contains XtraReport-specific scripts to handle its events in the End-User Designer.
ScriptSecurityPermissions Obsolete. Provides access to the collection of security permissions used to permit particular operations in report scripts.
ScriptsSource Specifies the report scripts.
ShowDesignerHints Obsolete. For internal use.
ShowExportWarnings Obsolete. For internal use.
ShowPreviewMarginLines Specifies whether the report preview window shows page margin lines.
ShowPrintingWarnings Obsolete. For internal use.
ShowPrintMarginsWarning Gets or sets a value which specifies whether an error message is shown when the page margins are set outside the printable area.
ShowPrintStatusDialog Gets or sets a value specifying whether a print status dialog is shown when a document is printed.
ShowUserFriendlyNamesInUserDesigner static Obsolete. Gets or sets a value indicating whether all property names and their values should be displayed in the user-friendly format in the Property Grid and smart tags of the End-User Designer.
ShrinkSubReportIconArea Obsolete. For internal use.
Site Gets or sets the ISite of the Component. Inherited from Component.
Size For internal use. Inherited from XRControl.
SizeF For internal use. Inherited from Band.
SnapGridSize Specifies the dimensions of the report designer snap grid.
SnapGridStepCount Specifies the number of grid cells comprising a larger snap grid unit.
SnapLineMargin For internal use. Inherited from Band.
SnapLinePadding For internal use. Inherited from XtraReportBase.
SnappingMode Specifies the mode in which report elements are snapped to each other when they are resized or being relocated.
SnapToGrid Obsolete. For internal use.
SourceUrl For internal use.
StyleName For internal use. Inherited from XtraReportBase.
StylePriority For internal use. Inherited from XtraReportBase.
Styles For internal use. Inherited from XtraReportBase.
StyleSheet Provides access to a collection of styles stored in a report.
StyleSheetPath Gets or sets a path to the style sheet contained in a style sheet file.
SubBands For internal use. Inherited from XtraReportBase.
Tag Bindable. Gets or sets the object that contains data about this control. Inherited from XRControl.
Target For internal use. Inherited from Band.
Text For internal use. Inherited from Band.
TextAlignment Specifies the alignment of the control’s text. Inherited from XRControl.
TextFormatString Designed to be used internally. Use a specific control’s TextFormatString property instead (e.g., XRLabel.TextFormatString, XRBarCode.TextFormatString or XRCheckBox.TextFormatString. Inherited from XRControl.
TextTrimming For internal use. Inherited from XRControl.
Top For internal use. Inherited from XRControl.
TopF For internal use. Inherited from Band.
Value For internal use. Inherited from XRControl.
Version For internal use.
VerticalContentSplitting Gets or sets a value indicating whether report controls outside the right page margin should be split across pages, or moved in their entirety to the next page.
Visible Gets or sets a value indicating whether or not the report control is displayed in a document. Inherited from XRControl.
Watermark Provides access to a report’s watermark settings.
Width For internal use. Inherited from XRControl.
WidthF For internal use. Inherited from Band.
WordWrap For internal use. Inherited from Band.
XlsxFormatString For internal use. Inherited from Band.
XmlDataPath Specifies the path to an XML file that should be used as the report’s data source. Inherited from XtraReportBase.

Methods

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.
BeginUpdate() Starts the XtraReport‘s runtime initialization.
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.
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.
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.
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 using the specified CSV-specific options.
ExportToCsv(Stream) Exports a report to the specified stream in CSV format.
ExportToCsv(String, CsvExportOptions) Exports a report to the specified file path in CSV format using the specified CSV-specific options.
ExportToCsv(String) Exports a report to the specified file path in CSV format.
ExportToDocx(Stream, DocxExportOptions) Exports a report to the specified stream in DOCX format using the defined DOCX-specific options.
ExportToDocx(Stream) Exports a report to the specified stream in DOCX format.
ExportToDocx(String, DocxExportOptions) Exports a report to the specified file path in DOCX format using the specified DOCX-specific options.
ExportToDocx(String) Exports a report to the specified file path in DOCX format.
ExportToHtml(Stream, HtmlExportOptions) Exports a report to the specified stream in HTML format using the specified HTML-specific options.
ExportToHtml(Stream) Exports a report to the specified stream in HTML format.
ExportToHtml(String, HtmlExportOptions) Exports a report to the specified file path in HTML format using the specified HTML-specific options.
ExportToHtml(String) Exports a report to the specified file path in HTML format.
ExportToImage(Stream, ImageExportOptions) Exports a report to the specified stream in Image format using the specified Image-specific options.
ExportToImage(Stream, ImageFormat) Exports a report to the specified stream in the specified Image format.
ExportToImage(Stream) Exports a report to the specified stream in Image format.
ExportToImage(String, ImageExportOptions) Exports a report to the specified file path in Image format using the specified Image-specific options.
ExportToImage(String, ImageFormat) Exports a report to the specified file path using the specified image format.
ExportToImage(String) Exports a report to the specified file path in Image format.
ExportToMail() Exports a document to HTML and then inserts it into a specified e-mail.
ExportToMail(MailMessageExportOptions, String, String, String) Exports a document to HTML and then inserts it into a specified e-mail.
ExportToMail(MailMessageExportOptions) Exports a document to HTML and then inserts it into a specified e-mail.
ExportToMail(String, String, String) Exports a document to HTML and then inserts it into a specified e-mail.
ExportToMht(Stream, MhtExportOptions) Exports a report to the specified stream in MHT format using the specified MHT-specific options.
ExportToMht(Stream) Exports a report to the specified stream in MHT format.
ExportToMht(String, MhtExportOptions) Exports a report to the specified file path in MHT format using the specified MHT-specific options.
ExportToMht(String) Exports a report to the specified file path in MHT format.
ExportToPdf(Stream, PdfExportOptions) Exports a report to the specified stream in PDF using the specified PDF-specific options.
ExportToPdf(Stream) Exports a report to the specified stream in PDF.
ExportToPdf(String, PdfExportOptions) Exports a report to the specified file path in PDF using the specified PDF-specific options.
ExportToPdf(String) Exports a report to the specified file path in PDF.
ExportToRtf(Stream, RtfExportOptions) Exports a document to the specified file path in RTF format.
ExportToRtf(Stream) Exports a report to the specified stream in RTF format.
ExportToRtf(String, RtfExportOptions) Exports a document to the specified file path in RTF format.
ExportToRtf(String) Exports a report to the specified file path in RTF format.
ExportToText(Stream, TextExportOptions) Exports a report to the specified stream in Text format using the specified Text-specific options.
ExportToText(Stream) Exports a report to the specified stream in Text format.
ExportToText(String, TextExportOptions) Exports a report to the specified file path in Text format using the specified Text-specific options.
ExportToText(String) Exports a report to the specified file path in Text format.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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) Gets the current value of the specified column in the report’s DataSource. Inherited from XtraReportBase.
GetCurrentColumnValue<T>(String) Gets the current value (strongly typed) of the specified column in the report’s DataSource. Inherited from XtraReportBase.
GetCurrentRow() Returns the currently processed data row from the report’s DataSource. 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.
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 the report’s definition (layout and configuration) from a Stream object in the REPX format.
LoadLayout(String) Loads the report’s definition (layout and configuration) from a file in the REPX format.
LoadLayoutFromXml(Stream, Boolean)
LoadLayoutFromXml(String) Restores the report from its XML definition residing in the specified file.
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.
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.
SaveLayout(Stream) Saves the report’s definition (layout and configuration) to a Stream object in the REPX data format.
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.
SaveLayout(String) Saves the report’s definition (layout and configuration) to a file in the REPX format.
SaveLayoutToXml(Stream) Save the report in XML format to the specified stream.
SaveLayoutToXml(String) Save 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() 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.
ValidateScripts() Validates report scripts.

Events

Name Description
AfterPrint Occurs after an XRControl object is displayed in the report. Inherited from XRControl.
BandHeightChanged Occurs when the height of any band in the collection returned by the XtraReportBase.Bands property changes. Inherited from XtraReportBase.
BeforePrint Occurs before an XRControl object creates its image in a report being generated. Inherited from XRControl.
DataSourceDemanded Occurs before report generation, to specify a data source for the report. Inherited from XtraReportBase.
DataSourceRowChanged Occurs when the current row in the report’s data source has been changed. Inherited from XtraReportBase.
DesignerLoaded Occurs after the End-User Designer has been loaded for the current report instance.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
Draw Overrides the XRControl.Draw event. Inherited from Band.
EvaluateBinding Overrides the XRControl.EvaluateBinding event to hide it. Inherited from Band.
FillEmptySpace Fires after page rendering if a gap remains between the rendered bands.
FilterComponentProperties static Occurs every time the Property Grid refreshes its item list in the End-User Designer.
FilterControlProperties static Obsolete. Occurs every time the Property Grid refreshes its item list in the End-User Designer.
HeightChanged Occurs when the band height is changed. Inherited from Band.
HtmlItemCreated Overrides the XRControl.HtmlItemCreated property.
LocationChanged Overrides the XRControl.LocationChanged event. Inherited from Band.
ParametersRequestBeforeShow Occurs before displaying the Parameters panel in a Print Prevew.
ParametersRequestSubmit Occurs when all parameter values in the Parameters UI are entered, and the Submit button is pressed.
ParametersRequestValueChanged Occurs when the parameter values are changed in the Parameters UI.
ParentChanged Overrides the XRControl.ParentChanged event. Inherited from Band.
PreviewClick Hides the inappropriate XRControl.PreviewClick event of the parent XRControl class. Inherited from Band.
PreviewDoubleClick Hides the inappropriate XRControl.PreviewDoubleClick event of the parent XRControl class. Inherited from Band.
PreviewMouseDown Hides the inappropriate XRControl.PreviewMouseDown event of the parent XRControl class. Inherited from Band.
PreviewMouseMove Hides the inappropriate XRControl.PreviewMouseMove event of the parent XRControl class. Inherited from Band.
PreviewMouseUp Hides the inappropriate XRControl.PreviewMouseUp event of the parent XRControl class. Inherited from Band.
PrintOnPage Overrides the XRControl.PrintOnPage event to hide it. Inherited from Band.
PrintProgress Occurs before sending every document page to a printer to indicate the current printing progress.
SaveComponents Occurs when a report is saved to an REPX file and allows you to manually decide which components should be stored into a report definition file, and which aren’t.
SizeChanged Overrides the XRControl.SizeChanged event. Inherited from Band.
TextChanged Overrides the XRControl.TextChanged event. Inherited from Band.
See Also