Class StiReport

Hierarchy

  • StiReport

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_totalPageCountValue

_totalPageCountValue: number = 0

autoLocalizeReportOnRun

autoLocalizeReportOnRun: boolean = false

beginRenderEvent

beginRenderEvent: StiEvent = new StiEvent()

bookmarkValue

bookmarkValue: StiBookmark

cacheAllData

cacheAllData: boolean = false

cacheTotals

cacheTotals: boolean = false

cachedTotals

cachedTotals: Hashtable = null

cachedTotalsLocked

cachedTotalsLocked: boolean = false

column

column: number = 1

compiledReport

compiledReport: StiReport

containsTables

containsTables: boolean = false

convertNulls

convertNulls: boolean = true

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

culture

culture: string = ""

currentPage

currentPage: number = 0

currentPrintPage

currentPrintPage: number = 0

dashboardViewerSettings

dashboardViewerSettings: StiDashboardViewerSettings = StiDashboardViewerSettings.All

designer

designer: IStiDesignerBase

Gets a report designer.

endRenderEvent

endRenderEvent: StiEvent = new StiEvent()

engine

engine: StiEngine = null

exportedEvent

exportedEvent: StiEvent = new StiEvent()

exportingEvent

exportingEvent: StiEvent = new StiEvent()

globalizationManager

globalizationManager: IStiGlobalizationManager = new StiNullGlobalizationManager()

globalizationStrings

globalizationStrings: StiGlobalizationContainerCollection = null

groupLine

groupLine: number = 1

htmlPreviewMode

htmlPreviewMode: StiHtmlPreviewMode = StiHtmlPreviewMode.Div

Specifies the HTML mode which is used for viewing report in the webviewer.

httpHeadersContainer

httpHeadersContainer: Header[] = []

imageCache

imageCache: Hashtable

indexName

indexName: number = 1

Internal use only.

interactionCollapsingStates

interactionCollapsingStates: any = null

isDocument

isDocument: boolean = false

isExporting

isExporting: boolean = false

isInteractionRendering

isInteractionRendering: boolean = false

isPageDesigner

isPageDesigner: boolean = false

isRendered

isRendered: boolean = false

isRendering

isRendering: boolean = false

isReportRenderingAfterSubmit

isReportRenderingAfterSubmit: boolean

Internal use only.

isSerializing

isSerializing: boolean = false

isStopped

isStopped: boolean = false

jsonLoaderHelper

jsonLoaderHelper: StiJsonLoaderHelper

key

key: string

Gets or sets the report key.

licenseKey

licenseKey: string

line

line: number = 1

lineThrough

lineThrough: number = 1

metaTags

metaTags: StiMetaTagCollection = new StiMetaTagCollection()

modifiedVariables

modifiedVariables: Hashtable = new Hashtable()

onBeginProcessData

onBeginProcessData: function = null

Type declaration

onBeginRender

onBeginRender: function

Type declaration

    • (): void

    • Returns void

onEndProcessData

onEndProcessData: function = null

Type declaration

onEndRender

onEndRender: function = null

Type declaration

    • (): void

    • Returns void

onExported

onExported: function = null

Type declaration

onExporting

onExporting: function = null

Type declaration

onPrepareVariables

onPrepareVariables: function = null

Type declaration

onPrinted

onPrinted: function = null

Type declaration

onPrinting

onPrinting: function = null

Type declaration

    • (): void

    • Returns void

onRefreshing

onRefreshing: function

Type declaration

    • (): void

    • Returns void

onRendering

onRendering: function = null

Type declaration

    • (): void

    • Returns void

pageCopyNumber

pageCopyNumber: number = 1

pageNofMLocalizationString

pageNofMLocalizationString: string = null

pages

pages: StiPagesCollection

parameterAlignment

parameterAlignment: StiHorAlignment = StiHorAlignment.Left

parametersOrientation

parametersOrientation: StiOrientation = StiOrientation.Horizontal

parentReport

parentReport: StiReport = null

password

password: string = null

preparedExportImages

preparedExportImages: Hashtable<StiComponent, Image> = null

previewSettings

previewSettings: number = <number>Stimulsoft.Report.Viewer.StiPreviewSettings.Default

previewToolBarOptions

previewToolBarOptions: StiPreviewToolBarOptions = new StiPreviewToolBarOptions()

