Class WebReport

Represents the Web Report.

Inheritance
System.Object
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
WebReport
Namespace: FastReport.Web
Assembly: FastReport.Web.dll
Syntax
[ToolboxBitmap(typeof(WebReport), "Resources.Report.bmp")]
public class WebReport : WebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, INamingContainer

Constructors

WebReport()

Initializes a new instance of the WebReport class.

Declaration
public WebReport()

WebReport(Boolean)

Initializes a new instance of the WebReport class.

Declaration
public WebReport(bool inlineRegistration)
Parameters
Type Name Description
System.Boolean inlineRegistration

Enable registration of JS/CSS footprint inline.

WebReport(Boolean, Boolean)

Initializes a new instance of the WebReport class.

Declaration
public WebReport(bool inlineRegistration, bool stretched)
Parameters
Type Name Description
System.Boolean inlineRegistration

Enable registration of JS/CSS footprint inline.
System.Boolean stretched

Creates the control with 100% width and height.

Properties

AutoHeight

Used only if layers mode is off

Declaration
[Browsable(true)]
public bool AutoHeight { get; set; }
Property Value
Type Description
System.Boolean

AutoWidth

Used only if layers mode is off

Declaration
[Browsable(true)]
public bool AutoWidth { get; set; }
Property Value
Type Description
System.Boolean

ButtonsPath

Sets the path to the custom buttons on site.

Declaration
[Browsable(true)]
public string ButtonsPath { get; set; }
Property Value
Type Description
System.String
Remarks

Pictures should be named: Checkbox.gif, Progress.gif, toolbar.png, toolbar_background.png, toolbar_big.png, toolbar_disabled.png, toolbar_disabled.png

CacheDelay

Delay in cache in minutes

Declaration
[Browsable(true)]
public int CacheDelay { get; set; }
Property Value
Type Description
System.Int32

CachePriority

Priority of items in cache

Declaration
[Browsable(true)]
public CacheItemPriority CachePriority { get; set; }
Property Value
Type Description
System.Web.Caching.CacheItemPriority

CloudEnvironmet

Enable or disable the multiple instances environment

Declaration
[Browsable(true)]
public bool CloudEnvironmet { get; set; }
Property Value
Type Description
System.Boolean

CsvDataOnly

Enable or disable an exporting data without any header/group bands.

Declaration
[Browsable(true)]
public bool CsvDataOnly { get; set; }
Property Value
Type Description
System.Boolean

CsvSeparator

Gets or sets the cells separator.

Declaration
[Browsable(true)]
public string CsvSeparator { get; set; }
Property Value
Type Description
System.String

CurrentPage

Gets or sets number of current page.

Declaration
[Browsable(false)]
public int CurrentPage { get; set; }
Property Value
Type Description
System.Int32

CurrentTab

Gets the current tab.

Declaration
[Browsable(false)]
public ReportTab CurrentTab { get; }
Property Value
Type Description
ReportTab

CurrentTabIndex

Gets or sets the current tab index.

Declaration
[Browsable(false)]
public int CurrentTabIndex { get; set; }
Property Value
Type Description
System.Int32

DateTimePickerFormat

Gets or sets date time format in jqueryui datepicker style

Declaration
[Browsable(true)]
public string DateTimePickerFormat { get; set; }
Property Value
Type Description
System.String

Debug

Enables or disables showing any debug information on errors.

Declaration
[Browsable(true)]
public bool Debug { get; set; }
Property Value
Type Description
System.Boolean

DesignerConfig

Gets or sets the text of configuration of Online Designer

Declaration
[Browsable(true)]
public string DesignerConfig { get; set; }
Property Value
Type Description
System.String

DesignerLocale

Gets or sets the locale of Designer

Declaration
[Browsable(true)]
public string DesignerLocale { get; set; }
Property Value
Type Description
System.String

DesignerPath

Gets or sets path to the Report Designer

Declaration
[Browsable(true)]
public string DesignerPath { get; set; }
Property Value
Type Description
System.String

DesignerSaveCallBack

Gets or sets path to callback page after Save from Designer

Declaration
[Browsable(true)]
public string DesignerSaveCallBack { get; set; }
Property Value
Type Description
System.String

DesignerSavePath

Gets or sets path to a folder for save designed reports If value is empty then designer posts saved report in variable ReportFile on call the DesignerSaveCallBack

Declaration
[Browsable(true)]
public string DesignerSavePath { get; set; }
Property Value
Type Description
System.String

DesignReport

Enable the Report Designer

Declaration
[Browsable(true)]
public bool DesignReport { get; set; }
Property Value
Type Description
System.Boolean

DesignScriptCode

Enable code editor in the Report Designer

Declaration
[Browsable(true)]
public bool DesignScriptCode { get; set; }
Property Value
Type Description
System.Boolean

Dialogs

Enables or disables showing the report dialogs.

Declaration
[Browsable(true)]
public bool Dialogs { get; set; }
Property Value
Type Description
System.Boolean

DocxMatrixBased

Enable or disable a matrix view of Word 2007 document.

Declaration
[Browsable(true)]
public bool DocxMatrixBased { get; set; }
Property Value
Type Description
System.Boolean

DocxParagraphBased

Enable or disable a paragraph view of Word 2007 document.

Declaration
[Browsable(true)]
public bool DocxParagraphBased { get; set; }
Property Value
Type Description
System.Boolean

DocxPrintOptimized

Enable or disable the print optimized images in Word 2007 document.

Declaration
[Browsable(true)]
public bool DocxPrintOptimized { get; set; }
Property Value
Type Description
System.Boolean

DocxRowHeightIs

Gets or sets a value of RowHeightIs Word 2007 document.

Declaration
[Browsable(true)]
public string DocxRowHeightIs { get; set; }
Property Value
Type Description
System.String

DocxWysiwyg

