stimulsoft.report.StiReport

	Property	Defined By
		autoDisposeImages : Boolean Frees memory after closing the Viewer that is used to store the StiImage objects in the report.	StiReport
		autoLocalizeReportOnRun : Boolean Gets or sets property which allows automatic localization of the report when running starts.	StiReport
		beginRenderEvent : StiBeginRenderEvent Occurs when when a report begins to render.	StiReport
		bookmark : StiBookmark Gets or sets the root bookmark.	StiReport
		bookmarkValue : StiBookmark	StiReport
		cacheAllData : Boolean Gets or sets value, which indicates whether it is necessary to cache all data of the report in one DataSet or not.	StiReport
		cacheTotals : Boolean Gets or sets value which indicates whether to allows cache totals.	StiReport
		calculationMode : int Gets or sets the method of calculation in report.	StiReport
		collate : int Gets or sets value which can be used for pages collating.	StiReport
		column : int Gets or sets the current column.	StiReport
		compiledReport : StiReport	StiReport
		convertNulls : Boolean Gets or sets value which shows whether it is necessary to convert null or DBNull.	StiReport
		currentPage : int	StiReport
		currentPrintPage : int	StiReport
		dataBandsUsedInPageTotals : StiHashtable Internal use only	StiReport
		dataSources : StiDataSourcesCollection [read-only]	StiReport
		dataStore : StiDataCollection [read-only]	StiReport
		date : StiDateTime [read-only] Gets the current date.	StiReport
		_designer : IStiDesignerBase	StiReport
		designer : IStiDesignerBase Gets a report designer.	StiReport
		dictionary : StiDictionary Gets or sets a dictionary of data.	StiReport
		endRenderEvent : StiEndRenderEvent Occurs when when a report ends to render.	StiReport
		engine : StiEngine	StiReport
		engineVersion : int Gets or sets the current report engine.	StiReport
		exportedEvent : StiExportedEvent Occurs when report ends exporting.	StiReport
		exportingEvent : StiExportingEvent Occurs when report starts exporting.	StiReport
		globalizationStrings : StiGlobalizationContainerCollection [read-only] Gets a collection which consists of globalization strings.	StiReport
		groupLine : int Gets or sets the current group number.	StiReport
		indexName : int = 1	StiReport
		info : StiDesignerInfo Gets or sets information which is necessary for the report designer.	StiReport
		isCompiled : Boolean [read-only]	StiReport
		isDesigning : Boolean [read-only]	StiReport
		isDocument : Boolean Gets value which indicates that this report contain rendered docuement which loaded from file or other source.	StiReport
		isEditedInPreview : Boolean	StiReport
		isEditedInViewer : Boolean	StiReport
		isExporting : Boolean [read-only]	StiReport
		isExportStarted : Boolean Internal use only! (see Stimulsoft_ViewerFx -> StiMainPanel.mxml -> startExportTimer()	StiReport
		isFirstPage : Boolean [read-only]	StiReport
		isFirstPageTrough : Boolean [read-only]	StiReport
		isFirstPass : Boolean [read-only]	StiReport
		isInteractionRendering : Boolean Gets value which indicates that current rendering of report is used for interaction purposes.	StiReport
		isLastPage : Boolean [read-only]	StiReport
		isLastPageTrough : Boolean [read-only]	StiReport
		isModified : Boolean	StiReport
		isNew : Boolean	StiReport
		isPackedReport : Boolean [read-only] Gets value which indicates that report loaded from packed format.	StiReport
		isPageDesigner : Boolean	StiReport
		isPreviewDialogs : Boolean	StiReport
		isPrinting : Boolean	StiReport
		isRendered : Boolean	StiReport
		isRendering : Boolean	StiReport
		isSecondPass : Boolean [read-only]	StiReport
		isSelected : Boolean Gets or sets value, which indicates whether the report in the designer is selected or not.	StiReport
		isSerializing : Boolean	StiReport
		isStopped : Boolean	StiReport
		isThumbnails : Boolean	StiReport
		line : int Gets or sets the current line that starts at the beginning of a group.	StiReport
		lineABC : String [read-only] Gets or sets the current line (Alphabetical) that starts at the beginning of a group.	StiReport
		lineRoman : String [read-only] Gets the current line (Roman numerals) that starts at the beginning of a group.	StiReport
		lineThrough : int Gets or sets the current line which starts at the beginning of a report.	StiReport
		_manualBookmark : StiBookmark	StiReport
		manualBookmark : StiBookmark Gets or sets the root manual bookmark.	StiReport
		metaTags : StiMetaTagCollection [read-only] Gets collection of meta tags.	StiReport
		numberOfPass : int Gets or sets the number of passes which the report generator makes while report rendering.	StiReport
		pageNofM : String [read-only] Gets string value which contains "Page N of M".	StiReport
		pageNofMLocalizationString : String Gets string value which contains localization template for "Page N of M".	StiReport
		pageNofMThrough : String [read-only] Gets string value which contains "Page N of M".	StiReport
		pageNumber : int Gets or sets an index of the current page printed taking into consideration segmented pages.	StiReport
		pageNumberThrough : int [read-only] Gets or sets an index of the current page printed taking into consideration segmented pages.	StiReport
		pages : StiPagesCollection [read-only] Gets a collection which consists of the pages of the template of the report.	StiReport
		password : String Internal use only.	StiReport
		previewMode : int Gets or sets the preview mode of the report.	StiReport
		previewSettings : int Gets or sets controls which will be shown in the Preview Window.	StiReport
		printedEvent : StiPrintedEvent Occurs when report ends printing.	StiReport
		printerSettings : StiPrinterSettings Gets or sets printer settings of current report.	StiReport
		printingEvent : StiPrintingEvent Occurs when report starts printing.	StiReport
		progress : StiProgressInformation	StiReport
		ref : int	StiReport
		referencedAssemblies : Array Gets or sets an array of referenced assemblies.	StiReport
		renderedPages : StiPagesCollection Gets a collection of rendered pages.	StiReport
		renderedWith : int Gets or sets a technology a report was rendered with.	StiReport
		renderingEvent : StiRenderingEvent Occurs when a report rendering.	StiReport
		reportAlias : String Gets or sets a report alias.	StiReport
		reportAuthor : String Gets or sets a report author.	StiReport
		reportCacheMode : int Gets or sets value, which indicates how report engine use report cache.	StiReport
		reportChanged : StiDateTime Gets or sets the date of the last report changes.	StiReport
		reportCreated : StiDateTime Gets or sets the date of the report creation.	StiReport
		reportDescription : String Gets or sets a report description.	StiReport
		reportFile : String Gets or sets the last opened or saved file name.	StiReport
		reportGuid : String Gets or sets the report Guid.	StiReport
		reportName : String Gets or sets a report name.	StiReport
		reportPass : String = None	StiReport
		reportRenderingMessages : StiStringCollection Gets or sets collection which contains report rendering messages.	StiReport
		reportUnit : int Gets the current unit of the report.	StiReport
		reportVersion : String Gets or sets version of the report engine.	StiReport
		requestParameters : Boolean 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.	StiReport
		script : String Gets or sets a script of the report.	StiReport
		scriptLanguage : int Gets or sets the current script language.	StiReport
		statusString : String Gets or sets string representation of the current report status when report is rendered.	StiReport
		stop : Boolean	StiReport
		stopBeforePage : int Gets or sets a page number.	StiReport
		storeImagesInResources : Boolean Gets or sets value which indicates that images from report will be stored as assembly resources.	StiReport
		styles : StiStylesCollection [read-only] Gets a collection which consists of styles.	StiReport
		subReportsMasterReport : StiReport = null The master report for subreports.	StiReport
		subReportsPrintOnPreviousPage : Boolean = false	StiReport
		subReportsResetPageNumber : Boolean = false	StiReport
		time : StiDateTime [read-only] Gets the current date and time.	StiReport
		today : StiDateTime [read-only] Gets the current date.	StiReport
		totalPageCount : int Gets or sets the number of pages in a report (RunTime Variable).	StiReport
		totalPageCountThrough : int [read-only] Gets or sets the number of pages in a report.	StiReport
		totalPageCountValue : int = 0	StiReport
		unit : StiUnit Gets the current unit.	StiReport
		variables : StiHashtable Returns the collection of code defined reprot variables.	StiReport
		viewerInfo : StiViewerInfo Gets or sets information which is necessary for the report viewer.	StiReport

	Method	Defined By
		StiReport()	StiReport
		addAnchor(value:Object):void	StiReport
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void	StiReport
		applyStyleCollection(collectionName:String):void Applies styles associated with the specified style collection to all components in the report.	StiReport
		applyStyles():void Applies styles of a report to all components in the report.	StiReport
		clone(... args):Object [override]	StiReport
		convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void Converts all components coordinates from one unit into another.	StiReport
		createReportScript():void	StiReport
		design(designer:* = null):* Calls the designer for the report.	StiReport
		designDialog(rectangle:Rectangle = null, title:String, allowResize:Boolean = false, allowDrag:Boolean = false):* Calls the designer for the report as a dialog form.	StiReport
		dispatchEvent(event:Event):Boolean	StiReport
		dispose():void	StiReport
		equals(object:Object):Boolean [override]	StiReport
		getAnchor(value:Object):StiRuntimeVariables Gets runtime values by the value of an anchor.	StiReport
		getAnchorPageNumber(value:Object):int Gets the page number by the value of an anchor.	StiReport
		getAnchorPageNumberThrough(value:Object):int Gets the page number through by the value of an anchor.	StiReport
		getComponentByName(componentName:String):StiComponent	StiReport
		getComponents():StiComponentsCollection Returns a list of all components, including pages in the report.	StiReport
		getComponentsCount():int Returns count of all components of the report.	StiReport
		getCurrentPage():StiPage Returns the current page.	StiReport
		getExportFileName(format:int = -1):String Возвращает имя файла для экспортирования	StiReport
		getPageNumber(index:int):int	StiReport
		getReportFileName():String Возвращает имя файла, сформированное по алиасу и имени отчёта	StiReport
		getSelected():Array Returns the array of the selected components on the current page (including pages and modifiers).	StiReport
		getShortTypeName():String Get a short object type name (without library path).	StiObject
		getType():Class	StiObject
		getTypeName():String	StiObject
		hasEventListener(type:String):Boolean	StiReport
		invert():void Inverts selection of a report.	StiReport
		invokeEndRender():void Raises the EndRender event for the report.	StiReport
		isSimple(object:*):Boolean [static]	StiObject
		loadDocumentFromByteArray(bytes:ByteArray):void Loads a rendered report from the byteArray.	StiReport
		loadDocumentFromString(string:String):void Loads a rendered report from the string.	StiReport
		loadDocumentFromXML(xml:XMLNode):void Loads a rendered report from the XML node.	StiReport
		loadEncryptedDocumentFromByteArray(bytes:ByteArray, key:String):void Loads a encrypted rendered report from the byteArray.	StiReport
		loadEncryptedDocumentFromString(string:String, key:String):void Loads a encrypted rendered report from the string.	StiReport
		loadEncryptedReportFromByteArray(bytes:ByteArray, key:String):void Loads a encrypted report template from the byteArray.	StiReport
		loadEncryptedReportFromString(string:String, key:String):void Loads a encrypted report template from the string.	StiReport
		loadPackedDocumentFromByteArray(bytes:ByteArray):void Loads a packed rendered report from the byteArray.	StiReport
		loadPackedDocumentFromString(string:String):void Loads a packed rendered report from the string.	StiReport
		loadPackedReportFromByteArray(bytes:ByteArray):void Loads a packed report template from the byteArray.	StiReport
		loadPackedReportFromString(string:String):void Loads a packed report template from the string.	StiReport
		loadReportFromByteArray(bytes:ByteArray):void Loads a report template from the byteArray.	StiReport
		loadReportFromString(string:String):void Loads a report template from the string.	StiReport
		loadReportFromUrl(url:String):void Loads a report template from the url.	StiReport
		loadReportFromXML(xml:XMLNode):void Loads a report template from the XML node.	StiReport
		localizeReport(cultureName:String):void Localize a report to the specified culture name.	StiReport
		memberwiseClone():Object [override]	StiReport
		print(showPrintDialog:Boolean = false, pages:String = All):void	StiReport
		regData(name:String, alias:String, data:Object):void	StiReport
		regDataSet(name:String, alias:String, dataSet:DataSet):void	StiReport
		regDataTable(name:String, alias:String, dataTable:DataTable):void	StiReport
		regDataXML(name:String, alias:String, data:XML):void	StiReport
		regDataXMLDocument(name:String, alias:String, data:XMLDocument):void	StiReport
		regDataXMLNode(name:String, alias:String, dataNode:XMLNode, schemaNode:XMLNode = null):void	StiReport
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void	StiReport
		renameStyle(oldStylename:String, newStyleName:String):void	StiReport
		render(showProgress:Boolean = false, loadImages:Boolean = true):void	StiReport
		reset():void Resets selection of a report.	StiReport
		resetSelection():void Resets selection from all selected objects in the report.	StiReport
		saveDocumentToByteArray():ByteArray Saves a rendered report to the byteArray.	StiReport
		saveDocumentToString():String Saves a rendered report to the string.	StiReport
		saveDocumentToXML():XMLNode Saves a rendered report to the XML node.	StiReport
		saveEncryptedDocumentToByteArray(key:String):ByteArray Saves a encrypted rendered report to the byteArray.	StiReport
		saveEncryptedDocumentToString(key:String):String Saves a encrypted rendered report to the string.	StiReport
		saveEncryptedReportToByteArray(key:String):ByteArray Saves a encrypted report template to the byteArray.	StiReport
		saveEncryptedReportToString(key:String):String Saves a encrypted report template to the string.	StiReport
		savePackedDocumentToByteArray():ByteArray Saves a packed rendered report to the byteArray.	StiReport
		savePackedDocumentToString():String Saves a packed rendered report to the string.	StiReport
		savePackedReportToByteArray():ByteArray Saves a packed report template to the byteArray.	StiReport
		savePackedReportToString():String Saves a packed report template to the string.	StiReport
		saveReportToByteArray():ByteArray Saves a report template to the byteArray.	StiReport
		saveReportToString():String Saves a report template to the string.	StiReport
		saveReportToXML():XMLNode Saves a report template to the XML node.	StiReport
		select():void Selects a report.	StiReport
		show(viewer:* = null):* Shows a rendered report.	StiReport
		showDialog(rectangle:Rectangle = null, title:String, allowResize:Boolean = false, allowDrag:Boolean = false):* Shows the rendered report as a dialog form.	StiReport
		updateBrowserTitle(title:String):void Обновление заголовка браузера	StiReport

Property Detail

_designer

property

public var _designer:IStiDesignerBase

_manualBookmark

property

public var _manualBookmark:StiBookmark

autoDisposeImages

property

autoDisposeImages:Boolean

Frees memory after closing the Viewer that is used to store the StiImage objects in the report.

Implementation
public function get autoDisposeImages():Boolean
public function set autoDisposeImages(value:Boolean):void

autoLocalizeReportOnRun

property

autoLocalizeReportOnRun:Boolean

Gets or sets property which allows automatic localization of the report when running starts.

Implementation
public function get autoLocalizeReportOnRun():Boolean
public function set autoLocalizeReportOnRun(value:Boolean):void

beginRenderEvent

property

beginRenderEvent:StiBeginRenderEvent

Occurs when when a report begins to render.

Implementation
public function get beginRenderEvent():StiBeginRenderEvent
public function set beginRenderEvent(value:StiBeginRenderEvent):void

bookmark

property

bookmark:StiBookmark

Gets or sets the root bookmark. Internal use only.

Implementation
public function get bookmark():StiBookmark
public function set bookmark(value:StiBookmark):void

bookmarkValue

property

public var bookmarkValue:StiBookmark

cacheAllData

property

cacheAllData:Boolean

Gets or sets value, which indicates whether it is necessary to cache all data of the report in one DataSet or not.

Implementation
public function get cacheAllData():Boolean
public function set cacheAllData(value:Boolean):void

cachedTotals

property

sti_internal var cachedTotals:StiHashtable = null

cachedTotalsLocked

property

sti_internal var cachedTotalsLocked:Boolean = false

cacheTotals

property

cacheTotals:Boolean

Gets or sets value which indicates whether to allows cache totals.

Implementation
public function get cacheTotals():Boolean
public function set cacheTotals(value:Boolean):void

calculationMode

property

calculationMode:int

Gets or sets the method of calculation in report.

Implementation
public function get calculationMode():int
public function set calculationMode(value:int):void

cells

property

cells:StiCells [read-only]

Property used for access to internal CrossTab variables. Internal use only.

Implementation
sti_internal function get cells():StiCells

collate

property

collate:int

Gets or sets value which can be used for pages collating. The value of the property cannot be less then 1.

Implementation
public function get collate():int
public function set collate(value:int):void

column

property

column:int

Gets or sets the current column.

Implementation
public function get column():int
public function set column(value:int):void

compiledReport

property

compiledReport:StiReport

Implementation
public function get compiledReport():StiReport
public function set compiledReport(value:StiReport):void

convertNulls

property

convertNulls:Boolean

Gets or sets value which shows whether it is necessary to convert null or DBNull.

Implementation
public function get convertNulls():Boolean
public function set convertNulls(value:Boolean):void

currentPage

property

currentPage:int

Implementation
public function get currentPage():int
public function set currentPage(value:int):void

currentPrintPage

property

currentPrintPage:int

Implementation
public function get currentPrintPage():int
public function set currentPrintPage(value:int):void

dataBandsSorting

property

sti_internal var dataBandsSorting:StiHashtable = null

dataBandsUsedInPageTotals

property

dataBandsUsedInPageTotals:StiHashtable

Internal use only

Implementation
public function get dataBandsUsedInPageTotals():StiHashtable
public function set dataBandsUsedInPageTotals(value:StiHashtable):void

dataSources

property

dataSources:StiDataSourcesCollection [read-only]

Implementation
public function get dataSources():StiDataSourcesCollection

dataStore

property

dataStore:StiDataCollection [read-only]

Implementation
public function get dataStore():StiDataCollection

date

property

date:StiDateTime [read-only]

Gets the current date.

Implementation
public function get date():StiDateTime

designer

property

designer:IStiDesignerBase

Gets a report designer.

Implementation
public function get designer():IStiDesignerBase
public function set designer(value:IStiDesignerBase):void

dictionary

property

dictionary:StiDictionary

Gets or sets a dictionary of data.

Implementation
public function get dictionary():StiDictionary
public function set dictionary(value:StiDictionary):void

endRenderEvent

property

endRenderEvent:StiEndRenderEvent

Occurs when when a report ends to render.

Implementation
public function get endRenderEvent():StiEndRenderEvent
public function set endRenderEvent(value:StiEndRenderEvent):void

engine

property

engine:StiEngine

Implementation
public function get engine():StiEngine
public function set engine(value:StiEngine):void

engineVersion

property

engineVersion:int

Gets or sets the current report engine.

Implementation
public function get engineVersion():int
public function set engineVersion(value:int):void

exportedEvent

property

exportedEvent:StiExportedEvent

Occurs when report ends exporting.

Implementation
public function get exportedEvent():StiExportedEvent
public function set exportedEvent(value:StiExportedEvent):void

exportingEvent

property

exportingEvent:StiExportingEvent

Occurs when report starts exporting.

Implementation
public function get exportingEvent():StiExportingEvent
public function set exportingEvent(value:StiExportingEvent):void

globalizationStrings

property

globalizationStrings:StiGlobalizationContainerCollection [read-only]

Gets a collection which consists of globalization strings.

Implementation
public function get globalizationStrings():StiGlobalizationContainerCollection

groupLine

property

groupLine:int

Gets or sets the current group number.

Implementation
public function get groupLine():int
public function set groupLine(value:int):void

indexName

property

public var indexName:int = 1

info

property

info:StiDesignerInfo

Gets or sets information which is necessary for the report designer.

Implementation
public function get info():StiDesignerInfo
public function set info(value:StiDesignerInfo):void

isCompiled

property

isCompiled:Boolean [read-only]

Implementation
public function get isCompiled():Boolean

isDesigning

property

isDesigning:Boolean [read-only]

Implementation
public function get isDesigning():Boolean

isDocument

property

isDocument:Boolean

Gets value which indicates that this report contain rendered docuement which loaded from file or other source.

Implementation
public function get isDocument():Boolean
public function set isDocument(value:Boolean):void

isEditedInPreview

property

isEditedInPreview:Boolean

Implementation
public function get isEditedInPreview():Boolean
public function set isEditedInPreview(value:Boolean):void

isEditedInViewer

property

isEditedInViewer:Boolean

Implementation
public function get isEditedInViewer():Boolean
public function set isEditedInViewer(value:Boolean):void

isExporting

property

isExporting:Boolean [read-only]

Implementation
public function get isExporting():Boolean

isExportStarted

property

isExportStarted:Boolean

Internal use only! (see Stimulsoft_ViewerFx -> StiMainPanel.mxml -> startExportTimer()

Implementation
public function get isExportStarted():Boolean
public function set isExportStarted(value:Boolean):void

isFirstPage

property

isFirstPage:Boolean [read-only]

Implementation
public function get isFirstPage():Boolean

isFirstPageTrough

property

isFirstPageTrough:Boolean [read-only]

Implementation
public function get isFirstPageTrough():Boolean

isFirstPass

property

isFirstPass:Boolean [read-only]

Implementation
public function get isFirstPass():Boolean

isInteractionRendering

property

isInteractionRendering:Boolean

Gets value which indicates that current rendering of report is used for interaction purposes. Internal use only.

Implementation
public function get isInteractionRendering():Boolean
public function set isInteractionRendering(value:Boolean):void

isLastPage

property

isLastPage:Boolean [read-only]

Implementation
public function get isLastPage():Boolean

isLastPageTrough

property

isLastPageTrough:Boolean [read-only]

Implementation
public function get isLastPageTrough():Boolean

isModified

property

isModified:Boolean

Implementation
public function get isModified():Boolean
public function set isModified(value:Boolean):void

isNew

property

isNew:Boolean

Implementation
public function get isNew():Boolean
public function set isNew(value:Boolean):void

isPackedReport

property

isPackedReport:Boolean [read-only]

Gets value which indicates that report loaded from packed format.

Implementation
public function get isPackedReport():Boolean

isPageDesigner

property

isPageDesigner:Boolean

Implementation
public function get isPageDesigner():Boolean
public function set isPageDesigner(value:Boolean):void

isPreviewDialogs

property

isPreviewDialogs:Boolean

Implementation
public function get isPreviewDialogs():Boolean
public function set isPreviewDialogs(value:Boolean):void

isPrinting

property

isPrinting:Boolean

Implementation
public function get isPrinting():Boolean
public function set isPrinting(value:Boolean):void

isRendered

property

isRendered:Boolean

Implementation
public function get isRendered():Boolean
public function set isRendered(value:Boolean):void

isRendering

property

isRendering:Boolean

Implementation
public function get isRendering():Boolean
public function set isRendering(value:Boolean):void

isSecondPass

property

isSecondPass:Boolean [read-only]

Implementation
public function get isSecondPass():Boolean

isSelected

property

isSelected:Boolean

Gets or sets value, which indicates whether the report in the designer is selected or not.

Implementation
public function get isSelected():Boolean
public function set isSelected(value:Boolean):void

isSerializing

property

isSerializing:Boolean

Implementation
public function get isSerializing():Boolean
public function set isSerializing(value:Boolean):void

isStopped

property

isStopped:Boolean

Implementation
public function get isStopped():Boolean
public function set isStopped(value:Boolean):void

isThumbnails

property

isThumbnails:Boolean

Implementation
public function get isThumbnails():Boolean
public function set isThumbnails(value:Boolean):void

line

property

line:int

Gets or sets the current line that starts at the beginning of a group.

Implementation
public function get line():int
public function set line(value:int):void

lineABC

property

lineABC:String [read-only]

Gets or sets the current line (Alphabetical) that starts at the beginning of a group.

Implementation
public function get lineABC():String

lineRoman

property

lineRoman:String [read-only]

Gets the current line (Roman numerals) that starts at the beginning of a group.

Implementation
public function get lineRoman():String

lineThrough

property

lineThrough:int

Gets or sets the current line which starts at the beginning of a report.

Implementation
public function get lineThrough():int
public function set lineThrough(value:int):void

manualBookmark

property

manualBookmark:StiBookmark

Gets or sets the root manual bookmark. Please use Bookmark property in EngineV2.

Implementation
public function get manualBookmark():StiBookmark
public function set manualBookmark(value:StiBookmark):void

metaTags

property

metaTags:StiMetaTagCollection [read-only]

Gets collection of meta tags.

Implementation
public function get metaTags():StiMetaTagCollection

numberOfPass

property

numberOfPass:int

Gets or sets the number of passes which the report generator makes while report rendering.

Implementation
public function get numberOfPass():int
public function set numberOfPass(value:int):void

pageNofM

property

pageNofM:String [read-only]

Gets string value which contains "Page N of M". Property ResetPageNumber can reset value of N.

Implementation
public function get pageNofM():String

pageNofMLocalizationString

property

pageNofMLocalizationString:String

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.

Implementation
public function get pageNofMLocalizationString():String
public function set pageNofMLocalizationString(value:String):void

pageNofMThrough

property

pageNofMThrough:String [read-only]

Gets string value which contains "Page N of M". Property ResetPageNumber is ignored.

Implementation
public function get pageNofMThrough():String

pageNumber

property

pageNumber:int

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.

Implementation
public function get pageNumber():int
public function set pageNumber(value:int):void

pageNumberThrough

property

pageNumberThrough:int [read-only]

Gets or sets an index of the current page printed taking into consideration segmented pages. Number starts from 1. Property ResetPageNumber is ignored.

Implementation
public function get pageNumberThrough():int

pages

property

pages:StiPagesCollection [read-only]

Gets a collection which consists of the pages of the template of the report.

Implementation
public function get pages():StiPagesCollection

password

property

password:String

Internal use only.

Implementation
public function get password():String
public function set password(value:String):void

previewMode

property

previewMode:int

Gets or sets the preview mode of the report.

Implementation
public function get previewMode():int
public function set previewMode(value:int):void

previewSettings

property

previewSettings:int

Gets or sets controls which will be shown in the Preview Window.

Implementation
public function get previewSettings():int
public function set previewSettings(value:int):void

printedEvent

property

printedEvent:StiPrintedEvent

Occurs when report ends printing.

Implementation
public function get printedEvent():StiPrintedEvent
public function set printedEvent(value:StiPrintedEvent):void

printerSettings

property

printerSettings:StiPrinterSettings

Gets or sets printer settings of current report.

Implementation
public function get printerSettings():StiPrinterSettings
public function set printerSettings(value:StiPrinterSettings):void

printingEvent

property

printingEvent:StiPrintingEvent

Occurs when report starts printing.

Implementation
public function get printingEvent():StiPrintingEvent
public function set printingEvent(value:StiPrintingEvent):void

progress

property

progress:StiProgressInformation

Implementation
public function get progress():StiProgressInformation
public function set progress(value:StiProgressInformation):void

ref

property

ref:int

Implementation
public function get ref():int
public function set ref(value:int):void

referencedAssemblies

property

referencedAssemblies:Array

Gets or sets an array of referenced assemblies.

Implementation
public function get referencedAssemblies():Array
public function set referencedAssemblies(value:Array):void

renderedPages

property

renderedPages:StiPagesCollection

Gets a collection of rendered pages.

Implementation
public function get renderedPages():StiPagesCollection
public function set renderedPages(value:StiPagesCollection):void

renderedWith

property

renderedWith:int

Gets or sets a technology a report was rendered with.

Implementation
public function get renderedWith():int
public function set renderedWith(value:int):void

renderingEvent

property

renderingEvent:StiRenderingEvent

Occurs when a report rendering.

Implementation
public function get renderingEvent():StiRenderingEvent
public function set renderingEvent(value:StiRenderingEvent):void

reportAlias

property

reportAlias:String

Gets or sets a report alias.

Implementation
public function get reportAlias():String
public function set reportAlias(value:String):void

reportAuthor

property

reportAuthor:String

Gets or sets a report author.

Implementation
public function get reportAuthor():String
public function set reportAuthor(value:String):void

reportCacheMode

property

reportCacheMode:int

Gets or sets value, which indicates how report engine use report cache.

Implementation
public function get reportCacheMode():int
public function set reportCacheMode(value:int):void

reportChanged

property

reportChanged:StiDateTime

Gets or sets the date of the last report changes.

Implementation
public function get reportChanged():StiDateTime
public function set reportChanged(value:StiDateTime):void

reportCreated

property

reportCreated:StiDateTime

Gets or sets the date of the report creation.

Implementation
public function get reportCreated():StiDateTime
public function set reportCreated(value:StiDateTime):void

reportDescription

property

reportDescription:String

Gets or sets a report description.

Implementation
public function get reportDescription():String
public function set reportDescription(value:String):void

reportFile

property

reportFile:String

Gets or sets the last opened or saved file name.

Implementation
public function get reportFile():String
public function set reportFile(value:String):void

reportGuid

property

reportGuid:String

Gets or sets the report Guid.

Implementation
public function get reportGuid():String
public function set reportGuid(value:String):void

reportName

property

reportName:String

Gets or sets a report name.

Implementation
public function get reportName():String
public function set reportName(value:String):void

reportPass

property

public var reportPass:String = None

reportRenderingMessages

property

reportRenderingMessages:StiStringCollection

Gets or sets collection which contains report rendering messages.

Implementation
public function get reportRenderingMessages():StiStringCollection
public function set reportRenderingMessages(value:StiStringCollection):void

reportUnit

property

reportUnit:int

Gets the current unit of the report.

Implementation
public function get reportUnit():int
public function set reportUnit(value:int):void

reportVersion

property

reportVersion:String

Gets or sets version of the report engine.

Implementation
public function get reportVersion():String
public function set reportVersion(value:String):void

requestParameters

property

requestParameters:Boolean

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.

Implementation
public function get requestParameters():Boolean
public function set requestParameters(value:Boolean):void

script

property

script:String

Gets or sets a script of the report.

Implementation
public function get script():String
public function set script(value:String):void

scriptLanguage

property

scriptLanguage:int

Gets or sets the current script language.

Implementation
public function get scriptLanguage():int
public function set scriptLanguage(value:int):void

statusString

property

statusString:String

Gets or sets string representation of the current report status when report is rendered.

Implementation
public function get statusString():String
public function set statusString(value:String):void

stop

property

stop:Boolean

Implementation
public function get stop():Boolean
public function set stop(value:Boolean):void

stopBeforePage

property

stopBeforePage:int

Gets or sets a page number. When this page is reached then the report rendering is stopped.

Implementation
public function get stopBeforePage():int
public function set stopBeforePage(value:int):void

storeImagesInResources

property

storeImagesInResources:Boolean

Gets or sets value which indicates that images from report will be stored as assembly resources.

Implementation
public function get storeImagesInResources():Boolean
public function set storeImagesInResources(value:Boolean):void

styles

property

styles:StiStylesCollection [read-only]

Gets a collection which consists of styles.

Implementation
public function get styles():StiStylesCollection

subReportsMasterReport

property

public var subReportsMasterReport:StiReport = null

The master report for subreports. Do not use this field.

subReportsPrintOnPreviousPage

property

public var subReportsPrintOnPreviousPage:Boolean = false

subReportsResetPageNumber

property

public var subReportsResetPageNumber:Boolean = false

time

property

time:StiDateTime [read-only]

Gets the current date and time.

Implementation
public function get time():StiDateTime

today

property

today:StiDateTime [read-only]

Gets the current date.

Implementation
public function get today():StiDateTime

totalPageCount

property

totalPageCount:int

Gets or sets the number of pages in a report (RunTime Variable).

Implementation
public function get totalPageCount():int
public function set totalPageCount(value:int):void

totalPageCountThrough

property

totalPageCountThrough:int [read-only]

Gets or sets the number of pages in a report. Property ResetPageNumber is ignored.

Implementation
public function get totalPageCountThrough():int

totalPageCountValue

property

public var totalPageCountValue:int = 0

totals

property

totals:StiHashtable

Implementation
sti_internal function get totals():StiHashtable
sti_internal function set totals(value:StiHashtable):void

unit

property

unit:StiUnit

Gets the current unit.

Implementation
public function get unit():StiUnit
public function set unit(value:StiUnit):void

variables

property

variables:StiHashtable

Returns the collection of code defined reprot variables.

Implementation
public function get variables():StiHashtable
public function set variables(value:StiHashtable):void

viewerInfo

property

viewerInfo:StiViewerInfo

Gets or sets information which is necessary for the report viewer.

Implementation
public function get viewerInfo():StiViewerInfo
public function set viewerInfo(value:StiViewerInfo):void

Constructor Detail

StiReport

()

Constructor

public function StiReport()

Method Detail

addAnchor

()

method

public function addAnchor(value:Object):void

Parameters

value:Object

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Parameters

	`type:String`

	`listener:Function`

	`useCapture:Boolean` (default = `false`)

	`priority:int` (default = `0`)

	`useWeakReference:Boolean` (default = `false`)

applyStyleCollection

()

method

public function applyStyleCollection(collectionName:String):void

Applies styles associated with the specified style collection to all components in the report.

Parameters

collectionName:String

applyStyles

()

method

public function applyStyles():void

Applies styles of a report to all components in the report.

checkExcelValue

()

method

sti_internal function checkExcelValue(sender:Object, value:*):*

Parameters

	`sender:Object`

	`value:*`

Returns

*

clone

()

method

override public function clone(... args):Object

Parameters

... args

Returns

Object

convert

()

method

public function convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void

Converts all components coordinates from one unit into another.

Parameters

	`oldUnit:StiUnit`

	`newUnit:StiUnit`

	`convertComponents:Boolean` (default = `true`)

createReportScript

()

method

public function createReportScript():void

design

()

method

public function design(designer:* = null):*

Calls the designer for the report.

Parameters

designer:* (default = null)

Returns

*

designDialog

()

method

 public function designDialog(rectangle:Rectangle = null, title:String, allowResize:Boolean = false, allowDrag:Boolean = false):*

Calls the designer for the report as a dialog form.

Parameters

	`rectangle:Rectangle` (default = `null`)

	`title:String`

	`allowResize:Boolean` (default = `false`)

	`allowDrag:Boolean` (default = `false`)

Returns

*

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns

Boolean

dispose

()

method

public function dispose():void

equals

()

method

override public function equals(object:Object):Boolean

Parameters

object:Object

Returns

Boolean

getAnchor

()

method

public function getAnchor(value:Object):StiRuntimeVariables

Gets runtime values by the value of an anchor.

Parameters

value:Object

Returns

StiRuntimeVariables

getAnchorPageNumber

()

method

public function getAnchorPageNumber(value:Object):int

Gets the page number by the value of an anchor.

Parameters

value:Object

Returns

int

getAnchorPageNumberThrough

()

method

public function getAnchorPageNumberThrough(value:Object):int

Gets the page number through by the value of an anchor.

Parameters

value:Object

Returns

int

getComponentByName

()

method

public function getComponentByName(componentName:String):StiComponent

Parameters

componentName:String

Returns

StiComponent

getComponents

()

method

public function getComponents():StiComponentsCollection

Returns a list of all components, including pages in the report.

Returns

StiComponentsCollection

getComponentsCount

()

method

public function getComponentsCount():int

Returns count of all components of the report.

Returns

int

getCurrentPage

()

method

public function getCurrentPage():StiPage

Returns the current page.

Returns

StiPage

getExportFileName

()

method

public function getExportFileName(format:int = -1):String

Возвращает имя файла для экспортирования

Parameters

format:int (default = -1)

Returns

String

getPageNumber

()

method

public function getPageNumber(index:int):int

Parameters

index:int

Returns

int

getReportFileName

()

method

public function getReportFileName():String

Возвращает имя файла, сформированное по алиасу и имени отчёта

Returns

String

getSelected

()

method

public function getSelected():Array

Returns the array of the selected components on the current page (including pages and modifiers).

Returns

Array

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns

Boolean

invert

()

method

public function invert():void

Inverts selection of a report.

invokeEndRender

()

method

public function invokeEndRender():void

Raises the EndRender event for the report.

loadDocumentFromByteArray

()

method

public function loadDocumentFromByteArray(bytes:ByteArray):void

Loads a rendered report from the byteArray.

Parameters

bytes:ByteArray

loadDocumentFromString

()

method

public function loadDocumentFromString(string:String):void

Loads a rendered report from the string.

Parameters

string:String

loadDocumentFromXML

()

method

public function loadDocumentFromXML(xml:XMLNode):void

Loads a rendered report from the XML node.

Parameters

xml:XMLNode

loadEncryptedDocumentFromByteArray

()

method

public function loadEncryptedDocumentFromByteArray(bytes:ByteArray, key:String):void

Loads a encrypted rendered report from the byteArray.

Parameters

	`bytes:ByteArray`

	`key:String`

loadEncryptedDocumentFromString

()

method

public function loadEncryptedDocumentFromString(string:String, key:String):void

Loads a encrypted rendered report from the string.

Parameters

	`string:String`

	`key:String`

loadEncryptedReportFromByteArray

()

method

public function loadEncryptedReportFromByteArray(bytes:ByteArray, key:String):void

Loads a encrypted report template from the byteArray.

Parameters

	`bytes:ByteArray`

	`key:String`

loadEncryptedReportFromString

()

method

public function loadEncryptedReportFromString(string:String, key:String):void

Loads a encrypted report template from the string.

Parameters

	`string:String`

	`key:String`

loadPackedDocumentFromByteArray

()

method

public function loadPackedDocumentFromByteArray(bytes:ByteArray):void

Loads a packed rendered report from the byteArray.

Parameters

bytes:ByteArray

loadPackedDocumentFromString

()

method

public function loadPackedDocumentFromString(string:String):void

Loads a packed rendered report from the string.

Parameters

string:String

loadPackedReportFromByteArray

()

method

public function loadPackedReportFromByteArray(bytes:ByteArray):void

Loads a packed report template from the byteArray.

Parameters

bytes:ByteArray

loadPackedReportFromString

()

method

public function loadPackedReportFromString(string:String):void

Loads a packed report template from the string.

Parameters

string:String

loadReportFromByteArray

()

method

public function loadReportFromByteArray(bytes:ByteArray):void

Loads a report template from the byteArray.

Parameters

bytes:ByteArray

loadReportFromString

()

method

public function loadReportFromString(string:String):void

Loads a report template from the string.

Parameters

string:String

loadReportFromUrl

()

method

public function loadReportFromUrl(url:String):void

Loads a report template from the url.

Parameters

url:String

loadReportFromXML

()

method

public function loadReportFromXML(xml:XMLNode):void

Loads a report template from the XML node.

Parameters

xml:XMLNode

localizeReport

()

method

public function localizeReport(cultureName:String):void

Localize a report to the specified culture name. The culture definition must be placed in GlobalizationStrings.

Parameters

cultureName:String

memberwiseClone

()

method

override public function memberwiseClone():Object

Returns

Object

prepareVariables

()

method

sti_internal function prepareVariables():void

()

method

public function print(showPrintDialog:Boolean = false, pages:String = All):void

Parameters

	`showPrintDialog:Boolean` (default = `false`)

	`pages:String` (default = `All`)

regData

()

method

public function regData(name:String, alias:String, data:Object):void

Parameters

	`name:String`

	`alias:String`

	`data:Object`

regDataSet

()

method

public function regDataSet(name:String, alias:String, dataSet:DataSet):void

Parameters

	`name:String`

	`alias:String`

	`dataSet:DataSet`

regDataTable

()

method

public function regDataTable(name:String, alias:String, dataTable:DataTable):void

Parameters

	`name:String`

	`alias:String`

	`dataTable:DataTable`

regDataXML

()

method

public function regDataXML(name:String, alias:String, data:XML):void

Parameters

	`name:String`

	`alias:String`

	`data:XML`

regDataXMLDocument

()

method

public function regDataXMLDocument(name:String, alias:String, data:XMLDocument):void

Parameters

	`name:String`

	`alias:String`

	`data:XMLDocument`

regDataXMLNode

()

method

public function regDataXMLNode(name:String, alias:String, dataNode:XMLNode, schemaNode:XMLNode = null):void

Parameters

	`name:String`

	`alias:String`

	`dataNode:XMLNode`

	`schemaNode:XMLNode` (default = `null`)

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

	`type:String`

	`listener:Function`

	`useCapture:Boolean` (default = `false`)

renameStyle

()

method

public function renameStyle(oldStylename:String, newStyleName:String):void

Parameters

	`oldStylename:String`

	`newStyleName:String`

render

()

method

public function render(showProgress:Boolean = false, loadImages:Boolean = true):void

Parameters

	`showProgress:Boolean` (default = `false`)

	`loadImages:Boolean` (default = `true`)

reset

()

method

public function reset():void

Resets selection of a report.

resetSelection

()

method

public function resetSelection():void

Resets selection from all selected objects in the report.

saveDocumentToByteArray

()

method

public function saveDocumentToByteArray():ByteArray

Saves a rendered report to the byteArray.

Returns

ByteArray

saveDocumentToString

()

method

public function saveDocumentToString():String

Saves a rendered report to the string.

Returns

String

saveDocumentToXML

()

method

public function saveDocumentToXML():XMLNode

Saves a rendered report to the XML node.

Returns

XMLNode

saveEncryptedDocumentToByteArray

()

method

public function saveEncryptedDocumentToByteArray(key:String):ByteArray

Saves a encrypted rendered report to the byteArray.

Parameters

key:String

Returns

ByteArray

saveEncryptedDocumentToString

()

method

public function saveEncryptedDocumentToString(key:String):String

Saves a encrypted rendered report to the string.

Parameters

key:String

Returns

String

saveEncryptedReportToByteArray

()

method

public function saveEncryptedReportToByteArray(key:String):ByteArray

Saves a encrypted report template to the byteArray.

Parameters

key:String

Returns

ByteArray

saveEncryptedReportToString

()

method

public function saveEncryptedReportToString(key:String):String

Saves a encrypted report template to the string.

Parameters

key:String

Returns

String

savePackedDocumentToByteArray

()

method

public function savePackedDocumentToByteArray():ByteArray

Saves a packed rendered report to the byteArray.

Returns

ByteArray

savePackedDocumentToString

()

method

public function savePackedDocumentToString():String

Saves a packed rendered report to the string.

Returns

String

savePackedReportToByteArray

()

method

public function savePackedReportToByteArray():ByteArray

Saves a packed report template to the byteArray.

Returns

ByteArray

savePackedReportToString

()

method

public function savePackedReportToString():String

Saves a packed report template to the string.

Returns

String

saveReportToByteArray

()

method

public function saveReportToByteArray():ByteArray

Saves a report template to the byteArray.

Returns

ByteArray

saveReportToString

()

method

public function saveReportToString():String

Saves a report template to the string.

Returns

String

saveReportToXML

()

method

public function saveReportToXML():XMLNode

Saves a report template to the XML node.

Returns

XMLNode

select

()

method

public function select():void

Selects a report.

show

()

method

public function show(viewer:* = null):*

Shows a rendered report. If the report is not rendered then its rendering starts.

Parameters

viewer:* (default = null)

Returns

*

showDialog

()

method

 public function showDialog(rectangle:Rectangle = null, title:String, allowResize:Boolean = false, allowDrag:Boolean = false):*

Shows the rendered report as a dialog form. If the report is not rendered then its rendering starts.

Parameters

	`rectangle:Rectangle` (default = `null`)

	`title:String`

	`allowResize:Boolean` (default = `false`)

	`allowDrag:Boolean` (default = `false`)

Returns

*

toString1

()

method

sti_internal function toString1(obj:*):String

Internal use only. Used only for converting an object to the string.

Parameters

obj:*

Returns

String

toString2

()

method

sti_internal function toString2(sender:Object, obj:*, allowExcelCheck:Boolean = false):String

Parameters

	`sender:Object`

	`obj:*`

	`allowExcelCheck:Boolean` (default = `false`)

Returns

String

updateBrowserTitle

()

method

public function updateBrowserTitle(title:String):void

Обновление заголовка браузера

Parameters

title:String

Mon Mar 27 2017, 09:08 AM +03:00

Stimulsoft Reports.Flex Class Reference	All Packages \| All Classes \| Index \| Frames No Frames
StiReport	Properties \| Methods

Package	stimulsoft.report
Class	public class StiReport
Inheritance	StiReport StiObject Object
Implements	IStiRef, IStiUnitConvert, IStiEngineVersionProperty, IStiReport