Class StiStyle

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new StiStyle(name?: string, description?: string, report?: StiReport): StiStyle

  • Parameters

    • Default value name: string = ""
    • Default value description: string = ""
    • Default value report: StiReport = null

    Returns StiStyle

Properties

allowUseNegativeTextBrush

allowUseNegativeTextBrush: boolean = false

allowUseTextFormat

allowUseTextFormat: boolean = false

negativeTextBrush

negativeTextBrush: StiBrush = new StiSolidBrush(Color.red)

Gets or sets a brush to draw the negative values.

report

report: StiReport = null

textFormat

textFormat: StiFormatService = new Stimulsoft.Report.Components.TextFormats.StiGeneralFormatService()

Gets or sets the format of the component.

Accessors

allowUseBorder

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

  • Gets or sets a value which indicates whether a report engine can use Border formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use Border formatting or not.

    Parameters

    • value: boolean

    Returns void

allowUseBorderFormatting

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

  • Gets or sets a value which indicates whether a report engine can use Border formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use Border formatting or not.

    Parameters

    • value: boolean

    Returns void

allowUseBorderSides

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

  • Gets or sets a value which indicates whether a report engine can use Border Sides or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use Border Sides or not.

    Parameters

    • value: boolean

    Returns void

allowUseBorderSidesFromLocation

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

  • Gets or sets a value which indicates whether a report engine can set border sides of a component depending on the component location.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can set border sides of a component depending on the component location.

    Parameters

    • value: boolean

    Returns void

allowUseBrush

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

  • Gets or sets a value which indicates whether a report engine can use Brush formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use Brush formatting or not.

    Parameters

    • value: boolean

    Returns void

allowUseFont

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

  • Gets or sets a value which indicates whether a report engine can use Font formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use Font formatting or not.

    Parameters

    • value: boolean

    Returns void

allowUseHorAlignment

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

  • Gets or sets a value which indicates whether a report engine can use HorAlignment formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use HorAlignment formatting or not.

    Parameters

    • value: boolean

    Returns void

allowUseImage

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

  • Gets or sets a value which indicates whether a report engine can use Image formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use Image formatting or not.

    Parameters

    • value: boolean

    Returns void

allowUseTextBrush

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

  • Gets or sets a value which indicates whether a report engine can use TextBrush formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use TextBrush formatting or not.

    Parameters

    • value: boolean

    Returns void

allowUseTextOptions

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

  • Gets or sets a value which indicates whether a report engine can use TextOptions formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use TextOptions formatting or not.

    Parameters

    • value: boolean

    Returns void

allowUseVertAlignment

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

  • Gets or sets a value which indicates whether a report engine can use VertAlignment formatting or not.

    Returns boolean

  • Gets or sets a value which indicates whether a report engine can use VertAlignment formatting or not.

    Parameters

    • value: boolean

    Returns void

border

  • Gets or sets a border of the component.

    Returns StiBorder

  • Gets or sets a border of the component.

    Parameters

    Returns void

brush

  • Gets or sets a brush to fill the style.

    Returns StiBrush

  • Gets or sets a brush to fill the style.

    Parameters

    Returns void

collectionName

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

conditions

dashboardName

  • get dashboardName(): string

description

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

font

  • get font(): Font
  • set font(value: Font): void

  • Gets or sets a font for drawing this style.

    Returns Font

  • Gets or sets a font for drawing this style.

    Parameters

    Returns void

horAlignment

image

  • get image(): Image
  • set image(value: Image): void

  • Gets or sets an image to fill the Image property of the Image component.

    Returns Image

  • Gets or sets an image to fill the Image property of the Image component.

    Parameters

    Returns void

lineSpacing

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

  • Gets or sets line spacing of a text.

    Returns number

  • Gets or sets line spacing of a text.

    Parameters

    • value: number

    Returns void

name

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

  • Gets or sets a style name.

    Returns string

  • Gets or sets a style name.

    Parameters

    • value: string

    Returns void

properties

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

textBrush

  • Gets or sets a brush to draw the text.

    Returns StiBrush

  • Gets or sets a brush to draw the text.

    Parameters

    Returns void

vertAlignment

  • Gets or sets a vertical alignment of the style.

    Returns StiVertAlignment

  • Gets or sets a vertical alignment of the style.

    Parameters

    Returns void

Methods

as

clone

  • clone(): any

equals

  • equals(obj: any, allowEqualName?: boolean, allowEqualDescription?: boolean): boolean

  • Parameters

    • obj: any
    • Default value allowEqualName: boolean = true
    • Default value allowEqualDescription: boolean = true

    Returns boolean

getStyleFromComponent

getStyleFromComponents

implements

  • implements(): any[]

is

is2

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

Protected isPropertiesInitializedProtected

  • isPropertiesInitializedProtected(): boolean

isPropertyPresent

  • isPropertyPresent(key: any): boolean

loadFromJsonObject

  • loadFromJsonObject(jObject: StiJson): void

loadFromXml

  • loadFromXml(xmlNode: XmlNode): void

memberwiseClone

meta

saveToJsonObject

setStyleToComponent

toString

  • toString(): string

Static getStyle

Generated using TypeDoc