Enable or disable the WYSIWYG for Word 2007 document.

Declaration
[Browsable(true)]
public bool DocxWysiwyg { get; set; }
Property Value
Type Description
System.Boolean

EmbedPictures

Enables or disables embedding pictures in HTML (inline HTML5 images).

Declaration
[Browsable(true)]
public bool EmbedPictures { get; set; }
Property Value
Type Description
System.Boolean

EnableMargins

Declaration
[Browsable(true)]
public bool EnableMargins { get; set; }
Property Value
Type Description
System.Boolean

ExternalJquery

Enable or disable using of external jQuery library

Declaration
[Browsable(true)]
public bool ExternalJquery { get; set; }
Property Value
Type Description
System.Boolean

Height

Declaration
public override Unit Height { get; set; }
Property Value
Type Description
System.Web.UI.WebControls.Unit
Overrides
System.Web.UI.WebControls.WebControl.Height

InlineRegistration

Enable or disable inline object registration

Declaration
[Browsable(true)]
public bool InlineRegistration { get; set; }
Property Value
Type Description
System.Boolean

Layers

Enable or disable layers mode visualisation

Declaration
[Browsable(true)]
public bool Layers { get; set; }
Property Value
Type Description
System.Boolean

LocalizationFile

Gets or sets the name of localization file.

Declaration
[Browsable(true)]
public string LocalizationFile { get; set; }
Property Value
Type Description
System.String

LogFile

Gets or sets the log file path.

Declaration
[Browsable(true)]
public string LogFile { get; set; }
Property Value
Type Description
System.String

MhtPictures

Gets or sets a value indicating that pictures are enabled.

Declaration
[Browsable(true)]
public bool MhtPictures { get; set; }
Property Value
Type Description
System.Boolean

MhtWysiwyg

Gets or sets a value that determines whether the wysiwyg mode should be used for better results.

Declaration
[Browsable(true)]
public bool MhtWysiwyg { get; set; }
Property Value
Type Description
System.Boolean

OdsCreator

Gets or sets the creator of the document.

Declaration
[Browsable(true)]
public string OdsCreator { get; set; }
Property Value
Type Description
System.String

OdsPageBreaks

Gets or sets a value indicating that page breaks are enabled.

Declaration
[Browsable(true)]
public bool OdsPageBreaks { get; set; }
Property Value
Type Description
System.Boolean

OdsWysiwyg

Gets or sets a value that determines whether the wysiwyg mode should be used for better results.

Declaration
[Browsable(true)]
public bool OdsWysiwyg { get; set; }
Property Value
Type Description
System.Boolean

OdtCreator

Gets or sets the creator of the document.

Declaration
[Browsable(true)]
public string OdtCreator { get; set; }
Property Value
Type Description
System.String

OdtPageBreaks

Gets or sets a value indicating that page breaks are enabled.

Declaration
[Browsable(true)]
public bool OdtPageBreaks { get; set; }
Property Value
Type Description
System.Boolean

OdtWysiwyg

Gets or sets a value that determines whether the wysiwyg mode should be used for better results.

Declaration
[Browsable(true)]
public bool OdtWysiwyg { get; set; }
Property Value
Type Description
System.Boolean

Padding

Gets or sets Padding of Report section

Declaration
[Browsable(true)]
public Padding Padding { get; set; }
Property Value
Type Description
System.Windows.Forms.Padding

PdfA

Enable or disable the PDF/A document.

Declaration
[Browsable(true)]
public bool PdfA { get; set; }
Property Value
Type Description
System.Boolean

PdfAllowAnnotate

Enable or disable an annotating in protected document.

Declaration
[Browsable(true)]
public bool PdfAllowAnnotate { get; set; }
Property Value
Type Description
System.Boolean

PdfAllowCopy

Enable or disable a copying in protected document.

Declaration
[Browsable(true)]
public bool PdfAllowCopy { get; set; }
Property Value
Type Description
System.Boolean

PdfAllowModify

Enable or disable a modifying in protected document.

Declaration
[Browsable(true)]
public bool PdfAllowModify { get; set; }
Property Value
Type Description
System.Boolean

PdfAllowPrint

Enable or disable a printing in protected document.

Declaration
[Browsable(true)]
public bool PdfAllowPrint { get; set; }
Property Value
Type Description
System.Boolean

PdfAuthor

Sets the Author of the document.

Declaration
[Browsable(true)]
public string PdfAuthor { get; set; }
Property Value
Type Description
System.String

PdfBackground

Enable or disable an exporting of the background in PDF.

Declaration
[Browsable(true)]
public bool PdfBackground { get; set; }
Property Value
Type Description
System.Boolean

PdfCenterWindow

Enable or disable a centering the window.

Declaration
[Browsable(true)]
public bool PdfCenterWindow { get; set; }
Property Value
Type Description
System.Boolean

PdfColorSpace

Select a color space (RGB or CMYK)

Declaration
[Browsable(true)]
public PDFExport.PdfColorSpace PdfColorSpace { get; set; }
Property Value
Type Description
PDFExport.PdfColorSpace

PdfCreator

Sets the Creator of the document.

Declaration
[Browsable(true)]
public string PdfCreator { get; set; }
Property Value
Type Description
System.String

PdfDisplayDocTitle

Enable or disable a displaying document's title.

Declaration
[Browsable(true)]
public bool PdfDisplayDocTitle { get; set; }
Property Value
Type Description
System.Boolean

PdfEmbeddingFonts

Enable or disable an embedding the TrueType fonts.

Declaration
[Browsable(true)]
public bool PdfEmbeddingFonts { get; set; }
Property Value
Type Description
System.Boolean

PdfFitWindow

Enable or disable a fitting the window.

Declaration
[Browsable(true)]
public bool PdfFitWindow { get; set; }
Property Value
Type Description
System.Boolean

PdfHideMenubar

Enable or disable a hiding the menu's bar.

