Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "DocumentTemplates$Style"
versionInfo: StructureVersionInfo = ...

Accessors

  • get backgroundColor(): IColor
  • set backgroundColor(newValue: IColor): void
  • get bold(): boolean
  • set bold(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get borderColorBottom(): IColor
  • set borderColorBottom(newValue: IColor): void
  • get borderColorLeft(): IColor
  • set borderColorLeft(newValue: IColor): void
  • get borderColorRight(): IColor
  • set borderColorRight(newValue: IColor): void
  • get borderColorTop(): IColor
  • set borderColorTop(newValue: IColor): void
  • get borderWidthBottom(): number
  • set borderWidthBottom(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get borderWidthLeft(): number
  • set borderWidthLeft(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get borderWidthRight(): number
  • set borderWidthRight(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get borderWidthTop(): number
  • set borderWidthTop(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get container(): TContainer
  • Returns TContainer

  • get customStyles(): string
  • set customStyles(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get fontColor(): IColor
  • set fontColor(newValue: IColor): void
  • get fontSize(): number
  • set fontSize(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

  • get italic(): boolean
  • set italic(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get model(): TModel
  • Returns TModel

  • get overrideBackgroundColor(): boolean
  • set overrideBackgroundColor(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get overrideBold(): boolean
  • set overrideBold(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get overrideFontColor(): boolean
  • set overrideFontColor(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get overrideFontFamily(): boolean
  • set overrideFontFamily(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get overrideFontSize(): boolean
  • set overrideFontSize(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get overrideItalic(): boolean
  • set overrideItalic(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

Methods

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns Style

  • delete(): void
  • Deletes this element from the model.

    Returns void

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns Style

  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: Style) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<Style>
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: (elem: Style) => void
        • Parameters

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<Style>

  • toJSON(): IStructureJSON
  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

  • traverse(visit: (structure: IStructure) => void): void
  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void
  • create(model: IModel): Style
  • Creates and returns a new Style instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    • model: IModel

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent DataGridCell element passed as argument.

    Parameters

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent DataGridColumn element passed as argument.

    Parameters

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent DocumentTemplate element passed as argument.

    Parameters

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent DynamicLabel element passed as argument.

    Parameters

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent Grid element passed as argument.

    Parameters

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent StaticLabel element passed as argument.

    Parameters

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent TableCell element passed as argument.

    Parameters

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent Table element passed as argument.

    Parameters

    Returns Style

  • Creates and returns a new Style instance in the SDK and on the server. The new Style will be automatically stored in the 'style' property of the parent Title element passed as argument.

    Parameters

    Returns Style

Generated using TypeDoc