Click or drag to resize

StiReport Class

Report class.
Inheritance Hierarchy

Namespace:  Stimulsoft.Report
Assembly:  Stimulsoft.Report (in Stimulsoft.Report.dll) Version: 2019.3.1.0
Syntax
public class StiReport : Component, IStiReport, 
	IStiApp, IStiAppCell, IStiSelect, ICloneable, IStiStateSaveRestore, 
	IStiUnitConvert, IStiEngineVersionProperty, IStiPropertyGridObject

The StiReport type exposes the following members.

Constructors
  NameDescription
Public methodStiReport
Creates a new object of the StiReport type.
Top
Properties
  NameDescription
Public propertyAbout
Returns information about the report.
Public propertyAggregateFunctions
Gets or sets the array for registration of aggregate function objects in the compiled report.
Public propertyAutoLocalizeReportOnRun
Gets or sets property which allows automatic localization of the report when running starts.
Public propertyBeginRenderEvent
Occurs when the report rendering starts.
Public propertyBookmark
Gets or sets the root bookmark. Internal use only.
Public propertyBusinessObjectsStore
Gets collection of the registered business objects.
Public propertyCacheAllData
Gets or sets value, which indicates whether it is necessary to cache all data of the report in one DataSet or not.
Public propertyCacheTotals
Gets or sets value, which allows to cache totals
Public propertyCalculationMode
Gets or sets the method of calculation in report.
Protected propertyCanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Protected propertyCells
Property used for access to internal CrossTab variables. Internal use only.
Public propertyCollate
Gets or sets value which can be used for pages collating. The value of the property cannot be less then 1.
Public propertyColumn
Gets or sets the current column.
Public propertyCompiledReport
Gets or sets a compiled report.
Public propertyCompilerResults
Gets or sets compiler results.
Public propertyComponentId
Public propertyContainer
Public propertyContainsDashboard
Gets or sets value, which indicates that the report contains dashboard pages.
Public propertyConvertNulls
Gets or sets value which shows whether it is necessary to convert null or DBNull.
Public propertyCookieContainer
Internal use only.
Public propertyCulture
Gets or sets default report culture
Public propertyCurrentPage
Gets or sets the index of the current page. Counting starts from 0.
Public propertyCurrentPrintPage
Gets or sets the index of the current page.
Public propertyDashboardViewerSettings
Gets or sets controls which will be shown in the Dashboard Viewer.
Public propertyDataBandsUsedInPageTotals
Internal use only.
Public propertyDataSources
Gets data sources of the report.
Public propertyDataStore
Gets data available for the current report.
Public propertyDate
Gets the current date.
Public propertyDesigner
Gets a report designer.
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Public propertyDictionary
Gets or sets a dictionary of data.
Public propertyEndRenderEvent
Occurs when the report rendering is finished.
Public propertyEngine
Gets or sets report engine core (EngineV2). Internal use only.
Public propertyEngineV1
Gets or sets report engine code (EngineV1). Internal use only.
Public propertyEngineVersion
Gets or sets version of engine which will be used for report rendering. EngineV1 is old version of engine. EngineV2 is newest version of engine. Its more powerful and more flexible.
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertyExportedEvent
Occurs when report ends exporting.
Public propertyExportingEvent
Occurs when report starts exporting.
Public propertyGlobalizationManager
Gets or sets a GlobalizationManager property which controls of the report localization.
Public propertyGlobalizationStrings
Gets a collection which consists of globalization strings.
Public propertyStatic memberGlobalMeasureGraphics
Graphics used for report rendering measurement. Internal use only.
Public propertyStatic memberGlobalRichTextMeasureGraphics
Property used for RichText rendering measurement. Internal use only.
Public propertyGroupLine
Gets or sets the current group number.
Public propertyImageCachePath
Gets path to the report image cache path. Path can't be changed.
Public propertyInfo
Gets or sets information which is necessary for the report designer.
Public propertyInteractionCollapsingStates
Internal use only.
Public propertyIsCompiled
Gets value, which indicates that the report is compiled.
Public propertyIsDesigning
Gets value, which indicates that the report is being designed.
Public propertyIsDocument
Gets value which indicates that this report contain rendered document which loaded from file or other source.
Public propertyIsEditedInViewer
Gets or sets value which indicates whether the rendered report is edited in preview window.
Public propertyIsExporting
Gets value, which indicates that the report is exporting.
Public propertyIsFirstPage
Public propertyIsFirstPageThrough
Public propertyIsFirstPass
Gets value which indicates that first report pass is rendered now.
Public propertyIsInteractionRendering
Gets value which indicates that current rendering of report is used for interaction purposes. Internal use only.
Public propertyIsJsonReport
Gets value which indicates that report loaded from JSON format.
Public propertyIsLastPage
Public propertyIsLastPageThrough
Public propertyIsModified
Gets or sets value, which indicates that the report was changed in the designer.
Public propertyIsPackedReport
Gets value which indicates that report loaded from packed format.
Public propertyIsPageDesigner
Gets or sets value, which indicates that the designer of the report is designing a page from viewer.
Public propertyIsPreviewDialogs
Internal use only.
Public propertyIsPrinting
Gets or sets value, which indicates that the report printing is in process.
Public propertyIsRendered
Gets or sets value which indicates whether the report is rendered or not.
Public propertyIsRenderedReportEmpty
Gets value, which indicates that rendered report contain only one rendered page and this rendered page does not contain any components.
Public propertyIsRendering
Gets or sets value which indicates whether the report rendering is in process.
Public propertyIsReportEmpty
Gets value, which indicates that report template contain only one template page and this template page does not contain any components.
Public propertyIsSecondPass
Gets value which indicates that second report pass is rendered now.
Public propertyIsSelected
Gets or sets value, which indicates whether the report in the designer is selected or not.
Public propertyIsSerializing
Gets or sets value, which indicates that serialization and deserialization is in process.
Public propertyIsSLPreviewDialogs
Internal use only.
Public propertyIsStopped
Gets or sets value, which indicates that the report rendering / printing was stopped.
Public propertyIsWpf
Gets value which indicates that this report is rendered with using WPF technology.
Public propertyItem
Indicates the collection of user-defined variables declared in a report from code.
Public propertyKey
Gets or sets the report key.
Public propertyLanguage
Instead of this property, please, use script language property.
Public propertyLine
Gets or sets the current line that starts at the beginning of a group.
Public propertyLineABC
Gets or sets the current line (Alphabetical) that starts at the beginning of a group.
Public propertyLineRoman
Gets the current line (Roman numerals) that starts at the beginning of a group.
Public propertyLineThrough
Gets or sets the current line which starts at the beginning of a report.
Public propertyListOfUsedData
Internal use only. List of used datasources for RetrieveOnlyUsedData feature.
Public propertyLocalizedName
Gets a localized report name.
Public propertyManualBookmark
Gets or sets the root manual bookmark. Please use Bookmark property in EngineV2.
Public propertyMasterReport
Public propertyMetaTags
Gets the collection of meta tags. Meta tags can be used for storing specific information in report. Meta tags will be saved in report file.
Public propertyNeedsCompiling
Gets or sets a value which indicates whether it is necessary to compile a report or it has just been compiled.
Public propertyNumberOfPass
Gets or sets the number of passes which the report generator makes while report rendering.
Public propertyPageCopyNumber
Gets or sets a number of a current copy of a page.
Public propertyPageNofM
Gets string value which contains "Page N of M". Property ResetPageNumber can reset value of N.
Public propertyPageNofMLocalizationString
Gets string value which contains localization template for "Page N of M". For example: Page {0} of {1}. By default this property equal to null and report engine use global localization string.
Public propertyPageNofMThrough
Gets string value which contains "Page N of M". Property ResetPageNumber is ignored.
Public propertyPageNumber
Gets or sets an index of the current page printed taking into consideration segmented pages. Number starts from 1. Property ResetPageNumber can reset value of this variable.
Public propertyPageNumberThrough
Gets or sets an index of the current page printed taking into consideration segmented pages. Number starts from 1. Property ResetPageNumber is ignored.
Public propertyPages
Gets a collection which consists of the template pages from the currect report.
Public propertyParametersOrientation
Gets or sets value which indicates parameters panel orientation.
Public propertyParentReport
Gets or sets the report which is a template (is not compiled) for this report.
Public propertyPassword
Internal use only.
Public propertyPreviewMode
Gets or sets the preview mode of the report.
Public propertyPreviewSettings
Gets or sets controls which will be shown in the Viewer Window.
Public propertyPrintedEvent
Occurs when report ends printing.
Public propertyPrinterSettings
Gets or sets printer settings of current report.
Public propertyPrintingEvent
Occurs when report starts printing.
Public propertyProgress
Gets or sets progress information.
Public propertyProgressOfRendering
Gets or sets value of progress of report rendering (0-100).
Public propertyPropName
Public propertyReferencedAssemblies
Gets or sets an array of referenced assemblies.
Public propertyRefreshTime
Gets or sets the time (in seconds) after which the report will be automatically rebuilt in the viewer.
Public propertyRenderedPages
Gets a collection of rendered pages from the current report.
Public propertyRenderedWith
Gets or sets a technology a report was rendered with.
Public propertyRenderingEvent
Occurs when a page is rendered.
Public propertyReportAlias
Gets or sets a report alias.
Public propertyReportAuthor
Gets or sets a report author.
Public propertyReportCacheMode
Gets or sets value, which indicates how report engine use report cache.
Public propertyReportCachePath
Gets path to the report cache path. Path can't be changed.
Public propertyReportCacheProcessingEvent
Occurs when a report cache is processing.
Public propertyReportChanged
Gets or sets the date of the last report changes.
Public propertyReportCreated
Gets or sets the date of the report creation.
Public propertyReportDataSources
Returns the collection of DataSources of the report.
Public propertyReportDescription
Gets or sets a report description.
Public propertyReportFile
Gets or sets the last opened or saved file name.
Public propertyReportGuid
Gets or sets the report Guid.
Public propertyReportIcon
Gets or sets a report icon.
Public propertyReportImage
Gets or sets a report image.
Public propertyReportMeasureGraphics
Graphics used for report rendering measurement. Internal use only.
Public propertyReportName
Gets or sets a report name.
Public propertyReportRenderingMessages
Gets or sets collection which contains report rendering messages.
Public propertyReportResources
Gets collection of report resources. Internal use only.
Public propertyReportSource
Gets or sets string representation of report template file. This property used when report placed on form.
Public propertyReportUnit
Gets the current measurement unit of the report.
Public propertyReportVersion
Gets or sets version of the report engine which changed the report last time.
Public propertyRequestParameters
Gets or sets value which indicates whether to request parameters from a user before report rendering or render a report with the default value of parameters.
Public propertyRetrieveOnlyUsedData
Gets or sets value, which indicates how report engine retrieve data - only used in the report data or all data.
Public propertyRtfCachePath
Gets path to the report rtf cache path. Path can't be changed.
Public propertySaveReportInResources
Gets or sets value, which allows to save report in resources. Property can be used when StiReport component placed on Form or WebForm.
Public propertyScript
Gets or sets a script of the report.
Public propertyScriptLanguage
Gets or sets the current script language.
Public propertySelectionTick
Internal use only.
Public propertySite (Overrides ComponentSite.)
Public propertyStates
Gets the component states manager.
Public propertyStatusString
Gets or sets string representation of the current report status when report is rendered.
Public propertyStopBeforePage
Gets or sets a page number. When this page is reached then the report rendering is stopped.
Public propertyStyles
Gets a collection which consists of report styles.
Public propertySubReports
Gets or sets the collection of the subreports of the report.
Public propertyTag
Gets or sets Tag property of the report.
Public propertyTime
Gets the current time.
Public propertyToday
Gets the current date.
Public propertyTotalPageCount
Gets or sets the number of pages in a report (RunTime Variable).
Public propertyTotalPageCountThrough
Gets or sets the number of pages in a report. Property ResetPageNumber is ignored.
Public propertyUnit
Gets the current unit.
Public propertyUseProgressInThread
Internal use only.
Public propertyVariables
Returns the collection of code defined report variables.
Public propertyViewerControl
Public propertyViewerForm
Top
Methods
  NameDescription