Declaration
[Browsable(true)]
public bool PdfHideMenubar { get; set; }
Property Value
Type Description
System.Boolean

PdfHideToolbar

Enable or disable a hiding the toolbar.

Declaration
[Browsable(true)]
public bool PdfHideToolbar { get; set; }
Property Value
Type Description
System.Boolean

PdfHideWindowUI

Enable or disable a hiding the Windows UI.

Declaration
[Browsable(true)]
public bool PdfHideWindowUI { get; set; }
Property Value
Type Description
System.Boolean

PdfImagesOriginalResolution

Enable or disable the Images Original Resolution.

Declaration
[Browsable(true)]
public bool PdfImagesOriginalResolution { get; set; }
Property Value
Type Description
System.Boolean

PdfInteractiveForms

Enable or disable the Intercative Forms inside PDF.

Declaration
[Browsable(true)]
public bool PdfInteractiveForms { get; set; }
Property Value
Type Description
System.Boolean

PdfJpegCompression

Enable or disable the Jpeg Compression.

Declaration
[Browsable(true)]
public bool PdfJpegCompression { get; set; }
Property Value
Type Description
System.Boolean

PdfKeywords

Sets the Keywords of the document.

Declaration
[Browsable(true)]
public string PdfKeywords { get; set; }
Property Value
Type Description
System.String

PdfOutline

Enable or disable a document's Outline.

Declaration
[Browsable(true)]
public bool PdfOutline { get; set; }
Property Value
Type Description
System.Boolean

PdfOwnerPassword

Sets the owners password.

Declaration
[Browsable(true)]
public string PdfOwnerPassword { get; set; }
Property Value
Type Description
System.String

PdfPrintOptimized

Enable or disable an optimization the images for printing.

Declaration
[Browsable(true)]
public bool PdfPrintOptimized { get; set; }
Property Value
Type Description
System.Boolean

PdfPrintScaling

Enable or disable a scaling the page for shrink to printable area.

Declaration
[Browsable(true)]
public bool PdfPrintScaling { get; set; }
Property Value
Type Description
System.Boolean

PdfProducer

Sets the Producer of the document.

Declaration
[Browsable(true)]
public string PdfProducer { get; set; }
Property Value
Type Description
System.String

PdfShowPrintDialog

Enable or disable a showing of Print Dialog.

Declaration
[Browsable(true)]
public bool PdfShowPrintDialog { get; set; }
Property Value
Type Description
System.Boolean

PdfSubject

Sets the Subject of the document.

Declaration
[Browsable(true)]
public string PdfSubject { get; set; }
Property Value
Type Description
System.String

PdfTextInCurves

Enable or disable an export text in curves.

Declaration
[Browsable(true)]
public bool PdfTextInCurves { get; set; }
Property Value
Type Description
System.Boolean

PdfTitle

Sets the Title of the document.

Declaration
[Browsable(true)]
public string PdfTitle { get; set; }
Property Value
Type Description
System.String

PdfUserPassword

Sets the users password.

Declaration
[Browsable(true)]
public string PdfUserPassword { get; set; }
Property Value
Type Description
System.String

Pictures

Switches the pictures visibility in report

Declaration
[Browsable(true)]
public bool Pictures { get; set; }
Property Value
Type Description
System.Boolean

PptxImageFormat

Gets or sets an image format that will be used to save pictures in PowerPoint file.

Declaration
[Browsable(true)]
public PptImageFormat PptxImageFormat { get; set; }
Property Value
Type Description
PptImageFormat

PreviewMode

Enables the preview mode for working together the Online Designer.

Declaration
[Browsable(false)]
public bool PreviewMode { get; set; }
Property Value
Type Description
System.Boolean

PrintInBrowser

Enable or disable print in browser.

Declaration
[Browsable(true)]
public bool PrintInBrowser { get; set; }
Property Value
Type Description
System.Boolean

PrintInPdf

Enable or disable print in PDF.

Declaration
[Browsable(true)]
public bool PrintInPdf { get; set; }
Property Value
Type Description
System.Boolean

PrintWindowHeight

Sets the height of print window.

Declaration
[Browsable(true)]
public string PrintWindowHeight { get; set; }
Property Value
Type Description
System.String

PrintWindowWidth

Sets the width of print window.

Declaration
[Browsable(true)]
public string PrintWindowWidth { get; set; }
Property Value
Type Description
System.String

RefreshTimeout

Timeout in seconds for automatic refresh of report. Zero value disable auto-refresh.

Declaration
[Browsable(true)]
public int RefreshTimeout { get; set; }
Property Value
Type Description
System.Int32

Report

Direct access to Report object.

Declaration
[Browsable(false)]
public Report Report { get; set; }
Property Value
Type Description
Report

ReportDataSources

Gets or sets report data source(s).

Declaration
[Browsable(true)]
public string ReportDataSources { get; set; }
Property Value
Type Description
System.String
Remarks

To pass several datasources, use ';' delimiter, for example: "sqlDataSource1;sqlDataSource2"

ReportDone

Returns true when report done. This property may be set in true for forcing load the prepared report.

Declaration
[Browsable(false)]
public bool ReportDone { get; set; }
Property Value
Type Description
System.Boolean

ReportFile

Gets or sets the name of report file.

Declaration
[Browsable(true)]
public string ReportFile { get; set; }
Property Value
Type Description
System.String

ReportGuid

Gets or sets guid of report.

Declaration
[Browsable(false)]
public string ReportGuid { get; set; }
Property Value
Type Description
System.String

ReportPath

Gets or sets the default path for reports (including inherited).

Declaration
public string ReportPath { get; set; }
Property Value
Type Description
System.String

ReportResourceString

Report Resource String.

Declaration
[Browsable(true)]
public string ReportResourceString { get; set; }
Property Value
Type Description
System.String

RequestHeaders

