Back to Devexpress

DevExpress.XtraReports.UI Namespace

xtrareports-devexpress-dot-xtrareports-51566412.md

latest46.8 KB
Original Source

DevExpress.XtraReports.UI Namespace

Contains classes that implement the basic functionality of XtraReports.

Assemblies : DevExpress.XtraReports.v25.2.dll, DevExpress.XtraReports.v25.2.Extensions.dll

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

Classes

NameDescription
BandThe base for classes that provide functionality to report bands.
BandCollectionA collection of Band objects.
BandEventArgsProvides data for the events that are associated with a band.
BandFactoryEnables you to customize the process of creating report bands in the End-User Report Designer.
BandScriptsContains names of the scripts for report bands.
BestSizeEstimator staticEnables you to find optimal boundaries to fit the text, and vice versa, get a font to fit the specified boundaries.
BindingEventArgsProvides data for the XRControl.EvaluateBinding event.
BottomMarginBandA report band used to display information at the bottom margin of every report page. This band cannot be deleted from a report.
CalculatedFieldA calculated field.
CalculatedFieldCollectionA collection of CalculatedField objects.
CalculatedFieldScriptsContains names of the scripts for a calculated field.
CanPublishOptionsContains settings that specify report control visibility on printouts and documents exported to specific formats.
ChangeEventArgsProvides data for the events that are associated with changes to property values.
CheckBoxGlyphOptionsProvides access to a control’s glyph options.
CheckBoxGlyphsContains checkbox glyph custom images.
CheckEditOptionsProvides options that define whether and how a check box’s content can be edited in Print Preview.
DataSourceRowEventArgsProvides data for the XtraReportBase.DataSourceRowChanged event.
DesignerOptionsAllows you to disable certain report layout validation indicators.
DetailBandThe main report band used to display recurrent data records from a report’s data source. This band cannot be deleted from a report.
DetailReportBandA report band containing a nested detail report.
DetailReportBandCollectionA collection of DetailReportBand objects.
DrawEventArgsProvides data for the XRControl.Draw event.
EditOptionsA base class for classes that provide options defining whether and how a control’s content can be edited in Print Preview.
ExpressionBindingProvides functionality to expression bindings.
ExpressionBindingCollectionA collection of ExpressionBinding objects.
ExternalFileAccessSecurityLevelSettings staticObsolete. This API is obsolete now.
FormattingA container of values, which are applied to a control when its owner Formatting Rule‘s condition is true.
FormattingRuleA Formatting Rule object.
FormattingRuleCollectionA collection of FormattingRule objects.
FormattingRuleSheetA repository of FormattingRule objects.
GetValueEventArgsProvides data for the CalculatedField.GetValue event.
GroupBandThe base for the GroupHeaderBand and GroupFooterBand classes that are used to group report data.
GroupBandScriptsContains the names of the scripts assigned to GroupBand.
GroupFieldDefines the objects used as criteria when creating groups in Reports.
GroupFieldCollectionA collection of GroupField objects.
GroupFooterBandA report band used for displaying information at the end of a group of records.
GroupHeaderBandA report band used for specifying grouping criteria and displaying information at the beginning of a group of records.
GroupHeaderBandScriptsContains the names of the scripts assigned to GroupHeaderBand.
GroupSortingSummaryGetResultEventArgsProvides data for the GroupHeaderBand.SortingSummaryGetResult event.
GroupSortingSummaryRowChangedEventArgsProvides data for the GroupHeaderBand.SortingSummaryRowChanged event.
HierarchyPrintOptionsSpecifies hierarchy print settings.
HtmlEventArgsProvides data for the XRControl.HtmlItemCreated event.
ImageEditOptionsProvides options that define whether and how a picture box‘s content can be edited in Print Preview.
MarginBandThe base for the TopMarginBand and BottomMarginBand classes.
MultiColumnProvides the multi-column functionality for reports.
PageBandThe base for the PageHeaderBand and PageFooterBand classes.
PageFooterBandA report band used to display information at the end of every report page.
PageHeaderBandA report band used to display information at the beginning of every report page.
ParameterBindingEnables you to pass the value of a report parameter to a subreport placed in a another report.
ParameterBindingBaseA base class for parameters of report controls.
ParameterBindingCollectionA collection of ParameterBinding objects.
PdfStreamingExporterProvides the functionality for exporting reports to PDF in streaming modes.
PreviewMouseEventArgsProvides data for the XRControl.PreviewClick, XRControl.PreviewDoubleClick, XRControl.PreviewMouseMove, XRControl.PreviewMouseDown and XRControl.PreviewMouseUp events.
PrintableComponentContainerA 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.
PrintOnPageEventArgsProvides data for the XRControl.PrintOnPage event.
ReportDesignToolAn instrument for editing reports in WinForms applications.
ReportFooterBandA report band used to display the report footer. Report controls placed on this band are displayed once at the end of the report.
ReportHeaderBandA report band used to display a report’s header. Report controls placed on this band are displayed once, at the beginning of the report.
ReportPrintOptionsProvides options that define how a report is printed in various circumstances.
ReportUnitExtensions staticProvides extension methods for the ReportUnit class, enabling you to obtain a floating number representation of a specific unit of measurement.
SaveComponentsEventArgsProvides data for the XtraReport.SaveComponents event.
SerializableStringFor internal use. Provides serialization functionality in the XtraReports Suite.
SignatureOptionsContains settings for an XRPdfSignature control.
SortingOptionsProvides options specifying how to sort a report in Print Preview.
StyleFlagsBaseThe base for the StylePriority and StyleUsing classes.
StylePriorityA container of settings that determine which properties of a style assigned to a control should override the corresponding properties of a control.
StyleUsingAn object that determines which of a style’s properties are used by an XRControl object.
SubBandA report band that is a copy of the source band located above it.
SubBandCollectionA collection of SubBand objects.
SubreportBaseThe base class for the XRSubreport class.
SubreportBaseScriptsContains the names of the scripts assigned to XRSubreport.
SummaryGetResultEventArgsProvides data for the XRLabel.SummaryGetResult event.
TextEditOptionsProvides options that define whether and how a control’s content can be edited in Print Preview.
TextFormatEventArgsProvides data for the XRLabel.SummaryCalculated event.
TopMarginBandA 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.
TruncatedControlScriptsContains the names of the scripts for certain report controls.
ValueBindingObsolete. Enables you to use an XRChart to visualize data in report groups without writing report scripts.
VerticalBandA base class for vertical bands
VerticalDetailBandA vertical band that displays recurring content from the report’s data source.
VerticalHeaderBandA vertical band that goes before the Vertical Detail band.
VerticalTotalBandA vertical band that goes after the Vertical Detail band.
WinControlContainerA container that is used to embed a Control class instance or descendants into a report.
WindowControlOptionsSpecifies how to print a control assigned to a PrintableComponentContainer.
XRAppearanceObjectProvides the appearance settings for the XRPivotGrid control’s elements.
XRBarCodeDisplays a bar code in a report.
XRBindingA 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.
XRBindingCollectionProvides methods and properties for creating a collection of XRBinding objects.
XRCharacterCombA Character Comb control that displays text so that each character is printed in an individual cell.
XRCharacterCombScriptsContains the names of the scripts assigned to XRCharacterComb.
XRChartA Chart control.
XRChartScriptsContains names of the scripts for an XRChart control.
XRCheckBoxA Checkbox control.
XRControlThe base class for all visual controls used for creating reports.
XRControl.XRControlStylesDefines the XRControl style.
XRControlCollectionA collection of XRControl objects.
XRControlCollectionBaseServes as the base class for classes that represent collections of XRControl class descendants.
XRControlEventsUsed to implement scripting for report bands and controls.
XRControlParameterA control’s parameter that enables you to pass values outside the control’s data source.
XRControlParameterCollectionA collection of control parameters.
XRControlScriptsContains names of the scripts for all report controls.
XRControlStyleAn individual style object that is also a base for all conditional formatting objects.
XRControlStyleSheetProvides functionality for an object used as a repository for the XRControl‘s styles.
XRCrossBandBoxA box that can be drawn across several report bands.
XRCrossBandControlThe 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.
XRCrossBandControlCollectionA collection of XRCrossBandControl objects.
XRCrossBandLineA vertical line that can be drawn across several report bands.
XRCrossTabDisplays multi-dimensional data in reports.
XRCrossTabCellScriptsContains the names of the scripts assigned to XRCrossTabCell.
XRCrossTabScriptsContains the names of the scripts assigned to XRCrossTab.
XRFieldEmbeddableControlThe base for all report controls that support the data binding using embedded fields.
XRGaugeA control that allows you to embed graphical gauges in a report.
XRGaugeScriptsContains the names of the scripts assigned to XRGauge.
XRGroupSortingSummaryContains settings that define the sorting of groups by summary function results.
XRLabelA Label control.
XRLabelScriptsContains names of the scripts for an XRLabel control.
XRLineA control that allows you to draw lines in reports.
XRLineScriptsContains names of the scripts for an XRLine control.
XRPageBreakA Page Break control that defines a page delimiter in a report.
XRPageBreakScriptsContains names of the scripts for an XRPageBreak control.
XRPageInfoA Page Information control that is used to display auxiliary information on report pages.
XRPanelA Panel control that can contain other controls.
XRPanelScriptsContains the names of the scripts assigned to XRPanel.
XRPdfContentA control that renders PDF file content in a report.
XRPdfContentScripts
XRPdfSignatureAdds a visual signature to a report exported to PDF.
XRPdfSignatureScriptsContains the names of the scripts assigned to XRPdfSignature controls.
XRPictureBoxA Picture Box control that is used to display an image in a report.
XRPictureboxScriptsContains the names of the scripts assigned to XRPictureBox.
XRPivotGridDisplays multi-dimensional data in reports.
XRPivotGridScriptsContains names of the scripts for an XRPivotGrid control.
XRRichTextA control that displays formatted text in a report.
XRRichTextBaseThe base for XRRichText and XRRichTextBox controls.
XRRichTextBoxObsolete. Use the XRRichText control instead.
XRRichTextBoxBaseThe base for the obsolete XRRichTextBox class.
XRScriptsBaseThe base for classes which contain names of the scripts for reports, bands and controls.
XRShapeA control that allows you to embed simple graphic elements into a report.
XRShapeScriptsContains the names of the scripts assigned to XRShape.
XRSparklineA control that displays a compact chart for report data.
XRSparklineScriptsContains the names of the scripts assigned to XRSparkline.
XRSubreportA control used to include the contents of one report in another report.
XRSummaryProvides 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.
XRSummaryEventsContains the names of the scripts available for XRSummary.
XRSummaryScriptsContains the names of the scripts assigned to XRSummary.
XRTableA Table control.
XRTableCellA cell in an XRTable row.
XRTableCellCollectionA collection of XRTableCell objects.
XRTableOfContentsA 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.
XRTableOfContentsLevelAn individual level in a Table of Contents.
XRTableOfContentsLevelBaseThe base for classes that provide functionality to the XRTableOfContents control levels.
XRTableOfContentsLevelCollectionA collection of levels assigned to a Table of Contents.
XRTableOfContentsScripts
XRTableOfContentsTitleThe title of a Table of Contents.
XRTableRowA row in an XRTable.
XRTableRowCollectionA collection of XRTableRow objects.
XRTableScriptsContains the names of the scripts assigned to XRTable.
XRWatermarkA watermark in a report.
XRZipCodeRenders 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.
XtraReportA DevExpress report.
XtraReportBaseThe base for XtraReport and DetailReportBand classes.
XtraReportBaseScriptsContains names of the scripts for the XtraReportBase class descendants.
XtraReportDesignerExtensions staticProvides extension methods that enable you to load a report in an End-User WinForms Report Designer.
XtraReportScriptsContains names of the scripts for an XtraReport object.

