[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Collapse]Reporting
 [Expand]Product Information
 [Expand]Get Started with DevExpress Reporting
 [Expand]Create Popular Reports
 [Expand]Detailed Guide to DevExpress Reporting
 [Expand]Visual Studio Report Designer
 [Expand]Create End-User Reporting Applications
 [Collapse]API Reference
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraPrinting.Caching
  [Expand]DevExpress.XtraReports
  [Expand]DevExpress.XtraReports.CodeCompletion
  [Expand]DevExpress.XtraReports.CodeCompletion.Storages
  [Expand]DevExpress.XtraReports.Configuration
  [Expand]DevExpress.XtraReports.Data
  [Expand]DevExpress.XtraReports.Design
  [Expand]DevExpress.XtraReports.Expressions
  [Expand]DevExpress.XtraReports.Extensions
  [Expand]DevExpress.XtraReports.FavoriteProperties
  [Expand]DevExpress.XtraReports.Localization
  [Expand]DevExpress.XtraReports.Native
  [Expand]DevExpress.XtraReports.ReportGallery
  [Expand]DevExpress.XtraReports.ReportGeneration
  [Expand]DevExpress.XtraReports.Security
  [Expand]DevExpress.XtraReports.Serialization
  [Expand]DevExpress.XtraReports.Service
  [Expand]DevExpress.XtraReports.Service.Extensions
  [Expand]DevExpress.XtraReports.Templates
  [Collapse]DevExpress.XtraReports.UI
   [Expand]Band Class
   [Expand]BandCollection Class
   [Expand]BandEventArgs Class
    BandEventHandler Delegate
   [Expand]BandFactory Class
    BandKind Enumeration
   [Expand]BandScripts Class
   [Expand]BestSizeEstimator Class
   [Expand]BindingEventArgs Class
    BindingEventHandler Delegate
   [Expand]BottomMarginBand Class
   [Expand]CalculatedField Class
   [Expand]CalculatedFieldCollection Class
   [Expand]CalculatedFieldScripts Class
   [Expand]ChangeEventArgs Class
    ChangeEventHandler Delegate
    ChartImageType Enumeration
   [Expand]CheckEditOptions Class
    ColumnDirection Enumeration
    DataBindingMode Enumeration
   [Expand]DataSourceRowEventArgs Class
    DataSourceRowEventHandler Delegate
   [Expand]DesignerOptions Class
    DesignWindowType Enumeration
   [Expand]DetailBand Class
   [Expand]DetailReportBand Class
   [Expand]DetailReportBandCollection Class
    DocumentExportMode Enumeration
   [Expand]DrawEventArgs Class
    DrawEventHandler Delegate
   [Expand]EditOptions Class
   [Expand]ExpressionBinding Class
   [Expand]ExpressionBindingCollection Class
    ExternalFileAccessSecurityLevel Enumeration
   [Expand]ExternalFileAccessSecurityLevelSettings Class
   [Expand]Formatting Class
   [Expand]FormattingRule Class
   [Expand]FormattingRuleCollection Class
   [Expand]FormattingRuleSheet Class
    GaugeImageType Enumeration
   [Expand]GetValueEventArgs Class
    GetValueEventHandler Delegate
   [Expand]GroupBand Class
   [Expand]GroupBandScripts Class
   [Expand]GroupField Class
   [Expand]GroupFieldCollection Class
   [Expand]GroupFooterBand Class
    GroupFooterUnion Enumeration
   [Expand]GroupHeaderBand Class
   [Expand]GroupHeaderBandScripts Class
   [Expand]GroupSortingSummaryGetResultEventArgs Class
    GroupSortingSummaryGetResultEventHandler Delegate
   [Expand]GroupSortingSummaryRowChangedEventArgs Class
    GroupSortingSummaryRowChangedEventHandler Delegate
    GroupUnion Enumeration
   [Expand]HtmlEventArgs Class
    HtmlEventHandler Delegate
   [Expand]IReportDesignTool Interface
   [Expand]MarginBand Class
   [Expand]MultiColumn Class
    MultiColumnMode Enumeration
   [Expand]PageBand Class
    PageBreak Enumeration
   [Expand]PageFooterBand Class
   [Expand]PageHeaderBand Class
   [Expand]ParameterBinding Class
   [Expand]ParameterBindingCollection Class
   [Expand]PdfStreamingExporter Class
   [Expand]PreviewMouseEventArgs Class
    PreviewMouseEventHandler Delegate
   [Expand]PrintableComponentContainer Class
   [Expand]PrintOnPageEventArgs Class
    PrintOnPageEventHandler Delegate
    ProcessDuplicatesMode Enumeration
    ProcessDuplicatesTarget Enumeration
    ProcessHiddenCellMode Enumeration
    PromptBoolean Enumeration
   [Expand]ReportDesignTool Class
   [Expand]ReportFooterBand Class
   [Expand]ReportHeaderBand Class
   [Expand]ReportPrintOptions Class
    ReportUnit Enumeration
   [Expand]ReportUnitExtensions Class
    RestrictionLevel Enumeration
    RightToLeft Enumeration
    RightToLeftLayout Enumeration
   [Expand]SaveComponentsEventArgs Class
   [Expand]SerializableString Class
    SerializationFormat Enumeration
    SnappingMode Enumeration
   [Expand]SortingOptions Class
    SortingSummaryFunction Enumeration
    SparklineImageType Enumeration
   [Expand]StyleFlagsBase Class
   [Expand]StylePriority Class
   [Expand]StyleUsing Class
   [Expand]SubBand Class
   [Expand]SubBandCollection Class
   [Expand]SubreportBase Class
   [Expand]SubreportBaseScripts Class
    SummaryFunc Enumeration
   [Expand]SummaryGetResultEventArgs Class
    SummaryGetResultHandler Delegate
    SummaryRunning Enumeration
   [Expand]TextEditOptions Class
    TextFitMode Enumeration
   [Expand]TextFormatEventArgs Class
    TextFormatEventHandler Delegate
   [Expand]TopMarginBand Class
   [Expand]TruncatedControlScripts Class
   [Expand]ValueBinding Class
    ValueSuppressType Enumeration
   [Expand]VerticalBand Class
   [Expand]VerticalDetailBand Class
   [Expand]VerticalHeaderBand Class
   [Expand]VerticalTotalBand Class
   [Expand]WinControlContainer Class
    WinControlDrawMethod Enumeration
    WinControlImageType Enumeration
    WinControlPrintMode Enumeration
   [Expand]WindowControlOptions Class
   [Expand]XRAppearanceObject Class
   [Expand]XRBarCode Class
    XRBarCodeOrientation Enumeration
   [Expand]XRBinding Class
   [Expand]XRBindingCollection Class
   [Expand]XRCharacterComb Class
   [Expand]XRCharacterCombScripts Class
   [Expand]XRChart Class
   [Expand]XRChartScripts Class
   [Expand]XRCheckBox Class
    XRColumnSortOrder Enumeration
   [Expand]XRControl Class
   [Expand]XRControlCollection Class
   [Expand]XRControlCollectionBase Class
   [Expand]XRControlEvents Class
   [Expand]XRControlScripts Class
   [Expand]XRControlStyle Class
   [Expand]XRControlStyleSheet Class
   [Expand]XRCrossBandBox Class
   [Expand]XRCrossBandControl Class
   [Expand]XRCrossBandControlCollection Class
   [Expand]XRCrossBandLine Class
    XRDockStyle Enumeration
   [Expand]XRFieldEmbeddableControl Class
   [Expand]XRGauge Class
   [Expand]XRGaugeScripts Class
   [Expand]XRGroupSortingSummary Class
   [Expand]XRLabel Class
   [Expand]XRLabelScripts Class
   [Expand]XRLine Class
   [Expand]XRLineScripts Class
   [Expand]XRPageBreak Class
   [Expand]XRPageBreakScripts Class
   [Expand]XRPageInfo Class
   [Expand]XRPanel Class
   [Expand]XRPanelScripts Class
   [Expand]XRPictureBox Class
   [Expand]XRPictureboxScripts Class
   [Expand]XRPivotGrid Class
   [Expand]XRPivotGridScripts Class
   [Expand]XRRichText Class
   [Expand]XRRichTextBase Class
   [Expand]XRRichTextBox Class
   [Expand]XRRichTextBoxBase Class
    XRRichTextStreamType Enumeration
   [Expand]XRScriptsBase Class
   [Expand]XRShape Class
   [Expand]XRShapeScripts Class
   [Expand]XRSparkline Class
   [Expand]XRSparklineScripts Class
   [Expand]XRSubreport Class
   [Expand]XRSummary Class
   [Expand]XRSummaryEvents Class
   [Expand]XRSummaryScripts Class
   [Expand]XRTable Class
   [Expand]XRTableCell Class
   [Expand]XRTableCellCollection Class
   [Expand]XRTableOfContents Class
   [Expand]XRTableOfContentsLevel Class
   [Expand]XRTableOfContentsLevelBase Class
   [Expand]XRTableOfContentsLevelCollection Class
   [Expand]XRTableOfContentsTitle Class
   [Expand]XRTableRow Class
   [Expand]XRTableRowCollection Class
   [Expand]XRTableScripts Class
   [Expand]XRWatermark Class
   [Expand]XRZipCode Class
   [Collapse]XtraReport Class
     XtraReport Members
     XtraReport Constructor
    [Expand]XtraReport Properties
    [Expand]XtraReport Events
    [Expand]XtraReport Methods
   [Expand]XtraReportBase Class
   [Expand]XtraReportBaseScripts Class
   [Expand]XtraReportDesignerExtensions Class
   [Expand]XtraReportScripts Class
  [Expand]DevExpress.XtraReports.UI.BarCode
  [Expand]DevExpress.XtraReports.UI.PivotGrid
  [Expand]DevExpress.XtraReports.UserDesigner
  [Expand]DevExpress.XtraReports.Web
  [Expand]DevExpress.XtraReports.Web.Azure.ReportDesigner
  [Expand]DevExpress.XtraReports.Web.Azure.WebDocumentViewer
  [Expand]DevExpress.XtraReports.Web.ClientControls
  [Expand]DevExpress.XtraReports.Web.ClientControls.DataContracts
  [Expand]DevExpress.XtraReports.Web.DocumentViewer
  [Expand]DevExpress.XtraReports.Web.DocumentViewer.Ribbon
  [Expand]DevExpress.XtraReports.Web.Extensions
  [Expand]DevExpress.XtraReports.Web.Localization
  [Expand]DevExpress.XtraReports.Web.QueryBuilder
  [Expand]DevExpress.XtraReports.Web.QueryBuilder.Native
  [Expand]DevExpress.XtraReports.Web.QueryBuilder.Services
  [Expand]DevExpress.XtraReports.Web.ReportDesigner
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.DataContracts
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Native
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Services
  [Expand]DevExpress.XtraReports.Web.Scripts
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer.DataContracts
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer.Native
  [Expand]DevExpress.XtraReports.Wizards
  [Expand]DevExpress.XtraReports.Wizards.Builder
  [Expand]DevExpress.XtraReports.Wizards.ColorSchemes
  [Expand]DevExpress.XtraReports.Wizards.Labels
  [Expand]DevExpress.XtraReports.Wizards.Presenters
  [Expand]DevExpress.XtraReports.Wizards.Templates
  [Expand]DevExpress.XtraReports.Wizards.Views
  [Expand]DevExpress.XtraReports.Wizards3
  [Expand]DevExpress.XtraReports.Wizards3.Presenters
  [Expand]DevExpress.XtraReports.Wizards3.Views
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