Gets or sets the request headers.

Declaration
[Browsable(false)]
public WebHeaderCollection RequestHeaders { get; set; }
Property Value
Type Description
System.Net.WebHeaderCollection

ResponseHeaders

Gets or sets the response headers.

Declaration
[Browsable(false)]
public WebHeaderCollection ResponseHeaders { get; set; }
Property Value
Type Description
System.Net.WebHeaderCollection

RtfAutoSize

Gets or sets a value that determines whether the rows in the resulting table should calculate its height automatically.

Declaration
[Browsable(true)]
public bool RtfAutoSize { get; set; }
Property Value
Type Description
System.Boolean

RtfCreator

Gets or sets the creator of the document.

Declaration
[Browsable(true)]
public string RtfCreator { get; set; }
Property Value
Type Description
System.String

RtfImageFormat

Gets or sets the image format that will be used to save pictures in RTF file.

Declaration
[Browsable(true)]
public RTFImageFormat RtfImageFormat { get; set; }
Property Value
Type Description
RTFImageFormat
Remarks

Default value is Metafile. This format is better for exporting such objects as MSChartObject and ShapeObject.

RtfJpegQuality

Gets or sets the quality of Jpeg images in RTF file.

Declaration
[Browsable(true)]
public int RtfJpegQuality { get; set; }
Property Value
Type Description
System.Int32
Remarks

Default value is 90. This property will be used if you select Jpeg in the RtfImageFormat property.

RtfPageBreaks

Gets or sets a value indicating that page breaks are enabled.

Declaration
[Browsable(true)]
public bool RtfPageBreaks { get; set; }
Property Value
Type Description
System.Boolean

RtfPictures

Gets or sets a value indicating that pictures are enabled.

Declaration
[Browsable(true)]
public bool RtfPictures { get; set; }
Property Value
Type Description
System.Boolean

RtfWysiwyg

Gets or sets a value that determines whether the wysiwyg mode should be used for better results.

Declaration
[Browsable(true)]
public bool RtfWysiwyg { get; set; }
Property Value
Type Description
System.Boolean

ShowAfterPrepare

Enables or disables showing the report after call Prepare.

Declaration
[Browsable(true)]
public bool ShowAfterPrepare { get; set; }
Property Value
Type Description
System.Boolean

ShowBackButton

Switches the visibility of Back buttons.

Declaration
[Browsable(true)]
public bool ShowBackButton { get; set; }
Property Value
Type Description
System.Boolean

ShowBottomToolbar

Switches the bottom toolbar visibility.

Declaration
[Browsable(true)]
public bool ShowBottomToolbar { get; set; }
Property Value
Type Description
System.Boolean

ShowCsvExport

Switch visibility the CSV (comma separated values) export in toolbar.

Declaration
[Browsable(true)]
public bool ShowCsvExport { get; set; }
Property Value
Type Description
System.Boolean

ShowDbfExport

Switches a visibility of DBF export in toolbar.

Declaration
[Browsable(true)]
public bool ShowDbfExport { get; set; }
Property Value
Type Description
System.Boolean

ShowExcel2007Export

Switches a visibility of Excel 2007 export in toolbar.

Declaration
[Browsable(true)]
public bool ShowExcel2007Export { get; set; }
Property Value
Type Description
System.Boolean

ShowExports

Switches the visibility of Exports in toolbar.

Declaration
[Browsable(true)]
public bool ShowExports { get; set; }
Property Value
Type Description
System.Boolean

ShowFirstButton

Switches the visibility of First Button in toolbar.

Declaration
[Browsable(true)]
public bool ShowFirstButton { get; set; }
Property Value
Type Description
System.Boolean

ShowLastButton

Switches the visibility of Last Button in toolbar.

Declaration
[Browsable(true)]
public bool ShowLastButton { get; set; }
Property Value
Type Description
System.Boolean

ShowMhtExport

Switches a visibility of MHT (web-archive) export in toolbar.

Declaration
[Browsable(true)]
public bool ShowMhtExport { get; set; }
Property Value
Type Description
System.Boolean

ShowNextButton

Switches the visibility of Next Button in toolbar.

Declaration
[Browsable(true)]
public bool ShowNextButton { get; set; }
Property Value
Type Description
System.Boolean

ShowOdsExport

Switches a visibility of Open Office Spreadsheet (ODS) export in toolbar.

Declaration
[Browsable(true)]
public bool ShowOdsExport { get; set; }
Property Value
Type Description
System.Boolean

ShowOdtExport

Switches a visibility of Open Office Text (ODT) export in toolbar

Declaration
[Browsable(true)]
public bool ShowOdtExport { get; set; }
Property Value
Type Description
System.Boolean

ShowOutline

Switches the outline visibility.

Declaration
[Browsable(true)]
public bool ShowOutline { get; set; }
Property Value
Type Description
System.Boolean

ShowPageNumber

Switches the visibility of Page Number in toolbar.

Declaration
[Browsable(true)]
public bool ShowPageNumber { get; set; }
Property Value
Type Description
System.Boolean

ShowPdfExport

Switches a visibility of PDF (Adobe Acrobat) export in toolbar.

Declaration
[Browsable(true)]
public bool ShowPdfExport { get; set; }
Property Value
Type Description
System.Boolean

ShowPowerPoint2007Export

Switches a visibility of PowerPoint 2007 export in toolbar.

Declaration
[Browsable(true)]
public bool ShowPowerPoint2007Export { get; set; }
Property Value
Type Description
System.Boolean

ShowPreparedReport

Switch a visibility of prepared report export in toolbar

Declaration
[Browsable(true)]
public bool ShowPreparedReport { get; set; }
Property Value
Type Description
System.Boolean

ShowPrevButton

Switches the visibility of Previous Button in toolbar.

Declaration
[Browsable(true)]
public bool ShowPrevButton { get; set; }
Property Value
Type Description
System.Boolean

