DevExpress.XtraReports.UI Namespace

Contains classes that implement the basic functionality of XtraReports.

Assemblies: DevExpress.XtraReports.v24.1.dll, DevExpress.XtraReports.v24.1.Extensions.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.Win.Reporting

Classes

Name	Description
Band	The base for classes that provide functionality to report bands.
BandCollection	A collection of Band objects.
BandEventArgs	Provides data for the events that are associated with a band.
BandFactory	Enables you to customize the process of creating report bands in the End-User Report Designer.
BandScripts	Contains names of the scripts for report bands.
BestSizeEstimator static	Enables you to find optimal boundaries to fit the text, and vice versa, get a font to fit the specified boundaries.
BindingEventArgs	Provides data for the XRControl.EvaluateBinding event.
BottomMarginBand	A report band used to display information at the bottom margin of every report page. This band cannot be deleted from a report.
CalculatedField	A calculated field.
CalculatedFieldCollection	A collection of CalculatedField objects.
CalculatedFieldScripts	Contains names of the scripts for a calculated field.
ChangeEventArgs	Provides data for the events that are associated with changes to property values.
CheckBoxGlyphOptions	Provides access to a control’s glyph options.
CheckBoxGlyphs	Contains checkbox glyph custom images.
CheckEditOptions	Provides options that define whether and how a check box’s content can be edited in Print Preview.
DataSourceRowEventArgs	Provides data for the XtraReportBase.DataSourceRowChanged event.
DesignerOptions	Allows you to disable certain report layout validation indicators.
DetailBand	The main report band used to display recurrent data records from a report’s data source. This band cannot be deleted from a report.
DetailReportBand	A report band containing a nested detail report.
DetailReportBandCollection	A collection of DetailReportBand objects.
DrawEventArgs	Provides data for the XRControl.Draw event.
EditOptions	A base class for classes that provide options defining whether and how a control’s content can be edited in Print Preview.
ExpressionBinding	Provides functionality to expression bindings.
ExpressionBindingCollection	A collection of ExpressionBinding objects.
ExternalFileAccessSecurityLevelSettings static	Obsolete. This API is obsolete now.
Formatting	A container of values, which are applied to a control when its owner Formatting Rule‘s condition is true.
FormattingRule	A Formatting Rule object.
FormattingRuleCollection	A collection of FormattingRule objects.
FormattingRuleSheet	A repository of FormattingRule objects.
GetValueEventArgs	Provides data for the CalculatedField.GetValue event.
GroupBand	The base for the GroupHeaderBand and GroupFooterBand classes that are used to group report data.
GroupBandScripts	Contains the names of the scripts assigned to GroupBand.
GroupField	Defines the objects used as criteria when creating groups in Reports.
GroupFieldCollection	A collection of GroupField objects.
GroupFooterBand	A report band used for displaying information at the end of a group of records.
GroupHeaderBand	A report band used for specifying grouping criteria and displaying information at the beginning of a group of records.
GroupHeaderBandScripts	Contains the names of the scripts assigned to GroupHeaderBand.
GroupSortingSummaryGetResultEventArgs	Provides data for the GroupHeaderBand.SortingSummaryGetResult event.
GroupSortingSummaryRowChangedEventArgs	Provides data for the GroupHeaderBand.SortingSummaryRowChanged event.
HierarchyPrintOptions	Specifies hierarchy print settings.
HtmlEventArgs	Provides data for the XRControl.HtmlItemCreated event.
ImageEditOptions	Provides options that define whether and how a picture box‘s content can be edited in Print Preview.
MarginBand	The base for the TopMarginBand and BottomMarginBand classes.
MultiColumn	Provides the multi-column functionality for reports.
PageBand	The base for the PageHeaderBand and PageFooterBand classes.
PageFooterBand	A report band used to display information at the end of every report page.
PageHeaderBand	A report band used to display information at the beginning of every report page.
ParameterBinding	Enables you to pass the value of a report parameter to a subreport placed in a another report.
ParameterBindingBase	A base class for parameters of report controls.
ParameterBindingCollection	A collection of ParameterBinding objects.
PdfStreamingExporter	Provides the functionality for exporting reports to PDF in streaming modes.
PreviewMouseEventArgs	Provides data for the XRControl.PreviewClick, XRControl.PreviewDoubleClick, XRControl.PreviewMouseMove, XRControl.PreviewMouseDown and XRControl.PreviewMouseUp events.
PrintableComponentContainer	A container that is used to add DevExpress controls, Windows Forms controls, controls that implement the IPrintable interface, and documents created using printing links to a report.
PrintOnPageEventArgs	Provides data for the XRControl.PrintOnPage event.
ReportDesignTool	An instrument for editing reports in WinForms applications.
ReportFooterBand	A report band used to display the report footer. Report controls placed on this band are displayed once at the end of the report.
ReportHeaderBand	A report band used to display a report’s header. Report controls placed on this band are displayed once, at the beginning of the report.
ReportPrintOptions	Provides options that define how a report is printed in various circumstances.
ReportUnitExtensions static	Provides extension methods for the ReportUnit class, enabling you to obtain a floating number representation of a specific unit of measurement.
SaveComponentsEventArgs	Provides data for the XtraReport.SaveComponents event.
SerializableString	For internal use. Provides serialization functionality in the XtraReports Suite.
SignatureOptions	Contains settings for an XRPdfSignature control.
SortingOptions	Provides options specifying how to sort a report in Print Preview.
StyleFlagsBase	The base for the StylePriority and StyleUsing classes.
StylePriority	A container of settings that determine which properties of a style assigned to a control should override the corresponding properties of a control.
StyleUsing	An object that determines which of a style’s properties are used by an XRControl object.
SubBand	A report band that is a copy of the source band located above it.
SubBandCollection	A collection of SubBand objects.
SubreportBase	The base class for the XRSubreport class.
SubreportBaseScripts	Contains the names of the scripts assigned to XRSubreport.
SummaryGetResultEventArgs	Provides data for the XRLabel.SummaryGetResult event.
TextEditOptions	Provides options that define whether and how a control’s content can be edited in Print Preview.
TextFormatEventArgs	Provides data for the XRLabel.SummaryCalculated event.
TopMarginBand	A report band used to display information at the top margin of every report page. The End User Report Designer does not allow you to remove this band from a report.
TruncatedControlScripts	Contains the names of the scripts for certain report controls.
ValueBinding	Obsolete. Enables you to use an XRChart to visualize data in report groups without writing report scripts.
VerticalBand	A base class for vertical bands
VerticalDetailBand	A vertical band that displays recurring content from the report’s data source.
VerticalHeaderBand	A vertical band that goes before the Vertical Detail band.
VerticalTotalBand	A vertical band that goes after the Vertical Detail band.
WinControlContainer	A container that is used to embed a Control class instance or descendants into a report.
WindowControlOptions	Specifies how to print a control assigned to a PrintableComponentContainer.
XRAppearanceObject	Provides the appearance settings for the XRPivotGrid control’s elements.
XRBarCode	Displays a bar code in a report.
XRBinding	A simple binding between the property value of an object and the property value of an instance of the XRControl class or one of its descendants.
XRBindingCollection	Provides methods and properties for creating a collection of XRBinding objects.
XRCharacterComb	A Character Comb control that displays text so that each character is printed in an individual cell.
XRCharacterCombScripts	Contains the names of the scripts assigned to XRCharacterComb.
XRChart	A Chart control.
XRChartScripts	Contains names of the scripts for an XRChart control.
XRCheckBox	A Checkbox control.
XRControl	The base class for all visual controls used for creating reports.
XRControl.XRControlStyles	Defines the XRControl style.
XRControlCollection	A collection of XRControl objects.
XRControlCollectionBase	Serves as the base class for classes that represent collections of XRControl class descendants.
XRControlEvents	Used to implement scripting for report bands and controls.
XRControlParameter	A control’s parameter that enables you to pass values outside the control’s data source.
XRControlParameterCollection	A collection of control parameters.
XRControlScripts	Contains names of the scripts for all report controls.
XRControlStyle	An individual style object that is also a base for all conditional formatting objects.
XRControlStyleSheet	Provides functionality for an object used as a repository for the XRControl‘s styles.
XRCrossBandBox	A box that can be drawn across several report bands.
XRCrossBandControl	The base for controls which are not restricted to a particular Band, but are drawn across multiple bands based on the specified start and end points.
XRCrossBandControlCollection	A collection of XRCrossBandControl objects.
XRCrossBandLine	A vertical line that can be drawn across several report bands.
XRCrossTab	Displays multi-dimensional data in reports.
XRCrossTabCellScripts	Contains the names of the scripts assigned to XRCrossTabCell.
XRCrossTabScripts	Contains the names of the scripts assigned to XRCrossTab.
XRFieldEmbeddableControl	The base for all report controls that support the data binding using embedded fields.
XRGauge	A control that allows you to embed graphical gauges in a report.
XRGaugeScripts	Contains the names of the scripts assigned to XRGauge.
XRGroupSortingSummary	Contains settings that define the sorting of groups by summary function results.
XRLabel	A Label control.
XRLabelScripts	Contains names of the scripts for an XRLabel control.
XRLine	A control that allows you to draw lines in reports.
XRLineScripts	Contains names of the scripts for an XRLine control.
XRPageBreak	A Page Break control that defines a page delimiter in a report.
XRPageBreakScripts	Contains names of the scripts for an XRPageBreak control.
XRPageInfo	A Page Information control that is used to display auxiliary information on report pages.
XRPanel	A Panel control that can contain other controls.
XRPanelScripts	Contains the names of the scripts assigned to XRPanel.
XRPdfContent	A control that renders PDF file content in a report.
XRPdfContentScripts
XRPdfSignature	Adds a visual signature to a report exported to PDF.
XRPdfSignatureScripts	Contains the names of the scripts assigned to XRPdfSignature controls.
XRPictureBox	A Picture Box control that is used to display an image in a report.
XRPictureboxScripts	Contains the names of the scripts assigned to XRPictureBox.
XRPivotGrid	Displays multi-dimensional data in reports.
XRPivotGridScripts	Contains names of the scripts for an XRPivotGrid control.
XRRichText	A control that displays formatted text in a report.
XRRichTextBase	The base for XRRichText and XRRichTextBox controls.
XRRichTextBox	Obsolete. Use the XRRichText control instead.
XRRichTextBoxBase	The base for the obsolete XRRichTextBox class.
XRScriptsBase	The base for classes which contain names of the scripts for reports, bands and controls.
XRShape	A control that allows you to embed simple graphic elements into a report.
XRShapeScripts	Contains the names of the scripts assigned to XRShape.
XRSparkline	A control that displays a compact chart for report data.
XRSparklineScripts	Contains the names of the scripts assigned to XRSparkline.
XRSubreport	A control used to include the contents of one report in another report.
XRSummary	Provides methods that calculate arithmetic functions for the values in the data source field bound to the XRControl.Text property of the XRLabel control and its descendants.
XRSummaryEvents	Contains the names of the scripts available for XRSummary.
XRSummaryScripts	Contains the names of the scripts assigned to XRSummary.
XRTable	A Table control.
XRTableCell	A cell in an XRTable row.
XRTableCellCollection	A collection of XRTableCell objects.
XRTableOfContents	A control that generates a table of contents in a report composed of sections and their corresponding page numbers based on the hierarchy of bookmarks contained in the report document map.
XRTableOfContentsLevel	An individual level in a Table of Contents.
XRTableOfContentsLevelBase	The base for classes that provide functionality to the XRTableOfContents control levels.
XRTableOfContentsLevelCollection	A collection of levels assigned to a Table of Contents.
XRTableOfContentsScripts
XRTableOfContentsTitle	The title of a Table of Contents.
XRTableRow	A row in an XRTable.
XRTableRowCollection	A collection of XRTableRow objects.
XRTableScripts	Contains the names of the scripts assigned to XRTable.
XRWatermark	A watermark in a report.
XRZipCode	Renders a numeric postal code that is used to identify the mail address in some countries. This control is not related to the Zone Improvement Plan (ZIP) code used by the United States Postal Service.
XtraReport	A DevExpress report.
XtraReportBase	The base for XtraReport and DetailReportBand classes.
XtraReportBaseScripts	Contains names of the scripts for the XtraReportBase class descendants.
XtraReportDesignerExtensions static	Provides extension methods that enable you to load a report in an End-User WinForms Report Designer.
XtraReportScripts	Contains names of the scripts for an XtraReport object.

