StiReport Properties |
The StiReport type exposes the following members.
Name | Description | |
---|---|---|
About |
Returns information about the report.
| |
AggregateFunctions |
Gets or sets the array for registration of aggregate function objects in the compiled report.
| |
AutoLocalizeReportOnRun |
Gets or sets property which allows automatic localization of the report when running starts.
| |
BeginRenderEvent |
Occurs when the report rendering starts.
| |
Bookmark |
Gets or sets the root bookmark. Internal use only.
| |
BusinessObjectsStore |
Gets collection of the registered business objects.
| |
CacheAllData |
Gets or sets value, which indicates whether it is necessary to cache all data of the report in one DataSet or not.
| |
CacheTotals |
Gets or sets value, which allows to cache totals
| |
CalculationMode |
Gets or sets the method of calculation in report.
| |
CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) | |
Cells |
Property used for access to internal CrossTab variables. Internal use only.
| |
Collate |
Gets or sets value which can be used for pages collating. The value of the property cannot be less then 1.
| |
Column |
Gets or sets the current column.
| |
CompiledReport |
Gets or sets a compiled report.
| |
CompilerResults |
Gets or sets compiler results.
| |
ComponentId | ||
Container | ||
ContainsDashboard |
Gets or sets value, which indicates that the report contains dashboard pages.
| |
ConvertNulls |
Gets or sets value which shows whether it is necessary to convert null or DBNull.
| |
CookieContainer |
Internal use only.
| |
Culture |
Gets or sets default report culture
| |
CurrentPage |
Gets or sets the index of the current page. Counting starts from 0.
| |
CurrentPrintPage |
Gets or sets the index of the current page.
| |
DashboardViewerSettings |
Gets or sets controls which will be shown in the Dashboard Viewer.
| |
DataBandsUsedInPageTotals |
Internal use only.
| |
DataSources |
Gets data sources of the report.
| |
DataStore |
Gets data available for the current report.
| |
Date |
Gets the current date.
| |
Designer |
Gets a report designer.
| |
DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) | |
Dictionary |
Gets or sets a dictionary of data.
| |
EndRenderEvent |
Occurs when the report rendering is finished.
| |
Engine |
Gets or sets report engine core (EngineV2). Internal use only.
| |
EngineV1 |
Gets or sets report engine code (EngineV1). Internal use only.
| |
EngineVersion |
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.
| |
Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) | |
ExportedEvent |
Occurs when report ends exporting.
| |
ExportingEvent |
Occurs when report starts exporting.
| |
GlobalizationManager |
Gets or sets a GlobalizationManager property which controls of the report localization.
| |
GlobalizationStrings |
Gets a collection which consists of globalization strings.
| |
GlobalMeasureGraphics |
Graphics used for report rendering measurement. Internal use only.
| |
GlobalRichTextMeasureGraphics |
Property used for RichText rendering measurement. Internal use only.
| |
GroupLine |
Gets or sets the current group number.
| |
ImageCachePath |
Gets path to the report image cache path. Path can't be changed.
| |
Info |
Gets or sets information which is necessary for the report designer.
| |
InteractionCollapsingStates |
Internal use only.
| |
IsCompiled |
Gets value, which indicates that the report is compiled.
| |
IsDesigning |
Gets value, which indicates that the report is being designed.
| |
IsDocument |
Gets value which indicates that this report contain rendered document which loaded from file or other source.
| |
IsEditedInViewer |
Gets or sets value which indicates whether the rendered report is edited in preview window.
| |
IsExporting |
Gets value, which indicates that the report is exporting.
| |
IsFirstPage | ||
IsFirstPageThrough | ||
IsFirstPass |
Gets value which indicates that first report pass is rendered now.
| |
IsInteractionRendering |
Gets value which indicates that current rendering of report is used for interaction purposes. Internal use only.
| |
IsJsonReport |
Gets value which indicates that report loaded from JSON format.
| |
IsLastPage | ||
IsLastPageThrough | ||
IsModified |
Gets or sets value, which indicates that the report was changed in the designer.
| |
IsPackedReport |
Gets value which indicates that report loaded from packed format.
| |
IsPageDesigner |
Gets or sets value, which indicates that the designer of the report is designing a page from viewer.
| |
IsPreviewDialogs |
Internal use only.
| |
IsPrinting |
Gets or sets value, which indicates that the report printing is in process.
| |
IsRendered |
Gets or sets value which indicates whether the report is rendered or not.
| |
IsRenderedReportEmpty |
Gets value, which indicates that rendered report contain only one rendered page and
this rendered page does not contain any components.
| |
IsRendering |
Gets or sets value which indicates whether the report rendering is in process.
| |
IsReportEmpty |
Gets value, which indicates that report template contain only one template page and
this template page does not contain any components.
| |
IsSecondPass |
Gets value which indicates that second report pass is rendered now.
| |
IsSelected |
Gets or sets value, which indicates whether the report in the designer is selected or not.
| |
IsSerializing |
Gets or sets value, which indicates that serialization and deserialization is in process.
| |
IsSLPreviewDialogs |
Internal use only.
| |
IsStopped |
Gets or sets value, which indicates that the report rendering / printing was stopped.
| |
IsWpf |
Gets value which indicates that this report is rendered with using WPF technology.
| |
Item |
Indicates the collection of user-defined variables declared in a report from code.
| |
Key |
Gets or sets the report key.
| |
Language |
Instead of this property, please, use script language property.
| |
Line |
Gets or sets the current line that starts at the beginning of a group.
| |
LineABC |
Gets or sets the current line (Alphabetical) that starts at the beginning of a group.
| |
LineRoman |
Gets the current line (Roman numerals) that starts at the beginning of a group.
| |
LineThrough |
Gets or sets the current line which starts at the beginning of a report.
| |
ListOfUsedData |
Internal use only. List of used datasources for RetrieveOnlyUsedData feature.
| |
LocalizedName |
Gets a localized report name.
| |
ManualBookmark |
Gets or sets the root manual bookmark. Please use Bookmark property in EngineV2.
| |
MasterReport | ||
MetaTags |
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.
| |
NeedsCompiling |
Gets or sets a value which indicates whether it is necessary to compile a report or it has just been compiled.
| |
NumberOfPass |
Gets or sets the number of passes which the report generator makes while report rendering.
| |
PageCopyNumber |
Gets or sets a number of a current copy of a page.
| |
PageNofM |
Gets string value which contains "Page N of M". Property ResetPageNumber can reset value of N.
| |
PageNofMLocalizationString |
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.
| |
PageNofMThrough |
Gets string value which contains "Page N of M". Property ResetPageNumber is ignored.
| |
PageNumber |
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.
| |
PageNumberThrough |
Gets or sets an index of the current page printed taking into consideration segmented pages. Number starts from 1.
Property ResetPageNumber is ignored.
| |
Pages |
Gets a collection which consists of the template pages from the currect report.
| |
ParametersOrientation |
Gets or sets value which indicates parameters panel orientation.
| |
ParentReport |
Gets or sets the report which is a template (is not compiled) for this report.
| |
Password |
Internal use only.
| |
PreviewMode |
Gets or sets the preview mode of the report.
| |
PreviewSettings |
Gets or sets controls which will be shown in the Viewer Window.
| |
PrintedEvent |
Occurs when report ends printing.
| |
PrinterSettings |
Gets or sets printer settings of current report.
| |
PrintingEvent |
Occurs when report starts printing.
| |
Progress |
Gets or sets progress information.
| |
ProgressOfRendering |
Gets or sets value of progress of report rendering (0-100).
| |
PropName | ||
ReferencedAssemblies |
Gets or sets an array of referenced assemblies.
| |
RefreshTime |
Gets or sets the time (in seconds) after which the report will be automatically rebuilt in the viewer.
| |
RenderedPages |
Gets a collection of rendered pages from the current report.
| |
RenderedWith |
Gets or sets a technology a report was rendered with.
| |
RenderingEvent |
Occurs when a page is rendered.
| |
ReportAlias |
Gets or sets a report alias.
| |
ReportAuthor |
Gets or sets a report author.
| |
ReportCacheMode |
Gets or sets value, which indicates how report engine use report cache.
| |
ReportCachePath |
Gets path to the report cache path. Path can't be changed.
| |
ReportCacheProcessingEvent |
Occurs when a report cache is processing.
| |
ReportChanged |
Gets or sets the date of the last report changes.
| |
ReportCreated |
Gets or sets the date of the report creation.
| |
ReportDataSources |
Returns the collection of DataSources of the report.
| |
ReportDescription |
Gets or sets a report description.
| |
ReportFile |
Gets or sets the last opened or saved file name.
| |
ReportGuid |
Gets or sets the report Guid.
| |
ReportIcon |
Gets or sets a report icon.
| |
ReportImage |
Gets or sets a report image.
| |
ReportMeasureGraphics |
Graphics used for report rendering measurement. Internal use only.
| |
ReportName |
Gets or sets a report name.
| |
ReportRenderingMessages |
Gets or sets collection which contains report rendering messages.
| |
ReportResources |
Gets collection of report resources. Internal use only.
| |
ReportSource |
Gets or sets string representation of report template file. This property used when report placed on form.
| |
ReportUnit |
Gets the current measurement unit of the report.
| |
ReportVersion |
Gets or sets version of the report engine which changed the report last time.
| |
RequestParameters |
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.
| |
RetrieveOnlyUsedData |
Gets or sets value, which indicates how report engine retrieve data - only used in the report data or all data.
| |
RtfCachePath |
Gets path to the report rtf cache path. Path can't be changed.
| |
SaveReportInResources |
Gets or sets value, which allows to save report in resources.
Property can be used when StiReport component placed on Form or WebForm.
| |
Script |
Gets or sets a script of the report.
| |
ScriptLanguage |
Gets or sets the current script language.
| |
SelectionTick |
Internal use only.
| |
Site | (Overrides ComponentSite.) | |
States |
Gets the component states manager.
| |
StatusString |
Gets or sets string representation of the current report status when report is rendered.
| |
StopBeforePage |
Gets or sets a page number. When this page is reached then the report rendering is stopped.
| |
Styles |
Gets a collection which consists of report styles.
| |
SubReports |
Gets or sets the collection of the subreports of the report.
| |
Tag |
Gets or sets Tag property of the report.
| |
Time |
Gets the current time.
| |
Today |
Gets the current date.
| |
TotalPageCount |
Gets or sets the number of pages in a report (RunTime Variable).
| |
TotalPageCountThrough |
Gets or sets the number of pages in a report. Property ResetPageNumber is ignored.
| |
Unit |
Gets the current unit.
| |
UseProgressInThread |
Internal use only.
| |
Variables |
Returns the collection of code defined report variables.
| |
ViewerControl | ||
ViewerForm |