Click or drag to resize

StiReport Properties

The StiReport type exposes the following members.

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
See Also