StiThreads Class
Namespace: Stimulsoft.Report.Engine
Constructors
| Constructor | Description |
|---|---|
| constructor(StiEngine engine) |
constructor(engine: StiEngine)
Parameters
- engine (StiEngine)
Methods
| Method | Returns | Description |
|---|---|---|
| createContainerEngine | StiEngine | |
| createContainerEngineAsync | Promise<StiEngine> | Creates a new engine sample to output in the specified container. |
| getDestinationContainer | StiContainer | |
| getTemplateContainer | StiContainer | |
| newPage | void | |
| newPageAsync | void | Prepares a new page to output a container. A new page is not always a page |
| selectThreadFromContainer | void | |
| selectThreadFromContainerAsync | void | Sets the stream to output the specified component. If the stream does not exist then it is created. |
Method Details
createContainerEngine
createContainerEngine(destinationName: string, report: StiReport, masterEngine: StiEngine, indexOfStartRenderedPages: number): StiEngine
Parameters
- destinationName (string)
- report (StiReport)
- masterEngine (StiEngine)
- indexOfStartRenderedPages (number)
Returns StiEngine
createContainerEngineAsync
createContainerEngineAsync(destinationName: string, report: StiReport, masterEngine: StiEngine, indexOfStartRenderedPages: number): Promise<StiEngine>
Creates a new engine sample to output in the specified container.
Parameters
- destinationName (string)
- report (StiReport)
- masterEngine (StiEngine)
- indexOfStartRenderedPages (number)
Returns Promise<StiEngine>
getDestinationContainer
getDestinationContainer(): StiContainer
Returns StiContainer
getTemplateContainer
getTemplateContainer(template: StiContainer, name: string): StiContainer
Parameters
- template (StiContainer)
- name (string)
Returns StiContainer
newPage
newPage(): void
newPageAsync
newPageAsync(): void
Prepares a new page to output a container. A new page is not always a page
selectThreadFromContainer
selectThreadFromContainer(container: StiContainer): void
Parameters
- container (StiContainer)
selectThreadFromContainerAsync
selectThreadFromContainerAsync(container: StiContainer): void
Sets the stream to output the specified component. If the stream does not exist then it is created.
Parameters
- container (StiContainer)
Fields
| Field | Type | Description |
|---|---|---|
| containerEngine | any | |
| containerEngine | any | |
| currentColumn | any | |
| currentPage | any | |
| destinationName | string | |
| engine | StiEngine | |
| isActive | any | |
| name | any | |
| name | any | |
| page | any | |
| page | any |