StiReport Methods

The methods of the StiReport class are listed here.

	Name	Description
	ConvertRtf	Internal use only. Used for converting series of strings to one rtf text.
	Dispose	This is Dispose, a member of class StiReport.
	Format	Returns formated string of the specified arguments.
	GetFilterString	This is GetFilterString, a member of class StiReport.
	IIF	Returns value1 if condition is true and value2 if condition is false.
	IsNull	Returns true if current row of dataColumn from dataSource contain null or DbNull.Value.
	LastOnPage	Returns true if the previous field value is equal to null or DBNull.Value.
	NextIsNull	Returns true if the next field value is equal to null or DBNull.Value.
	OnExported	This is OnExported, a member of class StiReport.
	OnExporting	This is OnExporting, a member of class StiReport.
	OnGetSubReport	This is OnGetSubReport, a member of class StiReport.
	OnPrinted	This is OnPrinted, a member of class StiReport.
	OnPrinting	This is OnPrinting, a member of class StiReport.
	ParseDateTime	This is ParseDateTime, a member of class StiReport.
	PreviousIsNull	Returns true if the previous field value is equal to null or DBNull.Value.

Public Methods

	Name	Description
	AddAnchor	This is the overview for the AddAnchor method overload.
	ApplyStyleCollection	This is the overview for the ApplyStyleCollection method overload.
	ApplyStyles	Applies styles of a report to all components in the report.
	ChangeType	This is the overview for the ChangeType method overload.
	ClearAllStates	Clears all earlier saved object states. Internal use only.
	ClearImageCache	Clear all image cache.
	ClearReportCache	Clear all report cache.
	Clone	Creates a new object that is a copy of the current instance.
	Compile	This is the overview for the Compile method overload.
	CompileReportsToAssembly	This is the overview for the CompileReportsToAssembly method overload.
	CompileStandaloneReport	Compiles a standalone report and locates it in the specified path.
	Convert	Converts all components coordinates from one unit into another.
	Design	This is the overview for the Design method overload.
	DesignV2WithWpf	This is the overview for the DesignV2WithWpf method overload.
	DesignWithWpf	This is the overview for the DesignWithWpf method overload.
	Div	This is the overview for the Div method overload.
	FindComponentBookmark	Returns the component by the bookmark value.
	FindComponentTag	Returns the component by its tag value.
	GetAnchor	Gets runtime values by the value of an anchor.
	GetAnchorPageNumber	Gets the page number by the value of an anchor.
	GetAnchorPageNumberThrough	Gets the page number through by the value of an anchor.
	GetComponentByName	This is GetComponentByName, a member of class StiReport.
	GetComponents	Returns a list of all components, including pages in the report.
	GetComponentsCount	Returns count of all components of the report.
	GetCurrentPage	Returns the current page.
	GetEvents	This is the overview for the GetEvents method overload.
	GetPageNumber	This is the overview for the GetPageNumber method overload.
	GetProperties	This is GetProperties, a member of class StiReport.
	GetReport	Returns new StiReport object implementation. Method use type from StiOptions.Engine.BaseReportType property.
	GetReportAssemblyCacheName	Gets or sets the last opened or saved file name.
	GetReportVersion	Returns report engine version.
	GetSelected	Returns the array of the selected components on the current page (including pages and modifiers).
	GetTotalRenderedPageCount	Internal use only.
	GotoComponent	Shows the specified component in the window of viewer.
	GotoComponentBookmark	Shows the component with the specified value of the bookmark in the window of viewer.
	GotoComponentTag	Shows the component with the specified value of the tag in the window of viewer.
	Invalidate	Draws again the window of viewer.
	Invert	Inverts selection of a report.
	InvokeBeginRender	Raises the BeginRender event for this report.
	InvokeClick	Raises the Click event for this report.
	InvokeDoubleClick	Raises the DoubleClick event for this report.
	InvokeEndRender	Raises the EndRender event for the report.
	InvokeExported	Raises the Exported event for this report.
	InvokeExporting	Raises the Exporting event for this report.
	InvokeGotoComp	Raises the GotoComp event for this report.
	InvokePaint	Raises the Paint event for this report.
	InvokePrinted	Raises the Printed event for this report.
	InvokePrinting	Raises the Printing event for this report.
	InvokeRefreshPreview	Raises the RefreshPreview event for this report.
	InvokeRefreshViewer	Raises the RefreshViewer event for this report.
	InvokeRendering	Raises the Rendering event for the report.
	InvokeReportCacheProcessing	Raises the ReportCacheProcessing event for the report.
	InvokeStatusChanged	Raises the StatusChanged event for the report.
	IsEncryptedFile	This is the overview for the IsEncryptedFile method overload.
	IsJsonFile	This is the overview for the IsJsonFile method overload.
	IsPackedFile	This is the overview for the IsPackedFile method overload.
	IsVariableExist	Checks if specified variable exists in the dictionary.
	LoadDocumentFromJson	This is the overview for the LoadDocumentFromJson method overload.
	LocalizeReport	This is the overview for the LocalizeReport method overload.
	RecalculateRenderedPagesSegments	Recalculate segments in all rendered pages
	RegBusinessObject	This is the overview for the RegBusinessObject method overload.
	RegData	This is the overview for the RegData method overload.
	RegReportDataSources	Internal use only. Registers datasources from ReportDataSources property in report dictionary.
	Reset	Resets selection of a report.
	ResetAggregateFunctions	Resets states of aggregate functions in compiled report.
	ResetRenderedState	Resets a rendered states.
	ResetSelection	Resets selection from all selected objects in the report.
	RestoreState	Restores the earlier saved object state.
	SaveState	Saves the current state of an object.
	ScriptNew	Forms a new script.
	ScriptPack	Packs a script.
	ScriptUnpack	This is the overview for the ScriptUnpack method overload.
	ScriptUpdate	This is the overview for the ScriptUpdate method overload.
	Select	Selects a report.
	SetInheritedMode	This is SetInheritedMode, a member of class StiReport.
	SetReportSource	Internal use only.
	this	Indicates the collection of user-defined variables declared in a report from code.
	ToString	This is the overview for the ToString method overload.
	UpdateInheritedReport	This is UpdateInheritedReport, a member of class StiReport.
	WriteToReportRenderingMessages	This is WriteToReportRenderingMessages, a member of class StiReport.

Internal Methods

	Name	Description
	Clear	This is the overview for the Clear method overload.
	DisposeCachedRichText	Dispose all cached rich text objects.
	DisposeCachedRichTextFormat	This is DisposeCachedRichTextFormat, a member of class StiReport.
	GenerateReportGuid	This is GenerateReportGuid, a member of class StiReport.
	GetPageIndex	This is the overview for the GetPageIndex method overload.
	GetReportName	Gets the report name.
	InvokeGetSubReport	Raises the GetSubReport event for this report.
	Load	Loads a report template from the byte array.
	PrepareForDesign	Internal use only.
	PrepareForDesignV2WithWpf	Internal use only.
	PrepareForDesignWithWpf	Internal use only.
	RenameStyle	Renames a style with the specified name to a new name.

Protected internal Methods

	Name	Description
	CheckExcelValue	This is CheckExcelValue, a member of class StiReport.

Made with Doc-O-Matic.

What do you think about this topic? Send feedback!