ShowPrint

Switches the visibility of Print button in toolbar.

Declaration
[Browsable(true)]
public bool ShowPrint { get; set; }
Property Value
Type Description
System.Boolean

ShowRefreshButton

Switches the visibility of Refresh in toolbar.

Declaration
[Browsable(true)]
public bool ShowRefreshButton { get; set; }
Property Value
Type Description
System.Boolean

ShowRtfExport

Switches a visibility of RTF export in toolbar.

Declaration
[Browsable(true)]
public bool ShowRtfExport { get; set; }
Property Value
Type Description
System.Boolean

ShowTabCloseButton

Switches the visibility of closing buttons for Tabs.

Declaration
[Browsable(true)]
public bool ShowTabCloseButton { get; set; }
Property Value
Type Description
System.Boolean

ShowTextExport

Switch a visibility of text (plain text) export in toolbar

Declaration
[Browsable(true)]
public bool ShowTextExport { get; set; }
Property Value
Type Description
System.Boolean

ShowToolbar

Switches the toolbar visibility.

Declaration
[Browsable(true)]
public bool ShowToolbar { get; set; }
Property Value
Type Description
System.Boolean

ShowWord2007Export

Switches a visibility of Word 2007 export in toolbar.

Declaration
[Browsable(true)]
public bool ShowWord2007Export { get; set; }
Property Value
Type Description
System.Boolean

ShowXmlExcelExport

Switches a visibility of XML (Excel) export in toolbar.

Declaration
[Browsable(true)]
public bool ShowXmlExcelExport { get; set; }
Property Value
Type Description
System.Boolean

ShowXpsExport

Switches a visibility of XPS export in toolbar.

Declaration
[Browsable(true)]
public bool ShowXpsExport { get; set; }
Property Value
Type Description
System.Boolean

ShowZoomButton

Switches the visibility of Zoom in toolbar.

Declaration
[Browsable(true)]
public bool ShowZoomButton { get; set; }
Property Value
Type Description
System.Boolean

SinglePage

Switches the pages layout between multiple pages (false) and single page (true).

Declaration
[Browsable(true)]
public bool SinglePage { get; set; }
Property Value
Type Description
System.Boolean

State

Gets or sets current state of report.

Declaration
[Browsable(false)]
public ReportState State { get; set; }
Property Value
Type Description
ReportState

TabPosition

Selects the position of tabs.

Declaration
[Browsable(true)]
public TabPosition TabPosition { get; set; }
Property Value
Type Description
TabPosition

Tabs

Direct access to the Tabs.

Declaration
[Browsable(false)]
public List<ReportTab> Tabs { get; }
Property Value
Type Description
System.Collections.Generic.List<ReportTab>

TextAllowFrames

Enable or disable the frames in text file.

Declaration
[Browsable(true)]
public bool TextAllowFrames { get; set; }
Property Value
Type Description
System.Boolean

TextDataOnly

Enable or disable an exporting data without any header/group bands.

Declaration
[Browsable(true)]
public bool TextDataOnly { get; set; }
Property Value
Type Description
System.Boolean

TextEmptyLines

Enable or disable an empty lines in text file.

Declaration
[Browsable(true)]
public bool TextEmptyLines { get; set; }
Property Value
Type Description
System.Boolean

TextPageBreaks

Gets or sets a value indicating that page breaks are enabled.

Declaration
[Browsable(true)]
public bool TextPageBreaks { get; set; }
Property Value
Type Description
System.Boolean

TextSimpleFrames

Enable or disable the simple (non graphic) frames in text file.

Declaration
[Browsable(true)]
public bool TextSimpleFrames { get; set; }
Property Value
Type Description
System.Boolean

ToolbarBackgroundStyle

Sets the toolbar background style.

Declaration
[Browsable(true)]
public ToolbarBackgroundStyle ToolbarBackgroundStyle { get; set; }
Property Value
Type Description
ToolbarBackgroundStyle

ToolbarColor

Sets the Toolbar background color.

Declaration
[Browsable(true)]
public Color ToolbarColor { get; set; }
Property Value
Type Description
System.Drawing.Color

ToolbarIconsStyle

Sets the toolbar icons style.

Declaration
[Browsable(true)]
public ToolbarIconsStyle ToolbarIconsStyle { get; set; }
Property Value
Type Description
ToolbarIconsStyle

ToolbarStyle

Sets the toolbar style - small or large.

Declaration
[Browsable(true)]
public ToolbarStyle ToolbarStyle { get; set; }
Property Value
Type Description
ToolbarStyle

TotalPages

Gets total pages of current report.

Declaration
[Browsable(false)]
public int TotalPages { get; }
Property Value
Type Description
System.Int32

UnlimitedHeight

Enables or disables unlimited height of report pages. This options overrides the report page property value when it set to true.

Declaration
[Browsable(true)]
public bool UnlimitedHeight { get; set; }
Property Value
Type Description
System.Boolean

UnlimitedWidth

Enables or disables unlimited width of report pages. This options overrides the report page property value when it set to true.

Declaration
[Browsable(true)]
public bool UnlimitedWidth { get; set; }
Property Value
Type Description
System.Boolean

Width

Declaration
public override Unit Width { get; set; }
Property Value
Type Description
System.Web.UI.WebControls.Unit
Overrides
System.Web.UI.WebControls.WebControl.Width

XlsxDataOnly

Enable or disable an exporting data without any header/group bands.

Declaration
[Browsable(true)]
public bool XlsxDataOnly { get; set; }
Property Value
Type Description
System.Boolean

XlsxGroupOnSeparateSheet

Enable or disable the Print Fit in Excel 2007 document.

Declaration
[Browsable(true)]
public bool XlsxGroupOnSeparateSheet { get; set; }
Property Value
Type Description
System.Boolean

XlsxPageBreaks

