DevExpress.XtraReports.UI Namespace
In This Article
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. |
Band |
A collection of Band objects. |
Band |
Provides data for the events that are associated with a band. |
Band |
Enables you to customize the process of creating report bands in the End-User Report Designer. |
Band |
Contains names of the scripts for report bands. |
Best |
Enables you to find optimal boundaries to fit the text, and vice versa, get a font to fit the specified boundaries. |
Binding |
Provides data for the XRControl. |
Bottom |
A report band used to display information at the bottom margin of every report page. This band cannot be deleted from a report. |
Calculated |
A calculated field. |
Calculated |
A collection of Calculated |
Calculated |
Contains names of the scripts for a calculated field. |
Change |
Provides data for the events that are associated with changes to property values. |
Check |
Provides access to a control’s glyph options. |
Check |
Contains checkbox glyph custom images. |
Check |
Provides options that define whether and how a check box’s content can be edited in Print Preview. |
Data |
Provides data for the Xtra |
Designer |
Allows you to disable certain report layout validation indicators. |
Detail |
The main report band used to display recurrent data records from a report’s data source. This band cannot be deleted from a report. |
Detail |
A report band containing a nested detail report. |
Detail |
A collection of Detail |
Draw |
Provides data for the XRControl. |
Edit |
A base class for classes that provide options defining whether and how a control’s content can be edited in Print Preview. |
Expression |
Provides functionality to expression bindings. |
Expression |
A collection of Expression |
External |
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. |
Formatting |
A Formatting Rule object. |
Formatting |
A collection of Formatting |
Formatting |
A repository of Formatting |
Get |
Provides data for the Calculated |
Group |
The base for the Group |
Group |
Contains the names of the scripts assigned to Group |
Group |
Defines the objects used as criteria when creating groups in Reports. |
Group |
A collection of Group |
Group |
A report band used for displaying information at the end of a group of records. |
Group |
A report band used for specifying grouping criteria and displaying information at the beginning of a group of records. |
Group |
Contains the names of the scripts assigned to Group |
Group |
Provides data for the Group |
Group |
Provides data for the Group |
Hierarchy |
Specifies hierarchy print settings. |
Html |
Provides data for the XRControl. |
Image |
Provides options that define whether and how a picture box‘s content can be edited in Print Preview. |
Margin |
The base for the Top |
Multi |
Provides the multi-column functionality for reports. |
Page |
The base for the Page |
Page |
A report band used to display information at the end of every report page. |
Page |
A report band used to display information at the beginning of every report page. |
Parameter |
Enables you to pass the value of a report parameter to a subreport placed in a another report. |
Parameter |
A base class for parameters of report controls. |
Parameter |
A collection of Parameter |
Pdf |
Provides the functionality for exporting reports to PDF in streaming modes. |
Preview |
Provides data for the XRControl. |
Printable |
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. |
Print |
Provides data for the XRControl. |
Report |
An instrument for editing reports in Win |
Report |
A report band used to display the report footer. Report controls placed on this band are displayed once at the end of the report. |
Report |
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. |
Report |
Provides options that define how a report is printed in various circumstances. |
Report |
Provides extension methods for the Report |
Save |
Provides data for the Xtra |
Serializable |
For internal use. Provides serialization functionality in the Xtra |
Signature |
Contains settings for an XRPdf |
Sorting |
Provides options specifying how to sort a report in Print Preview. |
Style |
The base for the Style |
Style |
A container of settings that determine which properties of a style assigned to a control should override the corresponding properties of a control. |
Style |
An object that determines which of a style’s properties are used by an XRControl object. |
Sub |
A report band that is a copy of the source band located above it. |
Sub |
A collection of Sub |
Subreport |
The base class for the XRSubreport class. |
Subreport |
Contains the names of the scripts assigned to XRSubreport. |
Summary |
Provides data for the XRLabel. |
Text |
Provides options that define whether and how a control’s content can be edited in Print Preview. |
Text |
Provides data for the XRLabel. |
Top |
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. |
Truncated |
Contains the names of the scripts for certain report controls. |
Value |
Obsolete. Enables you to use an XRChart to visualize data in report groups without writing report scripts. |
Vertical |
A base class for vertical bands |
Vertical |
A vertical band that displays recurring content from the report’s data source. |
Vertical |
A vertical band that goes before the Vertical Detail band. |
Vertical |
A vertical band that goes after the Vertical Detail band. |
Win |
A container that is used to embed a Control class instance or descendants into a report. |
Window |
Specifies how to print a control assigned to a Printable |
XRAppearance |
Provides the appearance settings for the XRPivot |
XRBar |
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. |
XRBinding |
Provides methods and properties for creating a collection of XRBinding objects. |
XRCharacter |
A Character Comb control that displays text so that each character is printed in an individual cell. |
XRCharacter |
Contains the names of the scripts assigned to XRCharacter |
XRChart | A Chart control. |
XRChart |
Contains names of the scripts for an XRChart control. |
XRCheck |
A Checkbox control. |
XRControl | The base class for all visual controls used for creating reports. |
XRControl. |
Defines the XRControl style.
|
XRControl |
A collection of XRControl objects. |
XRControl |
Serves as the base class for classes that represent collections of XRControl class descendants. |
XRControl |
Used to implement scripting for report bands and controls. |
XRControl |
A control’s parameter that enables you to pass values outside the control’s data source. |
XRControl |
A collection of control parameters. |
XRControl |
Contains names of the scripts for all report controls. |
XRControl |
An individual style object that is also a base for all conditional formatting objects. |
XRControl |
Provides functionality for an object used as a repository for the XRControl‘s styles. |
XRCross |
A box that can be drawn across several report bands. |
XRCross |
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. |
XRCross |
A collection of XRCross |
XRCross |
A vertical line that can be drawn across several report bands. |
XRCross |
Displays multi-dimensional data in reports. |
XRCross |
Contains the names of the scripts assigned to XRCross |
XRCross |
Contains the names of the scripts assigned to XRCross |
XRField |
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. |
XRGauge |
Contains the names of the scripts assigned to XRGauge. |
XRGroup |
Contains settings that define the sorting of groups by summary function results. |
XRLabel | A Label control. |
XRLabel |
Contains names of the scripts for an XRLabel control. |
XRLine | A control that allows you to draw lines in reports. |
XRLine |
Contains names of the scripts for an XRLine control. |
XRPage |
A Page Break control that defines a page delimiter in a report. |
XRPage |
Contains names of the scripts for an XRPage |
XRPage |
A Page Information control that is used to display auxiliary information on report pages. |
XRPanel | A Panel control that can contain other controls. |
XRPanel |
Contains the names of the scripts assigned to XRPanel. |
XRPdf |
A control that renders PDF file content in a report. |
XRPdf |
|
XRPdf |
Adds a visual signature to a report exported to PDF. |
XRPdf |
Contains the names of the scripts assigned to XRPdf |
XRPicture |
A Picture Box control that is used to display an image in a report. |
XRPicturebox |
Contains the names of the scripts assigned to XRPicture |
XRPivot |
Displays multi-dimensional data in reports. |
XRPivot |
Contains names of the scripts for an XRPivot |
XRRich |
A control that displays formatted text in a report. |
XRRich |
The base for XRRich |
XRRich |
Obsolete. Use the XRRich |
XRRich |
The base for the obsolete XRRich |
XRScripts |
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. |
XRShape |
Contains the names of the scripts assigned to XRShape. |
XRSparkline | A control that displays a compact chart for report data. |
XRSparkline |
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. |
XRSummary |
Contains the names of the scripts available for XRSummary. |
XRSummary |
Contains the names of the scripts assigned to XRSummary. |
XRTable | A Table control. |
XRTable |
A cell in an XRTable row. |
XRTable |
A collection of XRTable |
XRTable |
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. |
XRTable |
An individual level in a Table of Contents. |
XRTable |
The base for classes that provide functionality to the XRTable |
XRTable |
A collection of levels assigned to a Table of Contents. |
XRTable |
|
XRTable |
The title of a Table of Contents. |
XRTable |
A row in an XRTable. |
XRTable |
A collection of XRTable |
XRTable |
Contains the names of the scripts assigned to XRTable. |
XRWatermark | A watermark in a report. |
XRZip |
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. |
Xtra |
A DevExpress report. |
Xtra |
The base for Xtra |
Xtra |
Contains names of the scripts for the Xtra |
Xtra |
Provides extension methods that enable you to load a report in an End-User Win |
Xtra |
Contains names of the scripts for an Xtra |
#Interfaces
Name | Description |
---|---|
IReport |
Provides methods for showing both the standard and ribbon-based End-User Report Designer forms. |
#Delegates
#Enums
Name | Description |
---|---|
Auto |
Specifies whether and how to change the control’s size to fit its content. |
Band |
Specifies the types of bands used in the Xtra |
Chart |
Specifies how the XRChart control should be internally rendered in a report. |
Column |
Obsolete. Specifies the order in which the detail band is printed on a page when the multi-column mode is enabled. |
Data |
Lists the available data binding modes. |
Default |
Lists controls that can be used to display cross-tab data. |
Design |
Specifies the type of the End-User Designer tool window. |
External |
Obsolete. This API is obsolete now. |
Gauge |
Enumerates values that specify how the Gauge |
Group |
Specifies how a group footer is positioned with respect to its group in a report. |
Group |
Specifies how groups of records should be split across pages, if required. |
Multi |
Specifies which multi-column properties will be taken into account if the multi-column feature is enabled. |
Page |
Specifies where to make a page break, with respect to the given band. |
Print |
Lists values that specify how to print the Cross Tab across several pages. |
Process |
Lists modes that specify how to process report controls with duplicate values. |
Process |
Lists control characteristics whose duplicate values are processed. |
Process |
Lists modes used to specify how to fill the gap of a hidden cell in the XRTable control. |
Prompt |
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. |
Report |
Specifies whether the report uses localizaton strings embedded into a report definition or loads the localized resources from satellite resource assemblies. |
Report |
Lists the supported systems of measurement. |
Restriction |
Lists the options that define whether end-users are allowed to load untrusted reports with potentially dangerous content in desktop reporting applications. |
Right |
Lists the modes of assigning the right-to-left feature to a specific control. |
Right |
Lists the available right-to-left layout states. |
Serialization |
Lists the available report serialization formats. |
Snapping |
Specifies the snapping mode of a report. |
Sorting |
Lists the summary functions available for sorting groups by summary results. |
Sparkline |
Specifies how the XRSparkline control should be internally rendered in a report. |
Summary |
Specifies the arithmetic function to be calculated. |
Summary |
Specifies the report area for which the selected function is calculated. |
Synchronization |
Lists the modes that specify how to synchronize document preview options with report page settings. |
Text |
Lists modes that are available for changing control text size to fit its boundaries. |
Value |
Lists the values that specify how to process report controls that receive empty values. |
Vertical |
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. |
Win |
Specifies how the Windows Forms control that is embedded using a Win |
Win |
Specifies how the Windows Forms control that is embedded using a Win |
Win |
Specifies how the Windows Forms control that is embedded using a Win |
XRAccessible |
Lists values that define UI element roles in the exported PDF document. These roles are used by assistive technologies. |
XRBar |
Obsolete. This enumeration is obsolete and no longer in use. Use the Bar |
XRColumn |
Specifies the sorting order for a group. |
XRDock |
Provides values that determine how a control is positioned within a band. |
XRRich |
Specifies the types of input and output streams used to load and save data in the XRRich |