printedEvent

printedEvent: StiEvent = new StiEvent()

printingEvent

printingEvent: StiEvent = new StiEvent()

refreshingEvent

refreshingEvent: StiEvent = new StiEvent()

renderedWith

renderedWith: StiRenderedWith = StiRenderedWith.Unknown

Gets or sets a technology a report was rendered with.

renderingEvent

renderingEvent: StiEvent = new StiEvent()

reportAlias

reportAlias: string = ""

reportAuthor

reportAuthor: string = ""

reportCacheMode

reportCacheMode: StiReportCacheMode = StiReportCacheMode.Off

reportCachePath

reportCachePath: string = ""

Gets path to the report cache path. Path can't be changed.

reportCacheProcessingEvent

reportCacheProcessingEvent: StiEvent = new StiEvent()

reportChanged

reportChanged: DateTime = DateTime.now

reportCreated

reportCreated: DateTime = DateTime.now

reportDescription

reportDescription: string = ""

reportFile

reportFile: string = ""

reportFilePath

reportFilePath: string = ""

reportGuid

reportGuid: string = null

reportIcon

reportIcon: string

Gets or sets a report icon.

reportImage

reportImage: string

Gets or sets a report image.

reportPass

reportPass: StiReportPass = StiReportPass.None

reportVersion

reportVersion: string = StiVersion.version

requestParameters

requestParameters: boolean = false

retrieveOnlyUsedData

retrieveOnlyUsedData: boolean = false

scriptLanguage

scriptLanguage: StiReportLanguageType = StiReportLanguageType.JS

Gets or sets the current script language.

styles

styles: StiStylesCollection

subReports

subReports: StiReportsCollection

subReportsMasterReport

subReportsMasterReport: StiReport = null

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

subReportsPrintOnPreviousPage

subReportsPrintOnPreviousPage: boolean = false

subReportsResetPageNumber

subReportsResetPageNumber: boolean = false

tag

tag: any

variables

variables: Hashtable = null

Accessors

aggregateFunctions