Gets or sets a value indicating that page breaks are enabled.

Declaration
[Browsable(true)]
public bool XlsxPageBreaks { get; set; }
Property Value
Type Description
System.Boolean

XlsxPrintFitPage

Enable or disable the Print Fit in Excel 2007 document.

Declaration
[Browsable(true)]
public bool XlsxPrintFitPage { get; set; }
Property Value
Type Description
System.Boolean

XlsxPrintOptimized

Enable or disable the print optimized images in Excel 2007 document.

Declaration
[Browsable(true)]
public bool XlsxPrintOptimized { get; set; }
Property Value
Type Description
System.Boolean

XlsxSeamless

Gets or sets a value indicating that table without breaks are enabled.

Declaration
[Browsable(true)]
public bool XlsxSeamless { get; set; }
Property Value
Type Description
System.Boolean

XlsxWysiwyg

Gets or sets a value that determines whether the wysiwyg mode should be used for better results.

Declaration
[Browsable(true)]
public bool XlsxWysiwyg { get; set; }
Property Value
Type Description
System.Boolean

XmlExcelDataOnly

Enable or disable an exporting data without any header/group bands.

Declaration
[Browsable(true)]
public bool XmlExcelDataOnly { get; set; }
Property Value
Type Description
System.Boolean

XmlExcelPageBreaks

Gets or sets a value indicating that page breaks are enabled.

Declaration
[Browsable(true)]
public bool XmlExcelPageBreaks { get; set; }
Property Value
Type Description
System.Boolean

XmlExcelWysiwyg

Gets or sets a value that determines whether the wysiwyg mode should be used for better results.

Declaration
[Browsable(true)]
public bool XmlExcelWysiwyg { get; set; }
Property Value
Type Description
System.Boolean

Zoom

Sets the zoom scale factor of previewed page between 0..1f.

Declaration
[Browsable(true)]
public float Zoom { get; set; }
Property Value
Type Description
System.Single

ZoomMode

Sets the zoom mode of previewed page.

Declaration
[Browsable(true)]
public ZoomMode ZoomMode { get; set; }
Property Value
Type Description
ZoomMode

Methods

AddAttributesToRender(HtmlTextWriter)