XtraReport Members

The base class for any report created using the XtraReports Suite.

Expanded Public Constructors

Show: Inherited
  Name Description
Public method XtraReport Initializes a new instance of the XtraReport class with the default settings.
Top

Expanded Public Properties

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

Expanded Public Methods

Show: Inherited
  Name Description
Public method AllControls<T> Returns a collection that contains all controls found within XRControl (within a report). (Inherited from XRControl)
Public method 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)
Public method BeginInit For internal use. Starts the XtraReport's initialization. Initialization occurs at runtime.
Public method BeginUpdate Starts the XtraReport's runtime initialization.
Public method BringToFront Brings the control to the front of the z-order. (Inherited from XRControl)
Public method CollectParameters For internal use. Collects all report parameters that satisfy the specified conditions.
Public methodStatic member CreateBand Creates a band of the specified type. (Inherited from XtraReportBase)
Public method CreateDocument Overloaded. Creates a document from the XtraReport object, so it can be displayed or printed.
Public method CreateLayoutViewDocument For internal use. Creates a report document for editing using a Silverlight Report Designer.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public methodStatic member CreatePrintingSystem Creates a Printing System for the report.
Public method Dispose Releases all resources used by the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public method EndInit For internal use. Ends the XtraReport's initialization.
Public method EndUpdate Ends the XtraReport's runtime initialization.
Public methodStatic member EnsureStaticConstructor This method is intended for internal use only. Normally, you don't need to use it.
Public method Equals Determines whether the specified System.Object is equal to the current System.Object. (Inherited from System.Object)
Public methodStatic member Equals Determines whether the specified System.Object instances are considered equal. (Inherited from System.Object)
Public method ExportToCsv Overloaded. Exports a report to the specified stream in CSV format.
Public method ExportToDocx Overloaded. Exports a report to the specified file path in DOCX format.
Public method ExportToHtml Overloaded. Exports a report to the specified stream in HTML format.
Public method ExportToImage Overloaded. Exports a report to the specified file path using the specified image format.
Public method ExportToMail Overloaded. Exports a document to HTML and then inserts it into a specified e-mail.
Public method ExportToMht Overloaded. Exports a report to the specified file path in MHT format using the specified MHT-specific options.
Public method ExportToPdf Overloaded. Exports a report to the specified stream in PDF using the specified PDF-specific options.
Public method ExportToRtf Overloaded. Exports a report to the specified stream in RTF format.
Public method ExportToText Overloaded. Exports a report to the specified file path in Text format using the specified Text-specific options.
Public method ExportToXls Overloaded. 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 DevExpress.XtraGrid.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.
Public method ExportToXlsx Overloaded. Exports a report to the specified stream in XLSX format.This method exports data in WYSIWYG mode. Certain controls (e.g., a DevExpress.XtraGrid.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.
Public method FillDataSource Populates a data source, which is assigned to a report's XtraReportBase.DataSource property. (Inherited from XtraReportBase)
Public method FindControl Finds the control that has the specified name in the XRControl.Controls collection. (Inherited from XRControl)
Public method FromDisplayName Obtains the real name of a data field, based on the field's display name. (Inherited from XtraReportBase)
Public methodStatic member FromFile Loads the report definition from the specified REPX file.
Public methodStatic member FromStream 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.
Public method GetCurrentColumnValue Gets the current value of the specified column in the report's XtraReportBase.DataSource. (Inherited from XtraReportBase)
Public method GetCurrentColumnValue<T> Gets the current value (strongly typed) of the specified column in the report's XtraReportBase.DataSource. (Inherited from XtraReportBase)
Public method GetCurrentRow Returns the current data row in the report's data source. (Inherited from XtraReportBase)
Public method GetEffectiveBackColor Returns the color actually used as the control's background color. (Inherited from XRControl)
Public method GetEffectiveBorderColor Returns the color actually used as the control's border color. (Inherited from XRControl)
Public method GetEffectiveBorderDashStyle Returns the border dash style that is actually used by the control. (Inherited from XRControl)
Public method GetEffectiveBorders Returns the borders settings actually used as the control's borders settings. (Inherited from XRControl)
Public method GetEffectiveBorderWidth Returns the border width settings actually used as the control's current settings. (Inherited from XRControl)
Public method GetEffectiveFont Returns the font actually used as the control's font. (Inherited from XRControl)
Public method GetEffectiveForeColor Returns the color actually used as the control's foreground color. (Inherited from XRControl)
Public method GetEffectivePadding Returns the padding values actually used as the control's padding. (Inherited from XRControl)
Public method 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)
Public method GetEffectiveTextAlignment Returns the text alignment actually used as the control's text alignment. (Inherited from XRControl)
Public method GetHashCode Serves as a hash function for a particular type. System.Object.GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from System.Object)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method GetNextColumnValue Gets the next value of the specified column in the report's XtraReportBase.DataSource. (Inherited from XtraReportBase)
Public method GetNextColumnValue<T> Gets the next value (strongly typed) of the specified column in the report's XtraReportBase.DataSource. (Inherited from XtraReportBase)
Public method GetNextRow Returns the next data row in the report's data source. (Inherited from XtraReportBase)
Public method GetPreviousColumnValue Gets the previous value of the specified column in the report's XtraReportBase.DataSource. (Inherited from XtraReportBase)
Public method GetPreviousColumnValue<T> Gets the previous value (strongly typed) of the specified column in the report's XtraReportBase.DataSource. (Inherited from XtraReportBase)
Public method GetPreviousRow Returns the previous data row in the report's data source. (Inherited from XtraReportBase)
Public method GetType Gets the System.Type of the current instance. (Inherited from System.Object)
Public method HasExportWarningControls Returns a collection of controls for which export warnings exist.
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method IterateReportsRecursive For internal use. (Inherited from XtraReportBase)
Public method LoadLayout Overloaded. Loads the report's definition (layout and configuration) from a System.IO.Stream object in the REPX format.
Public method LoadLayoutFromXml Overloaded.
Public method ModifyDocument Adds and/or removes the report's document pages.
Public method PerformLayout Forces the control to apply layout logic to itself and all its child controls. (Inherited from XRControl)
Public methodStatic member ReferenceEquals Determines whether the specified System.Object instances are the same instance. (Inherited from System.Object)
Public method RemoveInvalidBindings Removes inappropriate bindings assigned to the XRControl's properties. (Inherited from XRControl)
Public method 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)
Public method 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)
Public method ResetBorderDashStyle Resets the XRControl.BorderDashStyle property to en empty value. (Inherited from XRControl)
Public method 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)
Public method 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)
Public method 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)
Public method 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)
Public method 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)
Public method 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)
Public method ResumeLayout Resumes normal layout logic for the control. (Inherited from XRControl)
Public method SaveLayout Overloaded. Saves the report's definition (layout and configuration) to a System.IO.Stream object in the REPX data format.
Public method SaveLayoutToXml Overloaded. Save the report in XML format to the specified file.
Public method SendToBack Sends the control to the back of the z-order. (Inherited from XRControl)
Public method StopPageBuilding Interrupts the process of document creation.
Public method SuspendLayout Temporarily suspends the layout logic for the control. (Inherited from XRControl)
Public method ToImage Overloaded. Replaces the XRControl.ToImage method. (Inherited from Band)
Public method ToString Returns a System.String containing the name of the System.ComponentModel.Component, if any. This method should not be overridden. (Inherited from System.ComponentModel.Component)
Public methodStatic member UnitToDpi Obsolete. Converts report measurement units into screen coordinates.
Public method ValidateScripts Validates report scripts.
Top

