XtraReport Properties

Properties

Name Description
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.

CalculatedFields

Provides access to a report's collection of calculated fields.

ComponentStorage

For internal use.

ControlType

Gets the assembly-qualified name of the report.

CrossBandControls

Provides access to a collection of cross-band controls in the current report.

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.

DisplayName

Specifies text displayed in the report title of a corresponding End-User Designer's tab, as well as the default file name of the exported document.

DocumentExportMode

For internal use.

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.

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.

Extensions

Provides access to the report's extensions.

FormattingRuleSheet

Provides access to a collection of formatting rules stored in a report.

GridSize

Obsolete. For internal use.

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.

Landscape

Gets or sets a value indicating whether the page orientation is landscape.

LockedInUserDesigner

For internal use.

Margins

Gets or sets the margins of the report's pages (measured in report units).

MasterReport

Gets or sets the XtraReport object which contains the current report as a subreport.

ObjectStorage

For internal use.

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.

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.

Pages

Gets a collection of pages generated for this report.

PaperKind

Gets or sets the type of paper for the report.

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.

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.

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.

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).

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.

ScriptSecurityPermissions

Provides access to the collection of security permissions used to permit particular operations in report scripts.

Scripts

Provides access to an object that contains XtraReport-specific scripts to handle its events in the End-User Designer.

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.

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.

ShowPrintingWarnings

Obsolete. For internal use.

ShowUserFriendlyNamesInUserDesigner

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.

SnapGridSize

Specifies the dimensions of the report designer snap grid.

SnapGridStepCount

Specifies the number of grid cells comprising a larger snap grid unit.

SnapToGrid

Obsolete. For internal use.

SnappingMode

Specifies the mode in which report elements are snapped to each other when they are resized or being relocated.

SourceUrl

For internal use.

StyleSheet

Provides access to a collection of styles stored in a report.

StyleSheetPath

Gets or sets the path to the style sheet contained in a style sheet file.

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.

Watermark

Provides access to a report's watermark settings.