docx
    Preparing search index...

    Type Alias IRunStylePropertiesOptions

    Run style properties options.

    These properties define the formatting that can be applied to a run of text, including font, size, bold, italic, underline, color, and other character formatting.

    Reference: http://officeopenxml.com/WPtextFormatting.php

    type IRunStylePropertiesOptions = {
        allCaps?: boolean;
        bold?: boolean;
        boldComplexScript?: boolean;
        border?: IBorderOptions;
        characterSpacing?: number;
        color?: string | ThemeColor;
        doubleStrike?: boolean;
        eastAsianLayout?: IEastAsianLayoutOptions;
        effect?: typeof TextEffect[keyof typeof TextEffect];
        emboss?: boolean;
        emphasisMark?: {
            type?: typeof EmphasisMarkType[keyof typeof EmphasisMarkType];
        };
        fitText?: IFitTextOptions;
        font?: | string
        | IFontOptions
        | IFontAttributesProperties
        | IThemeFontReference;
        highlight?: typeof HighlightColor[keyof typeof HighlightColor];
        highlightComplexScript?: boolean
        | string;
        imprint?: boolean;
        italics?: boolean;
        italicsComplexScript?: boolean;
        kern?: number | PositiveUniversalMeasure;
        language?: ILanguageOptions;
        math?: boolean;
        noProof?: boolean;
        position?: UniversalMeasure;
        revision?: IRunPropertiesChangeOptions;
        rightToLeft?: boolean;
        scale?: number;
        shading?: IShadingAttributesProperties;
        size?: number | PositiveUniversalMeasure;
        sizeComplexScript?: boolean | number | PositiveUniversalMeasure;
        smallCaps?: boolean;
        snapToGrid?: boolean;
        specVanish?: boolean;
        strike?: boolean;
        subScript?: boolean;
        superScript?: boolean;
        underline?: {
            color?: string | ThemeColor;
            type?: typeof UnderlineType[keyof typeof UnderlineType];
        };
        vanish?: boolean;
    }
    Index
    allCaps? bold? boldComplexScript? border? characterSpacing? color? doubleStrike? eastAsianLayout? effect? emboss? emphasisMark? fitText? font? highlight? highlightComplexScript? imprint? italics? italicsComplexScript? kern? language? math? noProof? position? revision? rightToLeft? scale? shading? size? sizeComplexScript? smallCaps? snapToGrid? specVanish? strike? subScript? superScript? underline? vanish?
    allCaps?: boolean
    bold?: boolean
    boldComplexScript?: boolean
    border?: IBorderOptions
    characterSpacing?: number
    color?: string | ThemeColor

    The text's color: a hex color such as "FF0000", "auto", or a color of the document's theme such as { theme: "accent1" }

    doubleStrike?: boolean
    eastAsianLayout?: IEastAsianLayoutOptions

    Word's East Asian typography for the run's text: two lines in one, which sets it in two half-size lines within one line, optionally in brackets, and horizontal in vertical, which sets it across the line in text that runs down the page

    effect?: typeof TextEffect[keyof typeof TextEffect]
    emboss?: boolean
    emphasisMark?: { type?: typeof EmphasisMarkType[keyof typeof EmphasisMarkType] }
    fitText?: IFitTextOptions

    Squeezes or spreads the run's text so that it takes up the width given, as Word's Fit Text does. Runs next to each other with the same group are fitted to it together.

    font?: string | IFontOptions | IFontAttributesProperties | IThemeFontReference

    The font: a font name, a font for each character set, or one of the fonts of the document's theme, such as { theme: "body" }

    highlight?: typeof HighlightColor[keyof typeof HighlightColor]
    highlightComplexScript?: boolean | string

    Has no effect. WordprocessingML has no highlight of its own for complex script text: highlight highlights all the run's text. docx used to write it as w:highlightCs, which is in no schema.

    imprint?: boolean
    italics?: boolean
    italicsComplexScript?: boolean
    kern?: number | PositiveUniversalMeasure
    language?: ILanguageOptions
    math?: boolean
    noProof?: boolean
    position?: UniversalMeasure
    revision?: IRunPropertiesChangeOptions
    rightToLeft?: boolean
    scale?: number
    shading?: IShadingAttributesProperties
    size?: number | PositiveUniversalMeasure
    sizeComplexScript?: boolean | number | PositiveUniversalMeasure
    smallCaps?: boolean
    snapToGrid?: boolean
    specVanish?: boolean

    Keeps a hidden paragraph mark hidden even when hidden text is shown, so its paragraph always runs on into the next one, as Word's style separator does. It is meant for a paragraph's mark, with vanish: new Paragraph({ run: { vanish: true, specVanish: true } }). Without vanish, Word doesn't hide the mark.

    strike?: boolean
    subScript?: boolean
    superScript?: boolean
    underline?: {
        color?: string | ThemeColor;
        type?: typeof UnderlineType[keyof typeof UnderlineType];
    }
    vanish?: boolean

    Hides the text. false shows text that the run's style hides.

    Settings
    Member Visibility

    On This Page
    Properties