Declaration
protected override void AddAttributesToRender(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer
Overrides
System.Web.UI.WebControls.WebControl.AddAttributesToRender(System.Web.UI.HtmlTextWriter)

AddTab(Report)

Adds the new report tab.

Declaration
public ReportTab AddTab(Report report)
Parameters
Type Name Description
Report report
Returns
Type Description
ReportTab

AddTab(Report, String)

Adds the new report tab.

Declaration
public ReportTab AddTab(Report report, string name)
Parameters
Type Name Description
Report report
System.String name
Returns
Type Description
ReportTab

AddTab(Report, String, Boolean)

Adds the new report tab.

Declaration
public ReportTab AddTab(Report report, string name, bool reportDone)
Parameters
Type Name Description
Report report
System.String name
System.Boolean reportDone
Returns
Type Description
ReportTab

AddTab(Report, String, Boolean, Boolean)

Adds the new report tab.

Declaration
public ReportTab AddTab(Report report, string name, bool reportDone, bool needParent)
Parameters
Type Name Description
Report report
System.String name
System.Boolean reportDone
System.Boolean needParent
Returns
Type Description
ReportTab

ExportCsv()

Exports in CSV format.

Declaration
public void ExportCsv()

ExportCsv(HttpContext)

Exports in CSV format.

Declaration
public void ExportCsv(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportDbf()

Exports in DBF format.

Declaration
public void ExportDbf()

ExportDbf(HttpContext)

Exports in DBF format.

Declaration
public void ExportDbf(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportExcel2007()

Exports in Excel 2007 format.

Declaration
public void ExportExcel2007()

ExportExcel2007(HttpContext)

Exports in Excel 2007 format.

Declaration
public void ExportExcel2007(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportHtml(HttpContext, Boolean, Boolean)

Exports in HTML format inline.

Declaration
public void ExportHtml(HttpContext context, bool displayInline, bool print)
Parameters
Type Name Description
System.Web.HttpContext context
System.Boolean displayInline
System.Boolean print

ExportMht()

Exports in MHT format.

Declaration
public void ExportMht()

ExportMht(HttpContext)

Exports in MHT format.

Declaration
public void ExportMht(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportOds()

Exports in Open Office Spreadsheet format.

Declaration
public void ExportOds()

ExportOds(HttpContext)

Exports in Open Office Spreadsheet format.

Declaration
public void ExportOds(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportOdt()

Exports in Open Office Text format.

Declaration
public void ExportOdt()

ExportOdt(HttpContext)

Exports in Open Office Text format.

Declaration
public void ExportOdt(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportPdf()

Exports in PDF format.

Declaration
public void ExportPdf()

ExportPdf(Boolean)

Exports in PDF format.

Declaration
public void ExportPdf(bool displayInline)
Parameters
Type Name Description
System.Boolean displayInline

ExportPdf(HttpContext)

Exports in PDF format.

Declaration
public void ExportPdf(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportPdf(HttpContext, Boolean, Boolean, Boolean)

Exports in PDF format inline.

Declaration
public void ExportPdf(HttpContext context, bool displayInline, bool showPrintDialog, bool print)
Parameters
Type Name Description
System.Web.HttpContext context
System.Boolean displayInline
System.Boolean showPrintDialog
System.Boolean print

ExportPowerPoint2007()

Exports in PowerPoint 2007 format.

Declaration
public void ExportPowerPoint2007()

ExportPowerPoint2007(HttpContext)

Exports in PowerPoint 2007 format.

Declaration
public void ExportPowerPoint2007(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportPrepared()

Exports in prepared report.

Declaration
public void ExportPrepared()

ExportPrepared(HttpContext)

Exports in prepared report.

Declaration
public void ExportPrepared(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportRtf()

Exports in RTF format.

Declaration
public void ExportRtf()

ExportRtf(HttpContext)

Exports in RTF format.

Declaration
public void ExportRtf(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportText()

Exports in Text format.

Declaration
public void ExportText()

ExportText(HttpContext)

Exports in Text format.

Declaration
public void ExportText(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportWord2007()

Exports in Word 2007 format.

Declaration
public void ExportWord2007()

ExportWord2007(HttpContext)

Exports in Word 2007 format.

Declaration
public void ExportWord2007(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportXmlExcel()

Exports in XML (Excel 2003) format.

Declaration
public void ExportXmlExcel()

ExportXmlExcel(HttpContext)

Exports in XML (Excel 2003) format.

Declaration
public void ExportXmlExcel(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

ExportXps()

Exports in XPS format.

Declaration
public void ExportXps()

ExportXps(HttpContext)

Exports in XPS format.

Declaration
public void ExportXps(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

FirstPage()

Forces going to the first report page.

Declaration
public void FirstPage()

GetColor(Color)

Declaration
protected string GetColor(Color color)
Parameters
Type Name Description
System.Drawing.Color color
Returns
Type Description
System.String

GetHtml()

Returns the HTML code of report preview control.

Declaration
public HtmlString GetHtml()
Returns
Type Description
System.Web.HtmlString

HtmlString object.

GetPreparedData()

Gets the stream with serialized prepared report data.

Declaration
public Stream GetPreparedData()
Returns
Type Description
System.IO.Stream

Stream object.

GetPropData()

Gets the stream with serialized properties data.

Declaration
public Stream GetPropData()
Returns
Type Description
System.IO.Stream

Stream object.

GetReportData()

Gets the stream with serialized report data.

Declaration
public Stream GetReportData()
Returns
Type Description
System.IO.Stream

Stream object.

LastPage()

Forces going to the last report page.

Declaration
public void LastPage()

LoadFromFile(String)

Loads the report from file.

Declaration
public WebReport LoadFromFile(string fileName)
Parameters
Type Name Description
System.String fileName

File Name.
Returns
Type Description
WebReport

WebReport object.

LoadFromStream(Stream)

Loads the report from stream.

Declaration
public WebReport LoadFromStream(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

Stream object.
Returns
Type Description
WebReport

WebReport object.

LoadPrepared(Stream)

Loads the prepared report from stream. Also the property ReportDone will be enabled and ShowRefreshButton will be disabled.

Declaration
public WebReport LoadPrepared(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

Stream object.
Returns
Type Description
WebReport

WebReport object.

LoadPrepared(String)

Loads the prepared report from file. Also the property ReportDone will be enabled and ShowRefreshButton will be disabled.

Declaration
public WebReport LoadPrepared(string fileName)
Parameters
Type Name Description
System.String fileName

File Name.
Returns
Type Description
WebReport

WebReport object.

NextPage()

Forces going to the next report page.

Declaration
public void NextPage()

OnCustomAuth(CustomAuthEventArgs)

Runs the OnCustomAuth event.

Declaration
public void OnCustomAuth(CustomAuthEventArgs e)
Parameters
Type Name Description
CustomAuthEventArgs e

CustomAuthEventArgs object.

OnCustomDraw(CustomDrawEventArgs)

Runs the OnCustomDraw event.

Declaration
public void OnCustomDraw(CustomDrawEventArgs e)
Parameters
Type Name Description
CustomDrawEventArgs e

CustomDrawEventArgs object.

OnInit(EventArgs)

Declaration
protected override void OnInit(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides
System.Web.UI.Control.OnInit(System.EventArgs)

OnLoad(EventArgs)

Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides
System.Web.UI.Control.OnLoad(System.EventArgs)

OnSaveDesignedReport(SaveDesignedReportEventArgs)

Runs the SaveDesignedReport event.

Declaration
public void OnSaveDesignedReport(SaveDesignedReportEventArgs e)
Parameters
Type Name Description
SaveDesignedReportEventArgs e

SaveDesignedReportEventArgs object.

OnStartReport(EventArgs)

Runs the StartReport event.

Declaration
public void OnStartReport(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs object.

OnUnload(EventArgs)

Declaration
protected override void OnUnload(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides
System.Web.UI.Control.OnUnload(System.EventArgs)

Prepare()

Prepares the report.

Declaration
public void Prepare()

PrevPage()

Forces going to the previous report page.

Declaration
public void PrevPage()

PrintHtml()

Prints in browser.

Declaration
public void PrintHtml()

PrintHtml(HttpContext)

Prints in browser.

Declaration
public void PrintHtml(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

PrintPdf()

Prints in Adobe Acrobat.

Declaration
public void PrintPdf()

PrintPdf(Boolean)

Prints in Adobe Acrobat.

Declaration
public void PrintPdf(bool showPrintDialog)
Parameters
Type Name Description
System.Boolean showPrintDialog

PrintPdf(HttpContext)

Prints in Adobe Acrobat.

Declaration
public void PrintPdf(HttpContext context)
Parameters
Type Name Description
System.Web.HttpContext context

PrintPdf(HttpContext, Boolean)

Prints in Adobe Acrobat.

Declaration
public void PrintPdf(HttpContext context, bool showPrintDialog)
Parameters
Type Name Description
System.Web.HttpContext context
System.Boolean showPrintDialog

Refresh()

Forces refreshing of report.

Declaration
public void Refresh()

RegisterData(IEnumerable, String)

Registers the IEnumerable in report dictionary.

Declaration
public WebReport RegisterData(IEnumerable data, string name)
Parameters
Type Name Description
System.Collections.IEnumerable data

IEnumerable data.
System.String name

Name for the registered data.
Returns
Type Description
WebReport

WebReport object.

RegisterData(DataRelation, String)

Registers the DataRelation in report dictionary.

Declaration
public WebReport RegisterData(DataRelation data, string name)
Parameters
Type Name Description
System.Data.DataRelation data

DataRelation object.
System.String name

Name for the registered data.
Returns
Type Description
WebReport

WebReport object.

RegisterData(DataSet)

Register the DataSet in report dictionary.

Declaration
public WebReport RegisterData(DataSet data)
Parameters
Type Name Description
System.Data.DataSet data

DataSet object.
Returns
Type Description
WebReport

WebReport object.

RegisterData(DataSet, String)

Register the DataSet in report dictionary.

Declaration
public WebReport RegisterData(DataSet data, string name)
Parameters
Type Name Description
System.Data.DataSet data

DataSet object.
System.String name

Name for the registered data.
Returns
Type Description
WebReport

WebReport object.

RegisterData(DataTable, String)

Registers the DataTable in report dictionary.

Declaration
public WebReport RegisterData(DataTable data, string name)
Parameters
Type Name Description
System.Data.DataTable data

DataTable object.
System.String name

Name for the registered data.
Returns
Type Description
WebReport

WebReport object.

RegisterData(DataView, String)

Registers the DataView in report dictionary.

Declaration
public WebReport RegisterData(DataView data, string name)
Parameters
Type Name Description
System.Data.DataView data

DataView object.
System.String name

Name for the registered data.
Returns
Type Description
WebReport

WebReport object.

RegisterDataAsp(Report, IEnumerable, String)

Registers the ASP.NET application data to use it in the report.

Declaration
public void RegisterDataAsp(Report report, IEnumerable data, string name)
Parameters
Type Name Description
Report report

The Report object.
System.Collections.IEnumerable data

The application data.
System.String name

The name of the data.

RegisterDataAsp(Report, IDataSource, String)

Registers the ASP.NET application data to use it in the report.

Declaration
public void RegisterDataAsp(Report report, IDataSource data, string name)
Parameters
Type Name Description
Report report

The Report object.
System.Web.UI.IDataSource data

The application data.
System.String name

The name of the data.

RenderContents(HtmlTextWriter)

Declaration
protected override void RenderContents(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer
Overrides
System.Web.UI.WebControls.WebControl.RenderContents(System.Web.UI.HtmlTextWriter)

Scripts()

Returns the code "" for registration the necessary js libraries.

Declaration
public HtmlString Scripts()
Returns
Type Description
System.Web.HtmlString

HtmlString object.

SetCustomAuthEvent(EventHandler<CustomAuthEventArgs>)

Sets the CustomAuth event handler.

Declaration
public WebReport SetCustomAuthEvent(EventHandler<CustomAuthEventArgs> auth)
Parameters
Type Name Description
System.EventHandler<CustomAuthEventArgs> auth

Event handler.
Returns
Type Description
WebReport

WebReport object.

SetCustomDrawEvent(EventHandler<CustomDrawEventArgs>)

Sets the CustomDraw event handler.

Declaration
public WebReport SetCustomDrawEvent(EventHandler<CustomDrawEventArgs> draw)
Parameters
Type Name Description
System.EventHandler<CustomDrawEventArgs> draw

Event handler.
Returns
Type Description
WebReport

WebReport object.

SetPage(Int32)

Forces going to the "value" report page.

Declaration
public void SetPage(int value)
Parameters
Type Name Description
System.Int32 value

SetPreparedData(Stream)

Loads the serialized prepared report data from stream.

Declaration
public void SetPreparedData(Stream reportStream)
Parameters
Type Name Description
System.IO.Stream reportStream

Stream object.

SetPropData(Stream)

Loads the serialized properties data from stream.

Declaration
public void SetPropData(Stream propStream)
Parameters
Type Name Description
System.IO.Stream propStream

Stream object.

SetReportData(Stream)

Loads the serialized report data from stream.

Declaration
public void SetReportData(Stream reportStream)
Parameters
Type Name Description
System.IO.Stream reportStream

Stream object.

SetScriptSecurity(IScriptChecker)

Sets custom class for checking the report script.

Declaration
public static void SetScriptSecurity(IScriptChecker scriptChecker)
Parameters
Type Name Description
IScriptChecker scriptChecker

SetSize(Unit, Unit)

Sets the size of WebReport object.

Declaration
public WebReport SetSize(Unit width, Unit height)
Parameters
Type Name Description
System.Web.UI.WebControls.Unit width

Width of WebReport.
System.Web.UI.WebControls.Unit height

Height of WebReport.
Returns
Type Description
WebReport

WebReport object.

SetStartEvent(EventHandler)

Sets the StartReport event handler.

Declaration
public WebReport SetStartEvent(EventHandler start)
Parameters
Type Name Description
System.EventHandler start

Event handler.
Returns
Type Description
WebReport

WebReport object.

Styles()

Returns the code for registration the necessary CSS.

Declaration
public HtmlString Styles()
Returns
Type Description
System.Web.HtmlString

HtmlString object.

Events

CustomAuth

Occurs when report auth is started.

Declaration
[Browsable(true)]
public event EventHandler<CustomAuthEventArgs> CustomAuth
Event Type
Type Description
System.EventHandler<CustomAuthEventArgs>

CustomDraw

Occurs when report drawing is started.

Declaration
[Browsable(true)]
public event EventHandler<CustomDrawEventArgs> CustomDraw
Event Type
Type Description
System.EventHandler<CustomDrawEventArgs>

SaveDesignedReport

Occurs when designed report saving is started.

Declaration
[Browsable(true)]
public event EventHandler<SaveDesignedReportEventArgs> SaveDesignedReport
Event Type
Type Description
System.EventHandler<SaveDesignedReportEventArgs>

StartReport

Occurs when report execution is started.

Declaration
[Browsable(true)]
public event EventHandler StartReport
Event Type
Type Description
System.EventHandler