Expanded Public Fields

Show: Inherited
  Name Description
Public fieldStatic member DefaultHorizontalContentSplitting Always DevExpress.XtraPrinting.HorizontalContentSplitting.Smart.
Public fieldStatic member DefaultPageSize A System.Drawing.Size object representing the default page size (850 by 1100 hundredths of an inch) used for reports.
Public fieldStatic member DefaultPaperKind Represents the default paper type (System.Drawing.Printing.PaperKind.Letter) used in a report.
Top

Expanded Public Events

Show: Inherited
  Name Description
Public event AfterPrint Occurs after an XRControl object is displayed in the report. (Inherited from XRControl)
Public event BandHeightChanged Occurs when the height of any band in the collection returned by the XtraReportBase.Bands property changes. (Inherited from XtraReportBase)
Public event BeforePrint Occurs before an XRControl object creates its image in a report being generated. (Inherited from XRControl)
Public event DataSourceDemanded Occurs before report generation, to specify a data source for the report. (Inherited from XtraReportBase)
Public event DataSourceRowChanged Occurs when the current row in the report's data source has been changed. (Inherited from XtraReportBase)
Public event DesignerLoaded Occurs after the End-User Designer has been loaded for the current report instance.
Public event Disposed Occurs when the component is disposed by a call to the System.ComponentModel.Component.Dispose method. (Inherited from System.ComponentModel.Component)
Public event Draw Overrides the XRControl.Draw event. (Inherited from Band)
Public event EvaluateBinding Overrides the XRControl.EvaluateBinding event to hide it. (Inherited from Band)
Public event FillEmptySpace Fires after page rendering if a gap remains between the rendered bands.
Public eventStatic member FilterComponentProperties Occurs every time the Property Grid refreshes its item list in the End-User Designer.
Public eventStatic member FilterControlProperties Obsolete. Occurs every time the Property Grid refreshes its item list in the End-User Designer.
Public event HeightChanged Occurs when the band height is changed. (Inherited from Band)
Public event HtmlItemCreated Overrides the XRControl.HtmlItemCreated property.
Public event LocationChanged Overrides the XRControl.LocationChanged event. (Inherited from Band)
Public event ParametersRequestBeforeShow Occurs before displaying the Parameters panel in a Print Prevew.
Public event ParametersRequestSubmit Occurs when all parameter values in the Parameters UI are entered, and the Submit button is pressed.
Public event ParametersRequestValueChanged Occurs when the parameter values are changed in the Parameters UI.
Public event ParentChanged Overrides the XRControl.ParentChanged event. (Inherited from Band)
Public event PreviewClick Hides the inappropriate XRControl.PreviewClick event of the parent XRControl class. (Inherited from Band)
Public event PreviewDoubleClick Hides the inappropriate XRControl.PreviewDoubleClick event of the parent XRControl class. (Inherited from Band)
Public event PreviewMouseDown Hides the inappropriate XRControl.PreviewMouseDown event of the parent XRControl class. (Inherited from Band)
Public event PreviewMouseMove Hides the inappropriate XRControl.PreviewMouseMove event of the parent XRControl class. (Inherited from Band)
Public event PreviewMouseUp Hides the inappropriate XRControl.PreviewMouseUp event of the parent XRControl class. (Inherited from Band)
Public event PrintOnPage Overrides the XRControl.PrintOnPage event to hide it. (Inherited from Band)
Public event PrintProgress Occurs before sending every document page to a printer to indicate the current printing progress.
Public event 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.
Public event SizeChanged Overrides the XRControl.SizeChanged event. (Inherited from Band)
Public event TextChanged Overrides the XRControl.TextChanged event. (Inherited from Band)
Top

Expanded See Also

Is this topic helpful?​​​​​​​