Public methodAddAnchor(Object)
Adds anchor.
Public methodAddAnchor(Object, Object)
Adds anchor.
Public methodApplyStyleCollection(String)
Applies styles associated with the specified style collection to all components in the report.
Public methodApplyStyleCollection(String, ListStiComponent)
Applies styles associated with the specified style collection to all components in the report.
Public methodApplyStyles
Applies styles of a report to all components in the report.
Public methodStatic memberChangeType(Object, Type)
Changes a type of the specified value.
Public methodStatic memberChangeType(Object, Type, Boolean)
Changes a type of the specified value.
Protected methodCheckExcelValue
Protected methodClear
Resets a report to null state.
Public methodClearAllStates
Clears all earlier saved object states. Internal use only.
Public methodStatic memberClearImageCache
Clear all image cache.
Public methodStatic memberClearReportCache
Clear all report cache.
Public methodClone
Creates a new object that is a copy of the current instance.
Public methodCompile
Compiles a report.
Public methodCompile(Stream)
Compiles a report and locates it in the specified stream.
Public methodCompile(String)
Compiles a report.
Public methodCompile(StiOutputType)
Compiles a report.
Public methodCompile(String, StiOutputType)
Compiles a report and locates it to the specified path.
Public methodCompile(String, StiOutputType, Boolean)
Compiles a report and locates it in the specified path.
Public methodCompileAsync
Compiles a report.
Public methodCompileAsync(Stream)
Compiles a report and locates it in the specified stream.
Public methodCompileAsync(String)
Compiles a report.
Public methodCompileAsync(StiOutputType)
Compiles a report.
Public methodCompileAsync(String, StiOutputType)
Compiles a report and locates it to the specified path.
Public methodCompileAsync(String, StiOutputType, Boolean)
Compiles a report and locates it in the specified path.
Public methodCompileReportsToAssembly(String, StiReport)
Public methodStatic memberCompileReportsToAssembly(String, StiReport, StiReportLanguageType)
Public methodCompileReportsToAssemblyAsync(String, StiReport)
Public methodCompileReportsToAssemblyAsync(String, StiReport, StiReportLanguageType)
Public methodCompileStandaloneReport
Compiles a standalone report and locates it in the specified path.
Public methodCompileStandaloneReportAsync
Compiles a standalone report and locates it in the specified path.
Public methodConvert
Converts all components coordinates from one unit into another.
Protected methodConvertRtf
Internal use only. Used for converting series of strings to one rtf text.
Public methodStatic memberCreateNewDashboard
Public methodStatic memberCreateNewReport
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodCreateReportInNewAppDomain
Public methodDesign
Calls the designer for the report in the Modal window.
Public methodDesign(Boolean)
Calls the designer for the report.
Public methodDesign(Form)
Calls the designer for the report in the Parent Form.
Public methodDesign(Boolean, IWin32Window)
Calls the designer for the report.
Public methodDesignV2WithWpf
Calls the designer for the report in the Modal window with using WPF technology.
Public methodDesignV2WithWpf(Boolean)
Calls the designer for the report in the Modal window with using WPF technology.
Public methodDesignV2WithWpf(Object)
Calls the designer for the report in the Modal window with using WPF technology.
Public methodDesignV2WithWpf(Object, Boolean)
Calls the designer for the report in the Modal window with using WPF technology.
Public methodDesignWithWpf
Calls the designer for the report in the Modal window with using WPF technology.
Public methodDesignWithWpf(Boolean)
Public methodDesignWithWpf(Object, Boolean)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the StiReport and optionally releases the managed resources
(Overrides ComponentDispose(Boolean).)
Public methodStatic memberDiv(Decimal, Decimal)
Returns result of dividing value1 and value2. If value2 is zero, then result equal to 0.
Public methodStatic memberDiv(Double, Double)
Returns result of dividing value1 and value2. If value2 is zero, then result equal to 0.
Public methodStatic memberDiv(Int64, Int64)
Returns result of dividing value1 and value2. If value2 is zero, then result equal to 0.
Public methodStatic memberDiv(Decimal, Decimal, Decimal)
Returns result of dividing value1 and value2. If value2 is zero, then result is zeroResult (third argument).
Public methodStatic memberDiv(Double, Double, Double)
Returns result of dividing value1 and value2. If value2 is zero, then result is zeroResult (third argument).
Public methodStatic memberDiv(Int64, Int64, Int64)
Returns result of dividing value1 and value2. If value2 is zero, then result is zeroResult (third argument).
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExportDocument(StiExportFormat, Stream)
Exports a rendered report into the stream without dialog using the provider.
Public methodExportDocument(StiExportFormat, String)
Exports a rendered report into the file without dialog using the provider.
Public methodExportDocument(StiExportService, String)
Exports a rendered report into a file with dialog using the provider.
Public methodExportDocument(StiExportFormat, Stream, StiExportSettings)
Exports a rendered report into the stream without dialog using the provider.
Public methodExportDocument(StiExportFormat, String, StiExportSettings)
Exports a rendered report into the file without dialog using the provider.
Public methodExportDocument(StiExportService, String, Boolean)
Exports a rendered report into a file with dialog using the provider.
Public methodExportDocument(StiExportFormat, StiExportService, Stream, StiExportSettings)
Internal use only.
Public methodExportDocumentAsync(StiExportFormat, Stream)
Exports a rendered report into the stream without dialog using the provider.
Public methodExportDocumentAsync(StiExportFormat, String)
Exports a rendered report into the file without dialog using the provider.
Public methodExportDocumentAsync(StiExportService, String)
Exports a rendered report into a file with dialog using the provider.
Public methodExportDocumentAsync(StiExportFormat, Stream, StiExportSettings)
Exports a rendered report into the stream without dialog using the provider.
Public methodExportDocumentAsync(StiExportFormat, String, StiExportSettings)
Exports a rendered report into the file without dialog using the provider.
Public methodExportDocumentAsync(StiExportService, String, Boolean)
Exports a rendered report into a file with dialog using the provider.
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
Public methodFindComponentBookmark
Returns the component by the bookmark value.
Public methodFindComponentTag
Returns the component by its tag value.
Protected methodFormat
Returns formated string of the specified arguments.
Public methodGetAnchor
Gets runtime values by the value of an anchor.
Public methodGetAnchorPageNumber
Gets the page number by the value of an anchor.
Public methodGetAnchorPageNumberThrough
Gets the page number through by the value of an anchor.
Public methodGetComponentByName
Public methodGetComponents
Returns a list of all components, including pages in the report.
Public methodGetComponentsCount
Returns count of all components of the report.
Public methodGetCurrentPage
Returns the current page.
Public methodGetEvents
Returns events collection of this component.
Public methodGetEvents(IStiPropertyGrid)
Public methodGetFontResourceName
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetPageIndex
Returns the page index by page number and indexes of the segment. Used for segmented pages.
Public methodGetPageNumber(Int32)
Returns a page number by the index. Internal use only.
Public methodGetPageNumber(Int32, Int32, Int32)
Returns page numbers by the index. Internal use only.
Public methodGetProperties
Public methodGetRenderedComponents
Returns a list of all rendered components, including rendered pages in the report.
Public methodGetRenderedComponentsCount
Returns count of all rendered components of the report.
Public methodStatic memberGetReport
Returns new StiReport object implementation. Method use type from StiOptions.Engine.BaseReportType property.
Public methodGetReportAssemblyCacheName
Gets or sets the last opened or saved file name.
Public methodStatic memberGetReportFromAssembly(Byte)
Returns a created report from the byte array.
Public methodStatic memberGetReportFromAssembly(Stream)
Returns a created report from assembly.
Public methodStatic memberGetReportFromAssembly(Assembly)
Returns a created report from assembly.
Public methodStatic memberGetReportFromAssembly(String)
Returns a created report from assembly.
Public methodStatic memberGetReportFromAssembly(String, Boolean)
Returns a created report from assembly.
Public methodStatic memberGetReportsFromAssembly
Returns the array of rendered reports from assembly.
Public methodStatic memberGetReportVersion
Returns report engine version.
Public methodGetResourceFontName
Public methodGetSelected
Returns the array of the selected components on the current page (including pages and modifiers).
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Public methodGetTotalRenderedPageCount
Internal use only.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGotoComponent
Shows the specified component in the window of viewer.
Public methodGotoComponentBookmark
Shows the component with the specified value of the bookmark in the window of viewer.
Public methodGotoComponentTag
Shows the component with the specified value of the tag in the window of viewer.
Protected methodIIF
Returns value1 if condition is true and value2 if condition is false.
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodInvalidate
Draws again the window of viewer.
Public methodInvert
Inverts selection of a report.
Public methodInvokeBeginRender
Raises the BeginRender event for this report.
Public methodInvokeClick
Raises the Click event for this report.
Public methodInvokeDoubleClick
Raises the DoubleClick event for this report.
Public methodInvokeEndRender
Raises the EndRender event for the report.
Public methodInvokeExported
Raises the Exported event for this report.
Public methodInvokeExporting
Raises the Exporting event for this report.
Public methodInvokeGotoComp
Raises the GotoComp event for this report.
Public methodInvokePaint
Raises the Paint event for this report.
Public methodInvokePrinted
Raises the Printed event for this report.
Public methodInvokePrinting
Raises the Printing event for this report.
Public methodInvokeRefreshViewer
Raises the RefreshViewer event for this report.
Public methodInvokeRendering
Raises the Rendering event for the report.
Public methodInvokeReportCacheProcessing
Raises the ReportCacheProcessing event for the report.
Public methodInvokeStatusChanged
Raises the StatusChanged event for the report.
Public methodStatic memberIsEncryptedFile
Returns true if specified stream contains encrypted report.
Public methodStatic memberIsJsonFile
Returns true if specified stream contains packed report.
Protected methodIsNull
Returns true if current row of dataColumn from dataSource contain null or DbNull.Value.
Public methodStatic memberIsPackedFile
Returns true if specified stream contains packed report.
Public methodIsVariableExist
Checks if specified variable exists in the dictionary.
Protected methodLastOnPage
Returns true if the previous field value is equal to null or DBNull.Value.
Public methodLoad(Byte)
Loads a report template from the byte array.
Public methodLoad(Stream)
Loads a report template from the stream.
Public methodLoad(String)
Loads a report template from the file.
Public methodLoad(StiReportSLService, Stream)
Loads a report template from the stream using provider.
Public methodLoad(StiReportSLService, String)
Loads a report template from the file using the provider.
Public methodLoadDocument(Byte)
Loads a rendered report from the byte array.
Public methodLoadDocument(Stream)
Loads a rendered report from the stream.
Public methodLoadDocument(String)
Loads a rendered report from the file.
Public methodLoadDocument(StiDocumentSLService, Stream)
Loads a rendered report from the stream using the provider.
Public methodLoadDocument(StiDocumentSLService, String)
Loads a rendered report from the file using the provider.
Public methodLoadDocumentFonts
Public methodLoadDocumentFromJson(Stream)
Public methodLoadDocumentFromJson(String)
Loads a rendered report from the string.
Public methodLoadDocumentFromString
Loads a rendered report from the string.
Public methodLoadDocumentFromUrl
Loads a rendered report template from specified url.
Public methodLoadEditableFields(Stream)
Loads the editable fields of rendered report from the stream.
Public methodLoadEditableFields(String)
Loads the editable fields of rendered report from the stream.
Public methodLoadEncryptedDocument(Byte, String)
Loads a encrypted rendered report from the byte array.
Public methodLoadEncryptedDocument(Stream, String)
Loads a encrypted rendered report from the stream.
Public methodLoadEncryptedDocument(String, String)
Loads a encrypted rendered report from the file.
Public methodLoadEncryptedDocumentFromString
Loads a encrypted rendered report from the string.
Public methodLoadEncryptedReport(Byte, String)
Loads a encrypted report template from the byte array.
Public methodLoadEncryptedReport(Stream, String)
Loads a encrypted report template from the stream.
Public methodLoadEncryptedReport(String, String)
Loads a encrypted report template from the file.
Public methodLoadEncryptedReportFromString
Loads a encrypted report template from the string.
Public methodLoadFonts
Public methodLoadFromJson
Loads a report template from the string.
Public methodLoadFromString
Loads a report template from the string.
Public methodLoadFromUrl
Loads a report template from specified url.
Public methodLoadPackedDocument(Byte)
Loads a packed rendered report from the byte array.
Public methodLoadPackedDocument(Stream)
Loads a packed rendered report from the stream.
Public methodLoadPackedDocument(String)
Loads a packed rendered report from the file.
Public methodLoadPackedDocumentFromString
Loads a packed rendered report from the string.
Public methodLoadPackedReport(Byte)
Loads a packed report template from the byte array.
Public methodLoadPackedReport(Stream)
Loads a packed report template from the stream.
Public methodLoadPackedReport(String)
Loads a packed report template from the file.
Public methodLoadPackedReportFromString
Loads a packed report template from the string.
Public methodLoadReportFromResource(Assembly, String)
Loads a report template from the resource.
Public methodLoadReportFromResource(String, String)
Loads a report template from the resource.
Public methodLocalizeReport(CultureInfo)
Localize a report to the specified culture. The culture definition must be placed in GlobalizationStrings.
Public methodLocalizeReport(String)
Localize a report to the specified culture name. The culture definition must be placed in GlobalizationStrings.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodNextIsNull
Returns true if the next field value is equal to null or DBNull.Value.
Protected methodOnExported
Protected methodOnExporting
Protected methodOnGetSubReport
Protected methodOnPrinted
Protected methodOnPrinting
Protected methodParseDateTime
Protected methodPreviousIsNull
Returns true if the previous field value is equal to null or DBNull.Value.
Public methodPrint
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrint(Boolean)
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrint(PrinterSettings)
Prints the rendered report without print dialog. If the report is not rendered then its rendering starts.
Public methodPrint(Boolean, PrinterSettings)
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrint(Boolean, Int16)
Prints a rendered report. If the report is not rendered then its rendering starts.
Public methodPrint(Int32, Int32, Int16)
Prints the rendered report with the print dialog. If the report is not rendered then its rendering starts.
Public methodPrint(Boolean, Int32, Int32, Int16)
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrint(Boolean, Int32, Int32, Int16, PrinterSettings)
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrintAsync
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrintAsync(PrinterSettings)
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrintAsync(Int16)
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrintAsync(Int32, Int32, Int16)
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodPrintAsync(Int32, Int32, Int16, PrinterSettings)
Prints the rendered report. If the report is not rendered then its rendering starts.
Public methodStatic memberPrintReports(ListStiReport)
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Public methodStatic memberPrintReports(ListStiReport, Boolean, Int16)
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Public methodStatic memberPrintReports(ListStiReport, Boolean, Int16, PrinterSettings)
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Public methodPrintReportsAsync(ListStiReport)
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Public methodPrintReportsAsync(ListStiReport, Int16)
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Public methodPrintReportsAsync(ListStiReport, Int16, PrinterSettings)
Prints the collection of reports. If the report from collection is not rendered then its rendering starts.
Public methodPrintToDotMatrixPrinter
Prints a report to default dot-matrix printer in the RAW mode in ASCII encoding.
Public methodPrintToDotMatrixPrinter(String)
Prints a report to dot-matrix printer in the RAW mode in ASCII encoding.
Public methodPrintToDotMatrixPrinter(String, Encoding)
Prints report to dot-matrix printer in the RAW mode.
Public methodPrintToDotMatrixPrinter(String, Encoding, Int32, Int32)
Prints a report to dot-matrix printer in the RAW mode.
Public methodPrintToDotMatrixPrinter(String, Encoding, Boolean, StiTxtBorderType, Boolean, Boolean, Int32, Int32)
Prints a report to dot-matrix printer in RAW mode.
Public methodPrintToDotMatrixPrinter(String, Encoding, Boolean, StiTxtBorderType, Boolean, Boolean, Boolean, Boolean, Single, Single, Int32, Int32, Boolean, String)
Prints report to dot-matrix printer in the RAW mode.
Public methodPrintWithWpf
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Boolean)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Int32)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Object)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(String)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Boolean, Int32)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Object, Boolean)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Boolean, Int32, String)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Boolean, Int32, Int32, Int32)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Boolean, Int32, Int32, Int32, String)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpf(Object, Boolean, Int32, Int32, Int32, String)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpfAsync
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpfAsync(Int32)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpfAsync(Object)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpfAsync(String)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpfAsync(Int32, String)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpfAsync(Int32, Int32, Int32)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpfAsync(Int32, Int32, Int32, String)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodPrintWithWpfAsync(Object, Int32, Int32, Int32, String)
Prints the rendered report with using WPF technology. If the report is not rendered then its rendering starts. This method require Stimulsoft.Report.Wpf assembly.
Public methodRecalculateRenderedPagesSegments
Recalculate segments in all rendered pages
Public methodRegBusinessObject(ListStiBusinessObjectData)
Registers list of business objects in business objects store of specified report.
Public methodRegBusinessObject(String, Object)
Registers the business object in the report.
Public methodRegBusinessObject(String, String, Object)
Registers the business object in the report.
Public methodRegBusinessObject(String, String, String, Object)
Registers the business object in the report.
Public methodRegData(DataSet)
Registers all DataTable and DataRelation which are in the specified DataSet in the Data Store.
Public methodRegData(DataTable)
Registers the DataTable in the Data Store.
Public methodRegData(DataView)
Registers DataView in the Data Store.
Public methodRegData(StiDataCollection)
Registers the DataCollection in the DataStore of the report.
Public methodRegData(String, DataSet)
Registers all DataTables and DataRelations which are in the specified DataSet in the Data Store.
Public methodRegData(String, DataTable)
Registers an object in the Data Store.
Public methodRegData(String, DataView)
Registers DataView in the Data Store.
Public methodRegData(String, OdbcConnection)
Registers OdbcConnection in the Data Store.
Public methodRegData(String, OleDbConnection)
Registers OleDbConnection in the Data Store.
Public methodRegData(String, SqlConnection)
Registers SqlConnection in the Data Store.
Public methodRegData(String, Object)
Registers an object in the Data Store.
Public methodRegData(XElement, StiRelationDirection)
Registers the DataCollection in the DataStore of the report.
Public methodRegData(String, String, DataSet)
Registers all DataTables and DataRelations which are in the specified DataSet in the Data Store.
Public methodRegData(String, String, DataTable)
Registers an object in the Data Store.
Public methodRegData(String, String, DataView)
Registers DataView in the Data Store.
Public methodRegData(String, String, OdbcConnection)
Registers OdbcConnection in the Data Store.
Public methodRegData(String, String, OleDbConnection)
Registers OleDbConnection in the Data Store.
Public methodRegData(String, String, SqlConnection)
Registers SqlConnection in the Data Store.
Public methodRegData(String, String, Object)
Registers an object in the Data Store.
Public methodRegData(String, XElement, StiRelationDirection)
Registers the DataCollection in the DataStore of the report.
Public methodRegReportDataSources
Internal use only. Registers datasources from ReportDataSources property in report dictionary.
Public methodRender
Renders a report.
Public methodRender(Boolean)
Renders a report.
Public methodRender(StiRenderState)
Renders report.
Public methodRender(Boolean, Int32, Int32)
Renders a report.
Public methodRenderAsync
Renders a report.
Public methodRenderAsync(StiRenderState)
Renders report.
Public methodRenderAsync(Int32, Int32)
Renders a report.
Public methodRenderWithWpf
Renders a report with using WPF technology.
Public methodRenderWithWpf(Boolean)
Renders a report with using WPF technology.
Public methodRenderWithWpf(StiRenderState)
Renders a report with using WPF technology.
Public methodRenderWithWpf(Boolean, Int32, Int32)
Renders a report with using WPF technology.
Public methodRenderWithXbap
Renders a report with using Xbap technology.
Public methodRenderWithXbap(Boolean)
Renders a report with using Xbap technology.
Public methodRenderWithXbap(StiRenderState)
Renders a report with using Xbap technology.
Public methodRenderWithXbap(Boolean, Int32, Int32)
Renders a report with using Xbap technology.
Public methodReset
Resets selection of a report.
Public methodResetAggregateFunctions
Resets states of aggregate functions in compiled report.
Public methodResetRenderedState
Resets a rendered states.
Public methodResetSelection
Resets selection from all selected objects in the report.
Public methodRestoreState
Restores the earlier saved object state.
Public methodSave(Stream)
Saves a report template in the stream.
Public methodSave(String)
Saves a report template in the file.
Public methodSave(StiReportSLService, Stream)
Saves a report template in the file using the provider.
Public methodSave(StiReportSLService, String)
Saves a report template in the file using the provider.
Public methodSaveDocument(Stream)
Saves a rendered report in the stream.
Public methodSaveDocument(String)
Saves a rendered report in the file.
Public methodSaveDocument(StiDocumentSLService, Stream)
Saves a rendered report to the stream.
Public methodSaveDocument(StiDocumentSLService, String)
Saves a rendered report using the provider in the file.
Public methodSaveDocumentJsonToString
Saves a rendered report to the string.
Public methodSaveDocumentToByteArray
Saves a rendered report to the byte array.
Public methodSaveDocumentToString
Saves a rendered report to the string.
Public methodSaveEditableFields(Stream)
Saves the editable fields of rendered report to the stream.
Public methodSaveEditableFields(String)
Saves the editable fields of rendered report to the stream.
Public methodSaveEncryptedDocument(Stream, String)
Saves a encrypted rendered report to the stream.
Public methodSaveEncryptedDocument(String, String)
Saves a packed rendered report in the file.
Public methodSaveEncryptedDocumentToByteArray
Saves a encrypted rendered report to the byte array.
Public methodSaveEncryptedDocumentToString
Saves a encrypted rendered report to the string.
Public methodSaveEncryptedReport(Stream, String)
Saves a encrypted report template in the stream.
Public methodSaveEncryptedReport(String, String)
Saves a encrypted report template in the file.
Public methodSaveEncryptedReportToByteArray
Saves a encrypted report template in the byte array.
Public methodSaveEncryptedReportToString
Saves a encrypted report template to the string.
Public methodSavePackedDocument(Stream)
Saves a packed rendered report to the stream.
Public methodSavePackedDocument(String)
Saves a packed rendered report in the file.
Public methodSavePackedDocumentToByteArray
Saves a packed rendered report to the byte array.
Public methodSavePackedDocumentToString
Saves a packed rendered report to the string.
Public methodSavePackedReport(Stream)
Saves a packed report template in the stream.
Public methodSavePackedReport(String)
Saves a packed report template in the file.
Public methodSavePackedReportToByteArray
Saves a packed report template in the byte array.
Public methodSavePackedReportToString
Saves a packed report template to the string.
Public methodSaveReportSourceCode
Saves the report source code to the string.
Public methodSaveReportSourceCode(Boolean)
Saves the report source code to the string.
Public methodSaveReportSourceCode(Stream)
Saves the report source code to the stream.
Public methodSaveReportSourceCode(String)
Saves the report source code to the file.
Public methodSaveReportSourceCode(Stream, Boolean)
Saves the report source code to the stream.
Public methodSaveReportSourceCode(String, Boolean)
Saves the report source code to the file.
Public methodSaveReportSourceCodeForSilverlight
Saves the report source code for Silverlight to the string.
Public methodSaveReportSourceCodeForSilverlight(Stream)
Saves the report source code for Silverlight to the stream.
Public methodSaveReportSourceCodeForSilverlight(String)
Saves the report source code for Silverlight to the file.
Public methodSaveSnapshot(Stream)
Saves a report template with embedded data in the stream.
Public methodSaveSnapshot(String)
Saves a report template with embedded data
Public methodSaveState
Saves the current state of an object.
Public methodSaveToByteArray
Saves a report template in the byte array.
Public methodSaveToJson
Saves a report template in the file.
Public methodSaveToJsonString
Saves a report template to the string.
Public methodSaveToString
Saves a report template to the string.
Public methodScriptNew
Forms a new script.
Public methodScriptPack
Packs a script.
Public methodScriptUnpack
Unpacks a script.
Public methodScriptUnpack(Boolean)
Unpacks a script.
Public methodScriptUpdate
Updates a script to the current state of an object.
Public methodScriptUpdate(Boolean)
Updates a script to the current state of an object.
Public methodSelect
Selects a report.
Public methodSetInheritedMode
Public methodSetReportSource
Internal use only.
Public methodShow
Shows a rendered report. If the report is not rendered then its rendering starts.
Public methodShow(Boolean)
Shows the rendered report as a dialog form or not. If the report is not rendered then its rendering starts.
Public methodShow(Form)
Shows the rendered report as MDI child window. If the report is not rendered then its rendering starts.
Public methodShow(IWin32Window)
Shows the rendered report as MDI child window. If the report is not rendered then its rendering starts.
Public methodShow(IWin32Window, Boolean)
Shows the rendered report as MDI child window. If the report is not rendered then its rendering starts.
Public methodShowDotMatrix
Shows a rendered report in DotMatrix mode. If the report is not rendered then its rendering starts.
Public methodShowDotMatrix(Boolean)
Shows the rendered report in DotMatrix mode as a dialog form or not. If the report is not rendered then its rendering starts.
Public methodShowDotMatrix(Form)
Shows the rendered report in DotMatrix mode as MDI child window. If the report is not rendered then its rendering starts.
Public methodShowDotMatrix(IWin32Window)
Shows the rendered report in DotMatrix mode as MDI child window. If the report is not rendered then its rendering starts.
Public methodShowDotMatrix(IWin32Window, Boolean)
Shows the rendered report in DotMatrix mode as MDI child window. If the report is not rendered then its rendering starts.
Public methodShowDotMatrixWithRibbonGUI
Shows a rendered report in DotMatrix mode with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowDotMatrixWithRibbonGUI(Boolean)
Shows the rendered report in DotMatrix mode as a dialog form or not with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowDotMatrixWithRibbonGUI(Form)
Shows the rendered report in DotMatrix mode as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowDotMatrixWithRibbonGUI(IWin32Window)
Shows the rendered report in DotMatrix mode as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowDotMatrixWithRibbonGUI(IWin32Window, Boolean)
Shows the rendered report in DotMatrix mode as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowDotMatrixWithWpf
Shows a rendered report in DotMatrix mode with using WPF technology. If the report is not rendered then its rendering starts.
Public methodShowDotMatrixWithWpf(Boolean)
Shows the rendered report in DotMatrix mode as a dialog form or not with using WPF technology. If the report is not rendered then its rendering starts.
Public methodShowWithRibbonGUI
Shows a rendered report in viewer with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowWithRibbonGUI(Boolean)
Shows the rendered report as a dialog form or not with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowWithRibbonGUI(Form)
Shows the rendered report as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowWithRibbonGUI(IWin32Window)
Shows the rendered report as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowWithRibbonGUI(IWin32Window, Boolean)
Shows the rendered report as MDI child window with Ribbon GUI. If the report is not rendered then its rendering starts.
Public methodShowWithWpf
Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts.
Public methodShowWithWpf(Boolean)
Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts.
Public methodShowWithWpf(Object)
Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts.
Public methodShowWithWpf(Object, Boolean)
Shows the rendered report with using WPF technology. If the report is not rendered then its rendering starts.
Public methodShowWithWpfRibbonGUI
Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts.
Public methodShowWithWpfRibbonGUI(Boolean)
Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts.
Public methodShowWithWpfRibbonGUI(Object)
Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts.
Public methodShowWithWpfRibbonGUI(Object, Boolean)
Shows the rendered report with using WPF Ribbon GUI technology. If the report is not rendered then its rendering starts.
Public methodToString
Returns the name of the report and its alias.
(Overrides ComponentToString.)
Protected methodToString(Object)
Internal use only. Used only for converting an object to the string.
Protected methodToString(Object, Object)
Protected methodToString(Object, Object, Boolean)
Public methodUnloadReportAppDomain
Public methodUpdateInheritedReport
Public methodWriteToReportRenderingMessages
Top
Events
  NameDescription
Public eventBeginRender
Occurs when the report rendering starts.
Public eventClick
Occurs when user clicks in the viewer window.
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
Public eventDoubleClick
Occurs when user double clicks in the viewer window.
Public eventEndRender
Occurs when the report rendering is finished.
Public eventExported
Occurs when report ends exporting.
Public eventExporting
Occurs when report starts exporting.
Public eventGetSubReport
Occurs when report engine require Sub-Report.
Public eventGotoComp
Occurs when the Engine.GotoComponent method is called.
Public eventPaint
Occurs when it is necessary to repaint in the window of viewer.
Public eventPrinted
Occurs when report ends printing.
Public eventPrinting
Occurs when report starts printing.
Public eventRefreshViewer
Occurs when report rendering is finished and viewer control needs to be updated.
Public eventRendering
Occurs when a page is rendered.
Public eventReportCacheProcessing
Occurs when a report cache is processing.
Public eventStatusChanged
Occurs when status of the report is changed when report rendering.
Top
See Also