Back to Devexpress

XtraReport Properties

xtrareports-devexpress-dot-xtrareports-dot-ui-dot-xtrareport-dot-underscore-properties.md

latest22.1 KB
Original Source

XtraReport Properties

A DevExpress report.

NameDescription
BackColorGets or sets a control’s background color. Inherited from XRControl.
BandProvides access to the owner band, in which the current control is situated. Inherited from XRControl.
BandsGets the collection of bands contained in a report. Inherited from XtraReportBase.
BookmarkGets or sets the text shown as a root bookmark in a Document Map.
BookmarkDuplicateSuppressSpecifies whether or not to suppress duplicated bookmarks in a final document.
BorderColorGets or sets the control’s border color. Inherited from XRControl.
BorderDashStyleSpecifies the dash style for the control’s border. Inherited from XRControl.
BordersSpecifies a set of borders (top, right, bottom, left) that should be visible for the control. Inherited from XRControl.
BorderWidthSpecifies the width of cell borders in pixels, as a floating point value. Inherited from XRControl.
CalculatedFieldsProvides access to a report’s collection of calculated fields.
CanHaveChildrenOverrides the XRControl.CanHaveChildren property. Inherited from Band.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ComponentStorageRetrieves a collection of components serialized along with the report, such as data sources.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ControlTypeGets the assembly-qualified name of the report.
CrossBandControlsProvides access to a collection of cross-band controls in the current report.
CurrentRowHierarchyLevelInherited from XtraReportBase.
CurrentRowIndexGets the index of the current data row in a report’s XtraReportBase.DataSource. Inherited from XtraReportBase.
DataAdapterSpecifies the data adapter that should be used to populate a report’s data source. Inherited from XtraReportBase.
DataMemberSpecifies the collection, list, or table in the object assigned to the DataSource property from which to retrieve the data. Inherited from XtraReportBase.
DataSourceGets or sets an object that supplies data to the report. Inherited from XtraReportBase.
DataSourceSchemaGets or sets an XML/XSD file, containing a schema of a report’s data source.
DefaultPrinterSettingsUsingProvides access to an object that defines which of the system’s default printer settings should be used when printing an XtraReport.
DesignerOptionsProvides access to the options that determine the availability of popup hints and warnings in the Report Designer.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayNameGets or sets the report’s display name. If the name is not empty, it serves as the default name of the exported document and appears in the End-User Designer‘s report tab. Otherwise, the value of the report’s Name property is used as a display name.
DrawGridGets or sets a value indicating whether to draw the snap grid over the report surface.
DrawWatermarkGets or sets a value indicating whether or not to draw a watermark at design time.
EmptyBookmarkTextSpecifies the text for empty bookmark values ​​in the report element hierarchy.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpandedFor internal use.
ExportOptionsGets the settings used to specify exporting parameters when exporting a report.
ExpressionBindingsProvides access to a control’s collection of expression bindings. Inherited from XRControl.
ExtensionsProvides access to the report’s extensions.
FilterStringSpecifies the criteria used to filter data in a report. Inherited from XtraReportBase.
FontGets or sets the control’s font. Inherited from XRControl.
ForeColorGets or sets the control’s foreground color. Inherited from XRControl.
FormattingRulesProvides access to a collection of formatting rules applied to this control. Inherited from XRControl.
FormattingRuleSheetProvides access to a collection of formatting rules stored in a report.
HasChildrenGets a value indicating whether the control contains other XRControl objects. Inherited from XRControl.
HorizontalContentSplittingWhen 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.
ImageResourcesProvides access to a collection of the report’s named images.
IndexGets the zero-based index of this control in its parent’s collection of controls. Inherited from XRControl.
IsDisposedFor internal use. Gets a value indicating whether the control has been disposed of. Inherited from XRControl.
IsSingleChildChecks whether the report element (control or band) is a single child of its parent. Inherited from XRControl.
LandscapeGets or sets a value indicating whether the page orientation is landscape.
LocalizationItemsProvides access to a collection of items that combine the property name, its value and a language name.
MarginsGets or sets the report’s page margins.
MasterReportGets or sets the XtraReport object which contains the current report as a subreport.
NameGets or sets a name of the control. Inherited from XRControl.
PaddingGets or sets the control’s padding values (measured in report units). Inherited from XRControl.
PageColorGets or sets the fill color of report pages.
PageHeightFSpecifies the height of report pages (measured in report units). Has effect only if the XtraReport.PaperKind property is set to Custom.
PagesGets a collection of pages generated for this report.
PageSizeFSpecifies the size of report pages (measured in report units).
PageWidthFSpecifies the width of report pages (measured in report units). Applies only if the XtraReport.PaperKind property is set to Custom.
PaperKindGets or sets the report’s paper kind.
PaperNameGets or sets the name of the custom paper which is used in the printer that the document is going to be printed on.
ParameterPanelLayoutItems
ParametersProvides access to a report’s collection of parameters.
ParentSpecifies the parent object that contains the current control. Inherited from XRControl.
PrinterNameSpecifies the name of the printer to use for printing the report.
PrintingSystemReturns a report’s Printing System that provides print and export settings.
ReportProvides access to the report that contains the control. Inherited from XRControl.
ReportPrintOptionsProvides access to options that define a report’s print-out. Inherited from XtraReportBase.
ReportUnitSpecifies 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).
RequestParametersSpecifies whether the report document creation should start only after the user submits all the report parameter values.
RightToLeftSpecifies the content orientation of the XtraReport‘s controls.
RightToLeftLayoutSpecifies the position of controls within report bands.
RollPaperSpecifies whether the document is supposed to be printed on roll paper (in other words, as a single uninterrupted page).
RootReportProvides access to the report to which the control belongs. Inherited from XRControl.
RowCountGets the total amount of data rows in a report’s XtraReportBase.DataSource. Inherited from XtraReportBase.
ScriptLanguageGets or sets the scripting language of all the scripts used in this XtraReport object.
ScriptReferencesSpecifies the collection of file names (with full or relative paths) of the assemblies used by the scripts in a report.
ScriptReferencesStringGets or sets the string containing all script references represented by the XtraReport.ScriptReferences property.
ScriptsProvides access to an object that contains XtraReport-specific scripts to handle its events in the End-User Designer.
ScriptsSourceSpecifies the report scripts.
ShowPreviewMarginLinesSpecifies whether the report preview window shows page margin lines.
ShowPrintMarginsWarningGets or sets a value which specifies whether an error message is shown when the page margins are set outside the printable area.
ShowPrintStatusDialogGets or sets a value specifying whether a print status dialog is shown when a document is printed.
ShowUserFriendlyNamesInUserDesigner staticObsolete. Gets or sets a value indicating whether all property names and their values should be displayed in the user-friendly format in the Properties window and smart tags of the End-User Designer.
SiteGets or sets the ISite of the Component. Inherited from Component.
SnapGridSizeSpecifies the dimensions of the report designer snap grid.
SnapGridStepCountSpecifies the number of grid cells comprising a larger snap grid unit.
SnappingModeSpecifies the mode in which report elements are snapped to each other when they are resized or being relocated.
SourceUrlFor internal use.
StyleSheetProvides access to a collection of styles stored in a report.
StyleSheetPathGets or sets a path to the style sheet contained in a style sheet file.
TagBindable. Gets or sets the object that contains data about this control. Inherited from XRControl.
TextAlignmentSpecifies the positioning of text within a control. Inherited from XRControl.
VerticalContentSplittingGets 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.
VisibleGets or sets a value that specifies whether the report control is displayed in the document. Inherited from XRControl.
WatermarkIdBindable. Specifies the unique identifier of a watermark to be displayed in a report.
WatermarksGets the collection of watermarks.
XmlDataPathSpecifies the path to an XML file that should be used as the report’s data source. Inherited from XtraReportBase.

See Also

XtraReport Class

XtraReport Members

DevExpress.XtraReports.UI Namespace