allowEvalEvent

  • get allowEvalEvent(): boolean
  • set allowEvalEvent(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

bookmark

businessObjectsStore

calculationMode

cells

collate

  • get collate(): number
  • set collate(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

containsDashboard

  • get containsDashboard(): boolean

  • Gets or sets value, which indicates that the report contains dashboard pages.

    Returns boolean

containsOnlyDashboard

  • get containsOnlyDashboard(): boolean

  • Gets or sets value, which indicates that the report contains only dashboard pages.

    Returns boolean

dataBandsUsedInPageTotals

  • get dataBandsUsedInPageTotals(): string[]
  • set dataBandsUsedInPageTotals(value: string[]): void

  • Returns string[]

  • Parameters

    • value: string[]

    Returns void

dataSources

dataStore

  • get dataStore(): StiDataCollection

  • Returns StiDataCollection

date

dictionary

info

isDesigning

  • get isDesigning(): boolean

  • Returns boolean

isFirstPage

  • get isFirstPage(): boolean

  • Returns boolean

isFirstPageThrough

  • get isFirstPageThrough(): boolean

  • Returns boolean

isFirstPass

  • get isFirstPass(): boolean

  • Returns boolean

isLastPage

  • get isLastPage(): boolean

  • Returns boolean

isLastPageThrough

  • get isLastPageThrough(): boolean

  • Returns boolean

isModified

  • get isModified(): boolean
  • set isModified(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

isPreviewDialogs

  • get isPreviewDialogs(): boolean

  • Returns boolean

isPrinting

  • get isPrinting(): boolean
  • set isPrinting(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

isSecondPass

  • get isSecondPass(): boolean

  • Returns boolean

lineABC

  • get lineABC(): string

  • Returns string

lineRoman

  • get lineRoman(): string

  • Returns string

listOfUsedData

  • get listOfUsedData(): string[]
  • set listOfUsedData(value: string[]): void

  • Returns string[]

  • Parameters

    • value: string[]

    Returns void

manualBookmark

masterReport

  • get masterReport(): string
  • set masterReport(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

numberOfPass

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

    Returns StiNumberOfPass

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

    Parameters

    Returns void

pageNofM

  • get pageNofM(): string

  • Returns string

pageNofMThrough

  • get pageNofMThrough(): string

  • Returns string

pageNumber

  • get pageNumber(): number
  • set pageNumber(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

pageNumberThrough

  • get pageNumberThrough(): number

  • Returns number

parameterWidth

  • get parameterWidth(): number
  • set parameterWidth(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

pointer

refreshTime

  • get refreshTime(): number
  • set refreshTime(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

renderedPages

reportName

  • get reportName(): string
  • set reportName(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

reportRenderingMessages

  • get reportRenderingMessages(): string[]
  • set reportRenderingMessages(value: string[]): void

  • Returns string[]

  • Parameters

    • value: string[]

    Returns void

reportUnit

script

  • get script(): string
  • set script(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

scrollTime

  • get scrollTime(): number
  • set scrollTime(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

stopBeforePage

  • get stopBeforePage(): number
  • set stopBeforePage(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

time

today

totalPageCount

  • get totalPageCount(): number
  • set totalPageCount(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

totalPageCountThrough

  • get totalPageCountThrough(): number

  • Returns number

totals

unit

Methods

addAnchor

  • addAnchor(value: any, component?: any): void

  • Parameters

    • value: any
    • Default value component: any = null

    Returns void

applyStyleCollection

  • applyStyleCollection(collectionName: string): void

  • Parameters

    • collectionName: string

    Returns void

applyStyles

  • applyStyles(): void

  • Returns void

as

  • Type parameters

    • T

    Parameters

    Returns T

checkExcelValue

  • checkExcelValue(sender: any, value: any): any

  • Parameters

    • sender: any
    • value: any

    Returns any

clone

  • clone(): StiReport

  • Returns StiReport

convert

  • convert(oldUnit: StiUnit, newUnit: StiUnit, isReportSnapshot?: boolean): void

  • Parameters

    • oldUnit: StiUnit
    • newUnit: StiUnit
    • Default value isReportSnapshot: boolean = false

    Returns void

dispose

  • dispose(): void

  • Returns void

exportDocument

exportDocumentAsync

exportDocumentAsync2

fetchPages

getAnchorPageNumber

  • getAnchorPageNumber(value: any): number

  • Parameters

    • value: any

    Returns number

getAnchorPageNumberThrough

  • getAnchorPageNumberThrough(value: any): number

  • Parameters

    • value: any

    Returns number

getComponentByGuid

getComponentByName

getComponents

getComponentsCount

  • getComponentsCount(): number

  • Returns number

getCurrentPage

getDictionary

getFonts

  • getFonts(): Font[]

getKey

  • getKey(): string

  • Returns unique key to this application.

    Returns string

getLabel

  • getLabel(variableName: string): string

  • Parameters

    • variableName: string

    Returns string

getParam

  • getParam(paramName: string): any

  • Parameters

    • paramName: string

    Returns any

getParsedCulture

  • getParsedCulture(): string

  • Returns string

getRenderedComponents

getVariable

  • getVariable(name: string, onlyVariable?: boolean): any

  • Parameters

    • name: string
    • Default value onlyVariable: boolean = false

    Returns any

implements

  • implements(): any[]

  • Returns any[]

invokeBeginProcessData

  • Parameters

    • command: ProcessDataCommand
    • callback: function
        • (result: any): void

        • Parameters

          • result: any

          Returns void

    Returns void

invokeBeginRender

  • invokeBeginRender(): void

  • Returns void

invokeBeginRenderAsync

  • invokeBeginRenderAsync(): Promise<void>

  • Returns Promise<void>

invokeEndProcessData

invokeEndRender

  • invokeEndRender(): void

  • Returns void

invokeExported

invokeExporting

invokePrepareVariablesAsync

  • invokePrepareVariablesAsync(): Promise<unknown>

  • Returns Promise<unknown>

invokePrinted

  • invokePrinted(data: string | number[], callback: function): void

  • Parameters

    • data: string | number[]
    • callback: function
        • (result: string | number[]): void

        • Parameters

          • result: string | number[]

          Returns void

    Returns void

invokePrinting

  • invokePrinting(): void

  • Returns void

invokeRefreshViewer

  • invokeRefreshViewer(): void

  • Returns void

invokeRefreshing

  • invokeRefreshing(): void

  • Returns void

invokeRendering

  • invokeRendering(): void

  • Returns void

invokeReportCacheProcessing

  • invokeReportCacheProcessing(): void

  • Returns void

invokeResetAllFilters

  • invokeResetAllFilters(): void

  • Returns void

invokeStatusChanged

  • invokeStatusChanged(): void

  • Returns void

is

  • Type parameters

    • T

    Parameters

    Returns this

is2

  • is2<T>(type: object | Interface<T>): boolean

  • Type parameters

    • T

    Parameters

    Returns boolean

load

  • load(param: string | number[] | XmlNode | any): void

  • Parameters

    • param: string | number[] | XmlNode | any

    Returns void

loadDocument

  • loadDocument(param: string | number[] | any): void

  • Parameters

    • param: string | number[] | any

    Returns void

loadDocumentFile

  • loadDocumentFile(filePath: string): void

  • Parameters

    • filePath: string

    Returns void

loadEditableFields

  • loadEditableFields(param: string | XmlNode): StiReport

  • Parameters

    Returns StiReport

loadEditableFieldsFile

  • loadEditableFieldsFile(path: string): StiReport

  • Parameters

    • path: string

    Returns StiReport

loadEncryptedDocument

  • loadEncryptedDocument(param: string | number[] | any, key: string): void

  • Parameters

    • param: string | number[] | any
    • key: string

    Returns void

loadEncryptedDocumentFile

  • loadEncryptedDocumentFile(filePath: string, key: string): void

  • Parameters

    • filePath: string
    • key: string

    Returns void

loadEncryptedReport

  • loadEncryptedReport(param: string | number[] | any, key: string): void

  • Parameters

    • param: string | number[] | any
    • key: string

    Returns void

loadEncryptedReportFile

  • loadEncryptedReportFile(filePath: string, key: string): void

  • Parameters

    • filePath: string
    • key: string

    Returns void

loadFile

  • loadFile(filePath: string): void

  • Parameters

    • filePath: string

    Returns void

loadPacked

  • loadPacked(param: string | number[] | any): void

  • Parameters

    • param: string | number[] | any

    Returns void

loadPackedDocument

  • loadPackedDocument(param: string | number[] | any): void

  • Parameters

    • param: string | number[] | any

    Returns void

loadPackedDocumentFile

  • loadPackedDocumentFile(filePath: string): void

  • Parameters

    • filePath: string

    Returns void

loadPackedFile

  • loadPackedFile(filePath: string): void

  • Parameters

    • filePath: string

    Returns void

localizeReport

  • localizeReport(cultureName: string): void

  • Parameters

    • cultureName: string

    Returns void

mergeDocumentAsync

  • mergeDocumentAsync(report: StiReport, needRendering?: boolean): Promise<void>

  • Parameters

    • report: StiReport
    • Default value needRendering: boolean = false

    Returns Promise<void>

print

printToPdf

  • printToPdf(pagesRange?: StiPagesRange, element?: HTMLElement): void

  • Parameters

    • Default value pagesRange: StiPagesRange = null
    • Default value element: HTMLElement = null

    Returns void

processAutoLocalizeReportOnRun

  • processAutoLocalizeReportOnRun(): void

  • Returns void

regBusinessObject

regBusinessObject2

  • regBusinessObject2(category: string, name: string, alias: string, value: any): void

  • Parameters

    • category: string
    • name: string
    • alias: string
    • value: any

    Returns void

regData

  • Parameters

    • name: string
    • alias: string
    • data: any
    • Default value jsonRelationDirection: JsonRelationDirection = JsonRelationDirection.ParentToChild

    Returns void

renameStyle

  • renameStyle(oldStylename: string, newStyleName: string): void

  • Renames a style with the specified name to a new name.

    Parameters

    • oldStylename: string
    • newStyleName: string

    Returns void

render

  • render(showProgress?: boolean, fromPage?: number, toPage?: number): void

  • Parameters

    • Default value showProgress: boolean = false
    • Default value fromPage: number = -1
    • Default value toPage: number = -1

    Returns void

renderAsync

  • renderAsync(onRender?: Function, fromPage?: number, toPage?: number): void

  • Parameters

    • Default value onRender: Function = () => { }
    • Default value fromPage: number = -1
    • Default value toPage: number = -1

    Returns void

renderAsync2

  • renderAsync2(fromPage?: number, toPage?: number): Promise<void>

  • Parameters

    • Default value fromPage: number = -1
    • Default value toPage: number = -1

    Returns Promise<void>

resetAggregateFunctions

  • resetAggregateFunctions(): void

  • Returns void

resetRenderedState

  • resetRenderedState(): this

  • Returns this

saveDocumentFile

  • saveDocumentFile(path: string): void

  • Parameters

    • path: string

    Returns void

saveDocumentToJsonString

  • saveDocumentToJsonString(): string

  • Returns string

saveEditableFields

  • saveEditableFields(): string

  • Returns string

saveEditableFieldsFile

  • saveEditableFieldsFile(path: string): StiReport

  • Parameters

    • path: string

    Returns StiReport

saveEncryptedDocumentFile

  • saveEncryptedDocumentFile(path: string, key: string): void

  • Parameters

    • path: string
    • key: string

    Returns void

saveEncryptedDocumentToByteArray

  • saveEncryptedDocumentToByteArray(key: string): number[]

  • Parameters

    • key: string

    Returns number[]

saveEncryptedDocumentToString

  • saveEncryptedDocumentToString(key: string): string

  • Parameters

    • key: string

    Returns string

saveEncryptedReportFile

  • saveEncryptedReportFile(path: string, key: string): void

  • Parameters

    • path: string
    • key: string

    Returns void

saveEncryptedReportToByteArray

  • saveEncryptedReportToByteArray(key: string): number[]

  • Parameters

    • key: string

    Returns number[]

saveEncryptedReportToString

  • saveEncryptedReportToString(key: string): string

  • Parameters

    • key: string

    Returns string

saveFile

  • saveFile(path: string): void

  • Parameters

    • path: string

    Returns void

savePackedDocumentFile

  • savePackedDocumentFile(path: string): void

  • Parameters

    • path: string

    Returns void

savePackedDocumentToByteArray

  • savePackedDocumentToByteArray(): number[]

  • Returns number[]

savePackedDocumentToString

  • savePackedDocumentToString(): string

  • Returns string

savePackedFile

  • savePackedFile(path: string): void

  • Parameters

    • path: string

    Returns void

savePackedToByteArray

  • savePackedToByteArray(): number[]

  • Returns number[]

savePackedToString

  • savePackedToString(): string

  • Returns string

saveSnapshot

  • saveSnapshot(): Promise<string>

  • Saves a report template with embedded data

    Returns Promise<string>

saveToJsonString

  • saveToJsonString(): string

  • Returns string

scriptNew

  • scriptNew(): void

  • Returns void

setInheritedMode

  • setInheritedMode(inherited: boolean): void

  • Parameters

    • inherited: boolean

    Returns void

setKey

  • setKey(key: string): void

  • Parameters

    • key: string

    Returns void

setVariable

  • setVariable(name: string, value: any, onlyVariable?: boolean): void

  • Parameters

    • name: string
    • value: any
    • Default value onlyVariable: boolean = false

    Returns void

toString2

  • toString2(obj: any): string

  • Parameters

    • obj: any

    Returns string

toString3

  • toString3(sender: any, obj: any, allowExcelCheck?: boolean): string

  • Parameters

    • sender: any
    • obj: any
    • Default value allowExcelCheck: boolean = false

    Returns string

updateInheritedReport

  • updateInheritedReport(masterReport?: StiReport): void

  • Parameters

    • Default value masterReport: StiReport = null

    Returns void

writeToReportRenderingMessages

  • writeToReportRenderingMessages(str: string): void

  • Parameters

    • str: string

    Returns void

Static changeType

  • changeType(value: any, conversionType: Type, convertNulls?: boolean): any

  • Parameters

    • value: any
    • conversionType: Type
    • Default value convertNulls: boolean = true

    Returns any

Static createNewDashboard

  • createNewDashboard(): StiReport

  • Returns StiReport

Static createNewReport

  • createNewReport(): StiReport

  • Returns StiReport

Static getReportVersion

  • getReportVersion(): string

  • Returns string

Static isEncryptedFile

  • isEncryptedFile(bytes: number[] | Uint8Array): boolean

  • Parameters

    • bytes: number[] | Uint8Array

    Returns boolean

Static isPackedFile

  • isPackedFile(content: number[] | Uint8Array): boolean

  • Parameters

    • content: number[] | Uint8Array

    Returns boolean

Generated using TypeDoc