Skip to main content
A newer version of this page is available. .

XtraReport Properties

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