[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]CheckBoxGlyphOptions Class
   [Expand]CheckBoxGlyphs Class
   [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]HierarchyPrintOptions Class
   [Expand]HtmlEventArgs Class
    HtmlEventHandler Delegate
   [Expand]ImageEditOptions Class
   [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
    VerticalBandLayout Enumeration
   [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
   [Collapse]XRControl Class
     XRControl Members
     XRControl Constructor
    [Expand]XRControl Properties
    [Expand]XRControl Events
    [Expand]XRControl Methods
   [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
   [Expand]XtraReport Class
   [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)

XRControl Members

The base class for all visual controls used for creating reports.

Expanded Public Constructors

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

Expanded Public Properties

Show: Inherited
  Name Description
Public property AnchorHorizontal Specifies the horizontal anchoring style of a report control.
Public property AnchorVertical Specifies the vertical anchoring style of a report control.
Public property BackColor Gets or sets the control's background color.
Public property Band Provides access to the owner band, in which the current control is situated.
Public property Bookmark Bindable. Gets or sets the text of a bookmark for this control.
Public property BookmarkParent Gets or sets the report control whose bookmark is the parent of the current bookmark.
Public property BorderColor Gets or sets the control's border color.
Public property BorderDashStyle Specifies the dash style for the control's border.
Public property Borders Specifies a set of borders (top, right, bottom, left) that should be visible for the control.
Public property BorderWidth Specifies the width of cell borders in pixels, as a floating point value.
Public property Bottom For internal use.
Public property BottomF Gets the Y-coordinate of the control's bottom edge (measured in report units).
Public property Bounds For internal use.
Public property BoundsF Specifies the location and size of a report element, according to the system of measurement selected for the report.
Public property CanGrow Gets or sets a value indicating whether the control's height can grow in order to display the content in its entirety.
Public property CanHaveChildren Gets a value indicating whether the control can contain other controls.
Public property CanPublish Specifies whether or not a report control is displayed in a printed or exported document.
Public property CanShrink Gets or sets a value indicating whether the control's height can decrease if its contents do not completely fill the control.
Public property Container Gets the System.ComponentModel.IContainer that contains the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property Controls Gets the collection of XRControl objects or their descendants that are contained in this control.
Public property ControlType For internal use.
Public property DataBindings Provides access to the collection of a control's bindings.
Public property Dock Overloaded. For internal use.
Public property Dpi For internal use.
Public property DrillDownKey For internal use.
Public property EvenStyleName Gets or sets the current even style for the control.
Public property ExpressionBindings Provides access to a control's collection of expression bindings.
Public property Font Gets or sets the control's font.
Public property ForeColor Gets or sets the control's foreground color.
Public property FormattingRuleLinks For internal use.
Public property FormattingRules Provides access to a collection of formatting rules applied to this control.
Public property HasChildren Gets a value indicating whether the control contains other XRControl objects.
Public property Height For internal use.
Public property HeightF Specifies the control's height (measured in report units).
Public property Index Gets the zero-based index of this control in its parent's collection of controls.
Public property IsDisposed For internal use. Gets a value indicating whether the control has been disposed of.
Public property IsSingleChild Checks whether the report element (control or band) is a single child of its parent.
Public property KeepTogether Specifies whether a control can be split across pages.
Public property Left For internal use.
Public property LeftF Specifies the X-coordinate of the control's left edge (measured in report units).
Public property Location For internal use.
Public property LocationF Specifies the floating-point representation of the coordinates of the control's upper-left corner.
Public property LocationFloat For internal use. Supports serialization of the LocationF property.
Public property LockedInUserDesigner Gets or sets a value that specifies whether this control can be changed by an end-user in the End-User Designer.
Public property Name Gets or sets a name of the control.
Public property NavigateUrl Bindable. Specifies the URL to navigate to when the control is clicked.
Public property NullValueText For internal use.
Public property OddStyleName Gets or sets the current odd style for the control.
Public property Padding Gets or sets the control's padding values (measured in report units).
Public property Parent Specifies the parent object that contains the current control.
Public property ParentStyleUsing For internal use.
Public property ProcessDuplicates Obsolete. For internal use.
Public property ProcessDuplicatesMode For internal use.
Public property ProcessDuplicatesTarget For internal use.
Public property ProcessNullValues For internal use.
Public property Report Provides access to the report that contains the control.
Public property Right For internal use.
Public property RightF Gets the X-coordinate of the control's right edge (measured in report units).
Public property RightToLeft For internal use.
Public property RootReport Provides access to the report to which the control belongs.
Public property Scripts Provides access to an object that contains XRControl-specific scripts to handle its events in the End-User Report Designer.
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.
Public property SizeF Gets or sets the size of the control.
Public property SnapLineMargin Specifies the control's margins that are maintained when the control is aligned using snap lines.
Public property SnapLinePadding For internal use.
Public property StyleName Gets or sets the name of the style, which is applied to the current control.
Public property StylePriority Provides access to the settings that determine which properties of a style assigned to a control should override the corresponding properties of a control.
Public property Styles Gets a set of styles for the control.
Public property Tag Bindable. Gets or sets the object that contains data about this control.
Public property Target Specifies the target window or frame in which to display the linked Web page's content, when the control is clicked.
Public property Text Bindable. Specifies the control's text.
Public property TextAlignment Specifies the alignment of the control's text.
Public property TextFormatString For internal use.
Public property TextTrimming For internal use.
Public property Top For internal use.
Public property TopF Gets or sets the Y-coordinate of the control's top edge (measured in report units).
Public property Value For internal use.
Public property Visible Gets or sets a value indicating whether or not the report control is displayed in a document.
Public property Width For internal use.
Public property WidthF Specifies the control's width (measured in report units).
Public property WordWrap Indicates whether a control automatically wraps words to the beginning of the next line when necessary.
Public property XlsxFormatString Specifies the native Excel format to be imported to the control's content after the report is exported to an Excel file (XLS or XLSX).
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).
Public method BringToFront Brings the control to the front of the z-order.
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 method Dispose Releases all resources used by the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public methodStatic member Equals Determines whether the specified System.Object instances are considered equal. (Inherited from System.Object)
Public method Equals Determines whether the specified System.Object is equal to the current System.Object. (Inherited from System.Object)
Public method FindControl Finds the control that has the specified name in the Controls collection.
Public method GetEffectiveBackColor Returns the color actually used as the control's background color.
Public method GetEffectiveBorderColor Returns the color actually used as the control's border color.
Public method GetEffectiveBorderDashStyle Returns the border dash style that is actually used by the control.
Public method GetEffectiveBorders Returns the borders settings actually used as the control's borders settings.
Public method GetEffectiveBorderWidth Returns the border width settings actually used as the control's current settings.
Public method GetEffectiveFont Returns the font actually used as the control's font.
Public method GetEffectiveForeColor Returns the color actually used as the control's foreground color.
Public method GetEffectivePadding Returns the padding values actually used as the control's padding.
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.
Public method GetEffectiveTextAlignment Returns the text alignment actually used as the control's text alignment.
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 GetType Gets the System.Type of the current instance. (Inherited from System.Object)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method PerformLayout Forces the control to apply layout logic to itself and all its child controls.
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.
Public method ResetBackColor Resets the BackColor property value, so that it is no longer stored in the current control and is obtained from its parent instead.
Public method ResetBorderColor Resets the BorderColor property value, so that it is no longer stored in the current control and is obtained from its parent instead.
Public method ResetBorderDashStyle Resets the BorderDashStyle property to en empty value.
Public method ResetBorders Resets the Borders property value, so that it is no longer stored in the current control and is obtained from its parent instead.
Public method ResetBorderWidth Resets the BorderWidth property value, so that it is no longer stored in the current control and is obtained from its parent instead.
Public method ResetFont Resets the Font property value, so that it is no longer stored in the current control and is obtained from its parent instead.
Public method ResetForeColor Resets the ForeColor property value, so that it is no longer stored in the current control and is obtained from its parent instead.
Public method ResetPadding Resets the Padding property value, so that it is no longer stored in the current control and is obtained from its parent instead.
Public method ResetTextAlignment Resets the TextAlignment property value, so that it is no longer stored in the current control and is obtained from its parent instead.
Public method ResumeLayout Resumes normal layout logic for the control.
Public method SendToBack Sends the control to the back of the z-order.
Public method SuspendLayout Temporarily suspends the layout logic for the control.
Public method ToImage Overloaded. Returns a graphical representation of a control.
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)
Top

Expanded Public Events

Show: Inherited
  Name Description
Public event AfterPrint Occurs after an XRControl object is displayed in the report.
Public event BeforePrint Occurs before an XRControl object creates its image in a report being generated.
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 Occurs when an XRControl object is drawn or redrawn in a report's Print Preview.
Public event EvaluateBinding Occurs after a data-bound XRControl object obtains data from its data source.
Public event HtmlItemCreated Occurs when a new item used for a Web representation of the control is created.
Public event LocationChanged Occurs when the value of the Location property is changed.
Public event ParentChanged Occurs when the XRControl instance's parent is changed.
Public event PreviewClick Occurs when the mouse button is clicked while the cursor is hovering over one of the bricks created by the XRControl for its representation in the report preview.
Public event PreviewDoubleClick Occurs when the left mouse button is double-clicked while the cursor is hovering over one of the bricks created for the control's representation in the report preview.
Public event PreviewMouseDown Occurs when an end-user presses the mouse button while the mouse pointer is hovering over one of the bricks created for the control's representation in the report preview.
Public event PreviewMouseMove Occurs when the mouse cursor moves over the control during the report's preview.
Public event PreviewMouseUp Occurs when an end-user releases the left mouse button while the mouse pointer is hovering over one of the bricks created for the control's representation in the report preview.
Public event PrintOnPage Occurs when the representation of a control is printed on the current page of the report.
Public event SizeChanged Occurs when the value of the Size property is changed.
Public event TextChanged Occurs when the value of the Text property is changed.
Top

Expanded See Also

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