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