Class StiTableOfContents

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

afterPrintEvent

afterPrintEvent: StiEvent = new StiEvent()

alias

alias: string = ""

allowReconnectOnEachRowForDetails

allowReconnectOnEachRowForDetails: boolean = true

beforePrintEvent

beforePrintEvent: StiEvent = new StiEvent()

beginRenderEvent

beginRenderEvent: StiEvent = new StiEvent()

border

border: StiBorder = new StiBorder()

calcInvisible

calcInvisible: boolean = false

clickEvent

clickEvent: StiEvent = new StiEvent()

collapsedValue

collapsedValue: any = null

collapsingIndex

collapsingIndex: number = 0

collapsingTreePath

collapsingTreePath: string = null

columnGaps

columnGaps: number = 0

columnWidth

columnWidth: number = 0

columns

columns: number = 0

componentPlacement

componentPlacement: string = ""

cornerRadius

cornerRadius: StiCornerRadius = null

currentBookmark

currentBookmark: StiBookmark

currentPointer

currentPointer: StiBookmark

dataRelationName

dataRelationName: string = ""

defaultClientRectangle

defaultClientRectangle: Rectangle = new RectangleD(0, 0, 300, 100)

Gets or sets the default client area of a component.

doubleClickEvent

doubleClickEvent: StiEvent = new StiEvent()

endRenderEvent

endRenderEvent: StiEvent = new StiEvent()

expressions

expressions: StiAppExpressionCollection = new StiAppExpressionCollection()

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.

filterEngine

filterEngine: StiFilterEngine = StiFilterEngine.ReportEngine

filterMethodHandler

filterMethodHandler: Function

filterMode

filterMode: StiFilterMode = StiFilterMode.And

filterOn

filterOn: boolean = true

filters

filters: StiFiltersCollection = new StiFiltersCollection()

gapAfterLastColumn

gapAfterLastColumn: boolean = true

getBookmarkEvent

getBookmarkEvent: StiEvent = new StiEvent()

getCollapsedEvent

getCollapsedEvent: StiEvent = new StiEvent()

getDrillDownReportEvent

getDrillDownReportEvent: StiEvent = new StiEvent()

getHyperlinkEvent

getHyperlinkEvent: StiEvent = new StiEvent()

getPointerEvent

getPointerEvent: StiEvent = new StiEvent()

getTagEvent

getTagEvent: StiEvent = new StiEvent()

getToolTipEvent

getToolTipEvent: StiEvent = new StiEvent()

guid

guid: string = null

indent

indent: number = 15

Gets or sets indent from the left side of band for offset of data levels.

infographicsDisplayRectangle

infographicsDisplayRectangle: RectangleD = new RectangleD(0, 0, 0, 0)

isBofValue

isBofValue: boolean = false

isEofValue

isEofValue: boolean = false

isRendered

isRendered: boolean = false

jsonMasterComponentTemp

jsonMasterComponentTemp: string

keepDetails

keepDetails: StiKeepDetails = StiKeepDetails.None

limitRows

limitRows: string = ""

line

line: number = 1

lineThrough

lineThrough: number = 1

margins

margins: StiMargins = new StiMargins(10)

Gets or sets table margins.

masterComponent

masterComponent: StiComponent = null

minRowsInColumn

minRowsInColumn: number = 0

mouseEnterEvent

mouseEnterEvent: StiEvent = new StiEvent()

mouseLeaveEvent

mouseLeaveEvent: StiEvent = new StiEvent()

multipleInitialization

multipleInitialization: boolean = false

newColumnAfter

newColumnAfter: boolean = false

newColumnBefore

newColumnBefore: boolean = false

newPageAfter

newPageAfter: boolean = false

newPageBefore

newPageBefore: boolean = false

onBeginRender

onBeginRender: Function = null

onClick

onClick: Function

onDoubleClick

onDoubleClick: Function

onEndRender

onEndRender: Function = null

onGetCollapsed

onGetCollapsed: Function = null

onMouseEnter

onMouseEnter: Function

onMouseLeave

onMouseLeave: Function

onRendering

onRendering: Function = null

parentBookmark

parentBookmark: StiBookmark

parentComponentIsBand

parentComponentIsBand: boolean = false

parentComponentIsCrossBand

parentComponentIsCrossBand: boolean = false

parentPointer

parentPointer: StiBookmark

pointerValue

pointerValue: any = null

positionValue

