docx
    Preparing search index...

    Type Alias ITextWatermarkOptions

    Options for creating a text watermark.

    TextWatermark

    type ITextWatermarkOptions = {
        bold?: boolean;
        color?: string;
        font?: string;
        fontSize?: number;
        height?: number;
        italics?: boolean;
        layout?: WatermarkLayout;
        opacity?: number;
        rotation?: number;
        text: string;
        width?: number;
    }
    Index
    bold? color? font? fontSize? height? italics? layout? opacity? rotation? text width?
    bold?: boolean

    Whether the text is bold.

    color?: string

    Colour of the text: a named colour such as "silver" or a hex value such as "C0C0C0". Default is silver.

    font?: string

    Font family. Default is Calibri.

    fontSize?: number

    Font size in points. When omitted the text is sized automatically to fill the watermark's width and height, which is what Word does by default.

    height?: number

    Height of the watermark in points. Defaults to a height that keeps the letters in proportion for the width.

    italics?: boolean

    Whether the text is italic.

    layout?: WatermarkLayout

    Whether the text runs diagonally across the page or horizontally. Default is diagonal.

    opacity?: number

    Opacity of the text from 0 (invisible) to 1 (solid). Default is 0.5, Word's "semitransparent" setting.

    rotation?: number

    Clockwise rotation in degrees. Overrides the rotation implied by the layout.

    Readonlytext

    text: string

    The text to display, e.g. "DRAFT".

    width?: number

    Width of the watermark in points. Default is 527.85, which spans a Letter or A4 page diagonally.

    Settings
    Member Visibility

    On This Page
    Properties