Interfaces

Name	Description
IReportDesignTool	Provides methods for showing both the standard and ribbon-based End-User Report Designer forms.

Delegates

Name	Description
BandEventHandler	A method that will handle the XtraReportBase.BandHeightChanged event.
BeforePrintEventHandler	A method that will handle the XRControl.BeforePrint and XRCrossBandControl.BeforePrint events.
BindingEventHandler	A method that will handle the XRControl.EvaluateBinding event.
ChangeEventHandler	A method that will handle the events associated with the value changes of any properties.
DataSourceRowEventHandler	A method that will handle the XtraReportBase.DataSourceRowChanged event.
DrawEventHandler	A method that will handle the XRControl.Draw event.
GetValueEventHandler	A method that will handle the CalculatedField.GetValue event.
GroupSortingSummaryGetResultEventHandler	A method that will handle the GroupHeaderBand.SortingSummaryGetResult event.
GroupSortingSummaryRowChangedEventHandler	A method that will handle the GroupHeaderBand.SortingSummaryRowChanged event.
HtmlEventHandler	A method that will handle the XRControl.HtmlItemCreated event.
PreviewMouseEventHandler	A method that will handle the XRControl.PreviewMouseMove and XRControl.PreviewClick events.
PrintOnPageEventHandler	A method that will handle the XRControl.PrintOnPage event.
SummaryGetResultHandler	A method that will handle the XRLabel.SummaryGetResult event.
TextFormatEventHandler	A method that will handle the XRLabel.SummaryCalculated event.

