Interface IParagraphOptions

interface IParagraphOptions {
    alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute";
    autoSpaceEastAsianText?: boolean;
    bidirectional?: boolean;
    border?: IBordersOptions;
    bullet?: {
        level: number;
    };
    children?: readonly ParagraphChild[];
    contextualSpacing?: boolean;
    frame?: IXYFrameOptions | IAlignmentFrameOptions;
    heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    overflowPunctuation?: boolean;
    pageBreakBefore?: boolean;
    rightTabStop?: number;
    run?: IRunOptions;
    scale?: number;
    shading?: IShadingAttributesProperties;
    spacing?: ISpacingProperties;
    style?: string;
    suppressLineNumbers?: boolean;
    tabStops?: readonly TabStopDefinition[];
    text?: string;
    thematicBreak?: boolean;
    widowControl?: boolean;
    wordWrap?: boolean;
}

Hierarchy (view full)

Properties

alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"
autoSpaceEastAsianText?: boolean

This element specifies whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. This only works in Microsoft Word. It is not part of the ECMA-376 OOXML standard.

bidirectional?: boolean
bullet?: {
    level: number;
}

Type declaration

  • Readonly level: number
children?: readonly ParagraphChild[]
contextualSpacing?: boolean
heading?: "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Title"
keepLines?: boolean

Specifies that all lines of the paragraph are to be kept on a single page when possible.

keepNext?: boolean

Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. If multiple paragraphs are to be kept together but they exceed a page, then the set of paragraphs begin on a new page and page breaks are used thereafter as needed.

leftTabStop?: number
numbering?: {
    custom?: boolean;
    instance?: number;
    level: number;
    reference: string;
}

Type declaration

  • Optional Readonly custom?: boolean
  • Optional Readonly instance?: number
  • Readonly level: number
  • Readonly reference: string
outlineLevel?: number
overflowPunctuation?: boolean
pageBreakBefore?: boolean
rightTabStop?: number

Reference: ECMA-376, 3rd Edition (June, 2011), Fundamentals and Markup Language Reference § 17.3.1.29.

scale?: number
style?: string
suppressLineNumbers?: boolean
tabStops?: readonly TabStopDefinition[]
text?: string
thematicBreak?: boolean
widowControl?: boolean
wordWrap?: boolean

Generated using TypeDoc