Class StiAdvancedWatermark

Hierarchy

  • StiAdvancedWatermark

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new StiAdvancedWatermark(textEnabled?: boolean, text?: string, textColor?: Color, textAngle?: number, textFont?: Font, imageEnabled?: boolean, imageBytes?: number[], imageMultipleFactor?: number, imageTransparency?: number, imageAlignment?: ContentAlignment, imageTiling?: boolean, imageStretch?: boolean, imageAspectRatio?: boolean, weaveEnabled?: boolean, weaveMajorIcon?: StiFontIcons, weaveMajorSize?: number, weaveMajorColor?: Color, weaveMinorIcon?: StiFontIcons, weaveMinorSize?: number, weaveMinorColor?: Color, weaveAngle?: number, weaveDistance?: number): StiAdvancedWatermark

  • Parameters

    • Optional textEnabled: boolean
    • Optional text: string
    • Optional textColor: Color
    • Optional textAngle: number
    • Optional textFont: Font
    • Optional imageEnabled: boolean
    • Optional imageBytes: number[]
    • Optional imageMultipleFactor: number
    • Optional imageTransparency: number
    • Optional imageAlignment: ContentAlignment
    • Optional imageTiling: boolean
    • Optional imageStretch: boolean
    • Optional imageAspectRatio: boolean
    • Optional weaveEnabled: boolean
    • Optional weaveMajorIcon: StiFontIcons
    • Optional weaveMajorSize: number
    • Optional weaveMajorColor: Color
    • Optional weaveMinorIcon: StiFontIcons
    • Optional weaveMinorSize: number
    • Optional weaveMinorColor: Color
    • Optional weaveAngle: number
    • Optional weaveDistance: number

    Returns StiAdvancedWatermark

Properties

imageAlignment

imageAlignment: ContentAlignment = ContentAlignment.MiddleCenter

Gets or sets an alignment of the watermark's image.

imageAspectRatio

imageAspectRatio: boolean = false

Gets or sets value which indicates that this watermark's image will save its aspect ratio.

imageEnabled

imageEnabled: boolean = false

Gets or sets a value which indicates that watermark's image is visible or not.

imageMultipleFactor

imageMultipleFactor: number = 1

Gets or sets a value to multiply by it an watermark's image size.

imageStretch

imageStretch: boolean = false

Gets or sets a value which indicates that this watermark's image will be stretched on the page.

imageTiling

imageTiling: boolean = false

Gets or sets a value which indicates that watermark's image should be tiled.

text

text: string = "Text"

Gets or sets text of the watermark.

textAngle

textAngle: number = 45

Gets or sets an angle of the watermark text.

textColor

textColor: Color = StiAdvancedWatermark.defaultTextColor

Gets or sets a color of the watermark text.

textEnabled

textEnabled: boolean = false

Gets or sets a value which indicates that watermark's text is visible or not.

textFont

textFont: Font = new Font("Arial", 36)

Gets or sets a font of the watermark text.

weaveEnabled

weaveEnabled: boolean = false

Gets or sets a value which indicates that watermark's weave is visible or not.

weaveMajorColor

weaveMajorColor: Color = StiAdvancedWatermark.defaultWeaveMajorColor

weaveMajorIcon

weaveMajorIcon: StiFontIcons = StiFontIcons.Star

weaveMinorColor

weaveMinorColor: Color = StiAdvancedWatermark.defaultWeaveMinorColor

weaveMinorIcon

weaveMinorIcon: StiFontIcons = null

Accessors

image

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

  • Gets or sets value a watermark's image.

    Returns Image

  • Gets or sets value a watermark's image.

    Parameters

    Returns void

imageBytes

  • get imageBytes(): number[]
  • set imageBytes(value: number[]): void

  • Returns number[]

  • Parameters

    • value: number[]

    Returns void

imageTransparency

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

  • Returns number

  • Parameters

    • value: number

    Returns void

isVisible

  • get isVisible(): boolean

  • Returns boolean

weaveAngle

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

  • Returns number

  • Parameters

    • value: number

    Returns void

weaveDistance

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

  • Returns number

  • Parameters

    • value: number

    Returns void

weaveMajorSize

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

  • Returns number

  • Parameters

    • value: number

    Returns void

weaveMinorSize

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

  • Returns number

  • Parameters

    • value: number

    Returns void

Methods

clone

  • clone(): any

  • Creates a new object that is a copy of the current instance.

    Returns any

    A new object that is a copy of this instance.

isDefault

  • isDefault(): boolean

loadFromJsonObject

  • loadFromJsonObject(jObject: StiJson): void

loadFromXml

  • loadFromXml(xmlNode: XmlNode): void

  • Parameters

    Returns void

putImage

  • putImage(image: Image): void

  • Parameters

    Returns void

putImage2

  • putImage2(image: number[]): void

  • Parameters

    • image: number[]

    Returns void

resetImage

  • resetImage(): void

  • Returns void

saveToJsonObject

Generated using TypeDoc