Interfaces

NameDescription
IReportDesignToolProvides methods for showing both the standard and ribbon-based End-User Report Designer forms.

Delegates

NameDescription
BandEventHandlerA method that will handle the XtraReportBase.BandHeightChanged event.
BeforePrintEventHandlerA method that will handle the XRControl.BeforePrint and XRCrossBandControl.BeforePrint events.
BindingEventHandlerA method that will handle the XRControl.EvaluateBinding event.
ChangeEventHandlerA method that will handle the events associated with the value changes of any properties.
DataSourceRowEventHandlerA method that will handle the XtraReportBase.DataSourceRowChanged event.
DrawEventHandlerA method that will handle the XRControl.Draw event.
GetValueEventHandlerA method that will handle the CalculatedField.GetValue event.
GroupSortingSummaryGetResultEventHandlerA method that will handle the GroupHeaderBand.SortingSummaryGetResult event.
GroupSortingSummaryRowChangedEventHandlerA method that will handle the GroupHeaderBand.SortingSummaryRowChanged event.
HtmlEventHandlerA method that will handle the XRControl.HtmlItemCreated event.
PreviewMouseEventHandlerA method that will handle the XRControl.PreviewMouseMove and XRControl.PreviewClick events.
PrintOnPageEventHandlerA method that will handle the XRControl.PrintOnPage event.
SummaryGetResultHandlerA method that will handle the XRLabel.SummaryGetResult event.
TextFormatEventHandlerA method that will handle the XRLabel.SummaryCalculated event.