positionValue: number

printIfDetailEmpty

printIfDetailEmpty: boolean = false

printOn

printOn: StiPrintOnType = StiPrintOnType.AllPages

rectangleMoveComponent

rectangleMoveComponent: RectangleD = null

renderingEvent

renderingEvent: StiEvent = new StiEvent()

reportPointer

reportPointer: string = ""

Internal use only.

resetDataSource

resetDataSource: boolean = false

selectedLine

selectedLine: number = 1

skipFirst

skipFirst: boolean = true

styles

styles: StiStylesCollection = new Stimulsoft.Report.Styles.StiStylesCollection()

Gets true if this component is first in the report.

wordWrap

wordWrap: boolean = false

Static Protected propertyBlocked

propertyBlocked: string = Math.random().toString().substr(2)

Static Protected propertyCanBreak

propertyCanBreak: string = Math.random().toString().substr(2)

Static Protected propertyComponentStyle

propertyComponentStyle: string = Math.random().toString().substr(2)

Static Protected propertyDockable

propertyDockable: string = Math.random().toString().substr(2)

Static propertyEvenStyle

propertyEvenStyle: string = Math.random().toString().substr(2)

Static Protected propertyLinked

propertyLinked: string = Math.random().toString().substr(2)

Static Protected propertyLocked

propertyLocked: string = Math.random().toString().substr(2)

Static propertyOddStyle

propertyOddStyle: string = Math.random().toString().substr(2)

Static Protected propertyPlaceOnToolbox

propertyPlaceOnToolbox: string = Math.random().toString().substr(2)

Static Protected propertyRestrictions

propertyRestrictions: string = Math.random().toString().substr(2)

Accessors

anchor

bandInfo

blocked

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

bookmark

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

bookmarkValue

  • get bookmarkValue(): any
  • set bookmarkValue(value: any): void

bottom

  • get bottom(): number

breakIfLessThan

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

brush

businessObject

businessObjectGuid

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

canBreak

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

canGrow

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

canShrink

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

clientRectangle

collapsed

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

columnDirection

componentStyle

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

componentType

components

conditions

containerInfo

count

  • get count(): number

countData

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

dataBandInfo

dataRelation

dataSource

dataSourceName

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

displayRectangle

dockStyle

dockable

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

drillDownParameters

  • get drillDownParameters(): any[]
  • set drillDownParameters(value: any[]): void

enabled

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

evenStyle

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

filter

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

footerSize

  • get footerSize(): number

growToHeight

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

hasSelected

  • get hasSelected(): boolean

headerEndColor

  • get headerEndColor(): Color

headerSize

  • get headerSize(): number

headerStartColor

  • get headerStartColor(): Color

height

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

highlightState

hyperlink

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

hyperlinkValue

  • get hyperlinkValue(): any
  • set hyperlinkValue(value: any): void

ignoreNamingRule

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

inherited

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

interaction

isAutomaticDock

  • get isAutomaticDock(): boolean

isBof

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

isBusinessObjectEmpty

  • get isBusinessObjectEmpty(): boolean

isCross

  • get isCross(): boolean

isDataSourceEmpty

  • get isDataSourceEmpty(): boolean

isDesigning

  • get isDesigning(): boolean

isEmpty

  • get isEmpty(): boolean

isEnabled

  • get isEnabled(): boolean

isEof

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

isExporting

  • get isExporting(): boolean

isFirstInReport

  • get isFirstInReport(): boolean

  • Gets true if this component is first in the report.

    Returns boolean

isPrinting

  • get isPrinting(): boolean

isSelected

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

keepDetailsTogether

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

left

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

linked

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

localizedCategory

  • get localizedCategory(): string

localizedName

  • get localizedName(): string

locked

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

maxHeight

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

maxSize

  • get maxSize(): SizeD
  • set maxSize(value: SizeD): void

minHeight

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

minSize

  • get minSize(): SizeD
  • set minSize(value: SizeD): void

name

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

  • Gets or sets a component name.

    Returns string

  • Gets or sets a component name.

    Parameters

    • value: string

    Returns void

nestedLevel

  • get nestedLevel(): number

oddStyle

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

page

parent

placeOnToolbox

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

pointer

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

position

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

printAtBottom

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

printOnAllPages

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

printable

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

priority

  • get priority(): number

properties

renderedCount

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

report

  • get report(): StiReport
  • set report(value: StiReport): void

