Interface ISymbolRunOptions

interface ISymbolRunOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    break?: number;
    char: string;
    characterSpacing?: number;
    children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[];
    color?: string;
    doubleStrike?: boolean;
    effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?: "none" | "black" | "blue" | "cyan" | "darkBlue" | "darkCyan" | "darkGray" | "darkGreen" | "darkMagenta" | "darkRed" | "darkYellow" | "green" | "lightGray" | "magenta" | "red" | "white" | "yellow";
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    symbolfont?: string;
    text?: string;
    underline?: {
        color?: string;
        type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy (view full)

Properties

allCaps? bold? boldComplexScript? border? break? char characterSpacing? children? color? doubleStrike? effect? emboss? emphasisMark? font? highlight? highlightComplexScript? imprint? italics? italicsComplexScript? kern? language? math? noProof? position? revision? rightToLeft? scale? shading? size? sizeComplexScript? smallCaps? snapToGrid? specVanish? strike? style? subScript? superScript? symbolfont? text? underline? vanish?

Properties

Optional Readonly allCaps

allCaps?: boolean

Optional Readonly bold

bold?: boolean

Optional Readonly boldComplexScript

boldComplexScript?: boolean

Optional Readonly border

border?: IBorderOptions

Optional Readonly break

break?: number

Readonly char

char: string

Optional Readonly characterSpacing

characterSpacing?: number

Optional Readonly children

children?: readonly (string | FootnoteReferenceRun | FieldInstruction | Break | Begin | Separate | End | NoBreakHyphen | SoftHyphen | DayShort | MonthShort | YearShort | DayLong | MonthLong | YearLong | AnnotationReference | FootnoteReferenceElement | EndnoteReference | Separator | ContinuationSeparator | PageNumberElement | CarriageReturn | Tab | LastRenderedPageBreak | PositionalTab)[]

Optional Readonly color

color?: string

Optional Readonly doubleStrike

doubleStrike?: boolean

Optional Readonly effect

effect?: "none" | "blinkBackground" | "lights" | "antsBlack" | "antsRed" | "shimmer" | "sparkle"

Optional Readonly emboss

emboss?: boolean

Optional Readonly emphasisMark

emphasisMark?: {
    type?: "dot";
}

Type declaration

  • Optional Readonly type?: "dot"

Optional Readonly font

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonly highlight

highlight?: "none" | "black" | "blue" | "cyan" | "darkBlue" | "darkCyan" | "darkGray" | "darkGreen" | "darkMagenta" | "darkRed" | "darkYellow" | "green" | "lightGray" | "magenta" | "red" | "white" | "yellow"

Optional Readonly highlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonly imprint

imprint?: boolean

Optional Readonly italics

italics?: boolean

Optional Readonly italicsComplexScript

italicsComplexScript?: boolean

Optional Readonly kern

kern?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly language

language?: ILanguageOptions

Optional Readonly math

math?: boolean

Optional Readonly noProof

noProof?: boolean

Optional Readonly position

position?: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`

Optional Readonly revision

revision?: IRunPropertiesChangeOptions

Optional Readonly rightToLeft

rightToLeft?: boolean

Optional Readonly scale

scale?: number

Optional Readonly shading

shading?: IShadingAttributesProperties

Optional Readonly size

size?: number | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly sizeComplexScript

sizeComplexScript?: number | boolean | `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`

Optional Readonly smallCaps

smallCaps?: boolean

Optional Readonly snapToGrid

snapToGrid?: boolean

Optional Readonly specVanish

specVanish?: boolean

Optional Readonly strike

strike?: boolean

Optional Readonly style

style?: string

Optional Readonly subScript

subScript?: boolean

Optional Readonly superScript

superScript?: boolean

Optional Readonly symbolfont

symbolfont?: string

Optional Readonly text

text?: string

Optional Readonly underline

underline?: {
    color?: string;
    type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble";
}

Type declaration

  • Optional Readonly color?: string
  • Optional Readonly type?: "single" | "dotDash" | "dotDotDash" | "dotted" | "double" | "none" | "thick" | "wave" | "words" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dashDotHeavy" | "dashDotDotHeavy" | "wavyHeavy" | "wavyDouble"

Optional Readonly vanish

vanish?: boolean

Settings

Member Visibility

Theme

On This Page

allCapsboldboldComplexScriptborderbreakcharcharacterSpacingchildrencolordoubleStrikeeffectembossemphasisMarkfonthighlighthighlightComplexScriptimprintitalicsitalicsComplexScriptkernlanguagemathnoProofpositionrevisionrightToLeftscaleshadingsizesizeComplexScriptsmallCapssnapToGridspecVanishstrikestylesubScriptsuperScriptsymbolfonttextunderlinevanish

Generated using TypeDoc