Enums

Name	Description
AutoSizeMode	Specifies whether and how to change the control’s size to fit its content.
BandKind	Specifies the types of bands used in the XtraReports Suite.
ChartImageType	Specifies how the XRChart control should be internally rendered in a report.
ColumnDirection	Obsolete. Specifies the order in which the detail band is printed on a page when the multi-column mode is enabled.
DataBindingMode	Lists the available data binding modes.
DefaultCrossTabControl	Lists controls that can be used to display cross-tab data.
DesignWindowType	Specifies the type of the End-User Designer tool window.
ExternalFileAccessSecurityLevel	Obsolete. This API is obsolete now.
GaugeImageType	Enumerates values that specify how the GaugeImageType control should be internally rendered in a report.
GroupFooterUnion	Specifies how a group footer is positioned with respect to its group in a report.
GroupUnion	Specifies how groups of records should be split across pages, if required.
MultiColumnMode	Specifies which multi-column properties will be taken into account if the multi-column feature is enabled.
PageBreak	Specifies where to make a page break, with respect to the given band.
PrintLayout	Lists values that specify how to print the Cross Tab across several pages.
ProcessDuplicatesMode	Lists modes that specify how to process report controls with duplicate values.
ProcessDuplicatesTarget	Lists control characteristics whose duplicate values are processed.
ProcessHiddenCellMode	Lists modes used to specify how to fill the gap of a hidden cell in the XRTable control.
PromptBoolean	Lists values that specify whether and how to convert legacy reports to the new binding mode when opening them in the End-User Report Designer.
ReportLocalizationMode	Specifies whether the report uses localizaton strings embedded into a report definition or loads the localized resources from satellite resource assemblies.
ReportUnit	Lists the supported systems of measurement.
RestrictionLevel	Lists the options that define whether end-users are allowed to load untrusted reports with potentially dangerous content in desktop reporting applications.
RightToLeft	Lists the modes of assigning the right-to-left feature to a specific control.
RightToLeftLayout	Lists the available right-to-left layout states.
SerializationFormat	Lists the available report serialization formats.
SnappingMode	Specifies the snapping mode of a report.
SortingSummaryFunction	Lists the summary functions available for sorting groups by summary results.
SparklineImageType	Specifies how the XRSparkline control should be internally rendered in a report.
SummaryFunc	Specifies the arithmetic function to be calculated.
SummaryRunning	Specifies the report area for which the selected function is calculated.
SynchronizationMode	Lists the modes that specify how to synchronize document preview options with report page settings.
TextFitMode	Lists modes that are available for changing control text size to fit its boundaries.
ValueSuppressType	Lists the values that specify how to process report controls that receive empty values.
VerticalBandLayout	Specifies whether to display the Vertical Detail band’s content that does not fit on a page on the same page or on the next page.
WinControlDrawMethod	Specifies how the Windows Forms control that is embedded using a WinControlContainer should be drawn in a report.
WinControlImageType	Specifies how the Windows Forms control that is embedded using a WinControlContainer should be internally rendered in a report.
WinControlPrintMode	Specifies how the Windows Forms control that is embedded using a WinControlContainer should be rendered in a report.
XRAccessibleRole	Lists values that define UI element roles in the exported PDF document. These roles are used by assistive technologies.
XRBarCodeOrientation	Obsolete. This enumeration is obsolete and no longer in use. Use the BarCodeOrientation enumeration instead.
XRColumnSortOrder	Specifies the sorting order for a group.
XRDockStyle	Provides values that determine how a control is positioned within a band.
XRRichTextStreamType	Specifies the types of input and output streams used to load and save data in the XRRichText control.