resetPageNumber

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

restrictions

right

  • get right(): number

rightToLeft

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

selectRectangle

serviceCategory

  • get serviceCategory(): string

serviceEnabled

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

  • Gets or sets the value whether a service is enabled or not.

    Returns boolean

  • Gets or sets the value whether a service is enabled or not.

    Parameters

    • value: boolean

    Returns void

serviceInfo

  • get serviceInfo(): string

serviceName

  • get serviceName(): string

serviceType

  • get serviceType(): Type

shift

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

shiftMode

sort

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

states

tag

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

tagValue

  • get tagValue(): any
  • set tagValue(value: any): void

toolTip

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

toolTipValue

  • get toolTipValue(): any
  • set toolTipValue(value: any): void

toolboxCategory

toolboxPosition

  • get toolboxPosition(): number

top

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

useParentStyles

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

width

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

Methods

alignTo

allowDelete

  • allowDelete(): boolean

allowPrintOn

  • allowPrintOn(): boolean

applyConditions

as

break

  • break(dividedComponent: StiComponent, devideFactor: number, divLine: number): boolean

bringToFront

  • bringToFront(): void

canContainIn

changePosition

checkForParentComponent

checkLargeHeight

  • checkLargeHeight(needFullCalculation?: boolean): void

clearAllStates

  • clearAllStates(): void

clearContents

  • clearContents(): void

clone

  • clone(cloneProperties: boolean): StiBand

componentToPage

Protected construct

containerToPage

convert

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

correct

  • correct(onlySelect?: boolean): void

  • Parameters

    • Default value onlySelect: boolean = false

    Returns void

correct2

  • correct2(onlySelect: boolean): void

doBookmark

  • doBookmark(): boolean

doPointer

  • doPointer(createNewGuid?: boolean): void

dockToContainer

  • dockToContainer(): void

dockToContainer2

first

  • first(): void

firstAsync

  • firstAsync(): Promise<void>

getActualSize

  • getActualSize(isFirstPass?: boolean, REFneedSecondPass?: any): SizeD

getApp

getBottom

  • getBottom(): number

getCanGrow

  • getCanGrow(): boolean

getCanShrink

  • getCanShrink(): boolean

getColumnWidth

  • getColumnWidth(): number

getComponentStyle

  • getComponentStyle(): string

getComponentStyle2

Protected getComponentType

getComponents

getComponents2

  • getComponents2(REFcomps: any): void

getComponentsList

getConditions

getContainer

getContainerInRect

getContainerInRect2

getDataBand

getDisplayRectangle

getDisplayRectangle2

getDockRegion

getDockStyle

getFonts

  • getFonts(): Font[]

getGroupHeaderBand

getGrowToHeight

  • getGrowToHeight(): boolean

getHeaderText

  • getHeaderText(): string

getHeight

  • getHeight(): number

getIncorrect

getIsEnabled

  • getIsEnabled(): Promise<boolean>

getKey

  • getKey(): string

getLeft

  • getLeft(): number

getLinked

  • getLinked(): boolean

getMaxHeight

  • getMaxHeight(): number

getMaxSize

getMinHeight

  • getMinHeight(): number

getMinSize

getName

  • getName(): string

getPaintRectangle

  • getPaintRectangle(convertToHInches?: boolean, convertByZoom?: boolean, docking?: boolean): RectangleD

  • Parameters

    • Default value convertToHInches: boolean = true
    • Default value convertByZoom: boolean = true
    • Default value docking: boolean = true

    Returns RectangleD

getReport

getRestrictions

getRightToLeft

  • getRightToLeft(): boolean

getSelectedComponents

getSelectedComponents2

  • getSelectedComponents2(REFcomps: any): void

getSelectedRectangle

getShift

  • getShift(): boolean

getStates

getStylesList

getTop

  • getTop(): number

getUseParentStyles

  • getUseParentStyles(): boolean

getWidth

  • getWidth(): number

helpUrl

  • helpUrl(): string

  • Returns string

implements

  • implements(): any[]

internalRender

internalRenderAsync

invert

  • invert(): void

invokeAfterPrint

  • invokeAfterPrint(sender: any, e: EventArgs): void

invokeBeforePrint

invokeBeginRender

  • invokeBeginRender(): void

invokeClick

  • invokeClick(sender: any, e: EventArgs): void

invokeDoubleClick

  • invokeDoubleClick(sender: any, e: EventArgs): void

