Added in v2.3
Blazorise Reporting: API Reference
Explore the API reference for Blazorise Reporting components, report definitions, state, data sources, layout elements, and toolbar commands.
For examples and usage guidance, see the Reporting documentation.
API
Parameters
Report
| Parameter | Default | Type |
|---|---|---|
AllowBandCollapse | true | bool |
Enables collapsing and expanding bands in the designer rail. | ||
BandMode | Classic | ReportBandMode |
Band presentation used when constructing a report from declarative content. Persisted definitions retain their configured value. Possible values: RailSeparatorCompactClassic | ||
ChildContent | null | RenderFragment |
Declarative report content used as the initial report definition. | ||
Data | null | object |
Default data source object or enumerable used when no explicit ReportDataSource is declared. | ||
DefaultPreviewFormat | null | ReportPreviewFormat? |
Preview format selected when preview mode is first opened. Must be enabled in PreviewFormats. | ||
Definition | null | ReportDefinition |
Persisted report definition copied into the designer working state. | ||
DefinitionMode | null | ReportDefinitionMode? |
Controls how declarative child content is used with persisted definitions. | ||
DisableImageUploadProgressReport | false | bool |
Disables image upload progress callbacks. | ||
Editable | false | bool |
Defines whether the report can be edited using the interactive designer. | ||
ElementNavigationMode | ElementAndCell | ReportElementNavigationMode |
Defines how report elements participate in keyboard navigation when constructing a report from declarative content. Persisted definitions retain their configured value. Possible values: NoneElementCellElementAndCell | ||
ElementPlugins | null | IEnumerable<IReportElementPlugin> |
Custom report element plugins available only to this report instance. The collection is read during initialization. | ||
ImageAccept | "image/png, image/jpeg" | string |
A comma-separated list of image MIME types accepted by the image upload dialog. | ||
ImageMaxSize | 1024 * 1024 * 5 | long |
Maximum image size in bytes. | ||
ImageUploadSegmentFetchTimeout | TimeSpan.FromMinutes( 1 ) | TimeSpan |
Specifies the segment fetch timeout when uploading the image. | ||
Localizers | null | ReportLocalizers |
Custom localizers used by the report designer and viewer. | ||
MaxUploadImageChunkSize | 20 * 1024 | int |
Specifies the max chunk size when uploading the image. | ||
Mode | null | ReportMode? |
Externally controlled design or preview mode. | ||
PreviewFormat | null | ReportPreviewFormat? |
Externally controlled preview format. Must be either HTML or PDF. | ||
PreviewFormats | null | ReportPreviewFormat? |
Preview formats available for this report. None disables preview. | ||
ShowBandDataSource | true | bool |
Shows data source names in band labels when available. | ||
ShowCollisionWarnings | true | bool |
Defines collision warning visibility when constructing a report from declarative content. Persisted definitions retain their configured value. | ||
ShowCursorGuides | false | bool |
Defines cursor guide visibility when constructing a report from declarative content. Persisted definitions retain their configured value. | ||
ShowFineRulerTicks | false | bool |
Defines fine ruler tick visibility when constructing a report from declarative content. Persisted definitions retain their configured value. | ||
ShowPageTabs | true | bool |
Shows page navigation above the report designer surface. | ||
ShowRulers | true | bool |
Defines ruler visibility when constructing a report from declarative content. Persisted definitions retain their configured value. | ||
ShowStatusBar | true | bool |
Shows the status bar below the report designer or preview surface. | ||
ShowToolbar | true | bool |
Shows the report toolbar above the designer or viewer surface. | ||
UploadImage | true | bool |
Enables image upload from Image element source properties. | ||
ReportViewer
| Parameter | Default | Type |
|---|---|---|
AllowDownload | true | bool |
Enables download commands in the viewer toolbar. | ||
AllowPrint | true | bool |
Enables print commands in the viewer toolbar. | ||
DefaultPreviewFormat | Html | ReportPreviewFormat |
Preview format selected when preview mode is opened. Must be enabled in PreviewFormat. Possible values: NoneHtmlPdf | ||
PdfPreviewTemplate | null | RenderFragment<ReportPdfPreviewContext> |
Template used to render generated PDF previews. | ||
PreviewFormat | Html | ReportPreviewFormat |
Preview formats offered by the report viewer. None disables preview. Possible values: NoneHtmlPdf | ||
ReportPage
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Declarative report bands placed on this page. | ||
Height | null | double? |
Explicit page height in the configured measurement unit. | ||
MarginBottom | 0 | double |
Bottom printable page margin in the configured measurement unit. | ||
MarginLeft | 0 | double |
Left printable page margin in the configured measurement unit. | ||
MarginRight | 0 | double |
Right printable page margin in the configured measurement unit. | ||
MarginTop | 0 | double |
Top printable page margin in the configured measurement unit. | ||
MeasurementUnit | Centimeter | ReportMeasurementUnit |
Unit used by the declarative page dimensions and margins. Possible values: PointInchCentimeterMillimeter | ||
Name | — | string |
Friendly page name shown in the designer. | ||
Orientation | Portrait | ReportOrientation |
Page orientation applied to the selected size. Possible values: PortraitLandscape | ||
Size | A4 | ReportPageSize |
Named page size used when explicit dimensions are not supplied. Possible values: A4LetterCustomA3A5Legal | ||
Width | null | double? |
Explicit page width in the configured measurement unit. | ||
ReportText
| Parameter | Default | Type |
|---|---|---|
Appearance | null | ReportAppearanceDefinition |
Fill and opacity settings applied to the element. | ||
BackgroundColor | null | ReportColor |
Background color applied to the element. | ||
Bold | false | bool |
Enables bold text rendering. | ||
Border | null | ReportBorderDefinition |
Border settings applied around the element. | ||
BorderColor | null | ReportColor |
Border color applied to the element. | ||
BorderRadius | null | double? |
Border radius applied to the element corners. | ||
BorderStyle | ReportBorderStyle.Default | ReportBorderStyle |
Border style applied around the element. Possible values: DefaultSolidDashedDotted | ||
BorderWidth | null | double? |
Border width applied around the element. | ||
CanGrow | false | ReportValue<bool> |
Allows text content to expand the element vertically when rendered. | ||
Class | — | string |
Additional CSS classes applied to the element. | ||
FontColor | null | ReportColor |
Text color applied to the element. | ||
FontFamily | — | string |
Font family applied to text rendered by the element. | ||
FontSize | null | double? |
Font size applied to text rendered by the element. | ||
Height | 18 | double |
Element height in points. | ||
Italic | false | bool |
Enables italic text rendering. | ||
Name | — | string |
Friendly element name shown in the designer. | ||
Opacity | null | double? |
Element opacity from 0 to 1. | ||
ShowCollisionWarnings | true | bool |
Indicates whether the element participates in designer collision warnings. | ||
SnapToGrid | null | bool? |
Overrides the designer-level snap-to-grid behavior for this element. A null value inherits the designer setting. | ||
Style | — | string |
Inline style applied to the element. | ||
Suppress | false | ReportValue<bool> |
Prevents the element from being edited on the designer surface and rendered in preview output. | ||
Text | — | string |
Text content rendered by the element. | ||
TextAlignment | Default | TextAlignment |
Text alignment applied inside the element box. Possible values: DefaultStartEndCenterJustified | ||
Underline | false | bool |
Enables underline text rendering. | ||
VerticalAlignment | Default | VerticalAlignment |
Vertical text alignment applied inside the element box. Possible values: DefaultBaselineTopMiddleBottomTextTopTextBottom | ||
Width | 90 | double |
Element width in points. | ||
X | 0 | double |
Horizontal position within the containing report container, in points. | ||
Y | 0 | double |
Vertical position within the containing report container, in points. | ||
ReportField
| Parameter | Default | Type |
|---|---|---|
AggregateFunction | null | ReportAggregateFunction? |
Aggregate function applied when this field is rendered as a summary. | ||
Appearance | null | ReportAppearanceDefinition |
Fill and opacity settings applied to the element. | ||
BackgroundColor | null | ReportColor |
Background color applied to the element. | ||
Bold | false | bool |
Enables bold text rendering. | ||
Border | null | ReportBorderDefinition |
Border settings applied around the element. | ||
BorderColor | null | ReportColor |
Border color applied to the element. | ||
BorderRadius | null | double? |
Border radius applied to the element corners. | ||
BorderStyle | ReportBorderStyle.Default | ReportBorderStyle |
Border style applied around the element. Possible values: DefaultSolidDashedDotted | ||
BorderWidth | null | double? |
Border width applied around the element. | ||
CanGrow | false | ReportValue<bool> |
Allows text content to expand the element vertically when rendered. | ||
Class | — | string |
Additional CSS classes applied to the element. | ||
Field | — | string |
Field name or expression resolved against the current data item. | ||
FontColor | null | ReportColor |
Text color applied to the element. | ||
FontFamily | — | string |
Font family applied to text rendered by the element. | ||
FontSize | null | double? |
Font size applied to text rendered by the element. | ||
Format | null | ReportFormatDefinition |
Format applied to the resolved field value. | ||
Height | 18 | double |
Element height in points. | ||
Italic | false | bool |
Enables italic text rendering. | ||
Name | — | string |
Friendly element name shown in the designer. | ||
Opacity | null | double? |
Element opacity from 0 to 1. | ||
ShowCollisionWarnings | true | bool |
Indicates whether the element participates in designer collision warnings. | ||
SnapToGrid | null | bool? |
Overrides the designer-level snap-to-grid behavior for this element. A null value inherits the designer setting. | ||
Style | — | string |
Inline style applied to the element. | ||
Suppress | false | ReportValue<bool> |
Prevents the element from being edited on the designer surface and rendered in preview output. | ||
TextAlignment | Default | TextAlignment |
Text alignment applied inside the element box. Possible values: DefaultStartEndCenterJustified | ||
Underline | false | bool |
Enables underline text rendering. | ||
VerticalAlignment | Default | VerticalAlignment |
Vertical text alignment applied inside the element box. Possible values: DefaultBaselineTopMiddleBottomTextTopTextBottom | ||
Width | 90 | double |
Element width in points. | ||
X | 0 | double |
Horizontal position within the containing report container, in points. | ||
Y | 0 | double |
Vertical position within the containing report container, in points. | ||
ReportImage
| Parameter | Default | Type |
|---|---|---|
Appearance | null | ReportAppearanceDefinition |
Fill and opacity settings applied to the element. | ||
BackgroundColor | null | ReportColor |
Background color applied to the element. | ||
Border | null | ReportBorderDefinition |
Border settings applied around the element. | ||
BorderColor | null | ReportColor |
Border color applied to the element. | ||
BorderRadius | null | double? |
Border radius applied to the element corners. | ||
BorderStyle | ReportBorderStyle.Default | ReportBorderStyle |
Border style applied around the element. Possible values: DefaultSolidDashedDotted | ||
BorderWidth | null | double? |
Border width applied around the element. | ||
CanGrow | false | ReportValue<bool> |
Allows text content to expand the element vertically when rendered. | ||
Class | — | string |
Additional CSS classes applied to the element. | ||
Fit | ReportImageFit.Default | ReportImageFit |
Defines how the image fits inside the element bounds. Possible values: DefaultContainCoverFillNoneScaleDown | ||
Height | 18 | double |
Element height in points. | ||
Name | — | string |
Friendly element name shown in the designer. | ||
Opacity | null | double? |
Element opacity from 0 to 1. | ||
ShowCollisionWarnings | true | bool |
Indicates whether the element participates in designer collision warnings. | ||
SnapToGrid | null | bool? |
Overrides the designer-level snap-to-grid behavior for this element. A null value inherits the designer setting. | ||
Source | — | string |
Image source URL or data URI rendered by the element. | ||
Style | — | string |
Inline style applied to the element. | ||
Suppress | false | ReportValue<bool> |
Prevents the element from being edited on the designer surface and rendered in preview output. | ||
Text | — | string |
Alternate text associated with the image element. | ||
Width | 90 | double |
Element width in points. | ||
X | 0 | double |
Horizontal position within the containing report container, in points. | ||
Y | 0 | double |
Vertical position within the containing report container, in points. | ||
ReportLine
| Parameter | Default | Type |
|---|---|---|
Appearance | null | ReportAppearanceDefinition |
Fill and opacity settings applied to the element. | ||
BackgroundColor | null | ReportColor |
Background color applied to the element. | ||
Border | null | ReportBorderDefinition |
Border settings applied around the element. | ||
BorderColor | null | ReportColor |
Border color applied to the element. | ||
BorderRadius | null | double? |
Border radius applied to the element corners. | ||
BorderStyle | ReportBorderStyle.Default | ReportBorderStyle |
Border style applied around the element. Possible values: DefaultSolidDashedDotted | ||
BorderWidth | null | double? |
Border width applied around the element. | ||
CanGrow | false | ReportValue<bool> |
Allows text content to expand the element vertically when rendered. | ||
Class | — | string |
Additional CSS classes applied to the element. | ||
Height | 18 | double |
Element height in points. | ||
Name | — | string |
Friendly element name shown in the designer. | ||
Opacity | null | double? |
Element opacity from 0 to 1. | ||
Orientation | Horizontal | Orientation |
Line orientation within the element bounds. Possible values: HorizontalVertical | ||
ShowCollisionWarnings | true | bool |
Indicates whether the element participates in designer collision warnings. | ||
SnapToGrid | null | bool? |
Overrides the designer-level snap-to-grid behavior for this element. A null value inherits the designer setting. | ||
Style | — | string |
Inline style applied to the element. | ||
Suppress | false | ReportValue<bool> |
Prevents the element from being edited on the designer surface and rendered in preview output. | ||
Thickness | null | double? |
Line stroke thickness in points. | ||
Width | 90 | double |
Element width in points. | ||
X | 0 | double |
Horizontal position within the containing report container, in points. | ||
Y | 0 | double |
Vertical position within the containing report container, in points. | ||
ReportRectangle
| Parameter | Default | Type |
|---|---|---|
Appearance | null | ReportAppearanceDefinition |
Fill and opacity settings applied to the element. | ||
BackgroundColor | null | ReportColor |
Background color applied to the element. | ||
Border | null | ReportBorderDefinition |
Border settings applied around the element. | ||
BorderColor | null | ReportColor |
Border color applied to the element. | ||
BorderRadius | null | double? |
Border radius applied to the element corners. | ||
BorderStyle | ReportBorderStyle.Default | ReportBorderStyle |
Border style applied around the element. Possible values: DefaultSolidDashedDotted | ||
BorderWidth | null | double? |
Border width applied around the element. | ||
CanGrow | false | ReportValue<bool> |
Allows text content to expand the element vertically when rendered. | ||
Class | — | string |
Additional CSS classes applied to the element. | ||
Height | 18 | double |
Element height in points. | ||
Name | — | string |
Friendly element name shown in the designer. | ||
Opacity | null | double? |
Element opacity from 0 to 1. | ||
ShowCollisionWarnings | true | bool |
Indicates whether the element participates in designer collision warnings. | ||
SnapToGrid | null | bool? |
Overrides the designer-level snap-to-grid behavior for this element. A null value inherits the designer setting. | ||
Style | — | string |
Inline style applied to the element. | ||
Suppress | false | ReportValue<bool> |
Prevents the element from being edited on the designer surface and rendered in preview output. | ||
Width | 90 | double |
Element width in points. | ||
X | 0 | double |
Horizontal position within the containing report container, in points. | ||
Y | 0 | double |
Vertical position within the containing report container, in points. | ||
ReportPageBreak
| Parameter | Default | Type |
|---|---|---|
Appearance | null | ReportAppearanceDefinition |
Fill and opacity settings applied to the element. | ||
BackgroundColor | null | ReportColor |
Background color applied to the element. | ||
Border | null | ReportBorderDefinition |
Border settings applied around the element. | ||
BorderColor | null | ReportColor |
Border color applied to the element. | ||
BorderRadius | null | double? |
Border radius applied to the element corners. | ||
BorderStyle | ReportBorderStyle.Default | ReportBorderStyle |
Border style applied around the element. Possible values: DefaultSolidDashedDotted | ||
BorderWidth | null | double? |
Border width applied around the element. | ||
CanGrow | false | ReportValue<bool> |
Allows text content to expand the element vertically when rendered. | ||
Class | — | string |
Additional CSS classes applied to the element. | ||
Height | 18 | double |
Element height in points. | ||
Name | — | string |
Friendly element name shown in the designer. | ||
Opacity | null | double? |
Element opacity from 0 to 1. | ||
ShowCollisionWarnings | true | bool |
Indicates whether the element participates in designer collision warnings. | ||
SnapToGrid | null | bool? |
Overrides the designer-level snap-to-grid behavior for this element. A null value inherits the designer setting. | ||
Style | — | string |
Inline style applied to the element. | ||
Suppress | false | ReportValue<bool> |
Prevents the element from being edited on the designer surface and rendered in preview output. | ||
Width | 90 | double |
Element width in points. | ||
X | 0 | double |
Horizontal position within the containing report container, in points. | ||
Y | 0 | double |
Vertical position within the containing report container, in points. | ||
ReportTableColumn
| Parameter | Default | Type |
|---|---|---|
Field | — | string |
Field name rendered by cells in this column. | ||
Format | null | ReportFormatDefinition |
Format applied to column values. | ||
Title | — | string |
Header text displayed for the table column. | ||
Width | 90 | double |
Column width in points. | ||
ReportTableRow
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Cells declared inside the table row. | ||
Height | 24 | double |
Row height in points. | ||
ReportTableCell
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Elements declared inside the table cell. | ||
ColumnSpan | 1 | int |
Number of columns spanned by the cell. | ||
RowSpan | 1 | int |
Number of rows spanned by the cell. | ||
ReportDataSources
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Data source components declared for the parent report. | ||
ReportDataSource
| Parameter | Default | Type |
|---|---|---|
Data | null | object |
Object or enumerable exposed to the report designer and preview renderer, including nested objects and collections. | ||
Name | "Default" | string |
Name used by report bands and fields to reference this data source. | ||
ProviderType | — | string |
Data source provider type used to resolve schema and runtime data. | ||
Schema | null | ReportDataSourceSchema |
Field schema exposed by providers that do not use a reflected object model. | ||
Settings | [] | Dictionary<string, object> |
Provider-specific settings stored with the report definition. | ||
ReportObjectDataSource
| Parameter | Default | Type |
|---|---|---|
Data | null | object |
Object or enumerable exposed to the report designer and preview renderer, including nested objects and collections. | ||
Name | "Default" | string |
Name used by report bands and fields to reference this object data source. | ||
Schema | null | ReportDataSourceSchema |
Optional field schema used instead of schema inferred from the object model. | ||
ReportFormulaFields
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Formula field components declared for the parent report. | ||
ReportFormulaField
| Parameter | Default | Type |
|---|---|---|
Formula | — | string |
Formula expression evaluated when the field is rendered. | ||
Name | — | string |
Formula field name shown in the field explorer and used by expressions. | ||
ReportRunningTotals
| Parameter | Default | Type |
|---|---|---|
ChildContent | null | RenderFragment |
Running total field components declared for the parent report. | ||
ReportRunningTotal
| Parameter | Default | Type |
|---|---|---|
AggregateFunction | Sum | ReportAggregateFunction |
Summary operation used to update the running total value. Possible values: CountSumAverageMinimumMaximum | ||
DataSource | — | string |
Data source or path that provides the records being accumulated. | ||
EvaluateFormula | — | string |
Boolean formula used when EvaluateMode is set to Formula. | ||
EvaluateMode | EveryRecord | ReportRunningTotalEvaluateMode |
Determines whether every record or only formula-matching records are accumulated. Possible values: EveryRecordFormula | ||
Field | — | string |
Field path summarized by the running total. | ||
Id | System.Guid.NewGuid().ToString( "N" ) | string |
Stable identifier used by persisted report definitions. | ||
Name | — | string |
Running total field name shown in the field explorer and used by expressions. | ||
ResetGroupId | — | string |
Stable group section identifier used when ResetMode is set to Group. | ||
ResetMode | Never | ReportRunningTotalResetMode |
Determines when the accumulated value resets. Possible values: NeverGroup | ||
ReportToolbar
| Parameter | Default | Type |
|---|---|---|
ButtonTemplate | null | RenderFragment<ReportToolbarItemContext> |
Template used to render command buttons in the report toolbar. | ||
ChildContent | null | RenderFragment |
Toolbar items rendered by the report toolbar area. | ||
HiddenCommands | null | IReadOnlyCollection<ReportCommand> |
Commands omitted from the default report toolbar. | ||
ShowDataSourceButtons | true | bool |
Shows the data source command buttons in the default report toolbar. | ||
ShowEditButtons | true | bool |
Shows the edit command buttons in the default report toolbar. | ||
ShowExportButtons | true | bool |
Shows the export command buttons in the default report toolbar. | ||
ShowHistoryButtons | true | bool |
Shows the history command buttons in the default report toolbar. | ||
ShowModeButtons | true | bool |
Shows the report mode buttons in the default report toolbar. | ||
ShowPanesMenu | true | bool |
Shows the panes menu in the default report toolbar when dock panes are available. | ||
ShowPersistenceButtons | true | bool |
Shows the save and load buttons in the default report toolbar. | ||
ReportOptions
| Parameter | Default | Type |
|---|---|---|
AllowDownload | true | bool |
Enables download commands in report viewers by default. | ||
AllowPrint | true | bool |
Enables print commands in report viewers by default. | ||
DefaultPreviewFormat | Html | ReportPreviewFormat |
Preview format selected when a report first enters preview mode. Must be enabled in PreviewFormats. Possible values: NoneHtmlPdf | ||
DefinitionMode | SeedWhenEmpty | ReportDefinitionMode |
Strategy used when declarative report markup and persisted definitions are both available. Possible values: SeedWhenEmptyAlwaysUseDeclarativeUseDefinitionOnly | ||
Editable | false | bool |
Gets or sets whether reports can be edited using the interactive designer. | ||
PreviewFormats | Html | ReportPreviewFormat |
Preview formats available to report viewers by default. None disables preview. Possible values: NoneHtmlPdf | ||
ReportRenderOptions
| Parameter | Default | Type |
|---|---|---|
DataSources | new Dictionary<string, object>( StringComparer.OrdinalIgnoreCase ) | IDictionary<string, object> |
Gets or sets runtime data keyed by the data source names persisted in the report definition. | ||
DefaultData | null | object |
Gets or sets fallback runtime data used by report expressions and a single object data source. | ||
ElementPlugins | null | IEnumerable<IReportElementPlugin> |
Gets or sets custom report element plugins available only to this render operation. | ||
Parameters | new Dictionary<string, object>( StringComparer.OrdinalIgnoreCase ) | IDictionary<string, object> |
Gets or sets parameter values supplied to data source providers. | ||
BaseReportElementRenderer
| Parameter | Default | Type |
|---|---|---|
Context | null | ReportElementRenderContext |
Gets or sets the custom element render context. | ||
BaseReportElementPropertiesEditor
| Parameter | Default | Type |
|---|---|---|
Context | null | ReportElementPropertiesContext |
Gets or sets the custom element properties context. | ||
Events
Report
| Event | Type |
|---|---|
BandModeChanged | EventCallback<ReportBandMode> |
Raised when the designer band presentation changes. | |
DefinitionChanged | EventCallback<ReportDefinition> |
Raised with a snapshot of the updated report definition. | |
ElementNavigationModeChanged | EventCallback<ReportElementNavigationMode> |
Raised when the report element navigation mode changes. | |
ImageUpload | EventCallback<FileUploadEventArgs> |
Raised when the image upload action is confirmed. | |
ImageUploadChanged | EventCallback<FileChangedEventArgs> |
Raised when the selected image changes. | |
ImageUploadEnded | EventCallback<FileEndedEventArgs> |
Raised when reading an image ends. | |
ImageUploadProgressed | EventCallback<FileProgressedEventArgs> |
Raised when image read progress changes. | |
ImageUploadStarted | EventCallback<FileStartedEventArgs> |
Raised when reading an image starts. | |
ImageUploadWritten | EventCallback<FileWrittenEventArgs> |
Raised when an image chunk is read. | |
LoadRequested | Func<Task<ReportDefinition>> |
Handles requests to load a report definition. | |
ModeChanged | EventCallback<ReportMode> |
Raised when design or preview mode changes. | |
OperationFailed | EventCallback<ReportOperationFailedEventArgs> |
Raised when a report operation fails. | |
PdfProgressed | EventCallback<ReportProgress> |
Raised when the overall report PDF operation progress changes. | |
PreviewFormatChanged | EventCallback<ReportPreviewFormat> |
Raised when the preview format changes. | |
SaveRequested | Func<ReportDefinition, Task> |
Handles requests to save the current report definition. | |
ShowCollisionWarningsChanged | EventCallback<bool> |
Raised when collision warning visibility changes. | |
ShowCursorGuidesChanged | EventCallback<bool> |
Raised when cursor guide visibility changes. | |
ShowFineRulerTicksChanged | EventCallback<bool> |
Raised when fine-grained ruler tick visibility changes. | |
ShowRulersChanged | EventCallback<bool> |
Raised when designer ruler visibility changes. | |
ShowStatusBarChanged | EventCallback<bool> |
Raised when status bar visibility changes. | |
Methods
Report
| Method | Return | Parameters |
|---|---|---|
CanExecuteCommand | bool | ReportCommand command |
No documentation available - no XML comment
No documentation available - no XML comment | ||
ExecuteCommand | Task | ReportCommand command |
No documentation available - no XML comment
No documentation available - no XML comment | ||
GetDefinition | Task<ReportDefinition> | — |
Gets a copy of the current persistent report definition.
| ||
GetPdfDocument | Task<PdfDocumentDefinition> | CancellationToken cancellationToken |
Creates a PDF document definition from the current report state.
| ||
GetState | Task<ReportState> | — |
Gets the current interactive report designer state.
| ||
IsCommandActive | bool | ReportCommand command |
No documentation available - no XML comment
No documentation available - no XML comment | ||
LoadDefinition | Task | ReportDefinition definition |
Loads a persistent report definition.
| ||
LoadState | Task | ReportState state |
Loads an interactive report designer state.
| ||