Enums

NameDescription
AutoSizeModeSpecifies whether and how to change the control’s size to fit its content.
BandKindSpecifies the types of bands used in the XtraReports Suite.
ChartImageTypeSpecifies how the XRChart control should be internally rendered in a report.
ColumnDirectionObsolete. Specifies the order in which the detail band is printed on a page when the multi-column mode is enabled.
DataBindingModeLists the available data binding modes.
DefaultCrossTabControlLists controls that can be used to display cross-tab data.
DesignWindowTypeSpecifies the type of the End-User Designer tool window.
ExternalFileAccessSecurityLevelObsolete. This API is obsolete now.
FieldListDateTimeComponentBindingMode
GaugeImageTypeEnumerates values that specify how the GaugeImageType control should be internally rendered in a report.
GroupFooterUnionSpecifies how a group footer is positioned with respect to its group in a report.
GroupUnionSpecifies how groups of records should be split across pages, if required.
MultiColumnModeSpecifies which multi-column properties will be taken into account if the multi-column feature is enabled.
PageBreakSpecifies where to make a page break, with respect to the given band.
PrintLayoutLists values that specify how to print the Cross Tab across several pages.
ProcessDuplicatesModeLists modes that specify how to process report controls with duplicate values.
ProcessDuplicatesTargetLists control characteristics whose duplicate values are processed.
ProcessHiddenCellModeLists modes used to specify how to fill the gap of a hidden cell in the XRTable control.
PromptBooleanLists values that specify whether and how to convert legacy reports to the new binding mode when opening them in the End-User Report Designer.
ReportLocalizationModeSpecifies whether the report uses localizaton strings embedded into a report definition or loads the localized resources from satellite resource assemblies.
ReportUnitLists the supported systems of measurement.
RestrictionLevelLists the options that define whether end-users are allowed to load untrusted reports with potentially dangerous content in desktop reporting applications.
RightToLeftLists the modes of assigning the right-to-left feature to a specific control.
RightToLeftLayoutLists the available right-to-left layout states.
SerializationFormatLists the available report serialization formats.
SnappingModeSpecifies the snapping mode of a report.
SortingSummaryFunctionLists the summary functions available for sorting groups by summary results.
SparklineImageTypeSpecifies how the XRSparkline control should be internally rendered in a report.
SummaryFuncSpecifies the arithmetic function to be calculated.
SummaryRunningSpecifies the report area for which the selected function is calculated.
SynchronizationModeLists the modes that specify how to synchronize document preview options with report page settings.
TextFitModeLists modes that are available for changing control text size to fit its boundaries.
ValueSuppressTypeLists the values that specify how to process report controls that receive empty values.
VerticalBandLayoutSpecifies 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.
WinControlDrawMethodSpecifies how the Windows Forms control that is embedded using a WinControlContainer should be drawn in a report.
WinControlImageTypeSpecifies how the Windows Forms control that is embedded using a WinControlContainer should be internally rendered in a report.
WinControlPrintModeSpecifies how the Windows Forms control that is embedded using a WinControlContainer should be rendered in a report.
XRAccessibleRoleLists values that define UI element roles in the exported PDF document. These roles are used by assistive technologies.
XRBarCodeOrientationObsolete. This enumeration is obsolete and no longer in use. Use the BarCodeOrientation enumeration instead.
XRColumnSortOrderSpecifies the sorting order for a group.
XRDockStyleProvides values that determine how a control is positioned within a band.
XRRichTextStreamTypeSpecifies the types of input and output streams used to load and save data in the XRRichText control.