invokeEndRender

  • invokeEndRender(): void

invokeEvents

  • invokeEvents(): void

invokeGetBookmark

  • invokeGetBookmark(sender: any, e: EventArgs): void

invokeGetCollapsed

invokeGetDrillDownReport

invokeGetHyperlink

invokeGetPointer

invokeGetTag

invokeGetToolTip

invokeGroupRendering

  • invokeGroupRendering(): void

invokeMouseEnter

  • invokeMouseEnter(sender: any, e: EventArgs): void

invokeMouseLeave

  • invokeMouseLeave(sender: any, e: EventArgs): void

invokePainted

invokePainting

invokeRendering

  • invokeRendering(): void

is

is2

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

isExportAsImage

Protected isPropertiesInitializedProtected

  • isPropertiesInitializedProtected(): boolean

isPropertyPresent

  • isPropertyPresent(key: any): boolean

last

  • last(): void

loadFromJsonObject

  • loadFromJsonObject(jObject: StiJson): void

loadFromXml

  • loadFromXml(xmlNode: XmlNode): void

Protected loadRectangleDFromXml

makeHorizontalSpacingEqual

  • makeHorizontalSpacingEqual(): void

makeSameHeight

  • makeSameHeight(height: number): void

makeSameSize

  • makeSameSize(size: SizeD): void

makeSameWidth

  • makeSameWidth(width: number): void

makeVerticalSpacingEqual

  • makeVerticalSpacingEqual(): void

memberwiseClone

meta

moveBackward

  • moveBackward(): void

moveComponentsToPage

  • moveComponentsToPage(): void

moveForward

  • moveForward(): void

newGuid

  • newGuid(): void

next

  • next(): void

nextAsync

  • nextAsync(): Promise<void>

normalize

  • normalize(): void

offsetLocation

  • offsetLocation(offsetX: number, offsetY: number): void

Protected onAfterPrint

Protected onBeforePrint

onGetBookmark

  • onGetBookmark(): void

Protected onGetDrillDownReport

Protected onGetHyperlink

Protected onGetPointer

Protected onGetTag

Protected onGetToolTip

  • onGetToolTip(): void

Protected onPainted

Protected onPainting

onResizeComponent

  • onResizeComponent(oldSize: SizeD, newSize: SizeD): void

pageToComponent

pageToContainer

paint

parseContainerFromXml

  • parseContainerFromXml(xmlNode: XmlNode): void

prepare

  • prepare(): void

prior

  • prior(): void

render

renderAsync

renderMaster

  • renderMaster(): void

renderMasterAsync

  • renderMasterAsync(): Promise<void>

reset

  • reset(): void

resetSelection

  • resetSelection(): void

restoreState

  • restoreState(stateName: string): void

saveState

  • saveState(stateName: string): void

saveToJsonObject

select

  • select(): void

selectAll

  • selectAll(): void

sendToBack

  • sendToBack(): void

setCanGrow

  • setCanGrow(value: boolean): void

setCenterHorizontally

  • setCenterHorizontally(): void

setCenterVertically

  • setCenterVertically(): void

Protected setClientRectangle

setComponentStyle

  • setComponentStyle(value: string): void

setConditions

setDirectDisplayRectangle

  • setDirectDisplayRectangle(rect: RectangleD): void

setDisplayRectangle

setDockStyle

setHeight

  • setHeight(value: number): void

setKey

  • setKey(key: string): void

setLeft

  • setLeft(value: number): void

setLinked

  • setLinked(value: boolean): void

setMaxHeight

  • setMaxHeight(value: number): void

setMaxSize

  • setMaxSize(value: SizeD): void

setMinHeight

  • setMinHeight(value: number): void

setMinSize

  • setMinSize(value: SizeD): void

setName

  • setName(value: string): void

setPaintRectangle

setParentStylesToChilds

setReportVariables

  • setReportVariables(): void

setRestrictions

setRightToLeft

  • setRightToLeft(value: boolean): void

setTop

  • setTop(value: number): void

setUseParentStyles

  • setUseParentStyles(value: boolean): void

setWidth

  • setWidth(value: number): void

sortByPriority

  • sortByPriority(): void

toString

  • toString(): string

unPrepare

  • unPrepare(): void

Static doOffsetRect

Static isParentSelect

Static loadXmlSort

  • loadXmlSort(xmlNode: XmlNode): string[]

Generated using TypeDoc