diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index 2db0dea26e..66c4c84127 100644 --- a/api/classes/AbstractNumbering.html +++ b/api/classes/AbstractNumbering.html @@ -1,6 +1,6 @@ -AbstractNumbering | docx

Class AbstractNumbering

Hierarchy (view full)

Constructors

constructor +AbstractNumbering | docx

Class AbstractNumbering

Hierarchy (view full)

Constructors

constructor

Properties

id

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyid

id: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyid

id: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Alignment.html b/api/classes/Alignment.html index 1859f816cf..1574630edd 100644 --- a/api/classes/Alignment.html +++ b/api/classes/Alignment.html @@ -1,5 +1,5 @@ -Alignment | docx

Class Alignment

Hierarchy (view full)

Constructors

constructor +Alignment | docx

Class Alignment

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/AlignmentAttributes.html b/api/classes/AlignmentAttributes.html index ade2125f20..11bf9d16c7 100644 --- a/api/classes/AlignmentAttributes.html +++ b/api/classes/AlignmentAttributes.html @@ -1,3 +1,3 @@ -AlignmentAttributes | docx

Class AlignmentAttributes

Hierarchy (view full)

Constructors

constructor +AlignmentAttributes | docx

Class AlignmentAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new AlignmentAttributes(root): AlignmentAttributes

  • Parameters

    • root: {
          val:
              | "center"
              | "left"
              | "right"
              | "start"
              | "end"
              | "both"
              | "mediumKashida"
              | "distribute"
              | "numTab"
              | "highKashida"
              | "lowKashida"
              | "thaiDistribute";
      }
      • Readonlyval:
            | "center"
            | "left"
            | "right"
            | "start"
            | "end"
            | "both"
            | "mediumKashida"
            | "distribute"
            | "numTab"
            | "highKashida"
            | "lowKashida"
            | "thaiDistribute"

    Returns AlignmentAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new AlignmentAttributes(root): AlignmentAttributes

  • Parameters

    • root: {
          val:
              | "center"
              | "left"
              | "right"
              | "start"
              | "end"
              | "both"
              | "mediumKashida"
              | "distribute"
              | "numTab"
              | "highKashida"
              | "lowKashida"
              | "thaiDistribute";
      }
      • Readonlyval:
            | "center"
            | "left"
            | "right"
            | "start"
            | "end"
            | "both"
            | "mediumKashida"
            | "distribute"
            | "numTab"
            | "highKashida"
            | "lowKashida"
            | "thaiDistribute"

    Returns AlignmentAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/AnnotationReference.html b/api/classes/AnnotationReference.html index 6f334eb7be..8fa53c382a 100644 --- a/api/classes/AnnotationReference.html +++ b/api/classes/AnnotationReference.html @@ -1,5 +1,5 @@ -AnnotationReference | docx

Class AnnotationReference

Hierarchy (view full)

Constructors

constructor +AnnotationReference | docx

Class AnnotationReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Attributes.html b/api/classes/Attributes.html index 3235a92174..dbf26b9241 100644 --- a/api/classes/Attributes.html +++ b/api/classes/Attributes.html @@ -1,3 +1,3 @@ -Attributes | docx

Class Attributes

Hierarchy (view full)

  • XmlAttributeComponent<{
        bottom?: string;
        color?: string;
        fill?: string;
        footer?: string;
        gutter?: string;
        h?: string;
        header?: string;
        left?: string;
        linePitch?: string;
        pos?: string | number;
        right?: string;
        rsidR?: string;
        rsidRPr?: string;
        rsidSect?: string;
        space?: string;
        sz?: string;
        top?: string;
        type?: string;
        val?: string | number | boolean;
        w?: string;
    }>
    • Attributes

Constructors

constructor +Attributes | docx

Class Attributes

Hierarchy (view full)

  • XmlAttributeComponent<{
        bottom?: string;
        color?: string;
        fill?: string;
        footer?: string;
        gutter?: string;
        h?: string;
        header?: string;
        left?: string;
        linePitch?: string;
        pos?: string | number;
        right?: string;
        rsidR?: string;
        rsidRPr?: string;
        rsidSect?: string;
        space?: string;
        sz?: string;
        top?: string;
        type?: string;
        val?: string | number | boolean;
        w?: string;
    }>
    • Attributes

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new Attributes(root): Attributes

  • Parameters

    • root: {
          bottom?: string;
          color?: string;
          fill?: string;
          footer?: string;
          gutter?: string;
          h?: string;
          header?: string;
          left?: string;
          linePitch?: string;
          pos?: string | number;
          right?: string;
          rsidR?: string;
          rsidRPr?: string;
          rsidSect?: string;
          space?: string;
          sz?: string;
          top?: string;
          type?: string;
          val?: string | number | boolean;
          w?: string;
      }
      • Optional Readonlybottom?: string
      • Optional Readonlycolor?: string
      • Optional Readonlyfill?: string
      • Optional Readonlyfooter?: string
      • Optional Readonlygutter?: string
      • Optional Readonlyh?: string
      • Optional Readonlyheader?: string
      • Optional Readonlyleft?: string
      • Optional ReadonlylinePitch?: string
      • Optional Readonlypos?: string | number
      • Optional Readonlyright?: string
      • Optional ReadonlyrsidR?: string
      • Optional ReadonlyrsidRPr?: string
      • Optional ReadonlyrsidSect?: string
      • Optional Readonlyspace?: string
      • Optional Readonlysz?: string
      • Optional Readonlytop?: string
      • Optional Readonlytype?: string
      • Optional Readonlyval?: string | number | boolean
      • Optional Readonlyw?: string

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new Attributes(root): Attributes

  • Parameters

    • root: {
          bottom?: string;
          color?: string;
          fill?: string;
          footer?: string;
          gutter?: string;
          h?: string;
          header?: string;
          left?: string;
          linePitch?: string;
          pos?: string | number;
          right?: string;
          rsidR?: string;
          rsidRPr?: string;
          rsidSect?: string;
          space?: string;
          sz?: string;
          top?: string;
          type?: string;
          val?: string | number | boolean;
          w?: string;
      }
      • Optional Readonlybottom?: string
      • Optional Readonlycolor?: string
      • Optional Readonlyfill?: string
      • Optional Readonlyfooter?: string
      • Optional Readonlygutter?: string
      • Optional Readonlyh?: string
      • Optional Readonlyheader?: string
      • Optional Readonlyleft?: string
      • Optional ReadonlylinePitch?: string
      • Optional Readonlypos?: string | number
      • Optional Readonlyright?: string
      • Optional ReadonlyrsidR?: string
      • Optional ReadonlyrsidRPr?: string
      • Optional ReadonlyrsidSect?: string
      • Optional Readonlyspace?: string
      • Optional Readonlysz?: string
      • Optional Readonlytop?: string
      • Optional Readonlytype?: string
      • Optional Readonlyval?: string | number | boolean
      • Optional Readonlyw?: string

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BaseEmphasisMark.html b/api/classes/BaseEmphasisMark.html index 19b0fbf706..fca0636c83 100644 --- a/api/classes/BaseEmphasisMark.html +++ b/api/classes/BaseEmphasisMark.html @@ -1,4 +1,4 @@ -BaseEmphasisMark | docx

Class BaseEmphasisMarkAbstract

Hierarchy (view full)

Methods

addChildElement +BaseEmphasisMark | docx

Class BaseEmphasisMarkAbstract

Hierarchy (view full)

Methods

addChildElement prepForXml

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Methods
+

prepForXml

Settings

Member Visibility

On This Page

Methods
diff --git a/api/classes/BaseXmlComponent.html b/api/classes/BaseXmlComponent.html index 8ca015080b..57c34252ff 100644 --- a/api/classes/BaseXmlComponent.html +++ b/api/classes/BaseXmlComponent.html @@ -1,3 +1,3 @@ -BaseXmlComponent | docx

Class BaseXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor +BaseXmlComponent | docx

Class BaseXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

AbstractprepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

AbstractprepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Body.html b/api/classes/Body.html index 1de3c59cc5..c144aebe7c 100644 --- a/api/classes/Body.html +++ b/api/classes/Body.html @@ -1,10 +1,10 @@ -Body | docx

Class Body

Hierarchy (view full)

Constructors

constructor +Body | docx

Class Body

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement addSection prepForXml push -

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options): void

  • Adds new section properties. +

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options): void

  • Adds new section properties. Note: Previous section is created in paragraph after the current element, and then new section will be added. The spec says:

      @@ -12,4 +12,4 @@ The spec says:

    • last section should be direct child of body

    Parameters

    Returns void

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns void

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Bookmark.html b/api/classes/Bookmark.html index 92c5c3c019..756305e046 100644 --- a/api/classes/Bookmark.html +++ b/api/classes/Bookmark.html @@ -1,5 +1,5 @@ -Bookmark | docx

Class Bookmark

Constructors

constructor +Bookmark | docx

Class Bookmark

Constructors

constructor

Properties

children end start -

Constructors

constructor

Properties

Readonlychildren

children: readonly ParagraphChild[]

Readonlyend

end: BookmarkEnd

Readonlystart

start: BookmarkStart

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlychildren

children: readonly ParagraphChild[]

Readonlyend

end: BookmarkEnd

Readonlystart

start: BookmarkStart

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/BookmarkEnd.html b/api/classes/BookmarkEnd.html index 06e5a85ab8..e97c7806c1 100644 --- a/api/classes/BookmarkEnd.html +++ b/api/classes/BookmarkEnd.html @@ -1,5 +1,5 @@ -BookmarkEnd | docx

Class BookmarkEnd

Hierarchy (view full)

Constructors

constructor +BookmarkEnd | docx

Class BookmarkEnd

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BookmarkStart.html b/api/classes/BookmarkStart.html index acd1db0307..842f091bf0 100644 --- a/api/classes/BookmarkStart.html +++ b/api/classes/BookmarkStart.html @@ -1,5 +1,5 @@ -BookmarkStart | docx

Class BookmarkStart

Hierarchy (view full)

Constructors

constructor +BookmarkStart | docx

Class BookmarkStart

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Border.html b/api/classes/Border.html index bf5895288a..9e6ab37354 100644 --- a/api/classes/Border.html +++ b/api/classes/Border.html @@ -1,5 +1,5 @@ -Border | docx

Class Border

Hierarchy (view full)

Constructors

constructor +Border | docx

Class Border

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BorderElement.html b/api/classes/BorderElement.html index 478e336f21..f9952a4d5c 100644 --- a/api/classes/BorderElement.html +++ b/api/classes/BorderElement.html @@ -1,5 +1,5 @@ -BorderElement | docx

Class BorderElement

Hierarchy (view full)

Constructors

constructor +BorderElement | docx

Class BorderElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BuilderElement.html b/api/classes/BuilderElement.html index c5b60b3f0f..aa776eb62c 100644 --- a/api/classes/BuilderElement.html +++ b/api/classes/BuilderElement.html @@ -1,5 +1,5 @@ -BuilderElement | docx

Class BuilderElement<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor +BuilderElement | docx

Class BuilderElement<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CarriageReturn.html b/api/classes/CarriageReturn.html index 0db02ff400..642d744e45 100644 --- a/api/classes/CarriageReturn.html +++ b/api/classes/CarriageReturn.html @@ -1,5 +1,5 @@ -CarriageReturn | docx

Class CarriageReturn

Hierarchy (view full)

Constructors

constructor +CarriageReturn | docx

Class CarriageReturn

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CheckBox.html b/api/classes/CheckBox.html index b2f0921ea7..7a6299d088 100644 --- a/api/classes/CheckBox.html +++ b/api/classes/CheckBox.html @@ -1,5 +1,5 @@ -CheckBox | docx

Class CheckBox

Hierarchy (view full)

Constructors

constructor +CheckBox | docx

Class CheckBox

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CheckBoxSymbolElement.html b/api/classes/CheckBoxSymbolElement.html index 9b2e58de48..963fe0644c 100644 --- a/api/classes/CheckBoxSymbolElement.html +++ b/api/classes/CheckBoxSymbolElement.html @@ -1,5 +1,5 @@ -CheckBoxSymbolElement | docx

Class CheckBoxSymbolElement

Hierarchy (view full)

Constructors

constructor +CheckBoxSymbolElement | docx

Class CheckBoxSymbolElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CheckBoxUtil.html b/api/classes/CheckBoxUtil.html index ea59faa43b..96723d4b95 100644 --- a/api/classes/CheckBoxUtil.html +++ b/api/classes/CheckBoxUtil.html @@ -1,5 +1,5 @@ -CheckBoxUtil | docx

Class CheckBoxUtil

Hierarchy (view full)

Constructors

constructor +CheckBoxUtil | docx

Class CheckBoxUtil

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Column.html b/api/classes/Column.html index 3a6d56539e..9899222bc3 100644 --- a/api/classes/Column.html +++ b/api/classes/Column.html @@ -1,5 +1,5 @@ -Column | docx

Class Column

Hierarchy (view full)

Constructors

constructor +Column | docx

Class Column

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ColumnBreak.html b/api/classes/ColumnBreak.html index 62bd4eac95..f4064ad30e 100644 --- a/api/classes/ColumnBreak.html +++ b/api/classes/ColumnBreak.html @@ -1,5 +1,5 @@ -ColumnBreak | docx

Class ColumnBreak

Hierarchy (view full)

Constructors

constructor +ColumnBreak | docx

Class ColumnBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Columns.html b/api/classes/Columns.html index 53a34a0572..d5411a16ee 100644 --- a/api/classes/Columns.html +++ b/api/classes/Columns.html @@ -1,5 +1,5 @@ -Columns | docx

Class Columns

Hierarchy (view full)

Constructors

constructor +Columns | docx

Class Columns

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Comment.html b/api/classes/Comment.html index a61869ca61..dffa8ea6ea 100644 --- a/api/classes/Comment.html +++ b/api/classes/Comment.html @@ -1,5 +1,5 @@ -Comment | docx

Class Comment

Hierarchy (view full)

Constructors

constructor +Comment | docx

Class Comment

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CommentRangeEnd.html b/api/classes/CommentRangeEnd.html index 3b753ca958..2c19dc2e96 100644 --- a/api/classes/CommentRangeEnd.html +++ b/api/classes/CommentRangeEnd.html @@ -1,5 +1,5 @@ -CommentRangeEnd | docx

Class CommentRangeEnd

Hierarchy (view full)

Constructors

constructor +CommentRangeEnd | docx

Class CommentRangeEnd

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CommentRangeStart.html b/api/classes/CommentRangeStart.html index d329c026c8..cfc4cc1dc2 100644 --- a/api/classes/CommentRangeStart.html +++ b/api/classes/CommentRangeStart.html @@ -1,5 +1,5 @@ -CommentRangeStart | docx

Class CommentRangeStart

Hierarchy (view full)

Constructors

constructor +CommentRangeStart | docx

Class CommentRangeStart

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CommentReference.html b/api/classes/CommentReference.html index 875076a061..877c5a3862 100644 --- a/api/classes/CommentReference.html +++ b/api/classes/CommentReference.html @@ -1,5 +1,5 @@ -CommentReference | docx

Class CommentReference

Hierarchy (view full)

Constructors

constructor +CommentReference | docx

Class CommentReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Comments.html b/api/classes/Comments.html index db57653683..fdde3f7c64 100644 --- a/api/classes/Comments.html +++ b/api/classes/Comments.html @@ -1,5 +1,5 @@ -Comments | docx

Class Comments

Hierarchy (view full)

Constructors

constructor +Comments | docx

Class Comments

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ConcreteHyperlink.html b/api/classes/ConcreteHyperlink.html index b89b63a4be..a5bbc59a4f 100644 --- a/api/classes/ConcreteHyperlink.html +++ b/api/classes/ConcreteHyperlink.html @@ -1,6 +1,6 @@ -ConcreteHyperlink | docx

Class ConcreteHyperlink

Hierarchy (view full)

Constructors

constructor +ConcreteHyperlink | docx

Class ConcreteHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

linkId

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ConcreteNumbering.html b/api/classes/ConcreteNumbering.html index 78ff67d4fe..b43c9d36d5 100644 --- a/api/classes/ConcreteNumbering.html +++ b/api/classes/ConcreteNumbering.html @@ -1,8 +1,8 @@ -ConcreteNumbering | docx

Class ConcreteNumbering

Hierarchy (view full)

Constructors

constructor +ConcreteNumbering | docx

Class ConcreteNumbering

Hierarchy (view full)

Constructors

constructor

Properties

instance numId reference

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Readonlyreference

reference: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Readonlyreference

reference: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ContinuationSeparator.html b/api/classes/ContinuationSeparator.html index d01f8f795e..bcfd03f5ea 100644 --- a/api/classes/ContinuationSeparator.html +++ b/api/classes/ContinuationSeparator.html @@ -1,5 +1,5 @@ -ContinuationSeparator | docx

Class ContinuationSeparator

Hierarchy (view full)

Constructors

constructor +ContinuationSeparator | docx

Class ContinuationSeparator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DayLong.html b/api/classes/DayLong.html index 5bd84d0cb4..43a0b3cef9 100644 --- a/api/classes/DayLong.html +++ b/api/classes/DayLong.html @@ -1,5 +1,5 @@ -DayLong | docx

Class DayLong

Hierarchy (view full)

Constructors

constructor +DayLong | docx

Class DayLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DayShort.html b/api/classes/DayShort.html index 8dea7765c8..b3f8dae186 100644 --- a/api/classes/DayShort.html +++ b/api/classes/DayShort.html @@ -1,5 +1,5 @@ -DayShort | docx

Class DayShort

Hierarchy (view full)

Constructors

constructor +DayShort | docx

Class DayShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DeletedTextRun.html b/api/classes/DeletedTextRun.html index 54a84f7f5a..aa698b5e12 100644 --- a/api/classes/DeletedTextRun.html +++ b/api/classes/DeletedTextRun.html @@ -1,5 +1,5 @@ -DeletedTextRun | docx

Class DeletedTextRun

Hierarchy (view full)

Constructors

constructor +DeletedTextRun | docx

Class DeletedTextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocGridAttributes.html b/api/classes/DocGridAttributes.html index ab62a456ce..8233da705a 100644 --- a/api/classes/DocGridAttributes.html +++ b/api/classes/DocGridAttributes.html @@ -1,3 +1,3 @@ -DocGridAttributes | docx

Class DocGridAttributes

Hierarchy (view full)

Constructors

constructor +DocGridAttributes | docx

Class DocGridAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Document.html b/api/classes/Document.html index 0d737a3ce5..709aec9ee4 100644 --- a/api/classes/Document.html +++ b/api/classes/Document.html @@ -1,4 +1,4 @@ -Document | docx

Class Document

Constructors

constructor +Document | docx

Class Document

Constructors

constructor

Accessors

AppProperties Comments ContentTypes @@ -14,4 +14,4 @@ Numbering Settings Styles -

Constructors

constructor

Accessors

AppProperties

  • get AppProperties(): AppProperties

  • Returns AppProperties

Comments

ContentTypes

CoreProperties

  • get CoreProperties(): CoreProperties

  • Returns CoreProperties

CustomProperties

  • get CustomProperties(): CustomProperties

  • Returns CustomProperties

Document

  • get Document(): DocumentWrapper

  • Returns DocumentWrapper

FileRelationships

  • get FileRelationships(): Relationships

  • Returns Relationships

FontTable

Footers

FootNotes

  • get FootNotes(): FootnotesWrapper

  • Returns FootnotesWrapper

Headers

Media

Numbering

Settings

Styles

Settings

Member Visibility

On This Page

Constructors
Accessors
+

Constructors

constructor

Accessors

AppProperties

  • get AppProperties(): AppProperties

  • Returns AppProperties

Comments

ContentTypes

CoreProperties

  • get CoreProperties(): CoreProperties

  • Returns CoreProperties

CustomProperties

  • get CustomProperties(): CustomProperties

  • Returns CustomProperties

Document

  • get Document(): DocumentWrapper

  • Returns DocumentWrapper

FileRelationships

  • get FileRelationships(): Relationships

  • Returns Relationships

FontTable

Footers

FootNotes

  • get FootNotes(): FootnotesWrapper

  • Returns FootnotesWrapper

Headers

Media

Numbering

Settings

Styles

Settings

Member Visibility

On This Page

Constructors
Accessors
diff --git a/api/classes/DocumentAttributes.html b/api/classes/DocumentAttributes.html index 3632950298..f4e60f15c5 100644 --- a/api/classes/DocumentAttributes.html +++ b/api/classes/DocumentAttributes.html @@ -1,3 +1,3 @@ -DocumentAttributes | docx

Class DocumentAttributes

Hierarchy (view full)

Constructors

constructor +DocumentAttributes | docx

Class DocumentAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentBackground.html b/api/classes/DocumentBackground.html index 095a70de28..769d610f13 100644 --- a/api/classes/DocumentBackground.html +++ b/api/classes/DocumentBackground.html @@ -1,5 +1,5 @@ -DocumentBackground | docx

Class DocumentBackground

Hierarchy (view full)

Constructors

constructor +DocumentBackground | docx

Class DocumentBackground

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentBackgroundAttributes.html b/api/classes/DocumentBackgroundAttributes.html index da7ea26c79..d6bfeba103 100644 --- a/api/classes/DocumentBackgroundAttributes.html +++ b/api/classes/DocumentBackgroundAttributes.html @@ -1,3 +1,3 @@ -DocumentBackgroundAttributes | docx

Class DocumentBackgroundAttributes

Hierarchy (view full)

  • XmlAttributeComponent<{
        color?: string;
        themeColor?: string;
        themeShade?: string;
        themeTint?: string;
    }>
    • DocumentBackgroundAttributes

Constructors

constructor +DocumentBackgroundAttributes | docx

Class DocumentBackgroundAttributes

Hierarchy (view full)

  • XmlAttributeComponent<{
        color?: string;
        themeColor?: string;
        themeShade?: string;
        themeTint?: string;
    }>
    • DocumentBackgroundAttributes

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentDefaults.html b/api/classes/DocumentDefaults.html index eb15e29ccf..d1c6defe7e 100644 --- a/api/classes/DocumentDefaults.html +++ b/api/classes/DocumentDefaults.html @@ -1,5 +1,5 @@ -DocumentDefaults | docx

Class DocumentDefaults

Hierarchy (view full)

Constructors

constructor +DocumentDefaults | docx

Class DocumentDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentGrid.html b/api/classes/DocumentGrid.html index 23bddf61a7..9c64eb26fb 100644 --- a/api/classes/DocumentGrid.html +++ b/api/classes/DocumentGrid.html @@ -1,5 +1,5 @@ -DocumentGrid | docx

Class DocumentGrid

Hierarchy (view full)

Constructors

constructor +DocumentGrid | docx

Class DocumentGrid

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DotEmphasisMark.html b/api/classes/DotEmphasisMark.html index afa3f037f4..5bbed75ccf 100644 --- a/api/classes/DotEmphasisMark.html +++ b/api/classes/DotEmphasisMark.html @@ -1,5 +1,5 @@ -DotEmphasisMark | docx

Class DotEmphasisMark

Hierarchy (view full)

Constructors

constructor +DotEmphasisMark | docx

Class DotEmphasisMark

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Drawing.html b/api/classes/Drawing.html index 6337da110c..0c513b7542 100644 --- a/api/classes/Drawing.html +++ b/api/classes/Drawing.html @@ -1,5 +1,5 @@ -Drawing | docx

Class Drawing

Hierarchy (view full)

Constructors

constructor +Drawing | docx

Class Drawing

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/EmphasisMark.html b/api/classes/EmphasisMark.html index e78706ac25..4a3af69a31 100644 --- a/api/classes/EmphasisMark.html +++ b/api/classes/EmphasisMark.html @@ -1,5 +1,5 @@ -EmphasisMark | docx

Class EmphasisMark

Hierarchy (view full)

Constructors

constructor +EmphasisMark | docx

Class EmphasisMark

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/EmptyElement.html b/api/classes/EmptyElement.html index 82e97164b9..c37d394807 100644 --- a/api/classes/EmptyElement.html +++ b/api/classes/EmptyElement.html @@ -1,5 +1,5 @@ -EmptyElement | docx

Class EmptyElement

Hierarchy (view full)

Constructors

constructor +EmptyElement | docx

Class EmptyElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/EndnoteReference.html b/api/classes/EndnoteReference.html index 1f97ee7d17..0bd35535e5 100644 --- a/api/classes/EndnoteReference.html +++ b/api/classes/EndnoteReference.html @@ -1,5 +1,5 @@ -EndnoteReference | docx

Class EndnoteReference

Hierarchy (view full)

Constructors

constructor +EndnoteReference | docx

Class EndnoteReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ExternalHyperlink.html b/api/classes/ExternalHyperlink.html index 3f240073cd..2e529ecc32 100644 --- a/api/classes/ExternalHyperlink.html +++ b/api/classes/ExternalHyperlink.html @@ -1,6 +1,6 @@ -ExternalHyperlink | docx

Class ExternalHyperlink

Hierarchy (view full)

Constructors

constructor +ExternalHyperlink | docx

Class ExternalHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

options

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyoptions

options: {
    children: readonly ParagraphChild[];
    link: string;
}

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyoptions

options: {
    children: readonly ParagraphChild[];
    link: string;
}

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/FileChild.html b/api/classes/FileChild.html index 90e1496b62..61b1e6fca7 100644 --- a/api/classes/FileChild.html +++ b/api/classes/FileChild.html @@ -1,6 +1,6 @@ -FileChild | docx

Class FileChild

Hierarchy (view full)

Constructors

constructor +FileChild | docx

Class FileChild

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/FootNoteReferenceRunAttributes.html b/api/classes/FootNoteReferenceRunAttributes.html index 354fa223a6..6c1ad910fd 100644 --- a/api/classes/FootNoteReferenceRunAttributes.html +++ b/api/classes/FootNoteReferenceRunAttributes.html @@ -1,3 +1,3 @@ -FootNoteReferenceRunAttributes | docx

Class FootNoteReferenceRunAttributes

Hierarchy (view full)

Constructors

constructor +FootNoteReferenceRunAttributes | docx

Class FootNoteReferenceRunAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootNotes.html b/api/classes/FootNotes.html index 77430aa27a..b5cfd85a42 100644 --- a/api/classes/FootNotes.html +++ b/api/classes/FootNotes.html @@ -1,6 +1,6 @@ -FootNotes | docx

Class FootNotes

Hierarchy (view full)

Constructors

constructor +FootNotes | docx

Class FootNotes

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement createFootNote prepForXml -

Constructors

constructor

Methods

addChildElement

createFootNote

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

createFootNote

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Footer.html b/api/classes/Footer.html index a8cef5ba56..8bb2d7ae7b 100644 --- a/api/classes/Footer.html +++ b/api/classes/Footer.html @@ -1,3 +1,3 @@ -Footer | docx

Class Footer

Constructors

constructor +Footer | docx

Class Footer

Constructors

constructor

Properties

options -

Constructors

constructor

Properties

Readonlyoptions

options: IHeaderOptions

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlyoptions

options: IHeaderOptions

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/FooterWrapper.html b/api/classes/FooterWrapper.html index 8f36009a26..b63659dd49 100644 --- a/api/classes/FooterWrapper.html +++ b/api/classes/FooterWrapper.html @@ -1,7 +1,7 @@ -FooterWrapper | docx

Class FooterWrapper

Implements

  • IViewWrapper

Constructors

constructor +FooterWrapper | docx

Class FooterWrapper

Implements

  • IViewWrapper

Constructors

constructor

Accessors

Media Relationships View

Methods

add addChildElement -

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/FootnoteReference.html b/api/classes/FootnoteReference.html index 28bd856a23..299fcf96ba 100644 --- a/api/classes/FootnoteReference.html +++ b/api/classes/FootnoteReference.html @@ -1,5 +1,5 @@ -FootnoteReference | docx

Class FootnoteReference

Hierarchy (view full)

Constructors

constructor +FootnoteReference | docx

Class FootnoteReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootnoteReferenceElement.html b/api/classes/FootnoteReferenceElement.html index c39e9e0b6f..84ab61c622 100644 --- a/api/classes/FootnoteReferenceElement.html +++ b/api/classes/FootnoteReferenceElement.html @@ -1,5 +1,5 @@ -FootnoteReferenceElement | docx

Class FootnoteReferenceElement

Hierarchy (view full)

Constructors

constructor +FootnoteReferenceElement | docx

Class FootnoteReferenceElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootnoteReferenceRun.html b/api/classes/FootnoteReferenceRun.html index 8a8f0be4f5..de9208118d 100644 --- a/api/classes/FootnoteReferenceRun.html +++ b/api/classes/FootnoteReferenceRun.html @@ -1,5 +1,5 @@ -FootnoteReferenceRun | docx

Class FootnoteReferenceRun

Hierarchy (view full)

  • Run
    • FootnoteReferenceRun

Constructors

constructor +FootnoteReferenceRun | docx

Class FootnoteReferenceRun

Hierarchy (view full)

  • Run
    • FootnoteReferenceRun

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/GridSpan.html b/api/classes/GridSpan.html index 82037ef599..75e4233822 100644 --- a/api/classes/GridSpan.html +++ b/api/classes/GridSpan.html @@ -1,6 +1,6 @@ GridSpan | docx

Class GridSpan

GridSpan element. Should be used in a table cell. Pass the number of columns that this cell need to span.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Header.html b/api/classes/Header.html index ebec4a660e..4de52f0822 100644 --- a/api/classes/Header.html +++ b/api/classes/Header.html @@ -1,3 +1,3 @@ -Header | docx

Class Header

Constructors

constructor +Header | docx

Class Header

Constructors

constructor

Properties

options -

Constructors

constructor

Properties

Readonlyoptions

options: IHeaderOptions

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlyoptions

options: IHeaderOptions

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/HeaderFooterReference.html b/api/classes/HeaderFooterReference.html index 6210fe813d..c446845f19 100644 --- a/api/classes/HeaderFooterReference.html +++ b/api/classes/HeaderFooterReference.html @@ -1,5 +1,5 @@ -HeaderFooterReference | docx

Class HeaderFooterReference

Hierarchy (view full)

Constructors

constructor +HeaderFooterReference | docx

Class HeaderFooterReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/HeaderWrapper.html b/api/classes/HeaderWrapper.html index 14c8e4d382..13dced5b09 100644 --- a/api/classes/HeaderWrapper.html +++ b/api/classes/HeaderWrapper.html @@ -1,7 +1,7 @@ -HeaderWrapper | docx

Class HeaderWrapper

Implements

  • IViewWrapper

Constructors

constructor +HeaderWrapper | docx

Class HeaderWrapper

Implements

  • IViewWrapper

Constructors

constructor

Accessors

Media Relationships View

Methods

add addChildElement -

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/HorizontalPosition.html b/api/classes/HorizontalPosition.html index 124ea5b517..4d5c554a66 100644 --- a/api/classes/HorizontalPosition.html +++ b/api/classes/HorizontalPosition.html @@ -1,5 +1,5 @@ -HorizontalPosition | docx

Class HorizontalPosition

Hierarchy (view full)

Constructors

constructor +HorizontalPosition | docx

Class HorizontalPosition

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/HpsMeasureElement.html b/api/classes/HpsMeasureElement.html index 18f0ab301d..5fdcb0f3da 100644 --- a/api/classes/HpsMeasureElement.html +++ b/api/classes/HpsMeasureElement.html @@ -1,5 +1,5 @@ -HpsMeasureElement | docx

Class HpsMeasureElement

Hierarchy (view full)

Constructors

constructor +HpsMeasureElement | docx

Class HpsMeasureElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/IgnoreIfEmptyXmlComponent.html b/api/classes/IgnoreIfEmptyXmlComponent.html index 2d8884a790..409b102bf7 100644 --- a/api/classes/IgnoreIfEmptyXmlComponent.html +++ b/api/classes/IgnoreIfEmptyXmlComponent.html @@ -1,5 +1,5 @@ -IgnoreIfEmptyXmlComponent | docx

Class IgnoreIfEmptyXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor +IgnoreIfEmptyXmlComponent | docx

Class IgnoreIfEmptyXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ImageRun.html b/api/classes/ImageRun.html index 4314ecc7d9..4a9eb39f8d 100644 --- a/api/classes/ImageRun.html +++ b/api/classes/ImageRun.html @@ -1,5 +1,5 @@ -ImageRun | docx

Class ImageRun

Hierarchy (view full)

Constructors

constructor +ImageRun | docx

Class ImageRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ImportedRootElementAttributes.html b/api/classes/ImportedRootElementAttributes.html index 0d34b76928..febd0bfde2 100644 --- a/api/classes/ImportedRootElementAttributes.html +++ b/api/classes/ImportedRootElementAttributes.html @@ -1,6 +1,6 @@ ImportedRootElementAttributes | docx

Class ImportedRootElementAttributes

Used for the attributes of root element that is being imported.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ImportedXmlComponent.html b/api/classes/ImportedXmlComponent.html index 92bd2793b2..7791278933 100644 --- a/api/classes/ImportedXmlComponent.html +++ b/api/classes/ImportedXmlComponent.html @@ -1,11 +1,11 @@ ImportedXmlComponent | docx

Class ImportedXmlComponent

Represents imported xml component from xml file.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml push fromXmlString

Constructors

constructor

Methods

addChildElement

prepForXml

push

StaticfromXmlString

Methods

addChildElement

prepForXml

push

StaticfromXmlString

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns ImportedXmlComponent

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Indent.html b/api/classes/Indent.html index 16d307281c..274b88b948 100644 --- a/api/classes/Indent.html +++ b/api/classes/Indent.html @@ -1,5 +1,5 @@ -Indent | docx

Class Indent

Hierarchy (view full)

Constructors

constructor +Indent | docx

Class Indent

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/InitializableXmlComponent.html b/api/classes/InitializableXmlComponent.html index 0f524b769f..fbc4f83148 100644 --- a/api/classes/InitializableXmlComponent.html +++ b/api/classes/InitializableXmlComponent.html @@ -1,5 +1,5 @@ -InitializableXmlComponent | docx

Class InitializableXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor +InitializableXmlComponent | docx

Class InitializableXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/InsertedTextRun.html b/api/classes/InsertedTextRun.html index c01ec6212f..6736db0b97 100644 --- a/api/classes/InsertedTextRun.html +++ b/api/classes/InsertedTextRun.html @@ -1,5 +1,5 @@ -InsertedTextRun | docx

Class InsertedTextRun

Hierarchy (view full)

Constructors

constructor +InsertedTextRun | docx

Class InsertedTextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/InternalHyperlink.html b/api/classes/InternalHyperlink.html index ea124c6900..f6e363e380 100644 --- a/api/classes/InternalHyperlink.html +++ b/api/classes/InternalHyperlink.html @@ -1,6 +1,6 @@ -InternalHyperlink | docx

Class InternalHyperlink

Hierarchy (view full)

Constructors

constructor +InternalHyperlink | docx

Class InternalHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

linkId

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/LastRenderedPageBreak.html b/api/classes/LastRenderedPageBreak.html index 7b19c93237..37fb89c114 100644 --- a/api/classes/LastRenderedPageBreak.html +++ b/api/classes/LastRenderedPageBreak.html @@ -1,5 +1,5 @@ -LastRenderedPageBreak | docx

Class LastRenderedPageBreak

Hierarchy (view full)

Constructors

constructor +LastRenderedPageBreak | docx

Class LastRenderedPageBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Level.html b/api/classes/Level.html index 815e2dd6e9..c02eb47d1a 100644 --- a/api/classes/Level.html +++ b/api/classes/Level.html @@ -1,5 +1,5 @@ -Level | docx

Class Level

Hierarchy (view full)

Constructors

constructor +Level | docx

Class Level

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelBase.html b/api/classes/LevelBase.html index 0f3f683707..c8c43ad4fc 100644 --- a/api/classes/LevelBase.html +++ b/api/classes/LevelBase.html @@ -1,5 +1,5 @@ -LevelBase | docx

Class LevelBase

Hierarchy (view full)

Constructors

constructor +LevelBase | docx

Class LevelBase

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelForOverride.html b/api/classes/LevelForOverride.html index efc020e281..ff143fdeb3 100644 --- a/api/classes/LevelForOverride.html +++ b/api/classes/LevelForOverride.html @@ -1,5 +1,5 @@ -LevelForOverride | docx

Class LevelForOverride

Hierarchy (view full)

Constructors

constructor +LevelForOverride | docx

Class LevelForOverride

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelOverride.html b/api/classes/LevelOverride.html index ca947a2246..3e2010f96c 100644 --- a/api/classes/LevelOverride.html +++ b/api/classes/LevelOverride.html @@ -1,5 +1,5 @@ -LevelOverride | docx

Class LevelOverride

Hierarchy (view full)

Constructors

constructor +LevelOverride | docx

Class LevelOverride

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Math.html b/api/classes/Math.html index 675f3fbed2..0a928ae628 100644 --- a/api/classes/Math.html +++ b/api/classes/Math.html @@ -1,5 +1,5 @@ -Math | docx

Class Math

Hierarchy (view full)

Constructors

constructor +Math | docx

Class Math

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathAccentCharacter.html b/api/classes/MathAccentCharacter.html index dd9b21b717..1a88e29fbf 100644 --- a/api/classes/MathAccentCharacter.html +++ b/api/classes/MathAccentCharacter.html @@ -1,5 +1,5 @@ -MathAccentCharacter | docx

Class MathAccentCharacter

Hierarchy (view full)

Constructors

constructor +MathAccentCharacter | docx

Class MathAccentCharacter

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathAngledBrackets.html b/api/classes/MathAngledBrackets.html index aaf431ad44..b438858bb0 100644 --- a/api/classes/MathAngledBrackets.html +++ b/api/classes/MathAngledBrackets.html @@ -1,5 +1,5 @@ -MathAngledBrackets | docx

Class MathAngledBrackets

Hierarchy (view full)

Constructors

constructor +MathAngledBrackets | docx

Class MathAngledBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathBase.html b/api/classes/MathBase.html index b1d04f8820..ee030a9047 100644 --- a/api/classes/MathBase.html +++ b/api/classes/MathBase.html @@ -1,5 +1,5 @@ -MathBase | docx

Class MathBase

Hierarchy (view full)

Constructors

constructor +MathBase | docx

Class MathBase

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathCurlyBrackets.html b/api/classes/MathCurlyBrackets.html index 2e27ddb210..9539d7afa3 100644 --- a/api/classes/MathCurlyBrackets.html +++ b/api/classes/MathCurlyBrackets.html @@ -1,5 +1,5 @@ -MathCurlyBrackets | docx

Class MathCurlyBrackets

Hierarchy (view full)

Constructors

constructor +MathCurlyBrackets | docx

Class MathCurlyBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathDegree.html b/api/classes/MathDegree.html index ba0019bdae..b825b0eb9f 100644 --- a/api/classes/MathDegree.html +++ b/api/classes/MathDegree.html @@ -1,5 +1,5 @@ -MathDegree | docx

Class MathDegree

Hierarchy (view full)

Constructors

constructor +MathDegree | docx

Class MathDegree

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathDenominator.html b/api/classes/MathDenominator.html index 54f40f3e83..260fdf34bb 100644 --- a/api/classes/MathDenominator.html +++ b/api/classes/MathDenominator.html @@ -1,5 +1,5 @@ -MathDenominator | docx

Class MathDenominator

Hierarchy (view full)

Constructors

constructor +MathDenominator | docx

Class MathDenominator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFraction.html b/api/classes/MathFraction.html index 4803e459fc..50ac343bba 100644 --- a/api/classes/MathFraction.html +++ b/api/classes/MathFraction.html @@ -1,5 +1,5 @@ -MathFraction | docx

Class MathFraction

Hierarchy (view full)

Constructors

constructor +MathFraction | docx

Class MathFraction

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunction.html b/api/classes/MathFunction.html index 6dfb104d19..dbdc58ced9 100644 --- a/api/classes/MathFunction.html +++ b/api/classes/MathFunction.html @@ -1,5 +1,5 @@ -MathFunction | docx

Class MathFunction

Hierarchy (view full)

Constructors

constructor +MathFunction | docx

Class MathFunction

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunctionName.html b/api/classes/MathFunctionName.html index ef0cc9cb57..5ae1ff09bc 100644 --- a/api/classes/MathFunctionName.html +++ b/api/classes/MathFunctionName.html @@ -1,5 +1,5 @@ -MathFunctionName | docx

Class MathFunctionName

Hierarchy (view full)

Constructors

constructor +MathFunctionName | docx

Class MathFunctionName

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunctionProperties.html b/api/classes/MathFunctionProperties.html index 8115c8b7b6..8eeb6f402a 100644 --- a/api/classes/MathFunctionProperties.html +++ b/api/classes/MathFunctionProperties.html @@ -1,5 +1,5 @@ -MathFunctionProperties | docx

Class MathFunctionProperties

Hierarchy (view full)

Constructors

constructor +MathFunctionProperties | docx

Class MathFunctionProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathIntegral.html b/api/classes/MathIntegral.html index 62d6334f68..6214bea88c 100644 --- a/api/classes/MathIntegral.html +++ b/api/classes/MathIntegral.html @@ -1,5 +1,5 @@ -MathIntegral | docx

Class MathIntegral

Hierarchy (view full)

Constructors

constructor +MathIntegral | docx

Class MathIntegral

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimit.html b/api/classes/MathLimit.html index 5563e201b2..c6fb88d715 100644 --- a/api/classes/MathLimit.html +++ b/api/classes/MathLimit.html @@ -1,5 +1,5 @@ -MathLimit | docx

Class MathLimit

Hierarchy (view full)

Constructors

constructor +MathLimit | docx

Class MathLimit

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitLocation.html b/api/classes/MathLimitLocation.html index e9b12dc437..fa1e53ce2b 100644 --- a/api/classes/MathLimitLocation.html +++ b/api/classes/MathLimitLocation.html @@ -1,5 +1,5 @@ -MathLimitLocation | docx

Class MathLimitLocation

Hierarchy (view full)

Constructors

constructor +MathLimitLocation | docx

Class MathLimitLocation

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitLower.html b/api/classes/MathLimitLower.html index 6e6ead0065..340340a9e1 100644 --- a/api/classes/MathLimitLower.html +++ b/api/classes/MathLimitLower.html @@ -1,5 +1,5 @@ -MathLimitLower | docx

Class MathLimitLower

Hierarchy (view full)

Constructors

constructor +MathLimitLower | docx

Class MathLimitLower

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitUpper.html b/api/classes/MathLimitUpper.html index 6b66512b6f..8bab910f7c 100644 --- a/api/classes/MathLimitUpper.html +++ b/api/classes/MathLimitUpper.html @@ -1,5 +1,5 @@ -MathLimitUpper | docx

Class MathLimitUpper

Hierarchy (view full)

Constructors

constructor +MathLimitUpper | docx

Class MathLimitUpper

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathNAryProperties.html b/api/classes/MathNAryProperties.html index a25145f1c0..0f216a5236 100644 --- a/api/classes/MathNAryProperties.html +++ b/api/classes/MathNAryProperties.html @@ -1,5 +1,5 @@ -MathNAryProperties | docx

Class MathNAryProperties

Hierarchy (view full)

Constructors

constructor +MathNAryProperties | docx

Class MathNAryProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathNumerator.html b/api/classes/MathNumerator.html index cf7109c472..753fa91180 100644 --- a/api/classes/MathNumerator.html +++ b/api/classes/MathNumerator.html @@ -1,5 +1,5 @@ -MathNumerator | docx

Class MathNumerator

Hierarchy (view full)

Constructors

constructor +MathNumerator | docx

Class MathNumerator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathPreSubSuperScript.html b/api/classes/MathPreSubSuperScript.html index 83e4923111..f6765654bf 100644 --- a/api/classes/MathPreSubSuperScript.html +++ b/api/classes/MathPreSubSuperScript.html @@ -1,5 +1,5 @@ -MathPreSubSuperScript | docx

Class MathPreSubSuperScript

Hierarchy (view full)

Constructors

constructor +MathPreSubSuperScript | docx

Class MathPreSubSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathPreSubSuperScriptProperties.html b/api/classes/MathPreSubSuperScriptProperties.html index aeaa300dcf..bc55c0aae1 100644 --- a/api/classes/MathPreSubSuperScriptProperties.html +++ b/api/classes/MathPreSubSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathPreSubSuperScriptProperties | docx

Class MathPreSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor +MathPreSubSuperScriptProperties | docx

Class MathPreSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRadical.html b/api/classes/MathRadical.html index 68c5e02e07..956a3777aa 100644 --- a/api/classes/MathRadical.html +++ b/api/classes/MathRadical.html @@ -1,5 +1,5 @@ -MathRadical | docx

Class MathRadical

Hierarchy (view full)

Constructors

constructor +MathRadical | docx

Class MathRadical

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRadicalProperties.html b/api/classes/MathRadicalProperties.html index 1034530c47..49df38bf75 100644 --- a/api/classes/MathRadicalProperties.html +++ b/api/classes/MathRadicalProperties.html @@ -1,5 +1,5 @@ -MathRadicalProperties | docx

Class MathRadicalProperties

Hierarchy (view full)

Constructors

constructor +MathRadicalProperties | docx

Class MathRadicalProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRoundBrackets.html b/api/classes/MathRoundBrackets.html index 0cc7b9be55..af55a66c60 100644 --- a/api/classes/MathRoundBrackets.html +++ b/api/classes/MathRoundBrackets.html @@ -1,5 +1,5 @@ -MathRoundBrackets | docx

Class MathRoundBrackets

Hierarchy (view full)

Constructors

constructor +MathRoundBrackets | docx

Class MathRoundBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRun.html b/api/classes/MathRun.html index 9114394cf0..4f5f9ff15c 100644 --- a/api/classes/MathRun.html +++ b/api/classes/MathRun.html @@ -1,5 +1,5 @@ -MathRun | docx

Class MathRun

Hierarchy (view full)

Constructors

constructor +MathRun | docx

Class MathRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSquareBrackets.html b/api/classes/MathSquareBrackets.html index aaab3ca5cd..edd57d0581 100644 --- a/api/classes/MathSquareBrackets.html +++ b/api/classes/MathSquareBrackets.html @@ -1,5 +1,5 @@ -MathSquareBrackets | docx

Class MathSquareBrackets

Hierarchy (view full)

Constructors

constructor +MathSquareBrackets | docx

Class MathSquareBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubScript.html b/api/classes/MathSubScript.html index e24abdac7c..f934aa3b85 100644 --- a/api/classes/MathSubScript.html +++ b/api/classes/MathSubScript.html @@ -1,5 +1,5 @@ -MathSubScript | docx

Class MathSubScript

Hierarchy (view full)

Constructors

constructor +MathSubScript | docx

Class MathSubScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubScriptElement.html b/api/classes/MathSubScriptElement.html index a22dc8cf9d..5d0d74c447 100644 --- a/api/classes/MathSubScriptElement.html +++ b/api/classes/MathSubScriptElement.html @@ -1,5 +1,5 @@ -MathSubScriptElement | docx

Class MathSubScriptElement

Hierarchy (view full)

Constructors

constructor +MathSubScriptElement | docx

Class MathSubScriptElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubScriptProperties.html b/api/classes/MathSubScriptProperties.html index 1acf55a067..9d8957809c 100644 --- a/api/classes/MathSubScriptProperties.html +++ b/api/classes/MathSubScriptProperties.html @@ -1,5 +1,5 @@ -MathSubScriptProperties | docx

Class MathSubScriptProperties

Hierarchy (view full)

Constructors

constructor +MathSubScriptProperties | docx

Class MathSubScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubSuperScript.html b/api/classes/MathSubSuperScript.html index 0d3526d469..19345b6cfb 100644 --- a/api/classes/MathSubSuperScript.html +++ b/api/classes/MathSubSuperScript.html @@ -1,5 +1,5 @@ -MathSubSuperScript | docx

Class MathSubSuperScript

Hierarchy (view full)

Constructors

constructor +MathSubSuperScript | docx

Class MathSubSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubSuperScriptProperties.html b/api/classes/MathSubSuperScriptProperties.html index 8f7797f0aa..15217fe93e 100644 --- a/api/classes/MathSubSuperScriptProperties.html +++ b/api/classes/MathSubSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathSubSuperScriptProperties | docx

Class MathSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor +MathSubSuperScriptProperties | docx

Class MathSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSum.html b/api/classes/MathSum.html index e2973a1848..086d820839 100644 --- a/api/classes/MathSum.html +++ b/api/classes/MathSum.html @@ -1,5 +1,5 @@ -MathSum | docx

Class MathSum

Hierarchy (view full)

Constructors

constructor +MathSum | docx

Class MathSum

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSuperScript.html b/api/classes/MathSuperScript.html index 1f6f3f9e28..9646048c76 100644 --- a/api/classes/MathSuperScript.html +++ b/api/classes/MathSuperScript.html @@ -1,5 +1,5 @@ -MathSuperScript | docx

Class MathSuperScript

Hierarchy (view full)

Constructors

constructor +MathSuperScript | docx

Class MathSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSuperScriptElement.html b/api/classes/MathSuperScriptElement.html index 0b97ea37af..28a3d2aa9a 100644 --- a/api/classes/MathSuperScriptElement.html +++ b/api/classes/MathSuperScriptElement.html @@ -1,5 +1,5 @@ -MathSuperScriptElement | docx

Class MathSuperScriptElement

Hierarchy (view full)

Constructors

constructor +MathSuperScriptElement | docx

Class MathSuperScriptElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSuperScriptProperties.html b/api/classes/MathSuperScriptProperties.html index 70d655fb81..40b3b04f30 100644 --- a/api/classes/MathSuperScriptProperties.html +++ b/api/classes/MathSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathSuperScriptProperties | docx

Class MathSuperScriptProperties

Hierarchy (view full)

Constructors

constructor +MathSuperScriptProperties | docx

Class MathSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Media.html b/api/classes/Media.html index 79eb0b5033..64b6ea9ec0 100644 --- a/api/classes/Media.html +++ b/api/classes/Media.html @@ -1,4 +1,4 @@ -Media | docx

Class Media

Constructors

constructor +Media | docx

Class Media

Constructors

constructor

Accessors

Array

Methods

addImage -

Constructors

constructor

Accessors

Array

Methods

addImage

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

Array

Methods

addImage

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/MonthLong.html b/api/classes/MonthLong.html index b861d4dfc8..1f6810ebd8 100644 --- a/api/classes/MonthLong.html +++ b/api/classes/MonthLong.html @@ -1,5 +1,5 @@ -MonthLong | docx

Class MonthLong

Hierarchy (view full)

Constructors

constructor +MonthLong | docx

Class MonthLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MonthShort.html b/api/classes/MonthShort.html index ba902be94a..b668fa6c78 100644 --- a/api/classes/MonthShort.html +++ b/api/classes/MonthShort.html @@ -1,5 +1,5 @@ -MonthShort | docx

Class MonthShort

Hierarchy (view full)

Constructors

constructor +MonthShort | docx

Class MonthShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NextAttributeComponent.html b/api/classes/NextAttributeComponent.html index 4d14899f0a..2659427c47 100644 --- a/api/classes/NextAttributeComponent.html +++ b/api/classes/NextAttributeComponent.html @@ -1,3 +1,3 @@ -NextAttributeComponent | docx

Class NextAttributeComponent<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor +NextAttributeComponent | docx

Class NextAttributeComponent<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NoBreakHyphen.html b/api/classes/NoBreakHyphen.html index 05f44c8b27..2c0a691283 100644 --- a/api/classes/NoBreakHyphen.html +++ b/api/classes/NoBreakHyphen.html @@ -1,5 +1,5 @@ -NoBreakHyphen | docx

Class NoBreakHyphen

Hierarchy (view full)

Constructors

constructor +NoBreakHyphen | docx

Class NoBreakHyphen

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NumberProperties.html b/api/classes/NumberProperties.html index edf1e11286..6141a5ecca 100644 --- a/api/classes/NumberProperties.html +++ b/api/classes/NumberProperties.html @@ -1,5 +1,5 @@ -NumberProperties | docx

Class NumberProperties

Hierarchy (view full)

Constructors

constructor +NumberProperties | docx

Class NumberProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NumberValueElement.html b/api/classes/NumberValueElement.html index 29d16c82af..a3585e27eb 100644 --- a/api/classes/NumberValueElement.html +++ b/api/classes/NumberValueElement.html @@ -1,5 +1,5 @@ -NumberValueElement | docx

Class NumberValueElement

Hierarchy (view full)

Constructors

constructor +NumberValueElement | docx

Class NumberValueElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Numbering.html b/api/classes/Numbering.html index 65f90822e1..1b116793fb 100644 --- a/api/classes/Numbering.html +++ b/api/classes/Numbering.html @@ -1,8 +1,8 @@ -Numbering | docx

Class Numbering

Hierarchy (view full)

Constructors

constructor +Numbering | docx

Class Numbering

Hierarchy (view full)

Constructors

constructor

Accessors

ConcreteNumbering ReferenceConfig

Methods

addChildElement createConcreteNumberingInstance prepForXml -

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference, instance): void

  • Parameters

    • reference: string
    • instance: number

    Returns void

prepForXml

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference, instance): void

  • Parameters

    • reference: string
    • instance: number

    Returns void

prepForXml

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/OnOffElement.html b/api/classes/OnOffElement.html index dad75264d1..73b6211fd5 100644 --- a/api/classes/OnOffElement.html +++ b/api/classes/OnOffElement.html @@ -1,5 +1,5 @@ -OnOffElement | docx

Class OnOffElement

Hierarchy (view full)

Constructors

constructor +OnOffElement | docx

Class OnOffElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/OutlineLevel.html b/api/classes/OutlineLevel.html index c23b943a27..ab00259cea 100644 --- a/api/classes/OutlineLevel.html +++ b/api/classes/OutlineLevel.html @@ -1,6 +1,6 @@ -OutlineLevel | docx

Class OutlineLevel

Hierarchy (view full)

Constructors

constructor +OutlineLevel | docx

Class OutlineLevel

Hierarchy (view full)

Constructors

constructor

Properties

level

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlylevel

level: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlylevel

level: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Packer.html b/api/classes/Packer.html index 33e15c4709..e4463816df 100644 --- a/api/classes/Packer.html +++ b/api/classes/Packer.html @@ -1,7 +1,7 @@ -Packer | docx

Class Packer

Constructors

constructor +Packer | docx

Class Packer

Constructors

constructor

Methods

toBase64String toBlob toBuffer toStream toString -

Constructors

constructor

Methods

StatictoBase64String

  • toBase64String(file, prettify?): Promise<string>

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Promise<string>

StatictoBlob

  • toBlob(file, prettify?): Promise<Blob>

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Promise<Blob>

StatictoBuffer

  • toBuffer(file, prettify?): Promise<Buffer>

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Promise<Buffer>

StatictoStream

  • toStream(file, prettify?): Stream

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Stream

StatictoString

  • toString(file, prettify?): Promise<string>

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

StatictoBase64String

  • toBase64String(file, prettify?): Promise<string>

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Promise<string>

StatictoBlob

  • toBlob(file, prettify?): Promise<Blob>

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Promise<Blob>

StatictoBuffer

  • toBuffer(file, prettify?): Promise<Buffer>

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Promise<Buffer>

StatictoStream

  • toStream(file, prettify?): Stream

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Stream

StatictoString

  • toString(file, prettify?): Promise<string>

  • Parameters

    • file: Document
    • Optionalprettify:
          | boolean
          | ""
          | " "
          | " "
          | "\t"

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBorders.html b/api/classes/PageBorders.html index 1ccf2505d1..c413e7ed08 100644 --- a/api/classes/PageBorders.html +++ b/api/classes/PageBorders.html @@ -1,5 +1,5 @@ -PageBorders | docx

Class PageBorders

Hierarchy (view full)

Constructors

constructor +PageBorders | docx

Class PageBorders

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBreak.html b/api/classes/PageBreak.html index 1f92ceb0af..fa40e7c22d 100644 --- a/api/classes/PageBreak.html +++ b/api/classes/PageBreak.html @@ -1,5 +1,5 @@ -PageBreak | docx

Class PageBreak

Hierarchy (view full)

Constructors

constructor +PageBreak | docx

Class PageBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBreakBefore.html b/api/classes/PageBreakBefore.html index cbd0b3825f..93a9107c76 100644 --- a/api/classes/PageBreakBefore.html +++ b/api/classes/PageBreakBefore.html @@ -1,6 +1,6 @@ PageBreakBefore | docx

Class PageBreakBefore

Add page break before the paragraph if there is no one added before.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageMargin.html b/api/classes/PageMargin.html index 961e26f0c7..3f19438be6 100644 --- a/api/classes/PageMargin.html +++ b/api/classes/PageMargin.html @@ -1,5 +1,5 @@ -PageMargin | docx

Class PageMargin

Hierarchy (view full)

Constructors

constructor +PageMargin | docx

Class PageMargin

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new PageMargin(top, right, bottom, left, header, footer, gutter): PageMargin

  • Parameters

    • top:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`
    • right:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • bottom:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`
    • left:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • header:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • footer:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • gutter:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`

    Returns PageMargin

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new PageMargin(top, right, bottom, left, header, footer, gutter): PageMargin

  • Parameters

    • top:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`
    • right:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • bottom:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`
    • left:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • header:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • footer:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • gutter:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`

    Returns PageMargin

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageNumberElement.html b/api/classes/PageNumberElement.html index 9e249c43f0..2b6a803093 100644 --- a/api/classes/PageNumberElement.html +++ b/api/classes/PageNumberElement.html @@ -1,5 +1,5 @@ -PageNumberElement | docx

Class PageNumberElement

Hierarchy (view full)

Constructors

constructor +PageNumberElement | docx

Class PageNumberElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageNumberType.html b/api/classes/PageNumberType.html index 5d8e4754e4..e6f1673024 100644 --- a/api/classes/PageNumberType.html +++ b/api/classes/PageNumberType.html @@ -1,5 +1,5 @@ -PageNumberType | docx

Class PageNumberType

Hierarchy (view full)

Constructors

constructor +PageNumberType | docx

Class PageNumberType

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageNumberTypeAttributes.html b/api/classes/PageNumberTypeAttributes.html index 9102542586..2099b62a67 100644 --- a/api/classes/PageNumberTypeAttributes.html +++ b/api/classes/PageNumberTypeAttributes.html @@ -1,3 +1,3 @@ -PageNumberTypeAttributes | docx

Class PageNumberTypeAttributes

Hierarchy (view full)

Constructors

constructor +PageNumberTypeAttributes | docx

Class PageNumberTypeAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageReference.html b/api/classes/PageReference.html index 018bcfda43..afee3796a7 100644 --- a/api/classes/PageReference.html +++ b/api/classes/PageReference.html @@ -1,5 +1,5 @@ -PageReference | docx

Class PageReference

Hierarchy (view full)

  • Run
    • PageReference

Constructors

constructor +PageReference | docx

Class PageReference

Hierarchy (view full)

  • Run
    • PageReference

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageSize.html b/api/classes/PageSize.html index 8835767068..d06c078806 100644 --- a/api/classes/PageSize.html +++ b/api/classes/PageSize.html @@ -1,5 +1,5 @@ -PageSize | docx

Class PageSize

Hierarchy (view full)

Constructors

constructor +PageSize | docx

Class PageSize

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new PageSize(width, height, orientation): PageSize

  • Parameters

    • width:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • height:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • orientation: "portrait" | "landscape"

    Returns PageSize

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new PageSize(width, height, orientation): PageSize

  • Parameters

    • width:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • height:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
    • orientation: "portrait" | "landscape"

    Returns PageSize

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageTextDirection.html b/api/classes/PageTextDirection.html index 9943a8540d..f4369c3266 100644 --- a/api/classes/PageTextDirection.html +++ b/api/classes/PageTextDirection.html @@ -1,5 +1,5 @@ -PageTextDirection | docx

Class PageTextDirection

Hierarchy (view full)

Constructors

constructor +PageTextDirection | docx

Class PageTextDirection

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Paragraph.html b/api/classes/Paragraph.html index 2ab7b53a86..36338bb00c 100644 --- a/api/classes/Paragraph.html +++ b/api/classes/Paragraph.html @@ -1,7 +1,7 @@ -Paragraph | docx

Class Paragraph

Hierarchy (view full)

Constructors

constructor +Paragraph | docx

Class Paragraph

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement addRunToFront prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

addRunToFront

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

addRunToFront

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ParagraphProperties.html b/api/classes/ParagraphProperties.html index 97d82c7732..d0d8d21317 100644 --- a/api/classes/ParagraphProperties.html +++ b/api/classes/ParagraphProperties.html @@ -1,6 +1,6 @@ -ParagraphProperties | docx

Class ParagraphProperties

Hierarchy (view full)

Constructors

constructor +ParagraphProperties | docx

Class ParagraphProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml push -

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ParagraphPropertiesDefaults.html b/api/classes/ParagraphPropertiesDefaults.html index cd39c153c4..4f4724d1b3 100644 --- a/api/classes/ParagraphPropertiesDefaults.html +++ b/api/classes/ParagraphPropertiesDefaults.html @@ -1,5 +1,5 @@ -ParagraphPropertiesDefaults | docx

Class ParagraphPropertiesDefaults

Hierarchy (view full)

Constructors

constructor +ParagraphPropertiesDefaults | docx

Class ParagraphPropertiesDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PositionalTab.html b/api/classes/PositionalTab.html index 9e9bc0084d..9e6206f3f5 100644 --- a/api/classes/PositionalTab.html +++ b/api/classes/PositionalTab.html @@ -1,5 +1,5 @@ -PositionalTab | docx

Class PositionalTab

Hierarchy (view full)

Constructors

constructor +PositionalTab | docx

Class PositionalTab

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Run.html b/api/classes/Run.html index db5fb167ad..54d516656f 100644 --- a/api/classes/Run.html +++ b/api/classes/Run.html @@ -1,5 +1,5 @@ -Run | docx

Class Run

Hierarchy (view full)

Constructors

constructor +Run | docx

Class Run

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunFonts.html b/api/classes/RunFonts.html index 4d1f3990d2..03281c8be1 100644 --- a/api/classes/RunFonts.html +++ b/api/classes/RunFonts.html @@ -1,5 +1,5 @@ -RunFonts | docx

Class RunFonts

Hierarchy (view full)

Constructors

constructor +RunFonts | docx

Class RunFonts

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunProperties.html b/api/classes/RunProperties.html index 674af7630f..6c75a913e7 100644 --- a/api/classes/RunProperties.html +++ b/api/classes/RunProperties.html @@ -1,6 +1,6 @@ -RunProperties | docx

Class RunProperties

Hierarchy (view full)

Constructors

constructor +RunProperties | docx

Class RunProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml push -

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunPropertiesChange.html b/api/classes/RunPropertiesChange.html index 32cecd7189..1896c9e6d5 100644 --- a/api/classes/RunPropertiesChange.html +++ b/api/classes/RunPropertiesChange.html @@ -1,5 +1,5 @@ -RunPropertiesChange | docx

Class RunPropertiesChange

Hierarchy (view full)

Constructors

constructor +RunPropertiesChange | docx

Class RunPropertiesChange

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunPropertiesDefaults.html b/api/classes/RunPropertiesDefaults.html index f9c98ea74a..e88273035c 100644 --- a/api/classes/RunPropertiesDefaults.html +++ b/api/classes/RunPropertiesDefaults.html @@ -1,5 +1,5 @@ -RunPropertiesDefaults | docx

Class RunPropertiesDefaults

Hierarchy (view full)

Constructors

constructor +RunPropertiesDefaults | docx

Class RunPropertiesDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SectionProperties.html b/api/classes/SectionProperties.html index a704eae18d..af5b748d01 100644 --- a/api/classes/SectionProperties.html +++ b/api/classes/SectionProperties.html @@ -1,5 +1,5 @@ -SectionProperties | docx

Class SectionProperties

Hierarchy (view full)

Constructors

constructor +SectionProperties | docx

Class SectionProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SectionTypeAttributes.html b/api/classes/SectionTypeAttributes.html index dfdf472e06..f22c586a46 100644 --- a/api/classes/SectionTypeAttributes.html +++ b/api/classes/SectionTypeAttributes.html @@ -1,3 +1,3 @@ -SectionTypeAttributes | docx

Class SectionTypeAttributes

Hierarchy (view full)

Constructors

constructor +SectionTypeAttributes | docx

Class SectionTypeAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Separator.html b/api/classes/Separator.html index baddb64a34..cfd8d085c9 100644 --- a/api/classes/Separator.html +++ b/api/classes/Separator.html @@ -1,5 +1,5 @@ -Separator | docx

Class Separator

Hierarchy (view full)

Constructors

constructor +Separator | docx

Class Separator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SequentialIdentifier.html b/api/classes/SequentialIdentifier.html index 0418f1dd34..a3810c64b3 100644 --- a/api/classes/SequentialIdentifier.html +++ b/api/classes/SequentialIdentifier.html @@ -1,5 +1,5 @@ -SequentialIdentifier | docx

Class SequentialIdentifier

Hierarchy (view full)

  • Run
    • SequentialIdentifier

Constructors

constructor +SequentialIdentifier | docx

Class SequentialIdentifier

Hierarchy (view full)

  • Run
    • SequentialIdentifier

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Shading.html b/api/classes/Shading.html index 687c0417c5..a9dec5d387 100644 --- a/api/classes/Shading.html +++ b/api/classes/Shading.html @@ -1,5 +1,5 @@ -Shading | docx

Class Shading

Hierarchy (view full)

Constructors

constructor +Shading | docx

Class Shading

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimpleField.html b/api/classes/SimpleField.html index 4782225310..243f75f9f9 100644 --- a/api/classes/SimpleField.html +++ b/api/classes/SimpleField.html @@ -1,5 +1,5 @@ -SimpleField | docx

Class SimpleField

Hierarchy (view full)

Constructors

constructor +SimpleField | docx

Class SimpleField

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimpleMailMergeField.html b/api/classes/SimpleMailMergeField.html index 83a3168e1b..5e06ab8e0f 100644 --- a/api/classes/SimpleMailMergeField.html +++ b/api/classes/SimpleMailMergeField.html @@ -1,5 +1,5 @@ -SimpleMailMergeField | docx

Class SimpleMailMergeField

Hierarchy (view full)

Constructors

constructor +SimpleMailMergeField | docx

Class SimpleMailMergeField

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimplePos.html b/api/classes/SimplePos.html index 78632ddd6e..4b85be0f40 100644 --- a/api/classes/SimplePos.html +++ b/api/classes/SimplePos.html @@ -1,5 +1,5 @@ -SimplePos | docx

Class SimplePos

Hierarchy (view full)

Constructors

constructor +SimplePos | docx

Class SimplePos

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SoftHyphen.html b/api/classes/SoftHyphen.html index 73058ca3c1..47ec657ce8 100644 --- a/api/classes/SoftHyphen.html +++ b/api/classes/SoftHyphen.html @@ -1,5 +1,5 @@ -SoftHyphen | docx

Class SoftHyphen

Hierarchy (view full)

Constructors

constructor +SoftHyphen | docx

Class SoftHyphen

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Spacing.html b/api/classes/Spacing.html index e2340b1982..609de3a3ec 100644 --- a/api/classes/Spacing.html +++ b/api/classes/Spacing.html @@ -1,5 +1,5 @@ -Spacing | docx

Class Spacing

Hierarchy (view full)

Constructors

constructor +Spacing | docx

Class Spacing

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringContainer.html b/api/classes/StringContainer.html index 79ec3394ae..d9470a6b19 100644 --- a/api/classes/StringContainer.html +++ b/api/classes/StringContainer.html @@ -1,5 +1,5 @@ -StringContainer | docx

Class StringContainer

Hierarchy (view full)

Constructors

constructor +StringContainer | docx

Class StringContainer

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringEnumValueElement.html b/api/classes/StringEnumValueElement.html index ca7fe3b20d..dd0d780692 100644 --- a/api/classes/StringEnumValueElement.html +++ b/api/classes/StringEnumValueElement.html @@ -1,5 +1,5 @@ -StringEnumValueElement | docx

Class StringEnumValueElement<T>

Type Parameters

  • T extends string

Hierarchy (view full)

Constructors

constructor +StringEnumValueElement | docx

Class StringEnumValueElement<T>

Type Parameters

  • T extends string

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringValueElement.html b/api/classes/StringValueElement.html index 6066412e62..e04b8f5939 100644 --- a/api/classes/StringValueElement.html +++ b/api/classes/StringValueElement.html @@ -1,5 +1,5 @@ -StringValueElement | docx

Class StringValueElement

Hierarchy (view full)

Constructors

constructor +StringValueElement | docx

Class StringValueElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Style.html b/api/classes/Style.html index 7213a59332..1cbb615988 100644 --- a/api/classes/Style.html +++ b/api/classes/Style.html @@ -1,5 +1,5 @@ -Style | docx

Class Style

Hierarchy (view full)

Constructors

constructor +Style | docx

Class Style

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StyleForCharacter.html b/api/classes/StyleForCharacter.html index 98ef0a735b..716134ab2e 100644 --- a/api/classes/StyleForCharacter.html +++ b/api/classes/StyleForCharacter.html @@ -1,5 +1,5 @@ -StyleForCharacter | docx

Class StyleForCharacter

Hierarchy

  • Style
    • StyleForCharacter

Constructors

constructor +StyleForCharacter | docx

Class StyleForCharacter

Hierarchy

  • Style
    • StyleForCharacter

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StyleForParagraph.html b/api/classes/StyleForParagraph.html index d7334eee18..dae51118e9 100644 --- a/api/classes/StyleForParagraph.html +++ b/api/classes/StyleForParagraph.html @@ -1,5 +1,5 @@ -StyleForParagraph | docx

Class StyleForParagraph

Hierarchy

  • Style
    • StyleForParagraph

Constructors

constructor +StyleForParagraph | docx

Class StyleForParagraph

Hierarchy

  • Style
    • StyleForParagraph

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StyleLevel.html b/api/classes/StyleLevel.html index 0dc998853c..193af31b94 100644 --- a/api/classes/StyleLevel.html +++ b/api/classes/StyleLevel.html @@ -1,4 +1,4 @@ -StyleLevel | docx

Class StyleLevel

Constructors

constructor +StyleLevel | docx

Class StyleLevel

Constructors

constructor

Properties

level styleName -

Constructors

constructor

Properties

Readonlylevel

level: number

ReadonlystyleName

styleName: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlylevel

level: number

ReadonlystyleName

styleName: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/Styles.html b/api/classes/Styles.html index ad55de1955..c4cf2c58c6 100644 --- a/api/classes/Styles.html +++ b/api/classes/Styles.html @@ -1,5 +1,5 @@ -Styles | docx

Class Styles

Hierarchy (view full)

Constructors

constructor +Styles | docx

Class Styles

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SymbolRun.html b/api/classes/SymbolRun.html index 9774f5a850..b7dc7c0dee 100644 --- a/api/classes/SymbolRun.html +++ b/api/classes/SymbolRun.html @@ -1,5 +1,5 @@ -SymbolRun | docx

Class SymbolRun

Hierarchy (view full)

Constructors

constructor +SymbolRun | docx

Class SymbolRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TDirection.html b/api/classes/TDirection.html index 90b18afd9e..bc5bdd9b84 100644 --- a/api/classes/TDirection.html +++ b/api/classes/TDirection.html @@ -1,6 +1,6 @@ TDirection | docx

Class TDirection

Text Direction within a table cell

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Tab.html b/api/classes/Tab.html index 71c7ec1bb3..66bab6e0e7 100644 --- a/api/classes/Tab.html +++ b/api/classes/Tab.html @@ -1,5 +1,5 @@ -Tab | docx

Class Tab

Hierarchy (view full)

Constructors

constructor +Tab | docx

Class Tab

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TabAttributes.html b/api/classes/TabAttributes.html index 501605c1de..947dc8e24f 100644 --- a/api/classes/TabAttributes.html +++ b/api/classes/TabAttributes.html @@ -1,3 +1,3 @@ -TabAttributes | docx

Class TabAttributes

Hierarchy (view full)

Constructors

constructor +TabAttributes | docx

Class TabAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new TabAttributes(root): TabAttributes

  • Parameters

    • root: {
          leader?:
              | "none"
              | "dot"
              | "hyphen"
              | "underscore"
              | "middleDot";
          pos: string | number;
          val:
              | "center"
              | "clear"
              | "left"
              | "right"
              | "start"
              | "end"
              | "decimal"
              | "bar"
              | "num";
      }
      • Optional Readonlyleader?:
            | "none"
            | "dot"
            | "hyphen"
            | "underscore"
            | "middleDot"
      • Readonlypos: string | number
      • Readonlyval:
            | "center"
            | "clear"
            | "left"
            | "right"
            | "start"
            | "end"
            | "decimal"
            | "bar"
            | "num"

    Returns TabAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new TabAttributes(root): TabAttributes

  • Parameters

    • root: {
          leader?:
              | "none"
              | "dot"
              | "hyphen"
              | "underscore"
              | "middleDot";
          pos: string | number;
          val:
              | "center"
              | "clear"
              | "left"
              | "right"
              | "start"
              | "end"
              | "decimal"
              | "bar"
              | "num";
      }
      • Optional Readonlyleader?:
            | "none"
            | "dot"
            | "hyphen"
            | "underscore"
            | "middleDot"
      • Readonlypos: string | number
      • Readonlyval:
            | "center"
            | "clear"
            | "left"
            | "right"
            | "start"
            | "end"
            | "decimal"
            | "bar"
            | "num"

    Returns TabAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TabStop.html b/api/classes/TabStop.html index df1c0901f9..a7e7d09622 100644 --- a/api/classes/TabStop.html +++ b/api/classes/TabStop.html @@ -1,5 +1,5 @@ -TabStop | docx

Class TabStop

Hierarchy (view full)

Constructors

constructor +TabStop | docx

Class TabStop

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TabStopItem.html b/api/classes/TabStopItem.html index e96235e6ed..d28a857dba 100644 --- a/api/classes/TabStopItem.html +++ b/api/classes/TabStopItem.html @@ -1,5 +1,5 @@ -TabStopItem | docx

Class TabStopItem

Hierarchy (view full)

Constructors

constructor +TabStopItem | docx

Class TabStopItem

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Table.html b/api/classes/Table.html index b4ac561ce9..a6b90c3248 100644 --- a/api/classes/Table.html +++ b/api/classes/Table.html @@ -1,6 +1,6 @@ -Table | docx

Class Table

Hierarchy (view full)

Constructors

constructor +Table | docx

Class Table

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableBorders.html b/api/classes/TableBorders.html index b4f8baffdb..c4fde73370 100644 --- a/api/classes/TableBorders.html +++ b/api/classes/TableBorders.html @@ -1,6 +1,6 @@ -TableBorders | docx

Class TableBorders

Hierarchy (view full)

Constructors

constructor +TableBorders | docx

Class TableBorders

Hierarchy (view full)

Constructors

constructor

Properties

NONE

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Static ReadonlyNONE

NONE: {
    bottom: {
        color: string;
        size: number;
        style: "none";
    };
    insideHorizontal: {
        color: string;
        size: number;
        style: "none";
    };
    insideVertical: {
        color: string;
        size: number;
        style: "none";
    };
    left: {
        color: string;
        size: number;
        style: "none";
    };
    right: {
        color: string;
        size: number;
        style: "none";
    };
    top: {
        color: string;
        size: number;
        style: "none";
    };
} = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Static ReadonlyNONE

NONE: {
    bottom: {
        color: string;
        size: number;
        style: "none";
    };
    insideHorizontal: {
        color: string;
        size: number;
        style: "none";
    };
    insideVertical: {
        color: string;
        size: number;
        style: "none";
    };
    left: {
        color: string;
        size: number;
        style: "none";
    };
    right: {
        color: string;
        size: number;
        style: "none";
    };
    top: {
        color: string;
        size: number;
        style: "none";
    };
} = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableCell.html b/api/classes/TableCell.html index d3a05b2e11..8bd9fb5fed 100644 --- a/api/classes/TableCell.html +++ b/api/classes/TableCell.html @@ -1,6 +1,6 @@ -TableCell | docx

Class TableCell

Hierarchy (view full)

Constructors

constructor +TableCell | docx

Class TableCell

Hierarchy (view full)

Constructors

constructor

Properties

options

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyoptions

options: ITableCellOptions

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyoptions

options: ITableCellOptions

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableCellBorders.html b/api/classes/TableCellBorders.html index bbfa97cc18..72530840ea 100644 --- a/api/classes/TableCellBorders.html +++ b/api/classes/TableCellBorders.html @@ -1,5 +1,5 @@ -TableCellBorders | docx

Class TableCellBorders

Hierarchy (view full)

Constructors

constructor +TableCellBorders | docx

Class TableCellBorders

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableFloatProperties.html b/api/classes/TableFloatProperties.html index 96ea9affd1..54e1bd45f8 100644 --- a/api/classes/TableFloatProperties.html +++ b/api/classes/TableFloatProperties.html @@ -1,5 +1,5 @@ -TableFloatProperties | docx

Class TableFloatProperties

Hierarchy (view full)

Constructors

constructor +TableFloatProperties | docx

Class TableFloatProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableLayout.html b/api/classes/TableLayout.html index 3218e41714..0ded720d88 100644 --- a/api/classes/TableLayout.html +++ b/api/classes/TableLayout.html @@ -1,5 +1,5 @@ -TableLayout | docx

Class TableLayout

Hierarchy (view full)

Constructors

constructor +TableLayout | docx

Class TableLayout

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableOfContents.html b/api/classes/TableOfContents.html index b23ea362c5..f2c5ae248b 100644 --- a/api/classes/TableOfContents.html +++ b/api/classes/TableOfContents.html @@ -1,6 +1,6 @@ -TableOfContents | docx

Class TableOfContents

Hierarchy (view full)

Constructors

constructor +TableOfContents | docx

Class TableOfContents

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableProperties.html b/api/classes/TableProperties.html index 05829aa8a9..4fb82ae6e0 100644 --- a/api/classes/TableProperties.html +++ b/api/classes/TableProperties.html @@ -1,5 +1,5 @@ -TableProperties | docx

Class TableProperties

Hierarchy (view full)

Constructors

constructor +TableProperties | docx

Class TableProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRow.html b/api/classes/TableRow.html index 96ac9b7db8..69eebaaf81 100644 --- a/api/classes/TableRow.html +++ b/api/classes/TableRow.html @@ -1,4 +1,4 @@ -TableRow | docx

Class TableRow

Hierarchy (view full)

Constructors

constructor +TableRow | docx

Class TableRow

Hierarchy (view full)

Constructors

constructor

Accessors

CellCount cells

Methods

addCellToColumnIndex @@ -7,5 +7,5 @@ columnIndexToRootIndex prepForXml rootIndexToColumnIndex -

Constructors

constructor

Accessors

CellCount

cells

Methods

addCellToColumnIndex

addCellToIndex

addChildElement

columnIndexToRootIndex

  • columnIndexToRootIndex(columnIndex, allowEndNewCell?): number

  • Parameters

    • columnIndex: number
    • allowEndNewCell: boolean = false

    Returns number

prepForXml

rootIndexToColumnIndex

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

CellCount

cells

Methods

addCellToColumnIndex

addCellToIndex

addChildElement

columnIndexToRootIndex

  • columnIndexToRootIndex(columnIndex, allowEndNewCell?): number

  • Parameters

    • columnIndex: number
    • allowEndNewCell: boolean = false

    Returns number

prepForXml

rootIndexToColumnIndex

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/TableRowHeight.html b/api/classes/TableRowHeight.html index 57b291af0e..782a97096e 100644 --- a/api/classes/TableRowHeight.html +++ b/api/classes/TableRowHeight.html @@ -1,5 +1,5 @@ -TableRowHeight | docx

Class TableRowHeight

Hierarchy (view full)

Constructors

constructor +TableRowHeight | docx

Class TableRowHeight

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRowHeightAttributes.html b/api/classes/TableRowHeightAttributes.html index 80c8e83204..0b18d223c7 100644 --- a/api/classes/TableRowHeightAttributes.html +++ b/api/classes/TableRowHeightAttributes.html @@ -1,3 +1,3 @@ -TableRowHeightAttributes | docx

Class TableRowHeightAttributes

Hierarchy (view full)

Constructors

constructor +TableRowHeightAttributes | docx

Class TableRowHeightAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRowProperties.html b/api/classes/TableRowProperties.html index 5c551b0a26..81d5df5d93 100644 --- a/api/classes/TableRowProperties.html +++ b/api/classes/TableRowProperties.html @@ -1,5 +1,5 @@ -TableRowProperties | docx

Class TableRowProperties

Hierarchy (view full)

Constructors

constructor +TableRowProperties | docx

Class TableRowProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableWidthElement.html b/api/classes/TableWidthElement.html index c38f428314..7d25aac427 100644 --- a/api/classes/TableWidthElement.html +++ b/api/classes/TableWidthElement.html @@ -1,5 +1,5 @@ -TableWidthElement | docx

Class TableWidthElement

Hierarchy (view full)

Constructors

constructor +TableWidthElement | docx

Class TableWidthElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TextRun.html b/api/classes/TextRun.html index 48225fc559..e6be3227a2 100644 --- a/api/classes/TextRun.html +++ b/api/classes/TextRun.html @@ -1,5 +1,5 @@ -TextRun | docx

Class TextRun

Hierarchy (view full)

Constructors

constructor +TextRun | docx

Class TextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ThematicBreak.html b/api/classes/ThematicBreak.html index ae8435edb5..719f0d37d4 100644 --- a/api/classes/ThematicBreak.html +++ b/api/classes/ThematicBreak.html @@ -1,5 +1,5 @@ -ThematicBreak | docx

Class ThematicBreak

Hierarchy (view full)

Constructors

constructor +ThematicBreak | docx

Class ThematicBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Type.html b/api/classes/Type.html index 34e191cc7f..0aaaeba5af 100644 --- a/api/classes/Type.html +++ b/api/classes/Type.html @@ -1,5 +1,5 @@ -Type | docx

Class Type

Hierarchy (view full)

Constructors

constructor +Type | docx

Class Type

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Underline.html b/api/classes/Underline.html index 5968efc17a..e273c82b74 100644 --- a/api/classes/Underline.html +++ b/api/classes/Underline.html @@ -1,5 +1,5 @@ -Underline | docx

Class Underline

Hierarchy (view full)

Constructors

constructor +Underline | docx

Class Underline

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new Underline(underlineType?, color?): Underline

  • Parameters

    • underlineType:
          | "single"
          | "dotDash"
          | "dotDotDash"
          | "dotted"
          | "double"
          | "none"
          | "thick"
          | "wave"
          | "words"
          | "dottedHeavy"
          | "dash"
          | "dashedHeavy"
          | "dashLong"
          | "dashLongHeavy"
          | "dashDotHeavy"
          | "dashDotDotHeavy"
          | "wavyHeavy"
          | "wavyDouble" = UnderlineType.SINGLE
    • Optionalcolor: string

    Returns Underline

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new Underline(underlineType?, color?): Underline

  • Parameters

    • underlineType:
          | "single"
          | "dotDash"
          | "dotDotDash"
          | "dotted"
          | "double"
          | "none"
          | "thick"
          | "wave"
          | "words"
          | "dottedHeavy"
          | "dash"
          | "dashedHeavy"
          | "dashLong"
          | "dashLongHeavy"
          | "dashDotHeavy"
          | "dashDotDotHeavy"
          | "wavyHeavy"
          | "wavyDouble" = UnderlineType.SINGLE
    • Optionalcolor: string

    Returns Underline

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalAlignAttributes.html b/api/classes/VerticalAlignAttributes.html index b7cbb321b1..bf342a79a3 100644 --- a/api/classes/VerticalAlignAttributes.html +++ b/api/classes/VerticalAlignAttributes.html @@ -1,3 +1,3 @@ -VerticalAlignAttributes | docx

Class VerticalAlignAttributes

Hierarchy (view full)

Constructors

constructor +VerticalAlignAttributes | docx

Class VerticalAlignAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalAlignElement.html b/api/classes/VerticalAlignElement.html index 51656cd6ae..55f9b27800 100644 --- a/api/classes/VerticalAlignElement.html +++ b/api/classes/VerticalAlignElement.html @@ -1,5 +1,5 @@ -VerticalAlignElement | docx

Class VerticalAlignElement

Hierarchy (view full)

Constructors

constructor +VerticalAlignElement | docx

Class VerticalAlignElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalMerge.html b/api/classes/VerticalMerge.html index 17ccbfd1f4..555ee78ce5 100644 --- a/api/classes/VerticalMerge.html +++ b/api/classes/VerticalMerge.html @@ -1,6 +1,6 @@ VerticalMerge | docx

Class VerticalMerge

Vertical merge element. Should be used in a table cell.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalPosition.html b/api/classes/VerticalPosition.html index 53888deb8e..045069164e 100644 --- a/api/classes/VerticalPosition.html +++ b/api/classes/VerticalPosition.html @@ -1,5 +1,5 @@ -VerticalPosition | docx

Class VerticalPosition

Hierarchy (view full)

Constructors

constructor +VerticalPosition | docx

Class VerticalPosition

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapNone.html b/api/classes/WrapNone.html index 7df550e624..8f3dfebbd0 100644 --- a/api/classes/WrapNone.html +++ b/api/classes/WrapNone.html @@ -1,5 +1,5 @@ -WrapNone | docx

Class WrapNone

Hierarchy (view full)

Constructors

constructor +WrapNone | docx

Class WrapNone

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapSquare.html b/api/classes/WrapSquare.html index 8cd81a8e4b..8ac41d7b0f 100644 --- a/api/classes/WrapSquare.html +++ b/api/classes/WrapSquare.html @@ -1,5 +1,5 @@ -WrapSquare | docx

Class WrapSquare

Hierarchy (view full)

Constructors

constructor +WrapSquare | docx

Class WrapSquare

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapTight.html b/api/classes/WrapTight.html index e6f1cbf192..39eee7e2ba 100644 --- a/api/classes/WrapTight.html +++ b/api/classes/WrapTight.html @@ -1,5 +1,5 @@ -WrapTight | docx

Class WrapTight

Hierarchy (view full)

Constructors

constructor +WrapTight | docx

Class WrapTight

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapTopAndBottom.html b/api/classes/WrapTopAndBottom.html index 4a72a04170..eea5258fe9 100644 --- a/api/classes/WrapTopAndBottom.html +++ b/api/classes/WrapTopAndBottom.html @@ -1,5 +1,5 @@ -WrapTopAndBottom | docx

Class WrapTopAndBottom

Hierarchy (view full)

Constructors

constructor +WrapTopAndBottom | docx

Class WrapTopAndBottom

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/XmlAttributeComponent.html b/api/classes/XmlAttributeComponent.html index 90c99f3983..cb3a8b67b9 100644 --- a/api/classes/XmlAttributeComponent.html +++ b/api/classes/XmlAttributeComponent.html @@ -1,3 +1,3 @@ -XmlAttributeComponent | docx

Class XmlAttributeComponent<T>Abstract

Type Parameters

  • T extends {
        [key: string]: any;
    }

Hierarchy (view full)

Constructors

constructor +XmlAttributeComponent | docx

Class XmlAttributeComponent<T>Abstract

Type Parameters

  • T extends {
        [key: string]: any;
    }

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/XmlComponent.html b/api/classes/XmlComponent.html index 9f72a26d71..4724c47deb 100644 --- a/api/classes/XmlComponent.html +++ b/api/classes/XmlComponent.html @@ -1,5 +1,5 @@ -XmlComponent | docx

Class XmlComponentAbstract

Hierarchy (view full)

Constructors

constructor +XmlComponent | docx

Class XmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/YearLong.html b/api/classes/YearLong.html index de7a8a7825..863b7ebdcd 100644 --- a/api/classes/YearLong.html +++ b/api/classes/YearLong.html @@ -1,5 +1,5 @@ -YearLong | docx

Class YearLong

Hierarchy (view full)

Constructors

constructor +YearLong | docx

Class YearLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/YearShort.html b/api/classes/YearShort.html index 9ec46a4b7b..825ac229b8 100644 --- a/api/classes/YearShort.html +++ b/api/classes/YearShort.html @@ -1,5 +1,5 @@ -YearShort | docx

Class YearShort

Hierarchy (view full)

Constructors

constructor +YearShort | docx

Class YearShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/functions/abstractNumUniqueNumericIdGen.html b/api/functions/abstractNumUniqueNumericIdGen.html index 78b8e2a759..1affc142eb 100644 --- a/api/functions/abstractNumUniqueNumericIdGen.html +++ b/api/functions/abstractNumUniqueNumericIdGen.html @@ -1 +1 @@ -abstractNumUniqueNumericIdGen | docx

Function abstractNumUniqueNumericIdGen

Settings

Member Visibility
+abstractNumUniqueNumericIdGen | docx

Function abstractNumUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/bookmarkUniqueNumericIdGen.html b/api/functions/bookmarkUniqueNumericIdGen.html index 43cd89331a..8565641a9c 100644 --- a/api/functions/bookmarkUniqueNumericIdGen.html +++ b/api/functions/bookmarkUniqueNumericIdGen.html @@ -1 +1 @@ -bookmarkUniqueNumericIdGen | docx

Function bookmarkUniqueNumericIdGen

Settings

Member Visibility
+bookmarkUniqueNumericIdGen | docx

Function bookmarkUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/concreteNumUniqueNumericIdGen.html b/api/functions/concreteNumUniqueNumericIdGen.html index f5ecb0587f..66339adbf7 100644 --- a/api/functions/concreteNumUniqueNumericIdGen.html +++ b/api/functions/concreteNumUniqueNumericIdGen.html @@ -1 +1 @@ -concreteNumUniqueNumericIdGen | docx

Function concreteNumUniqueNumericIdGen

Settings

Member Visibility
+concreteNumUniqueNumericIdGen | docx

Function concreteNumUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/convertInchesToTwip.html b/api/functions/convertInchesToTwip.html index 542633fbf0..c32a07eeeb 100644 --- a/api/functions/convertInchesToTwip.html +++ b/api/functions/convertInchesToTwip.html @@ -1 +1 @@ -convertInchesToTwip | docx

Function convertInchesToTwip

Settings

Member Visibility
+convertInchesToTwip | docx

Function convertInchesToTwip

Settings

Member Visibility
diff --git a/api/functions/convertMillimetersToTwip.html b/api/functions/convertMillimetersToTwip.html index fce3efcf26..ca3b5f9321 100644 --- a/api/functions/convertMillimetersToTwip.html +++ b/api/functions/convertMillimetersToTwip.html @@ -1 +1 @@ -convertMillimetersToTwip | docx

Function convertMillimetersToTwip

Settings

Member Visibility
+convertMillimetersToTwip | docx

Function convertMillimetersToTwip

Settings

Member Visibility
diff --git a/api/functions/convertToXmlComponent.html b/api/functions/convertToXmlComponent.html index cf87058960..e2a4084f5e 100644 --- a/api/functions/convertToXmlComponent.html +++ b/api/functions/convertToXmlComponent.html @@ -1,3 +1,3 @@ convertToXmlComponent | docx

Function convertToXmlComponent

Converts the given xml element (in json format) into XmlComponent.

Settings

Member Visibility
+

Returns undefined | string | ImportedXmlComponent

Settings

Member Visibility
diff --git a/api/functions/createFrameProperties.html b/api/functions/createFrameProperties.html index d44e2ad184..705794dd2d 100644 --- a/api/functions/createFrameProperties.html +++ b/api/functions/createFrameProperties.html @@ -1 +1 @@ -createFrameProperties | docx

Function createFrameProperties

Settings

Member Visibility
+createFrameProperties | docx

Function createFrameProperties

Settings

Member Visibility
diff --git a/api/functions/createLineNumberType.html b/api/functions/createLineNumberType.html index 85003368fd..edc2dcd581 100644 --- a/api/functions/createLineNumberType.html +++ b/api/functions/createLineNumberType.html @@ -1 +1 @@ -createLineNumberType | docx

Function createLineNumberType

Settings

Member Visibility
+createLineNumberType | docx

Function createLineNumberType

Settings

Member Visibility
diff --git a/api/functions/createStringElement.html b/api/functions/createStringElement.html index b648ad0b9e..b6518b4431 100644 --- a/api/functions/createStringElement.html +++ b/api/functions/createStringElement.html @@ -1 +1 @@ -createStringElement | docx

Function createStringElement

Settings

Member Visibility
+createStringElement | docx

Function createStringElement

Settings

Member Visibility
diff --git a/api/functions/dateTimeValue.html b/api/functions/dateTimeValue.html index 32a964075a..ebdf6ead5f 100644 --- a/api/functions/dateTimeValue.html +++ b/api/functions/dateTimeValue.html @@ -1 +1 @@ -dateTimeValue | docx

Function dateTimeValue

Settings

Member Visibility
+dateTimeValue | docx

Function dateTimeValue

Settings

Member Visibility
diff --git a/api/functions/decimalNumber.html b/api/functions/decimalNumber.html index 77dd0f5cf3..e3b20a5f69 100644 --- a/api/functions/decimalNumber.html +++ b/api/functions/decimalNumber.html @@ -1 +1 @@ -decimalNumber | docx

Function decimalNumber

  • decimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+decimalNumber | docx

Function decimalNumber

  • decimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/docPropertiesUniqueNumericIdGen.html b/api/functions/docPropertiesUniqueNumericIdGen.html index cb7f2a271d..421807151f 100644 --- a/api/functions/docPropertiesUniqueNumericIdGen.html +++ b/api/functions/docPropertiesUniqueNumericIdGen.html @@ -1 +1 @@ -docPropertiesUniqueNumericIdGen | docx

Function docPropertiesUniqueNumericIdGen

Settings

Member Visibility
+docPropertiesUniqueNumericIdGen | docx

Function docPropertiesUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/eighthPointMeasureValue.html b/api/functions/eighthPointMeasureValue.html index 4f377c1822..f803bc7070 100644 --- a/api/functions/eighthPointMeasureValue.html +++ b/api/functions/eighthPointMeasureValue.html @@ -1 +1 @@ -eighthPointMeasureValue | docx

Function eighthPointMeasureValue

  • eighthPointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+eighthPointMeasureValue | docx

Function eighthPointMeasureValue

  • eighthPointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/hashedId.html b/api/functions/hashedId.html index 0226798c22..76a0c8bc98 100644 --- a/api/functions/hashedId.html +++ b/api/functions/hashedId.html @@ -1 +1 @@ -hashedId | docx

Function hashedId

  • hashedId(data): string

  • Parameters

    • data:
          | string
          | Buffer
          | Uint8Array
          | ArrayBuffer

    Returns string

Settings

Member Visibility
+hashedId | docx

Function hashedId

  • hashedId(data): string

  • Parameters

    • data:
          | string
          | Buffer
          | Uint8Array
          | ArrayBuffer

    Returns string

Settings

Member Visibility
diff --git a/api/functions/hexColorValue.html b/api/functions/hexColorValue.html index 0428876b89..7c19a98ab9 100644 --- a/api/functions/hexColorValue.html +++ b/api/functions/hexColorValue.html @@ -1 +1 @@ -hexColorValue | docx

Function hexColorValue

  • hexColorValue(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+hexColorValue | docx

Function hexColorValue

  • hexColorValue(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/hpsMeasureValue.html b/api/functions/hpsMeasureValue.html index 354b383341..9341ffa3ea 100644 --- a/api/functions/hpsMeasureValue.html +++ b/api/functions/hpsMeasureValue.html @@ -1 +1 @@ -hpsMeasureValue | docx

Function hpsMeasureValue

  • hpsMeasureValue(val): string | number

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`

    Returns string | number

Settings

Member Visibility
+hpsMeasureValue | docx

Function hpsMeasureValue

  • hpsMeasureValue(val): string | number

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`

    Returns string | number

Settings

Member Visibility
diff --git a/api/functions/longHexNumber.html b/api/functions/longHexNumber.html index cee4bc9a1d..56a179f4c7 100644 --- a/api/functions/longHexNumber.html +++ b/api/functions/longHexNumber.html @@ -1 +1 @@ -longHexNumber | docx

Function longHexNumber

  • longHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+longHexNumber | docx

Function longHexNumber

  • longHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/measurementOrPercentValue.html b/api/functions/measurementOrPercentValue.html index dca0432044..d5e51b94a3 100644 --- a/api/functions/measurementOrPercentValue.html +++ b/api/functions/measurementOrPercentValue.html @@ -1 +1 @@ -measurementOrPercentValue | docx

Function measurementOrPercentValue

  • measurementOrPercentValue(val):
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`
        | `${number}%`
        | `-${number}%`

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`
          | `${number}%`
          | `-${number}%`

    Returns
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`
        | `${number}%`
        | `-${number}%`

Settings

Member Visibility
+measurementOrPercentValue | docx

Function measurementOrPercentValue

  • measurementOrPercentValue(val):
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`
        | `${number}%`
        | `-${number}%`

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`
          | `${number}%`
          | `-${number}%`

    Returns
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`
        | `${number}%`
        | `-${number}%`

Settings

Member Visibility
diff --git a/api/functions/patchDetector.html b/api/functions/patchDetector.html index 8b429c580d..8fe8b91622 100644 --- a/api/functions/patchDetector.html +++ b/api/functions/patchDetector.html @@ -1,2 +1,2 @@ patchDetector | docx

Function patchDetector

Detects which patches are needed/present in a template

-
  • patchDetector(__namedParameters): Promise<readonly string[]>

  • Parameters

    • __namedParameters: PatchDetectorOptions

    Returns Promise<readonly string[]>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/functions/patchDocument.html b/api/functions/patchDocument.html index 7441f6e714..aa7438f3cc 100644 --- a/api/functions/patchDocument.html +++ b/api/functions/patchDocument.html @@ -1 +1 @@ -patchDocument | docx

Function patchDocument

  • patchDocument<T>(__namedParameters): Promise<OutputByType[T]>

  • Type Parameters

    • T extends keyof OutputByType = keyof OutputByType

    Parameters

    Returns Promise<OutputByType[T]>

Settings

Member Visibility
+patchDocument | docx

Function patchDocument

  • patchDocument<T>(__namedParameters): Promise<OutputByType[T]>

  • Type Parameters

    • T extends keyof OutputByType = keyof OutputByType

    Parameters

    Returns Promise<OutputByType[T]>

Settings

Member Visibility
diff --git a/api/functions/percentageValue.html b/api/functions/percentageValue.html index 005ccc1754..1bf90fa4cb 100644 --- a/api/functions/percentageValue.html +++ b/api/functions/percentageValue.html @@ -1 +1 @@ -percentageValue | docx

Function percentageValue

  • percentageValue(val): `${number}%` | `-${number}%`

  • Parameters

    • val: `${number}%` | `-${number}%`

    Returns `${number}%` | `-${number}%`

Settings

Member Visibility
+percentageValue | docx

Function percentageValue

  • percentageValue(val): `${number}%` | `-${number}%`

  • Parameters

    • val: `${number}%` | `-${number}%`

    Returns `${number}%` | `-${number}%`

Settings

Member Visibility
diff --git a/api/functions/pointMeasureValue.html b/api/functions/pointMeasureValue.html index 2af17da14f..42de8f1670 100644 --- a/api/functions/pointMeasureValue.html +++ b/api/functions/pointMeasureValue.html @@ -1 +1 @@ -pointMeasureValue | docx

Function pointMeasureValue

  • pointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+pointMeasureValue | docx

Function pointMeasureValue

  • pointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/positiveUniversalMeasureValue.html b/api/functions/positiveUniversalMeasureValue.html index 5921680c20..7c9f0889fb 100644 --- a/api/functions/positiveUniversalMeasureValue.html +++ b/api/functions/positiveUniversalMeasureValue.html @@ -1 +1 @@ -positiveUniversalMeasureValue | docx

Function positiveUniversalMeasureValue

  • positiveUniversalMeasureValue(val):
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`

  • Parameters

    • val:
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`

    Returns
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`

Settings

Member Visibility
+positiveUniversalMeasureValue | docx

Function positiveUniversalMeasureValue

  • positiveUniversalMeasureValue(val):
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`

  • Parameters

    • val:
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`

    Returns
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`

Settings

Member Visibility
diff --git a/api/functions/shortHexNumber.html b/api/functions/shortHexNumber.html index c72c0e7846..0b63ca7ce5 100644 --- a/api/functions/shortHexNumber.html +++ b/api/functions/shortHexNumber.html @@ -1 +1 @@ -shortHexNumber | docx

Function shortHexNumber

  • shortHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+shortHexNumber | docx

Function shortHexNumber

  • shortHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/signedHpsMeasureValue.html b/api/functions/signedHpsMeasureValue.html index e8ca586cb3..45ac08cbc7 100644 --- a/api/functions/signedHpsMeasureValue.html +++ b/api/functions/signedHpsMeasureValue.html @@ -1 +1 @@ -signedHpsMeasureValue | docx

Function signedHpsMeasureValue

  • signedHpsMeasureValue(val): string | number

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`

    Returns string | number

Settings

Member Visibility
+signedHpsMeasureValue | docx

Function signedHpsMeasureValue

  • signedHpsMeasureValue(val): string | number

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`

    Returns string | number

Settings

Member Visibility
diff --git a/api/functions/signedTwipsMeasureValue.html b/api/functions/signedTwipsMeasureValue.html index 77946fff8e..a429f7d7e7 100644 --- a/api/functions/signedTwipsMeasureValue.html +++ b/api/functions/signedTwipsMeasureValue.html @@ -1 +1 @@ -signedTwipsMeasureValue | docx

Function signedTwipsMeasureValue

  • signedTwipsMeasureValue(val):
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`

    Returns
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`

Settings

Member Visibility
+signedTwipsMeasureValue | docx

Function signedTwipsMeasureValue

  • signedTwipsMeasureValue(val):
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`

    Returns
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`

Settings

Member Visibility
diff --git a/api/functions/twipsMeasureValue.html b/api/functions/twipsMeasureValue.html index e47ba6dbe3..12c04cad4b 100644 --- a/api/functions/twipsMeasureValue.html +++ b/api/functions/twipsMeasureValue.html @@ -1 +1 @@ -twipsMeasureValue | docx

Function twipsMeasureValue

  • twipsMeasureValue(val):
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`

    Returns
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`

Settings

Member Visibility
+twipsMeasureValue | docx

Function twipsMeasureValue

  • twipsMeasureValue(val):
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`

  • Parameters

    • val:
          | number
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`

    Returns
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`

Settings

Member Visibility
diff --git a/api/functions/uCharHexNumber.html b/api/functions/uCharHexNumber.html index c6eac1be36..3f0221a468 100644 --- a/api/functions/uCharHexNumber.html +++ b/api/functions/uCharHexNumber.html @@ -1 +1 @@ -uCharHexNumber | docx

Function uCharHexNumber

  • uCharHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+uCharHexNumber | docx

Function uCharHexNumber

  • uCharHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/uniqueId.html b/api/functions/uniqueId.html index b5a36cacaf..eb154b9878 100644 --- a/api/functions/uniqueId.html +++ b/api/functions/uniqueId.html @@ -1 +1 @@ -uniqueId | docx

Function uniqueId

Settings

Member Visibility
+uniqueId | docx

Function uniqueId

Settings

Member Visibility
diff --git a/api/functions/uniqueNumericIdCreator-1.html b/api/functions/uniqueNumericIdCreator-1.html index 10942c0abe..3691347dd5 100644 --- a/api/functions/uniqueNumericIdCreator-1.html +++ b/api/functions/uniqueNumericIdCreator-1.html @@ -1 +1 @@ -uniqueNumericIdCreator | docx

Function uniqueNumericIdCreator

Settings

Member Visibility
+uniqueNumericIdCreator | docx

Function uniqueNumericIdCreator

Settings

Member Visibility
diff --git a/api/functions/uniqueUuid.html b/api/functions/uniqueUuid.html index aaa491752e..e29bb428f1 100644 --- a/api/functions/uniqueUuid.html +++ b/api/functions/uniqueUuid.html @@ -1 +1 @@ -uniqueUuid | docx

Function uniqueUuid

Settings

Member Visibility
+uniqueUuid | docx

Function uniqueUuid

Settings

Member Visibility
diff --git a/api/functions/universalMeasureValue.html b/api/functions/universalMeasureValue.html index 5671514c9f..bc48ef9ed1 100644 --- a/api/functions/universalMeasureValue.html +++ b/api/functions/universalMeasureValue.html @@ -1 +1 @@ -universalMeasureValue | docx

Function universalMeasureValue

  • universalMeasureValue(val):
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`

  • Parameters

    • val:
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`

    Returns
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`

Settings

Member Visibility
+universalMeasureValue | docx

Function universalMeasureValue

  • universalMeasureValue(val):
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`

  • Parameters

    • val:
          | `${number}mm`
          | `${number}cm`
          | `${number}in`
          | `${number}pt`
          | `${number}pc`
          | `${number}pi`
          | `-${number}mm`
          | `-${number}cm`
          | `-${number}in`
          | `-${number}pt`
          | `-${number}pc`
          | `-${number}pi`

    Returns
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`

Settings

Member Visibility
diff --git a/api/functions/unsignedDecimalNumber.html b/api/functions/unsignedDecimalNumber.html index f30b103b4a..4360f2ea82 100644 --- a/api/functions/unsignedDecimalNumber.html +++ b/api/functions/unsignedDecimalNumber.html @@ -1 +1 @@ -unsignedDecimalNumber | docx

Function unsignedDecimalNumber

  • unsignedDecimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+unsignedDecimalNumber | docx

Function unsignedDecimalNumber

  • unsignedDecimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/interfaces/IAlignmentFrameOptions.html b/api/interfaces/IAlignmentFrameOptions.html index 8dd7ae5d97..2e00e039a8 100644 --- a/api/interfaces/IAlignmentFrameOptions.html +++ b/api/interfaces/IAlignmentFrameOptions.html @@ -1,4 +1,4 @@ -IAlignmentFrameOptions | docx

Interface IAlignmentFrameOptions

interface IAlignmentFrameOptions {
    alignment: {
        x:
            | "center"
            | "left"
            | "right"
            | "inside"
            | "outside";
        y:
            | "bottom"
            | "center"
            | "top"
            | "inside"
            | "outside";
    };
    anchor: {
        horizontal: "text" | "margin" | "page";
        vertical: "text" | "margin" | "page";
    };
    anchorLock?: boolean;
    dropCap?: "none" | "margin" | "drop";
    height: number;
    lines?: number;
    rule?: "auto" | "atLeast" | "exact";
    space?: {
        horizontal: number;
        vertical: number;
    };
    type: "alignment";
    width: number;
    wrap?:
        | "auto"
        | "none"
        | "around"
        | "notBeside"
        | "through"
        | "tight";
}

Hierarchy

  • IBaseFrameOptions
    • IAlignmentFrameOptions

Properties

alignment +IAlignmentFrameOptions | docx

Interface IAlignmentFrameOptions

interface IAlignmentFrameOptions {
    alignment: {
        x:
            | "center"
            | "left"
            | "right"
            | "inside"
            | "outside";
        y:
            | "bottom"
            | "center"
            | "top"
            | "inside"
            | "outside";
    };
    anchor: {
        horizontal: "text" | "margin" | "page";
        vertical: "text" | "margin" | "page";
    };
    anchorLock?: boolean;
    dropCap?: "none" | "margin" | "drop";
    height: number;
    lines?: number;
    rule?: "auto" | "atLeast" | "exact";
    space?: {
        horizontal: number;
        vertical: number;
    };
    type: "alignment";
    width: number;
    wrap?:
        | "auto"
        | "none"
        | "around"
        | "notBeside"
        | "through"
        | "tight";
}

Hierarchy

  • IBaseFrameOptions
    • IAlignmentFrameOptions

Properties

alignment anchor anchorLock? dropCap? @@ -9,4 +9,4 @@ type width wrap? -

Properties

Readonlyalignment

alignment: {
    x:
        | "center"
        | "left"
        | "right"
        | "inside"
        | "outside";
    y:
        | "bottom"
        | "center"
        | "top"
        | "inside"
        | "outside";
}

Readonlyanchor

anchor: {
    horizontal: "text" | "margin" | "page";
    vertical: "text" | "margin" | "page";
}

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

dropCap?: "none" | "margin" | "drop"

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Optional Readonlyrule

rule?: "auto" | "atLeast" | "exact"

Optional Readonlyspace

space?: {
    horizontal: number;
    vertical: number;
}

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

wrap?:
    | "auto"
    | "none"
    | "around"
    | "notBeside"
    | "through"
    | "tight"

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyalignment

alignment: {
    x:
        | "center"
        | "left"
        | "right"
        | "inside"
        | "outside";
    y:
        | "bottom"
        | "center"
        | "top"
        | "inside"
        | "outside";
}

Readonlyanchor

anchor: {
    horizontal: "text" | "margin" | "page";
    vertical: "text" | "margin" | "page";
}

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

dropCap?: "none" | "margin" | "drop"

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Optional Readonlyrule

rule?: "auto" | "atLeast" | "exact"

Optional Readonlyspace

space?: {
    horizontal: number;
    vertical: number;
}

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

wrap?:
    | "auto"
    | "none"
    | "around"
    | "notBeside"
    | "through"
    | "tight"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBaseCharacterStyleOptions.html b/api/interfaces/IBaseCharacterStyleOptions.html index 8b5ed4570d..71725f6062 100644 --- a/api/interfaces/IBaseCharacterStyleOptions.html +++ b/api/interfaces/IBaseCharacterStyleOptions.html @@ -1,4 +1,4 @@ -IBaseCharacterStyleOptions | docx

Interface IBaseCharacterStyleOptions

interface IBaseCharacterStyleOptions {
    basedOn?: string;
    link?: string;
    name?: string;
    next?: string;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy (view full)

Properties

basedOn? +IBaseCharacterStyleOptions | docx

Interface IBaseCharacterStyleOptions

interface IBaseCharacterStyleOptions {
    basedOn?: string;
    link?: string;
    name?: string;
    next?: string;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy (view full)

Properties

basedOn? link? name? next? @@ -11,4 +11,4 @@ Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored. However, if the current style is a numbering style, then the basedOn element is ignored.

WARNING: You cannot set basedOn to be the same as name. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.

-

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBaseParagraphStyleOptions.html b/api/interfaces/IBaseParagraphStyleOptions.html index 5a17d9352a..b789ff8639 100644 --- a/api/interfaces/IBaseParagraphStyleOptions.html +++ b/api/interfaces/IBaseParagraphStyleOptions.html @@ -1,4 +1,4 @@ -IBaseParagraphStyleOptions | docx

Interface IBaseParagraphStyleOptions

interface IBaseParagraphStyleOptions {
    basedOn?: string;
    link?: string;
    name?: string;
    next?: string;
    paragraph?: IParagraphStylePropertiesOptions;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy (view full)

Properties

basedOn? +IBaseParagraphStyleOptions | docx

Interface IBaseParagraphStyleOptions

interface IBaseParagraphStyleOptions {
    basedOn?: string;
    link?: string;
    name?: string;
    next?: string;
    paragraph?: IParagraphStylePropertiesOptions;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy (view full)

Properties

basedOn? link? name? next? @@ -12,4 +12,4 @@ Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored. However, if the current style is a numbering style, then the basedOn element is ignored.

WARNING: You cannot set basedOn to be the same as name. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.

-

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBorderOptions.html b/api/interfaces/IBorderOptions.html index 9453be1e6d..8c0a6d64b9 100644 --- a/api/interfaces/IBorderOptions.html +++ b/api/interfaces/IBorderOptions.html @@ -1,8 +1,8 @@ -IBorderOptions | docx

Interface IBorderOptions

interface IBorderOptions {
    color?: string;
    size?: number;
    space?: number;
    style:
        | "nil"
        | "single"
        | "dashDotStroked"
        | "dashed"
        | "dashSmallGap"
        | "dotDash"
        | "dotDotDash"
        | "dotted"
        | "double"
        | "doubleWave"
        | "inset"
        | "none"
        | "outset"
        | "thick"
        | "thickThinLargeGap"
        | "thickThinMediumGap"
        | "thickThinSmallGap"
        | "thinThickLargeGap"
        | "thinThickMediumGap"
        | "thinThickSmallGap"
        | "thinThickThinLargeGap"
        | "thinThickThinMediumGap"
        | "thinThickThinSmallGap"
        | "threeDEmboss"
        | "threeDEngrave"
        | "triple"
        | "wave";
}

Properties

color? +IBorderOptions | docx

Interface IBorderOptions

interface IBorderOptions {
    color?: string;
    size?: number;
    space?: number;
    style:
        | "nil"
        | "single"
        | "dashDotStroked"
        | "dashed"
        | "dashSmallGap"
        | "dotDash"
        | "dotDotDash"
        | "dotted"
        | "double"
        | "doubleWave"
        | "inset"
        | "none"
        | "outset"
        | "thick"
        | "thickThinLargeGap"
        | "thickThinMediumGap"
        | "thickThinSmallGap"
        | "thinThickLargeGap"
        | "thinThickMediumGap"
        | "thinThickSmallGap"
        | "thinThickThinLargeGap"
        | "thinThickThinMediumGap"
        | "thinThickThinSmallGap"
        | "threeDEmboss"
        | "threeDEngrave"
        | "triple"
        | "wave";
}

Properties

color? size? space? style

Properties

Optional Readonlycolor

color?: string

Border color, in hex (eg 'FF00AA')

-

Optional Readonlysize

size?: number

Size of the border in 1/8 pt

-

Optional Readonlyspace

space?: number

Spacing offset. Values are specified in pt

-

Readonlystyle

style:
    | "nil"
    | "single"
    | "dashDotStroked"
    | "dashed"
    | "dashSmallGap"
    | "dotDash"
    | "dotDotDash"
    | "dotted"
    | "double"
    | "doubleWave"
    | "inset"
    | "none"
    | "outset"
    | "thick"
    | "thickThinLargeGap"
    | "thickThinMediumGap"
    | "thickThinSmallGap"
    | "thinThickLargeGap"
    | "thinThickMediumGap"
    | "thinThickSmallGap"
    | "thinThickThinLargeGap"
    | "thinThickThinMediumGap"
    | "thinThickThinSmallGap"
    | "threeDEmboss"
    | "threeDEngrave"
    | "triple"
    | "wave"

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlysize

size?: number

Size of the border in 1/8 pt

+

Optional Readonlyspace

space?: number

Spacing offset. Values are specified in pt

+

Readonlystyle

style:
    | "nil"
    | "single"
    | "dashDotStroked"
    | "dashed"
    | "dashSmallGap"
    | "dotDash"
    | "dotDotDash"
    | "dotted"
    | "double"
    | "doubleWave"
    | "inset"
    | "none"
    | "outset"
    | "thick"
    | "thickThinLargeGap"
    | "thickThinMediumGap"
    | "thickThinSmallGap"
    | "thinThickLargeGap"
    | "thinThickMediumGap"
    | "thinThickSmallGap"
    | "thinThickThinLargeGap"
    | "thinThickThinMediumGap"
    | "thinThickThinSmallGap"
    | "threeDEmboss"
    | "threeDEngrave"
    | "triple"
    | "wave"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBordersOptions.html b/api/interfaces/IBordersOptions.html index 0c5dc62e81..7a29820ebd 100644 --- a/api/interfaces/IBordersOptions.html +++ b/api/interfaces/IBordersOptions.html @@ -1,5 +1,5 @@ -IBordersOptions | docx

Interface IBordersOptions

interface IBordersOptions {
    bottom?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? +IBordersOptions | docx

Interface IBordersOptions

interface IBordersOptions {
    bottom?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? left? right? top? -

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICharacterStyleOptions.html b/api/interfaces/ICharacterStyleOptions.html index f1df56599d..8e7b054056 100644 --- a/api/interfaces/ICharacterStyleOptions.html +++ b/api/interfaces/ICharacterStyleOptions.html @@ -1,4 +1,4 @@ -ICharacterStyleOptions | docx

Interface ICharacterStyleOptions

interface ICharacterStyleOptions {
    basedOn?: string;
    id: string;
    link?: string;
    name?: string;
    next?: string;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy (view full)

Properties

basedOn? +ICharacterStyleOptions | docx

Interface ICharacterStyleOptions

interface ICharacterStyleOptions {
    basedOn?: string;
    id: string;
    link?: string;
    name?: string;
    next?: string;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy (view full)

Properties

basedOn? id link? name? @@ -12,4 +12,4 @@ Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored. However, if the current style is a numbering style, then the basedOn element is ignored.

WARNING: You cannot set basedOn to be the same as name. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.

-

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICheckboxSymbolOptions.html b/api/interfaces/ICheckboxSymbolOptions.html index 2e22da079b..101d62a9ba 100644 --- a/api/interfaces/ICheckboxSymbolOptions.html +++ b/api/interfaces/ICheckboxSymbolOptions.html @@ -1,5 +1,5 @@ -ICheckboxSymbolOptions | docx

Interface ICheckboxSymbolOptions

interface ICheckboxSymbolOptions {
    alias?: string;
    checked?: boolean;
    checkedState?: ICheckboxSymbolProperties;
    uncheckedState?: ICheckboxSymbolProperties;
}

Properties

alias? +ICheckboxSymbolOptions | docx

Interface ICheckboxSymbolOptions

interface ICheckboxSymbolOptions {
    alias?: string;
    checked?: boolean;
    checkedState?: ICheckboxSymbolProperties;
    uncheckedState?: ICheckboxSymbolProperties;
}

Properties

alias? checked? checkedState? uncheckedState? -

Properties

Optional Readonlyalias

alias?: string

Optional Readonlychecked

checked?: boolean

Optional ReadonlycheckedState

checkedState?: ICheckboxSymbolProperties

Optional ReadonlyuncheckedState

uncheckedState?: ICheckboxSymbolProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalias

alias?: string

Optional Readonlychecked

checked?: boolean

Optional ReadonlycheckedState

checkedState?: ICheckboxSymbolProperties

Optional ReadonlyuncheckedState

uncheckedState?: ICheckboxSymbolProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICheckboxSymbolProperties.html b/api/interfaces/ICheckboxSymbolProperties.html index 33e21ec77f..c00d4b2b89 100644 --- a/api/interfaces/ICheckboxSymbolProperties.html +++ b/api/interfaces/ICheckboxSymbolProperties.html @@ -1,3 +1,3 @@ -ICheckboxSymbolProperties | docx

Interface ICheckboxSymbolProperties

interface ICheckboxSymbolProperties {
    font?: string;
    value?: string;
}

Properties

font? +ICheckboxSymbolProperties | docx

Interface ICheckboxSymbolProperties

interface ICheckboxSymbolProperties {
    font?: string;
    value?: string;
}

Properties

font? value? -

Properties

Optional Readonlyfont

font?: string

Optional Readonlyvalue

value?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyfont

font?: string

Optional Readonlyvalue

value?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICommentOptions.html b/api/interfaces/ICommentOptions.html index 4ddc273104..1773725542 100644 --- a/api/interfaces/ICommentOptions.html +++ b/api/interfaces/ICommentOptions.html @@ -1,6 +1,6 @@ -ICommentOptions | docx

Interface ICommentOptions

interface ICommentOptions {
    author?: string;
    children: readonly FileChild[];
    date?: Date;
    id: number;
    initials?: string;
}

Properties

author? +ICommentOptions | docx

Interface ICommentOptions

interface ICommentOptions {
    author?: string;
    children: readonly FileChild[];
    date?: Date;
    id: number;
    initials?: string;
}

Properties

author? children date? id initials? -

Properties

Optional Readonlyauthor

author?: string

Readonlychildren

children: readonly FileChild[]

Optional Readonlydate

date?: Date

Readonlyid

id: number

Optional Readonlyinitials

initials?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyauthor

author?: string

Readonlychildren

children: readonly FileChild[]

Optional Readonlydate

date?: Date

Readonlyid

id: number

Optional Readonlyinitials

initials?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICommentsOptions.html b/api/interfaces/ICommentsOptions.html index 8887e4e4f6..a1a72168ec 100644 --- a/api/interfaces/ICommentsOptions.html +++ b/api/interfaces/ICommentsOptions.html @@ -1,2 +1,2 @@ -ICommentsOptions | docx

Interface ICommentsOptions

interface ICommentsOptions {
    children: readonly ICommentOptions[];
}

Properties

children -

Properties

Readonlychildren

children: readonly ICommentOptions[]

Settings

Member Visibility

On This Page

Properties
+ICommentsOptions | docx

Interface ICommentsOptions

interface ICommentsOptions {
    children: readonly ICommentOptions[];
}

Properties

children +

Properties

Readonlychildren

children: readonly ICommentOptions[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IConcreteNumberingOptions.html b/api/interfaces/IConcreteNumberingOptions.html index 2621c889af..2d769a1c5a 100644 --- a/api/interfaces/IConcreteNumberingOptions.html +++ b/api/interfaces/IConcreteNumberingOptions.html @@ -1,6 +1,6 @@ -IConcreteNumberingOptions | docx

Interface IConcreteNumberingOptions

interface IConcreteNumberingOptions {
    abstractNumId: number;
    instance: number;
    numId: number;
    overrideLevels?: readonly IOverrideLevel[];
    reference: string;
}

Properties

abstractNumId +IConcreteNumberingOptions | docx

Interface IConcreteNumberingOptions

interface IConcreteNumberingOptions {
    abstractNumId: number;
    instance: number;
    numId: number;
    overrideLevels?: readonly IOverrideLevel[];
    reference: string;
}

Properties

abstractNumId instance numId overrideLevels? reference -

Properties

ReadonlyabstractNumId

abstractNumId: number

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Optional ReadonlyoverrideLevels

overrideLevels?: readonly IOverrideLevel[]

Readonlyreference

reference: string

Settings

Member Visibility

On This Page

Properties
+

Properties

ReadonlyabstractNumId

abstractNumId: number

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Optional ReadonlyoverrideLevels

overrideLevels?: readonly IOverrideLevel[]

Readonlyreference

reference: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IContext.html b/api/interfaces/IContext.html index 513e791ad6..ac52a19583 100644 --- a/api/interfaces/IContext.html +++ b/api/interfaces/IContext.html @@ -1,4 +1,4 @@ -IContext | docx

Interface IContext

interface IContext {
    file: Document;
    stack: IXmlableObject[];
    viewWrapper: IViewWrapper;
}

Properties

file +IContext | docx

Interface IContext

interface IContext {
    file: Document;
    stack: IXmlableObject[];
    viewWrapper: IViewWrapper;
}

Properties

file stack viewWrapper -

Properties

Readonlyfile

file: Document

Readonlystack

stack: IXmlableObject[]

ReadonlyviewWrapper

viewWrapper: IViewWrapper

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyfile

file: Document

Readonlystack

stack: IXmlableObject[]

ReadonlyviewWrapper

viewWrapper: IViewWrapper

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocGridAttributesProperties.html b/api/interfaces/IDocGridAttributesProperties.html index fb70a709d4..b0e5de3191 100644 --- a/api/interfaces/IDocGridAttributesProperties.html +++ b/api/interfaces/IDocGridAttributesProperties.html @@ -1,4 +1,4 @@ -IDocGridAttributesProperties | docx

Interface IDocGridAttributesProperties

interface IDocGridAttributesProperties {
    charSpace?: number;
    linePitch?: number;
    type?:
        | "default"
        | "lines"
        | "linesAndChars"
        | "snapToChars";
}

Properties

charSpace? +IDocGridAttributesProperties | docx

Interface IDocGridAttributesProperties

interface IDocGridAttributesProperties {
    charSpace?: number;
    linePitch?: number;
    type?:
        | "default"
        | "lines"
        | "linesAndChars"
        | "snapToChars";
}

Properties

charSpace? linePitch? type? -

Properties

Optional ReadonlycharSpace

charSpace?: number

Optional ReadonlylinePitch

linePitch?: number

Optional Readonlytype

type?:
    | "default"
    | "lines"
    | "linesAndChars"
    | "snapToChars"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycharSpace

charSpace?: number

Optional ReadonlylinePitch

linePitch?: number

Optional Readonlytype

type?:
    | "default"
    | "lines"
    | "linesAndChars"
    | "snapToChars"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentAttributesProperties.html b/api/interfaces/IDocumentAttributesProperties.html index 3002006324..c0456b8cc3 100644 --- a/api/interfaces/IDocumentAttributesProperties.html +++ b/api/interfaces/IDocumentAttributesProperties.html @@ -1,4 +1,4 @@ -IDocumentAttributesProperties | docx

Interface IDocumentAttributesProperties

interface IDocumentAttributesProperties {
    aink?: string;
    am3d?: string;
    cp?: string;
    cx?: string;
    cx1?: string;
    cx2?: string;
    cx3?: string;
    cx4?: string;
    cx5?: string;
    cx6?: string;
    cx7?: string;
    cx8?: string;
    dc?: string;
    dcmitype?: string;
    dcterms?: string;
    Ignorable?: string;
    m?: string;
    mc?: string;
    o?: string;
    r?: string;
    type?: string;
    v?: string;
    w?: string;
    w10?: string;
    w14?: string;
    w15?: string;
    w16?: string;
    w16cex?: string;
    w16cid?: string;
    w16sdtdh?: string;
    w16se?: string;
    wne?: string;
    wp?: string;
    wp14?: string;
    wpc?: string;
    wpg?: string;
    wpi?: string;
    wps?: string;
    xsi?: string;
}

Properties

aink? +IDocumentAttributesProperties | docx

Interface IDocumentAttributesProperties

interface IDocumentAttributesProperties {
    aink?: string;
    am3d?: string;
    cp?: string;
    cx?: string;
    cx1?: string;
    cx2?: string;
    cx3?: string;
    cx4?: string;
    cx5?: string;
    cx6?: string;
    cx7?: string;
    cx8?: string;
    dc?: string;
    dcmitype?: string;
    dcterms?: string;
    Ignorable?: string;
    m?: string;
    mc?: string;
    o?: string;
    r?: string;
    type?: string;
    v?: string;
    w?: string;
    w10?: string;
    w14?: string;
    w15?: string;
    w16?: string;
    w16cex?: string;
    w16cid?: string;
    w16sdtdh?: string;
    w16se?: string;
    wne?: string;
    wp?: string;
    wp14?: string;
    wpc?: string;
    wpg?: string;
    wpi?: string;
    wps?: string;
    xsi?: string;
}

Properties

aink? am3d? cp? cx? @@ -37,4 +37,4 @@ wpi? wps? xsi? -

Properties

Optional Readonlyaink

aink?: string

Optional Readonlyam3d

am3d?: string

Optional Readonlycp

cp?: string

Optional Readonlycx

cx?: string

Optional Readonlycx1

cx1?: string

Optional Readonlycx2

cx2?: string

Optional Readonlycx3

cx3?: string

Optional Readonlycx4

cx4?: string

Optional Readonlycx5

cx5?: string

Optional Readonlycx6

cx6?: string

Optional Readonlycx7

cx7?: string

Optional Readonlycx8

cx8?: string

Optional Readonlydc

dc?: string

Optional Readonlydcmitype

dcmitype?: string

Optional Readonlydcterms

dcterms?: string

Optional ReadonlyIgnorable

Ignorable?: string

Optional Readonlym

m?: string

Optional Readonlymc

mc?: string

Optional Readonlyo

o?: string

Optional Readonlyr

r?: string

Optional Readonlytype

type?: string

Optional Readonlyv

v?: string

Optional Readonlyw

w?: string

Optional Readonlyw10

w10?: string

Optional Readonlyw14

w14?: string

Optional Readonlyw15

w15?: string

Optional Readonlyw16

w16?: string

Optional Readonlyw16cex

w16cex?: string

Optional Readonlyw16cid

w16cid?: string

Optional Readonlyw16sdtdh

w16sdtdh?: string

Optional Readonlyw16se

w16se?: string

Optional Readonlywne

wne?: string

Optional Readonlywp

wp?: string

Optional Readonlywp14

wp14?: string

Optional Readonlywpc

wpc?: string

Optional Readonlywpg

wpg?: string

Optional Readonlywpi

wpi?: string

Optional Readonlywps

wps?: string

Optional Readonlyxsi

xsi?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyaink

aink?: string

Optional Readonlyam3d

am3d?: string

Optional Readonlycp

cp?: string

Optional Readonlycx

cx?: string

Optional Readonlycx1

cx1?: string

Optional Readonlycx2

cx2?: string

Optional Readonlycx3

cx3?: string

Optional Readonlycx4

cx4?: string

Optional Readonlycx5

cx5?: string

Optional Readonlycx6

cx6?: string

Optional Readonlycx7

cx7?: string

Optional Readonlycx8

cx8?: string

Optional Readonlydc

dc?: string

Optional Readonlydcmitype

dcmitype?: string

Optional Readonlydcterms

dcterms?: string

Optional ReadonlyIgnorable

Ignorable?: string

Optional Readonlym

m?: string

Optional Readonlymc

mc?: string

Optional Readonlyo

o?: string

Optional Readonlyr

r?: string

Optional Readonlytype

type?: string

Optional Readonlyv

v?: string

Optional Readonlyw

w?: string

Optional Readonlyw10

w10?: string

Optional Readonlyw14

w14?: string

Optional Readonlyw15

w15?: string

Optional Readonlyw16

w16?: string

Optional Readonlyw16cex

w16cex?: string

Optional Readonlyw16cid

w16cid?: string

Optional Readonlyw16sdtdh

w16sdtdh?: string

Optional Readonlyw16se

w16se?: string

Optional Readonlywne

wne?: string

Optional Readonlywp

wp?: string

Optional Readonlywp14

wp14?: string

Optional Readonlywpc

wpc?: string

Optional Readonlywpg

wpg?: string

Optional Readonlywpi

wpi?: string

Optional Readonlywps

wps?: string

Optional Readonlyxsi

xsi?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentBackgroundOptions.html b/api/interfaces/IDocumentBackgroundOptions.html index d5eaf12b57..88622b2bae 100644 --- a/api/interfaces/IDocumentBackgroundOptions.html +++ b/api/interfaces/IDocumentBackgroundOptions.html @@ -1,5 +1,5 @@ -IDocumentBackgroundOptions | docx

Interface IDocumentBackgroundOptions

interface IDocumentBackgroundOptions {
    color?: string;
    themeColor?: string;
    themeShade?: string;
    themeTint?: string;
}

Properties

color? +IDocumentBackgroundOptions | docx

Interface IDocumentBackgroundOptions

interface IDocumentBackgroundOptions {
    color?: string;
    themeColor?: string;
    themeShade?: string;
    themeTint?: string;
}

Properties

color? themeColor? themeShade? themeTint? -

Properties

Optional Readonlycolor

color?: string

Optional ReadonlythemeColor

themeColor?: string

Optional ReadonlythemeShade

themeShade?: string

Optional ReadonlythemeTint

themeTint?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolor

color?: string

Optional ReadonlythemeColor

themeColor?: string

Optional ReadonlythemeShade

themeShade?: string

Optional ReadonlythemeTint

themeTint?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentDefaultsOptions.html b/api/interfaces/IDocumentDefaultsOptions.html index 76ef16fa20..38f24dd039 100644 --- a/api/interfaces/IDocumentDefaultsOptions.html +++ b/api/interfaces/IDocumentDefaultsOptions.html @@ -1,3 +1,3 @@ -IDocumentDefaultsOptions | docx

Interface IDocumentDefaultsOptions

interface IDocumentDefaultsOptions {
    paragraph?: IParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
}

Properties

paragraph? +IDocumentDefaultsOptions | docx

Interface IDocumentDefaultsOptions

interface IDocumentDefaultsOptions {
    paragraph?: IParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
}

Properties

paragraph? run? -

Properties

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentFooter.html b/api/interfaces/IDocumentFooter.html index beff058eed..e22fea8b30 100644 --- a/api/interfaces/IDocumentFooter.html +++ b/api/interfaces/IDocumentFooter.html @@ -1,3 +1,3 @@ -IDocumentFooter | docx

Interface IDocumentFooter

interface IDocumentFooter {
    footer: FooterWrapper;
    type: "default" | "first" | "even";
}

Properties

footer +IDocumentFooter | docx

Interface IDocumentFooter

interface IDocumentFooter {
    footer: FooterWrapper;
    type: "default" | "first" | "even";
}

Properties

footer type -

Properties

Readonlyfooter

footer: FooterWrapper

Readonlytype

type: "default" | "first" | "even"

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyfooter

footer: FooterWrapper

Readonlytype

type: "default" | "first" | "even"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentHeader.html b/api/interfaces/IDocumentHeader.html index 9f87eaf8ce..f512a97a8d 100644 --- a/api/interfaces/IDocumentHeader.html +++ b/api/interfaces/IDocumentHeader.html @@ -1,3 +1,3 @@ -IDocumentHeader | docx

Interface IDocumentHeader

interface IDocumentHeader {
    header: HeaderWrapper;
    type: "default" | "first" | "even";
}

Properties

header +IDocumentHeader | docx

Interface IDocumentHeader

interface IDocumentHeader {
    header: HeaderWrapper;
    type: "default" | "first" | "even";
}

Properties

header type -

Properties

Readonlyheader

header: HeaderWrapper

Readonlytype

type: "default" | "first" | "even"

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyheader

header: HeaderWrapper

Readonlytype

type: "default" | "first" | "even"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentOptions.html b/api/interfaces/IDocumentOptions.html index e9b052d146..72e52e9f2c 100644 --- a/api/interfaces/IDocumentOptions.html +++ b/api/interfaces/IDocumentOptions.html @@ -1,2 +1,2 @@ -IDocumentOptions | docx

Interface IDocumentOptions

interface IDocumentOptions {
    background?: IDocumentBackgroundOptions;
}

Properties

background? -

Properties

Optional Readonlybackground

background?: IDocumentBackgroundOptions

Settings

Member Visibility

On This Page

Properties
+IDocumentOptions | docx

Interface IDocumentOptions

interface IDocumentOptions {
    background?: IDocumentBackgroundOptions;
}

Properties

background? +

Properties

Optional Readonlybackground

background?: IDocumentBackgroundOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDrawingOptions.html b/api/interfaces/IDrawingOptions.html index c02f21036c..dee430d60e 100644 --- a/api/interfaces/IDrawingOptions.html +++ b/api/interfaces/IDrawingOptions.html @@ -1,4 +1,4 @@ -IDrawingOptions | docx

Interface IDrawingOptions

interface IDrawingOptions {
    docProperties?: DocPropertiesOptions;
    floating?: IFloating;
    outline?: OutlineOptions;
}

Properties

docProperties? +IDrawingOptions | docx

Interface IDrawingOptions

interface IDrawingOptions {
    docProperties?: DocPropertiesOptions;
    floating?: IFloating;
    outline?: OutlineOptions;
}

Properties

docProperties? floating? outline? -

Properties

Optional ReadonlydocProperties

docProperties?: DocPropertiesOptions

Optional Readonlyfloating

floating?: IFloating

Optional Readonlyoutline

outline?: OutlineOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlydocProperties

docProperties?: DocPropertiesOptions

Optional Readonlyfloating

floating?: IFloating

Optional Readonlyoutline

outline?: OutlineOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IFloating.html b/api/interfaces/IFloating.html index ae499bd03f..e87779a7d9 100644 --- a/api/interfaces/IFloating.html +++ b/api/interfaces/IFloating.html @@ -1,4 +1,4 @@ -IFloating | docx

Interface IFloating

interface IFloating {
    allowOverlap?: boolean;
    behindDocument?: boolean;
    horizontalPosition: IHorizontalPositionOptions;
    layoutInCell?: boolean;
    lockAnchor?: boolean;
    margins?: IMargins;
    verticalPosition: IVerticalPositionOptions;
    wrap?: ITextWrapping;
    zIndex?: number;
}

Properties

allowOverlap? +IFloating | docx

Interface IFloating

interface IFloating {
    allowOverlap?: boolean;
    behindDocument?: boolean;
    horizontalPosition: IHorizontalPositionOptions;
    layoutInCell?: boolean;
    lockAnchor?: boolean;
    margins?: IMargins;
    verticalPosition: IVerticalPositionOptions;
    wrap?: ITextWrapping;
    zIndex?: number;
}

Properties

allowOverlap? behindDocument? horizontalPosition layoutInCell? @@ -7,4 +7,4 @@ verticalPosition wrap? zIndex? -

Properties

Optional ReadonlyallowOverlap

allowOverlap?: boolean

Optional ReadonlybehindDocument

behindDocument?: boolean

ReadonlyhorizontalPosition

horizontalPosition: IHorizontalPositionOptions

Optional ReadonlylayoutInCell

layoutInCell?: boolean

Optional ReadonlylockAnchor

lockAnchor?: boolean

Optional Readonlymargins

margins?: IMargins

ReadonlyverticalPosition

verticalPosition: IVerticalPositionOptions

Optional Readonlywrap

wrap?: ITextWrapping

Optional ReadonlyzIndex

zIndex?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallowOverlap

allowOverlap?: boolean

Optional ReadonlybehindDocument

behindDocument?: boolean

ReadonlyhorizontalPosition

horizontalPosition: IHorizontalPositionOptions

Optional ReadonlylayoutInCell

layoutInCell?: boolean

Optional ReadonlylockAnchor

lockAnchor?: boolean

Optional Readonlymargins

margins?: IMargins

ReadonlyverticalPosition

verticalPosition: IVerticalPositionOptions

Optional Readonlywrap

wrap?: ITextWrapping

Optional ReadonlyzIndex

zIndex?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IFontAttributesProperties.html b/api/interfaces/IFontAttributesProperties.html index 52df9a58d3..a6e2860978 100644 --- a/api/interfaces/IFontAttributesProperties.html +++ b/api/interfaces/IFontAttributesProperties.html @@ -1,6 +1,6 @@ -IFontAttributesProperties | docx

Interface IFontAttributesProperties

interface IFontAttributesProperties {
    ascii?: string;
    cs?: string;
    eastAsia?: string;
    hAnsi?: string;
    hint?: string;
}

Properties

ascii? +IFontAttributesProperties | docx

Interface IFontAttributesProperties

interface IFontAttributesProperties {
    ascii?: string;
    cs?: string;
    eastAsia?: string;
    hAnsi?: string;
    hint?: string;
}

Properties

ascii? cs? eastAsia? hAnsi? hint? -

Properties

Optional Readonlyascii

ascii?: string

Optional Readonlycs

cs?: string

Optional ReadonlyeastAsia

eastAsia?: string

Optional ReadonlyhAnsi

hAnsi?: string

Optional Readonlyhint

hint?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyascii

ascii?: string

Optional Readonlycs

cs?: string

Optional ReadonlyeastAsia

eastAsia?: string

Optional ReadonlyhAnsi

hAnsi?: string

Optional Readonlyhint

hint?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderFooterGroup.html b/api/interfaces/IHeaderFooterGroup.html index fef8060a3a..17be1a1b6a 100644 --- a/api/interfaces/IHeaderFooterGroup.html +++ b/api/interfaces/IHeaderFooterGroup.html @@ -1,4 +1,4 @@ -IHeaderFooterGroup | docx

Interface IHeaderFooterGroup<T>

interface IHeaderFooterGroup<T> {
    default?: T;
    even?: T;
    first?: T;
}

Type Parameters

  • T

Properties

default? +IHeaderFooterGroup | docx

Interface IHeaderFooterGroup<T>

interface IHeaderFooterGroup<T> {
    default?: T;
    even?: T;
    first?: T;
}

Type Parameters

  • T

Properties

default? even? first? -

Properties

Optional Readonlydefault

default?: T

Optional Readonlyeven

even?: T

Optional Readonlyfirst

first?: T

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlydefault

default?: T

Optional Readonlyeven

even?: T

Optional Readonlyfirst

first?: T

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderFooterOptions.html b/api/interfaces/IHeaderFooterOptions.html index 029108bc16..960655f2dd 100644 --- a/api/interfaces/IHeaderFooterOptions.html +++ b/api/interfaces/IHeaderFooterOptions.html @@ -1,3 +1,3 @@ -IHeaderFooterOptions | docx

Interface IHeaderFooterOptions

interface IHeaderFooterOptions {
    id?: number;
    type?: "default" | "first" | "even";
}

Properties

id? +IHeaderFooterOptions | docx

Interface IHeaderFooterOptions

interface IHeaderFooterOptions {
    id?: number;
    type?: "default" | "first" | "even";
}

Properties

id? type? -

Properties

Optional Readonlyid

id?: number

Optional Readonlytype

type?: "default" | "first" | "even"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyid

id?: number

Optional Readonlytype

type?: "default" | "first" | "even"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderOptions.html b/api/interfaces/IHeaderOptions.html index 130c9d05a3..0de459b48d 100644 --- a/api/interfaces/IHeaderOptions.html +++ b/api/interfaces/IHeaderOptions.html @@ -1,2 +1,2 @@ -IHeaderOptions | docx

Interface IHeaderOptions

interface IHeaderOptions {
    children: readonly (Paragraph | Table)[];
}

Properties

children -

Properties

Readonlychildren

children: readonly (Paragraph | Table)[]

Settings

Member Visibility

On This Page

Properties
+IHeaderOptions | docx

Interface IHeaderOptions

interface IHeaderOptions {
    children: readonly (Paragraph | Table)[];
}

Properties

children +

Properties

Readonlychildren

children: readonly (Paragraph | Table)[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHorizontalPositionOptions.html b/api/interfaces/IHorizontalPositionOptions.html index b64dad3f15..35b64348a5 100644 --- a/api/interfaces/IHorizontalPositionOptions.html +++ b/api/interfaces/IHorizontalPositionOptions.html @@ -1,4 +1,4 @@ -IHorizontalPositionOptions | docx

Interface IHorizontalPositionOptions

interface IHorizontalPositionOptions {
    align?:
        | "center"
        | "left"
        | "right"
        | "inside"
        | "outside";
    offset?: number;
    relative?:
        | "margin"
        | "page"
        | "character"
        | "column"
        | "insideMargin"
        | "leftMargin"
        | "outsideMargin"
        | "rightMargin";
}

Properties

align? +IHorizontalPositionOptions | docx

Interface IHorizontalPositionOptions

interface IHorizontalPositionOptions {
    align?:
        | "center"
        | "left"
        | "right"
        | "inside"
        | "outside";
    offset?: number;
    relative?:
        | "margin"
        | "page"
        | "character"
        | "column"
        | "insideMargin"
        | "leftMargin"
        | "outsideMargin"
        | "rightMargin";
}

Properties

align? offset? relative? -

Properties

Optional Readonlyalign

align?:
    | "center"
    | "left"
    | "right"
    | "inside"
    | "outside"

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

relative?:
    | "margin"
    | "page"
    | "character"
    | "column"
    | "insideMargin"
    | "leftMargin"
    | "outsideMargin"
    | "rightMargin"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalign

align?:
    | "center"
    | "left"
    | "right"
    | "inside"
    | "outside"

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

relative?:
    | "margin"
    | "page"
    | "character"
    | "column"
    | "insideMargin"
    | "leftMargin"
    | "outsideMargin"
    | "rightMargin"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IIndentAttributesProperties.html b/api/interfaces/IIndentAttributesProperties.html index 2156b84ae5..b7965eebac 100644 --- a/api/interfaces/IIndentAttributesProperties.html +++ b/api/interfaces/IIndentAttributesProperties.html @@ -1,7 +1,7 @@ -IIndentAttributesProperties | docx

Interface IIndentAttributesProperties

interface IIndentAttributesProperties {
    end?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    firstLine?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    hanging?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    left?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    right?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    start?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
}

Properties

end? +IIndentAttributesProperties | docx

Interface IIndentAttributesProperties

interface IIndentAttributesProperties {
    end?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    firstLine?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    hanging?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    left?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    right?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    start?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
}

Properties

end? firstLine? hanging? left? right? start? -

Properties

Optional Readonlyend

end?:
    | number
    | `${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 ReadonlyfirstLine

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

Optional Readonlyhanging

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

Optional Readonlyleft

left?:
    | number
    | `${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 Readonlyright

right?:
    | number
    | `${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 Readonlystart

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyend

end?:
    | number
    | `${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 ReadonlyfirstLine

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

Optional Readonlyhanging

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

Optional Readonlyleft

left?:
    | number
    | `${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 Readonlyright

right?:
    | number
    | `${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 Readonlystart

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ILevelParagraphStylePropertiesOptions.html b/api/interfaces/ILevelParagraphStylePropertiesOptions.html index 69970ccf36..4ecac42d68 100644 --- a/api/interfaces/ILevelParagraphStylePropertiesOptions.html +++ b/api/interfaces/ILevelParagraphStylePropertiesOptions.html @@ -1,4 +1,4 @@ -ILevelParagraphStylePropertiesOptions | docx

Interface ILevelParagraphStylePropertiesOptions

interface ILevelParagraphStylePropertiesOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    contextualSpacing?: boolean;
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    outlineLevel?: number;
    rightTabStop?: number;
    spacing?: ISpacingProperties;
    thematicBreak?: boolean;
}

Hierarchy (view full)

Properties

alignment? +ILevelParagraphStylePropertiesOptions | docx

Interface ILevelParagraphStylePropertiesOptions

interface ILevelParagraphStylePropertiesOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    contextualSpacing?: boolean;
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    outlineLevel?: number;
    rightTabStop?: number;
    spacing?: ISpacingProperties;
    thematicBreak?: boolean;
}

Hierarchy (view full)

Properties

alignment? contextualSpacing? indent? keepLines? @@ -8,6 +8,6 @@ rightTabStop? spacing? thematicBreak? -

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

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.

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

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.

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ILevelsOptions.html b/api/interfaces/ILevelsOptions.html index ce0df99239..05ad14ca58 100644 --- a/api/interfaces/ILevelsOptions.html +++ b/api/interfaces/ILevelsOptions.html @@ -1,4 +1,4 @@ -ILevelsOptions | docx

Interface ILevelsOptions

interface ILevelsOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    format?:
        | "hex"
        | "none"
        | "bullet"
        | "decimal"
        | "upperRoman"
        | "lowerRoman"
        | "upperLetter"
        | "lowerLetter"
        | "ordinal"
        | "cardinalText"
        | "ordinalText"
        | "chicago"
        | "ideographDigital"
        | "japaneseCounting"
        | "aiueo"
        | "iroha"
        | "decimalFullWidth"
        | "decimalHalfWidth"
        | "japaneseLegal"
        | "japaneseDigitalTenThousand"
        | "decimalEnclosedCircle"
        | "decimalFullWidth2"
        | "aiueoFullWidth"
        | "irohaFullWidth"
        | "decimalZero"
        | "ganada"
        | "chosung"
        | "decimalEnclosedFullstop"
        | "decimalEnclosedParen"
        | "decimalEnclosedCircleChinese"
        | "ideographEnclosedCircle"
        | "ideographTraditional"
        | "ideographZodiac"
        | "ideographZodiacTraditional"
        | "taiwaneseCounting"
        | "ideographLegalTraditional"
        | "taiwaneseCountingThousand"
        | "taiwaneseDigital"
        | "chineseCounting"
        | "chineseLegalSimplified"
        | "chineseCountingThousand"
        | "koreanDigital"
        | "koreanCounting"
        | "koreanLegal"
        | "koreanDigital2"
        | "vietnameseCounting"
        | "russianLower"
        | "russianUpper"
        | "numberInDash"
        | "hebrew1"
        | "hebrew2"
        | "arabicAlpha"
        | "arabicAbjad"
        | "hindiVowels"
        | "hindiConsonants"
        | "hindiNumbers"
        | "hindiCounting"
        | "thaiLetters"
        | "thaiNumbers"
        | "thaiCounting"
        | "bahtText"
        | "dollarText"
        | "custom";
    isLegalNumberingStyle?: boolean;
    level: number;
    start?: number;
    style?: {
        paragraph?: ILevelParagraphStylePropertiesOptions;
        run?: IRunStylePropertiesOptions;
    };
    suffix?: "space" | "nothing" | "tab";
    text?: string;
}

Properties

alignment? +ILevelsOptions | docx

Interface ILevelsOptions

interface ILevelsOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    format?:
        | "hex"
        | "none"
        | "bullet"
        | "decimal"
        | "upperRoman"
        | "lowerRoman"
        | "upperLetter"
        | "lowerLetter"
        | "ordinal"
        | "cardinalText"
        | "ordinalText"
        | "chicago"
        | "ideographDigital"
        | "japaneseCounting"
        | "aiueo"
        | "iroha"
        | "decimalFullWidth"
        | "decimalHalfWidth"
        | "japaneseLegal"
        | "japaneseDigitalTenThousand"
        | "decimalEnclosedCircle"
        | "decimalFullWidth2"
        | "aiueoFullWidth"
        | "irohaFullWidth"
        | "decimalZero"
        | "ganada"
        | "chosung"
        | "decimalEnclosedFullstop"
        | "decimalEnclosedParen"
        | "decimalEnclosedCircleChinese"
        | "ideographEnclosedCircle"
        | "ideographTraditional"
        | "ideographZodiac"
        | "ideographZodiacTraditional"
        | "taiwaneseCounting"
        | "ideographLegalTraditional"
        | "taiwaneseCountingThousand"
        | "taiwaneseDigital"
        | "chineseCounting"
        | "chineseLegalSimplified"
        | "chineseCountingThousand"
        | "koreanDigital"
        | "koreanCounting"
        | "koreanLegal"
        | "koreanDigital2"
        | "vietnameseCounting"
        | "russianLower"
        | "russianUpper"
        | "numberInDash"
        | "hebrew1"
        | "hebrew2"
        | "arabicAlpha"
        | "arabicAbjad"
        | "hindiVowels"
        | "hindiConsonants"
        | "hindiNumbers"
        | "hindiCounting"
        | "thaiLetters"
        | "thaiNumbers"
        | "thaiCounting"
        | "bahtText"
        | "dollarText"
        | "custom";
    isLegalNumberingStyle?: boolean;
    level: number;
    start?: number;
    style?: {
        paragraph?: ILevelParagraphStylePropertiesOptions;
        run?: IRunStylePropertiesOptions;
    };
    suffix?: "space" | "nothing" | "tab";
    text?: string;
}

Properties

alignment? format? isLegalNumberingStyle? level @@ -6,4 +6,4 @@ style? suffix? text? -

Properties

Optional Readonlyalignment

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

Optional Readonlyformat

format?:
    | "hex"
    | "none"
    | "bullet"
    | "decimal"
    | "upperRoman"
    | "lowerRoman"
    | "upperLetter"
    | "lowerLetter"
    | "ordinal"
    | "cardinalText"
    | "ordinalText"
    | "chicago"
    | "ideographDigital"
    | "japaneseCounting"
    | "aiueo"
    | "iroha"
    | "decimalFullWidth"
    | "decimalHalfWidth"
    | "japaneseLegal"
    | "japaneseDigitalTenThousand"
    | "decimalEnclosedCircle"
    | "decimalFullWidth2"
    | "aiueoFullWidth"
    | "irohaFullWidth"
    | "decimalZero"
    | "ganada"
    | "chosung"
    | "decimalEnclosedFullstop"
    | "decimalEnclosedParen"
    | "decimalEnclosedCircleChinese"
    | "ideographEnclosedCircle"
    | "ideographTraditional"
    | "ideographZodiac"
    | "ideographZodiacTraditional"
    | "taiwaneseCounting"
    | "ideographLegalTraditional"
    | "taiwaneseCountingThousand"
    | "taiwaneseDigital"
    | "chineseCounting"
    | "chineseLegalSimplified"
    | "chineseCountingThousand"
    | "koreanDigital"
    | "koreanCounting"
    | "koreanLegal"
    | "koreanDigital2"
    | "vietnameseCounting"
    | "russianLower"
    | "russianUpper"
    | "numberInDash"
    | "hebrew1"
    | "hebrew2"
    | "arabicAlpha"
    | "arabicAbjad"
    | "hindiVowels"
    | "hindiConsonants"
    | "hindiNumbers"
    | "hindiCounting"
    | "thaiLetters"
    | "thaiNumbers"
    | "thaiCounting"
    | "bahtText"
    | "dollarText"
    | "custom"

Optional ReadonlyisLegalNumberingStyle

isLegalNumberingStyle?: boolean

Readonlylevel

level: number

Optional Readonlystart

start?: number

Optional Readonlystyle

style?: {
    paragraph?: ILevelParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
}

Optional Readonlysuffix

suffix?: "space" | "nothing" | "tab"

Optional Readonlytext

text?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyformat

format?:
    | "hex"
    | "none"
    | "bullet"
    | "decimal"
    | "upperRoman"
    | "lowerRoman"
    | "upperLetter"
    | "lowerLetter"
    | "ordinal"
    | "cardinalText"
    | "ordinalText"
    | "chicago"
    | "ideographDigital"
    | "japaneseCounting"
    | "aiueo"
    | "iroha"
    | "decimalFullWidth"
    | "decimalHalfWidth"
    | "japaneseLegal"
    | "japaneseDigitalTenThousand"
    | "decimalEnclosedCircle"
    | "decimalFullWidth2"
    | "aiueoFullWidth"
    | "irohaFullWidth"
    | "decimalZero"
    | "ganada"
    | "chosung"
    | "decimalEnclosedFullstop"
    | "decimalEnclosedParen"
    | "decimalEnclosedCircleChinese"
    | "ideographEnclosedCircle"
    | "ideographTraditional"
    | "ideographZodiac"
    | "ideographZodiacTraditional"
    | "taiwaneseCounting"
    | "ideographLegalTraditional"
    | "taiwaneseCountingThousand"
    | "taiwaneseDigital"
    | "chineseCounting"
    | "chineseLegalSimplified"
    | "chineseCountingThousand"
    | "koreanDigital"
    | "koreanCounting"
    | "koreanLegal"
    | "koreanDigital2"
    | "vietnameseCounting"
    | "russianLower"
    | "russianUpper"
    | "numberInDash"
    | "hebrew1"
    | "hebrew2"
    | "arabicAlpha"
    | "arabicAbjad"
    | "hindiVowels"
    | "hindiConsonants"
    | "hindiNumbers"
    | "hindiCounting"
    | "thaiLetters"
    | "thaiNumbers"
    | "thaiCounting"
    | "bahtText"
    | "dollarText"
    | "custom"

Optional ReadonlyisLegalNumberingStyle

isLegalNumberingStyle?: boolean

Readonlylevel

level: number

Optional Readonlystart

start?: number

Optional Readonlystyle

style?: {
    paragraph?: ILevelParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
}

Optional Readonlysuffix

suffix?: "space" | "nothing" | "tab"

Optional Readonlytext

text?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMargins.html b/api/interfaces/IMargins.html index ecd679a464..69c66ffdc8 100644 --- a/api/interfaces/IMargins.html +++ b/api/interfaces/IMargins.html @@ -1,5 +1,5 @@ -IMargins | docx

Interface IMargins

interface IMargins {
    bottom?: number;
    left?: number;
    right?: number;
    top?: number;
}

Properties

bottom? +IMargins | docx

Interface IMargins

interface IMargins {
    bottom?: number;
    left?: number;
    right?: number;
    top?: number;
}

Properties

bottom? left? right? top? -

Properties

Optional Readonlybottom

bottom?: number

Optional Readonlyleft

left?: number

Optional Readonlyright

right?: number

Optional Readonlytop

top?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: number

Optional Readonlyleft

left?: number

Optional Readonlyright

right?: number

Optional Readonlytop

top?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathFractionOptions.html b/api/interfaces/IMathFractionOptions.html index 005d12f22f..cb787bdeec 100644 --- a/api/interfaces/IMathFractionOptions.html +++ b/api/interfaces/IMathFractionOptions.html @@ -1,3 +1,3 @@ -IMathFractionOptions | docx

Interface IMathFractionOptions

interface IMathFractionOptions {
    denominator: readonly MathComponent[];
    numerator: readonly MathComponent[];
}

Properties

denominator +IMathFractionOptions | docx

Interface IMathFractionOptions

interface IMathFractionOptions {
    denominator: readonly MathComponent[];
    numerator: readonly MathComponent[];
}

Properties

denominator numerator -

Properties

Readonlydenominator

denominator: readonly MathComponent[]

Readonlynumerator

numerator: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlydenominator

denominator: readonly MathComponent[]

Readonlynumerator

numerator: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathFunctionOptions.html b/api/interfaces/IMathFunctionOptions.html index e09babf633..6d107e3709 100644 --- a/api/interfaces/IMathFunctionOptions.html +++ b/api/interfaces/IMathFunctionOptions.html @@ -1,3 +1,3 @@ -IMathFunctionOptions | docx

Interface IMathFunctionOptions

interface IMathFunctionOptions {
    children: readonly MathComponent[];
    name: readonly MathComponent[];
}

Properties

children +IMathFunctionOptions | docx

Interface IMathFunctionOptions

interface IMathFunctionOptions {
    children: readonly MathComponent[];
    name: readonly MathComponent[];
}

Properties

children name -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlyname

name: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlyname

name: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathIntegralOptions.html b/api/interfaces/IMathIntegralOptions.html index a88fca40f4..cd19850511 100644 --- a/api/interfaces/IMathIntegralOptions.html +++ b/api/interfaces/IMathIntegralOptions.html @@ -1,4 +1,4 @@ -IMathIntegralOptions | docx

Interface IMathIntegralOptions

interface IMathIntegralOptions {
    children: readonly MathComponent[];
    subScript?: readonly MathComponent[];
    superScript?: readonly MathComponent[];
}

Properties

children +IMathIntegralOptions | docx

Interface IMathIntegralOptions

interface IMathIntegralOptions {
    children: readonly MathComponent[];
    subScript?: readonly MathComponent[];
    superScript?: readonly MathComponent[];
}

Properties

children subScript? superScript? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathLimitLowerOptions.html b/api/interfaces/IMathLimitLowerOptions.html index 8427c169b0..225fcb0397 100644 --- a/api/interfaces/IMathLimitLowerOptions.html +++ b/api/interfaces/IMathLimitLowerOptions.html @@ -1,3 +1,3 @@ -IMathLimitLowerOptions | docx

Interface IMathLimitLowerOptions

interface IMathLimitLowerOptions {
    children: readonly MathComponent[];
    limit: readonly MathComponent[];
}

Properties

children +IMathLimitLowerOptions | docx

Interface IMathLimitLowerOptions

interface IMathLimitLowerOptions {
    children: readonly MathComponent[];
    limit: readonly MathComponent[];
}

Properties

children limit -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathLimitUpperOptions.html b/api/interfaces/IMathLimitUpperOptions.html index 8a69a8d2c5..08c5e63a20 100644 --- a/api/interfaces/IMathLimitUpperOptions.html +++ b/api/interfaces/IMathLimitUpperOptions.html @@ -1,3 +1,3 @@ -IMathLimitUpperOptions | docx

Interface IMathLimitUpperOptions

interface IMathLimitUpperOptions {
    children: readonly MathComponent[];
    limit: readonly MathComponent[];
}

Properties

children +IMathLimitUpperOptions | docx

Interface IMathLimitUpperOptions

interface IMathLimitUpperOptions {
    children: readonly MathComponent[];
    limit: readonly MathComponent[];
}

Properties

children limit -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathOptions.html b/api/interfaces/IMathOptions.html index ed980ddf45..1a56cc465b 100644 --- a/api/interfaces/IMathOptions.html +++ b/api/interfaces/IMathOptions.html @@ -1,2 +1,2 @@ -IMathOptions | docx

Interface IMathOptions

interface IMathOptions {
    children: readonly MathComponent[];
}

Properties

children -

Properties

Readonlychildren

children: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+IMathOptions | docx

Interface IMathOptions

interface IMathOptions {
    children: readonly MathComponent[];
}

Properties

children +

Properties

Readonlychildren

children: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathPreSubSuperScriptOptions.html b/api/interfaces/IMathPreSubSuperScriptOptions.html index 5f0a7f9de7..0db66c91ac 100644 --- a/api/interfaces/IMathPreSubSuperScriptOptions.html +++ b/api/interfaces/IMathPreSubSuperScriptOptions.html @@ -1,4 +1,4 @@ -IMathPreSubSuperScriptOptions | docx

Interface IMathPreSubSuperScriptOptions

interface IMathPreSubSuperScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children +IMathPreSubSuperScriptOptions | docx

Interface IMathPreSubSuperScriptOptions

interface IMathPreSubSuperScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children subScript superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathRadicalOptions.html b/api/interfaces/IMathRadicalOptions.html index dbd40dc304..baa4abe35d 100644 --- a/api/interfaces/IMathRadicalOptions.html +++ b/api/interfaces/IMathRadicalOptions.html @@ -1,3 +1,3 @@ -IMathRadicalOptions | docx

Interface IMathRadicalOptions

interface IMathRadicalOptions {
    children: readonly MathComponent[];
    degree?: readonly MathComponent[];
}

Properties

children +IMathRadicalOptions | docx

Interface IMathRadicalOptions

interface IMathRadicalOptions {
    children: readonly MathComponent[];
    degree?: readonly MathComponent[];
}

Properties

children degree? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional Readonlydegree

degree?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional Readonlydegree

degree?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSubScriptOptions.html b/api/interfaces/IMathSubScriptOptions.html index 5b5a088a96..d5e0d65960 100644 --- a/api/interfaces/IMathSubScriptOptions.html +++ b/api/interfaces/IMathSubScriptOptions.html @@ -1,3 +1,3 @@ -IMathSubScriptOptions | docx

Interface IMathSubScriptOptions

interface IMathSubScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
}

Properties

children +IMathSubScriptOptions | docx

Interface IMathSubScriptOptions

interface IMathSubScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
}

Properties

children subScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSubSuperScriptOptions.html b/api/interfaces/IMathSubSuperScriptOptions.html index bb71d419b7..01b7f807cd 100644 --- a/api/interfaces/IMathSubSuperScriptOptions.html +++ b/api/interfaces/IMathSubSuperScriptOptions.html @@ -1,4 +1,4 @@ -IMathSubSuperScriptOptions | docx

Interface IMathSubSuperScriptOptions

interface IMathSubSuperScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children +IMathSubSuperScriptOptions | docx

Interface IMathSubSuperScriptOptions

interface IMathSubSuperScriptOptions {
    children: readonly MathComponent[];
    subScript: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children subScript superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSumOptions.html b/api/interfaces/IMathSumOptions.html index 7761025cf9..fffc427c96 100644 --- a/api/interfaces/IMathSumOptions.html +++ b/api/interfaces/IMathSumOptions.html @@ -1,4 +1,4 @@ -IMathSumOptions | docx

Interface IMathSumOptions

interface IMathSumOptions {
    children: readonly MathComponent[];
    subScript?: readonly MathComponent[];
    superScript?: readonly MathComponent[];
}

Properties

children +IMathSumOptions | docx

Interface IMathSumOptions

interface IMathSumOptions {
    children: readonly MathComponent[];
    subScript?: readonly MathComponent[];
    superScript?: readonly MathComponent[];
}

Properties

children subScript? superScript? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSuperScriptOptions.html b/api/interfaces/IMathSuperScriptOptions.html index b2b5f5cf47..f4f14c0609 100644 --- a/api/interfaces/IMathSuperScriptOptions.html +++ b/api/interfaces/IMathSuperScriptOptions.html @@ -1,3 +1,3 @@ -IMathSuperScriptOptions | docx

Interface IMathSuperScriptOptions

interface IMathSuperScriptOptions {
    children: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children +IMathSuperScriptOptions | docx

Interface IMathSuperScriptOptions

interface IMathSuperScriptOptions {
    children: readonly MathComponent[];
    superScript: readonly MathComponent[];
}

Properties

children superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMediaDataTransformation.html b/api/interfaces/IMediaDataTransformation.html index 7075ed2cad..81fe42c818 100644 --- a/api/interfaces/IMediaDataTransformation.html +++ b/api/interfaces/IMediaDataTransformation.html @@ -1,5 +1,5 @@ -IMediaDataTransformation | docx

Interface IMediaDataTransformation

interface IMediaDataTransformation {
    emus: {
        x: number;
        y: number;
    };
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    };
    pixels: {
        x: number;
        y: number;
    };
    rotation?: number;
}

Properties

emus +IMediaDataTransformation | docx

Interface IMediaDataTransformation

interface IMediaDataTransformation {
    emus: {
        x: number;
        y: number;
    };
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    };
    pixels: {
        x: number;
        y: number;
    };
    rotation?: number;
}

Properties

emus flip? pixels rotation? -

Properties

Readonlyemus

emus: {
    x: number;
    y: number;
}

Optional Readonlyflip

flip?: {
    horizontal?: boolean;
    vertical?: boolean;
}

Readonlypixels

pixels: {
    x: number;
    y: number;
}

Optional Readonlyrotation

rotation?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyemus

emus: {
    x: number;
    y: number;
}

Optional Readonlyflip

flip?: {
    horizontal?: boolean;
    vertical?: boolean;
}

Readonlypixels

pixels: {
    x: number;
    y: number;
}

Optional Readonlyrotation

rotation?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMediaTransformation.html b/api/interfaces/IMediaTransformation.html index a46ade6f3c..ae32dd3a75 100644 --- a/api/interfaces/IMediaTransformation.html +++ b/api/interfaces/IMediaTransformation.html @@ -1,5 +1,5 @@ -IMediaTransformation | docx

Interface IMediaTransformation

interface IMediaTransformation {
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    };
    height: number;
    rotation?: number;
    width: number;
}

Properties

flip? +IMediaTransformation | docx

Interface IMediaTransformation

interface IMediaTransformation {
    flip?: {
        horizontal?: boolean;
        vertical?: boolean;
    };
    height: number;
    rotation?: number;
    width: number;
}

Properties

flip? height rotation? width -

Properties

Optional Readonlyflip

flip?: {
    horizontal?: boolean;
    vertical?: boolean;
}

Readonlyheight

height: number

Optional Readonlyrotation

rotation?: number

Readonlywidth

width: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyflip

flip?: {
    horizontal?: boolean;
    vertical?: boolean;
}

Readonlyheight

height: number

Optional Readonlyrotation

rotation?: number

Readonlywidth

width: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/INumberingOptions.html b/api/interfaces/INumberingOptions.html index 3a53d06d4b..5ff02071e8 100644 --- a/api/interfaces/INumberingOptions.html +++ b/api/interfaces/INumberingOptions.html @@ -1,2 +1,2 @@ -INumberingOptions | docx

Interface INumberingOptions

interface INumberingOptions {
    config: readonly {
        levels: readonly ILevelsOptions[];
        reference: string;
    }[];
}

Properties

config -

Properties

Readonlyconfig

config: readonly {
    levels: readonly ILevelsOptions[];
    reference: string;
}[]

Settings

Member Visibility

On This Page

Properties
+INumberingOptions | docx

Interface INumberingOptions

interface INumberingOptions {
    config: readonly {
        levels: readonly ILevelsOptions[];
        reference: string;
    }[];
}

Properties

config +

Properties

Readonlyconfig

config: readonly {
    levels: readonly ILevelsOptions[];
    reference: string;
}[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageBorderAttributes.html b/api/interfaces/IPageBorderAttributes.html index 5a000c4ab7..4dee92b4e0 100644 --- a/api/interfaces/IPageBorderAttributes.html +++ b/api/interfaces/IPageBorderAttributes.html @@ -1,4 +1,4 @@ -IPageBorderAttributes | docx

Interface IPageBorderAttributes

interface IPageBorderAttributes {
    display?: "allPages" | "firstPage" | "notFirstPage";
    offsetFrom?: "text" | "page";
    zOrder?: "back" | "front";
}

Properties

display? +IPageBorderAttributes | docx

Interface IPageBorderAttributes

interface IPageBorderAttributes {
    display?: "allPages" | "firstPage" | "notFirstPage";
    offsetFrom?: "text" | "page";
    zOrder?: "back" | "front";
}

Properties

display? offsetFrom? zOrder? -

Properties

Optional Readonlydisplay

display?: "allPages" | "firstPage" | "notFirstPage"

Optional ReadonlyoffsetFrom

offsetFrom?: "text" | "page"

Optional ReadonlyzOrder

zOrder?: "back" | "front"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlydisplay

display?: "allPages" | "firstPage" | "notFirstPage"

Optional ReadonlyoffsetFrom

offsetFrom?: "text" | "page"

Optional ReadonlyzOrder

zOrder?: "back" | "front"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageBordersOptions.html b/api/interfaces/IPageBordersOptions.html index f63ba482a3..5563ba3e9e 100644 --- a/api/interfaces/IPageBordersOptions.html +++ b/api/interfaces/IPageBordersOptions.html @@ -1,6 +1,6 @@ -IPageBordersOptions | docx

Interface IPageBordersOptions

interface IPageBordersOptions {
    pageBorderBottom?: IBorderOptions;
    pageBorderLeft?: IBorderOptions;
    pageBorderRight?: IBorderOptions;
    pageBorders?: IPageBorderAttributes;
    pageBorderTop?: IBorderOptions;
}

Properties

pageBorderBottom? +IPageBordersOptions | docx

Interface IPageBordersOptions

interface IPageBordersOptions {
    pageBorderBottom?: IBorderOptions;
    pageBorderLeft?: IBorderOptions;
    pageBorderRight?: IBorderOptions;
    pageBorders?: IPageBorderAttributes;
    pageBorderTop?: IBorderOptions;
}

Properties

pageBorderBottom? pageBorderLeft? pageBorderRight? pageBorders? pageBorderTop? -

Properties

Optional ReadonlypageBorderBottom

pageBorderBottom?: IBorderOptions

Optional ReadonlypageBorderLeft

pageBorderLeft?: IBorderOptions

Optional ReadonlypageBorderRight

pageBorderRight?: IBorderOptions

Optional ReadonlypageBorders

pageBorders?: IPageBorderAttributes

Optional ReadonlypageBorderTop

pageBorderTop?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlypageBorderBottom

pageBorderBottom?: IBorderOptions

Optional ReadonlypageBorderLeft

pageBorderLeft?: IBorderOptions

Optional ReadonlypageBorderRight

pageBorderRight?: IBorderOptions

Optional ReadonlypageBorders

pageBorders?: IPageBorderAttributes

Optional ReadonlypageBorderTop

pageBorderTop?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageNumberTypeAttributes.html b/api/interfaces/IPageNumberTypeAttributes.html index 62c770901e..080316f12a 100644 --- a/api/interfaces/IPageNumberTypeAttributes.html +++ b/api/interfaces/IPageNumberTypeAttributes.html @@ -1,4 +1,4 @@ -IPageNumberTypeAttributes | docx

Interface IPageNumberTypeAttributes

interface IPageNumberTypeAttributes {
    formatType?:
        | "hex"
        | "none"
        | "bullet"
        | "decimal"
        | "upperRoman"
        | "lowerRoman"
        | "upperLetter"
        | "lowerLetter"
        | "ordinal"
        | "cardinalText"
        | "ordinalText"
        | "chicago"
        | "ideographDigital"
        | "japaneseCounting"
        | "aiueo"
        | "iroha"
        | "decimalFullWidth"
        | "decimalHalfWidth"
        | "japaneseLegal"
        | "japaneseDigitalTenThousand"
        | "decimalEnclosedCircle"
        | "decimalFullWidth2"
        | "aiueoFullWidth"
        | "irohaFullWidth"
        | "decimalZero"
        | "ganada"
        | "chosung"
        | "decimalEnclosedFullstop"
        | "decimalEnclosedParen"
        | "decimalEnclosedCircleChinese"
        | "ideographEnclosedCircle"
        | "ideographTraditional"
        | "ideographZodiac"
        | "ideographZodiacTraditional"
        | "taiwaneseCounting"
        | "ideographLegalTraditional"
        | "taiwaneseCountingThousand"
        | "taiwaneseDigital"
        | "chineseCounting"
        | "chineseLegalSimplified"
        | "chineseCountingThousand"
        | "koreanDigital"
        | "koreanCounting"
        | "koreanLegal"
        | "koreanDigital2"
        | "vietnameseCounting"
        | "russianLower"
        | "russianUpper"
        | "numberInDash"
        | "hebrew1"
        | "hebrew2"
        | "arabicAlpha"
        | "arabicAbjad"
        | "hindiVowels"
        | "hindiConsonants"
        | "hindiNumbers"
        | "hindiCounting"
        | "thaiLetters"
        | "thaiNumbers"
        | "thaiCounting"
        | "bahtText"
        | "dollarText";
    separator?:
        | "hyphen"
        | "period"
        | "colon"
        | "emDash"
        | "endash";
    start?: number;
}

Properties

formatType? +IPageNumberTypeAttributes | docx

Interface IPageNumberTypeAttributes

interface IPageNumberTypeAttributes {
    formatType?:
        | "hex"
        | "none"
        | "bullet"
        | "decimal"
        | "upperRoman"
        | "lowerRoman"
        | "upperLetter"
        | "lowerLetter"
        | "ordinal"
        | "cardinalText"
        | "ordinalText"
        | "chicago"
        | "ideographDigital"
        | "japaneseCounting"
        | "aiueo"
        | "iroha"
        | "decimalFullWidth"
        | "decimalHalfWidth"
        | "japaneseLegal"
        | "japaneseDigitalTenThousand"
        | "decimalEnclosedCircle"
        | "decimalFullWidth2"
        | "aiueoFullWidth"
        | "irohaFullWidth"
        | "decimalZero"
        | "ganada"
        | "chosung"
        | "decimalEnclosedFullstop"
        | "decimalEnclosedParen"
        | "decimalEnclosedCircleChinese"
        | "ideographEnclosedCircle"
        | "ideographTraditional"
        | "ideographZodiac"
        | "ideographZodiacTraditional"
        | "taiwaneseCounting"
        | "ideographLegalTraditional"
        | "taiwaneseCountingThousand"
        | "taiwaneseDigital"
        | "chineseCounting"
        | "chineseLegalSimplified"
        | "chineseCountingThousand"
        | "koreanDigital"
        | "koreanCounting"
        | "koreanLegal"
        | "koreanDigital2"
        | "vietnameseCounting"
        | "russianLower"
        | "russianUpper"
        | "numberInDash"
        | "hebrew1"
        | "hebrew2"
        | "arabicAlpha"
        | "arabicAbjad"
        | "hindiVowels"
        | "hindiConsonants"
        | "hindiNumbers"
        | "hindiCounting"
        | "thaiLetters"
        | "thaiNumbers"
        | "thaiCounting"
        | "bahtText"
        | "dollarText";
    separator?:
        | "hyphen"
        | "period"
        | "colon"
        | "emDash"
        | "endash";
    start?: number;
}

Properties

formatType? separator? start? -

Properties

Optional ReadonlyformatType

formatType?:
    | "hex"
    | "none"
    | "bullet"
    | "decimal"
    | "upperRoman"
    | "lowerRoman"
    | "upperLetter"
    | "lowerLetter"
    | "ordinal"
    | "cardinalText"
    | "ordinalText"
    | "chicago"
    | "ideographDigital"
    | "japaneseCounting"
    | "aiueo"
    | "iroha"
    | "decimalFullWidth"
    | "decimalHalfWidth"
    | "japaneseLegal"
    | "japaneseDigitalTenThousand"
    | "decimalEnclosedCircle"
    | "decimalFullWidth2"
    | "aiueoFullWidth"
    | "irohaFullWidth"
    | "decimalZero"
    | "ganada"
    | "chosung"
    | "decimalEnclosedFullstop"
    | "decimalEnclosedParen"
    | "decimalEnclosedCircleChinese"
    | "ideographEnclosedCircle"
    | "ideographTraditional"
    | "ideographZodiac"
    | "ideographZodiacTraditional"
    | "taiwaneseCounting"
    | "ideographLegalTraditional"
    | "taiwaneseCountingThousand"
    | "taiwaneseDigital"
    | "chineseCounting"
    | "chineseLegalSimplified"
    | "chineseCountingThousand"
    | "koreanDigital"
    | "koreanCounting"
    | "koreanLegal"
    | "koreanDigital2"
    | "vietnameseCounting"
    | "russianLower"
    | "russianUpper"
    | "numberInDash"
    | "hebrew1"
    | "hebrew2"
    | "arabicAlpha"
    | "arabicAbjad"
    | "hindiVowels"
    | "hindiConsonants"
    | "hindiNumbers"
    | "hindiCounting"
    | "thaiLetters"
    | "thaiNumbers"
    | "thaiCounting"
    | "bahtText"
    | "dollarText"

Optional Readonlyseparator

separator?:
    | "hyphen"
    | "period"
    | "colon"
    | "emDash"
    | "endash"

Optional Readonlystart

start?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyformatType

formatType?:
    | "hex"
    | "none"
    | "bullet"
    | "decimal"
    | "upperRoman"
    | "lowerRoman"
    | "upperLetter"
    | "lowerLetter"
    | "ordinal"
    | "cardinalText"
    | "ordinalText"
    | "chicago"
    | "ideographDigital"
    | "japaneseCounting"
    | "aiueo"
    | "iroha"
    | "decimalFullWidth"
    | "decimalHalfWidth"
    | "japaneseLegal"
    | "japaneseDigitalTenThousand"
    | "decimalEnclosedCircle"
    | "decimalFullWidth2"
    | "aiueoFullWidth"
    | "irohaFullWidth"
    | "decimalZero"
    | "ganada"
    | "chosung"
    | "decimalEnclosedFullstop"
    | "decimalEnclosedParen"
    | "decimalEnclosedCircleChinese"
    | "ideographEnclosedCircle"
    | "ideographTraditional"
    | "ideographZodiac"
    | "ideographZodiacTraditional"
    | "taiwaneseCounting"
    | "ideographLegalTraditional"
    | "taiwaneseCountingThousand"
    | "taiwaneseDigital"
    | "chineseCounting"
    | "chineseLegalSimplified"
    | "chineseCountingThousand"
    | "koreanDigital"
    | "koreanCounting"
    | "koreanLegal"
    | "koreanDigital2"
    | "vietnameseCounting"
    | "russianLower"
    | "russianUpper"
    | "numberInDash"
    | "hebrew1"
    | "hebrew2"
    | "arabicAlpha"
    | "arabicAbjad"
    | "hindiVowels"
    | "hindiConsonants"
    | "hindiNumbers"
    | "hindiCounting"
    | "thaiLetters"
    | "thaiNumbers"
    | "thaiCounting"
    | "bahtText"
    | "dollarText"

Optional Readonlyseparator

separator?:
    | "hyphen"
    | "period"
    | "colon"
    | "emDash"
    | "endash"

Optional Readonlystart

start?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphOptions.html b/api/interfaces/IParagraphOptions.html index fcaae8611e..cafcaca0f1 100644 --- a/api/interfaces/IParagraphOptions.html +++ b/api/interfaces/IParagraphOptions.html @@ -1,4 +1,4 @@ -IParagraphOptions | docx

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?: IFrameOptions;
    heading?:
        | "Heading1"
        | "Heading2"
        | "Heading3"
        | "Heading4"
        | "Heading5"
        | "Heading6"
        | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: false | {
        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? +IParagraphOptions | docx

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?: IFrameOptions;
    heading?:
        | "Heading1"
        | "Heading2"
        | "Heading3"
        | "Heading4"
        | "Heading5"
        | "Heading6"
        | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: false | {
        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? autoSpaceEastAsianText? bidirectional? border? @@ -27,9 +27,9 @@ thematicBreak? widowControl? wordWrap? -

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

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. +

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

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.

-

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional Readonlychildren

children?: readonly ParagraphChild[]

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

heading?:
    | "Heading1"
    | "Heading2"
    | "Heading3"
    | "Heading4"
    | "Heading5"
    | "Heading6"
    | "Title"

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

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.

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

-

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonlytext

text?: string

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional Readonlychildren

children?: readonly ParagraphChild[]

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

heading?:
    | "Heading1"
    | "Heading2"
    | "Heading3"
    | "Heading4"
    | "Heading5"
    | "Heading6"
    | "Title"

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

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.

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

+

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonlytext

text?: string

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphPropertiesOptions.html b/api/interfaces/IParagraphPropertiesOptions.html index 9b85c2493b..7c5df120cf 100644 --- a/api/interfaces/IParagraphPropertiesOptions.html +++ b/api/interfaces/IParagraphPropertiesOptions.html @@ -1,4 +1,4 @@ -IParagraphPropertiesOptions | docx

Interface IParagraphPropertiesOptions

interface IParagraphPropertiesOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    autoSpaceEastAsianText?: boolean;
    bidirectional?: boolean;
    border?: IBordersOptions;
    bullet?: {
        level: number;
    };
    contextualSpacing?: boolean;
    frame?: IFrameOptions;
    heading?:
        | "Heading1"
        | "Heading2"
        | "Heading3"
        | "Heading4"
        | "Heading5"
        | "Heading6"
        | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: false | {
        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[];
    thematicBreak?: boolean;
    widowControl?: boolean;
    wordWrap?: boolean;
}

Hierarchy (view full)

Properties

alignment? +IParagraphPropertiesOptions | docx

Interface IParagraphPropertiesOptions

interface IParagraphPropertiesOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    autoSpaceEastAsianText?: boolean;
    bidirectional?: boolean;
    border?: IBordersOptions;
    bullet?: {
        level: number;
    };
    contextualSpacing?: boolean;
    frame?: IFrameOptions;
    heading?:
        | "Heading1"
        | "Heading2"
        | "Heading3"
        | "Heading4"
        | "Heading5"
        | "Heading6"
        | "Title";
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: false | {
        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[];
    thematicBreak?: boolean;
    widowControl?: boolean;
    wordWrap?: boolean;
}

Hierarchy (view full)

Properties

alignment? autoSpaceEastAsianText? bidirectional? border? @@ -25,9 +25,9 @@ thematicBreak? widowControl? wordWrap? -

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

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. +

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

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.

-

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

heading?:
    | "Heading1"
    | "Heading2"
    | "Heading3"
    | "Heading4"
    | "Heading5"
    | "Heading6"
    | "Title"

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

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.

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

-

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

heading?:
    | "Heading1"
    | "Heading2"
    | "Heading3"
    | "Heading4"
    | "Heading5"
    | "Heading6"
    | "Title"

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

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.

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

+

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphStyleOptions.html b/api/interfaces/IParagraphStyleOptions.html index 6960ee9d39..42171599e5 100644 --- a/api/interfaces/IParagraphStyleOptions.html +++ b/api/interfaces/IParagraphStyleOptions.html @@ -1,4 +1,4 @@ -IParagraphStyleOptions | docx

Interface IParagraphStyleOptions

interface IParagraphStyleOptions {
    basedOn?: string;
    id: string;
    link?: string;
    name?: string;
    next?: string;
    paragraph?: IParagraphStylePropertiesOptions;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy (view full)

Properties

basedOn? +IParagraphStyleOptions | docx

Interface IParagraphStyleOptions

interface IParagraphStyleOptions {
    basedOn?: string;
    id: string;
    link?: string;
    name?: string;
    next?: string;
    paragraph?: IParagraphStylePropertiesOptions;
    quickFormat?: boolean;
    run?: IRunStylePropertiesOptions;
    semiHidden?: boolean;
    uiPriority?: number;
    unhideWhenUsed?: boolean;
}

Hierarchy (view full)

Properties

basedOn? id link? name? @@ -13,4 +13,4 @@ Note that if the type of the current style must match the type of the style upon which it is based or the basedOn element will be ignored. However, if the current style is a numbering style, then the basedOn element is ignored.

WARNING: You cannot set basedOn to be the same as name. This is akin to inheriting from itself. This creates a cyclic dependency and cause undesirable behavior.

-

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphStylePropertiesOptions.html b/api/interfaces/IParagraphStylePropertiesOptions.html index f202f0743d..4daa7a0314 100644 --- a/api/interfaces/IParagraphStylePropertiesOptions.html +++ b/api/interfaces/IParagraphStylePropertiesOptions.html @@ -1,4 +1,4 @@ -IParagraphStylePropertiesOptions | docx

Interface IParagraphStylePropertiesOptions

interface IParagraphStylePropertiesOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    contextualSpacing?: boolean;
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: false | {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    rightTabStop?: number;
    spacing?: ISpacingProperties;
    thematicBreak?: boolean;
}

Hierarchy (view full)

Properties

alignment? +IParagraphStylePropertiesOptions | docx

Interface IParagraphStylePropertiesOptions

interface IParagraphStylePropertiesOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    contextualSpacing?: boolean;
    indent?: IIndentAttributesProperties;
    keepLines?: boolean;
    keepNext?: boolean;
    leftTabStop?: number;
    numbering?: false | {
        custom?: boolean;
        instance?: number;
        level: number;
        reference: string;
    };
    outlineLevel?: number;
    rightTabStop?: number;
    spacing?: ISpacingProperties;
    thematicBreak?: boolean;
}

Hierarchy (view full)

Properties

alignment? contextualSpacing? indent? keepLines? @@ -9,6 +9,6 @@ rightTabStop? spacing? thematicBreak? -

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

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.

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

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.

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunOptions.html b/api/interfaces/IRunOptions.html index 94de199475..2481f28557 100644 --- a/api/interfaces/IRunOptions.html +++ b/api/interfaces/IRunOptions.html @@ -1,4 +1,4 @@ -IRunOptions | docx

Interface IRunOptions

interface IRunOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    break?: number;
    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;
    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? +IRunOptions | docx

Interface IRunOptions

interface IRunOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    break?: number;
    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;
    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? @@ -37,4 +37,4 @@ text? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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 Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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 Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunPropertiesChangeOptions.html b/api/interfaces/IRunPropertiesChangeOptions.html index 8882c00ab7..454acec7e1 100644 --- a/api/interfaces/IRunPropertiesChangeOptions.html +++ b/api/interfaces/IRunPropertiesChangeOptions.html @@ -1,4 +1,4 @@ -IRunPropertiesChangeOptions | docx

Interface IRunPropertiesChangeOptions

interface IRunPropertiesChangeOptions {
    allCaps?: boolean;
    author: string;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    date: 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;
    id: number;
    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;
    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? +IRunPropertiesChangeOptions | docx

Interface IRunPropertiesChangeOptions

interface IRunPropertiesChangeOptions {
    allCaps?: boolean;
    author: string;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    date: 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;
    id: number;
    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;
    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? author bold? boldComplexScript? @@ -37,4 +37,4 @@ superScript? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Readonlyauthor

author: string

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Readonlydate

date: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Readonlyid

id: number

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Readonlyauthor

author: string

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Readonlydate

date: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Readonlyid

id: number

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunPropertiesOptions.html b/api/interfaces/IRunPropertiesOptions.html index 5ac0b52428..d5709491e3 100644 --- a/api/interfaces/IRunPropertiesOptions.html +++ b/api/interfaces/IRunPropertiesOptions.html @@ -1,4 +1,4 @@ -IRunPropertiesOptions | docx

Interface IRunPropertiesOptions

interface IRunPropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    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;
    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? +IRunPropertiesOptions | docx

Interface IRunPropertiesOptions

interface IRunPropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    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;
    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? @@ -34,4 +34,4 @@ superScript? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunStylePropertiesOptions.html b/api/interfaces/IRunStylePropertiesOptions.html index d92aa926a7..aac04f5a8f 100644 --- a/api/interfaces/IRunStylePropertiesOptions.html +++ b/api/interfaces/IRunStylePropertiesOptions.html @@ -1,4 +1,4 @@ -IRunStylePropertiesOptions | docx

Interface IRunStylePropertiesOptions

interface IRunStylePropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    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;
    subScript?: boolean;
    superScript?: boolean;
    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? +IRunStylePropertiesOptions | docx

Interface IRunStylePropertiesOptions

interface IRunStylePropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    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;
    subScript?: boolean;
    superScript?: boolean;
    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? @@ -33,4 +33,4 @@ superScript? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISectionOptions.html b/api/interfaces/ISectionOptions.html index 69503c27f3..b49d0f347b 100644 --- a/api/interfaces/ISectionOptions.html +++ b/api/interfaces/ISectionOptions.html @@ -1,5 +1,5 @@ -ISectionOptions | docx

Interface ISectionOptions

interface ISectionOptions {
    children: readonly FileChild[];
    footers?: {
        default?: Footer;
        even?: Footer;
        first?: Footer;
    };
    headers?: {
        default?: Header;
        even?: Header;
        first?: Header;
    };
    properties?: ISectionPropertiesOptions;
}

Properties

children +ISectionOptions | docx

Interface ISectionOptions

interface ISectionOptions {
    children: readonly FileChild[];
    footers?: {
        default?: Footer;
        even?: Footer;
        first?: Footer;
    };
    headers?: {
        default?: Header;
        even?: Header;
        first?: Header;
    };
    properties?: ISectionPropertiesOptions;
}

Properties

children footers? headers? properties? -

Properties

Readonlychildren

children: readonly FileChild[]

Optional Readonlyfooters

footers?: {
    default?: Footer;
    even?: Footer;
    first?: Footer;
}

Optional Readonlyheaders

headers?: {
    default?: Header;
    even?: Header;
    first?: Header;
}

Optional Readonlyproperties

properties?: ISectionPropertiesOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly FileChild[]

Optional Readonlyfooters

footers?: {
    default?: Footer;
    even?: Footer;
    first?: Footer;
}

Optional Readonlyheaders

headers?: {
    default?: Header;
    even?: Header;
    first?: Header;
}

Optional Readonlyproperties

properties?: ISectionPropertiesOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISectionPropertiesOptions.html b/api/interfaces/ISectionPropertiesOptions.html index 31c78c7fad..25829f2426 100644 --- a/api/interfaces/ISectionPropertiesOptions.html +++ b/api/interfaces/ISectionPropertiesOptions.html @@ -1,4 +1,4 @@ -ISectionPropertiesOptions | docx

Interface ISectionPropertiesOptions

interface ISectionPropertiesOptions {
    column?: IColumnsAttributes;
    footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
    grid?: IDocGridAttributesProperties;
    headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
    lineNumbers?: ILineNumberAttributes;
    page?: {
        borders?: IPageBordersOptions;
        margin?: IPageMarginAttributes;
        pageNumbers?: IPageNumberTypeAttributes;
        size?: IPageSizeAttributes;
        textDirection?: "lrTb" | "tbRl";
    };
    titlePage?: boolean;
    type?:
        | "continuous"
        | "nextPage"
        | "nextColumn"
        | "evenPage"
        | "oddPage";
    verticalAlign?: "bottom" | "center" | "top";
}

Properties

column? +ISectionPropertiesOptions | docx

Interface ISectionPropertiesOptions

interface ISectionPropertiesOptions {
    column?: IColumnsAttributes;
    footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
    grid?: IDocGridAttributesProperties;
    headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
    lineNumbers?: ILineNumberAttributes;
    page?: {
        borders?: IPageBordersOptions;
        margin?: IPageMarginAttributes;
        pageNumbers?: IPageNumberTypeAttributes;
        size?: IPageSizeAttributes;
        textDirection?: "lrTb" | "tbRl";
    };
    titlePage?: boolean;
    type?:
        | "continuous"
        | "nextPage"
        | "nextColumn"
        | "evenPage"
        | "oddPage";
    verticalAlign?: "bottom" | "center" | "top";
}

Properties

column? footerWrapperGroup? grid? headerWrapperGroup? @@ -7,4 +7,4 @@ titlePage? type? verticalAlign? -

Properties

Optional Readonlycolumn

column?: IColumnsAttributes

Optional ReadonlyfooterWrapperGroup

footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>

Optional Readonlygrid

grid?: IDocGridAttributesProperties

Optional ReadonlyheaderWrapperGroup

headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>

Optional ReadonlylineNumbers

lineNumbers?: ILineNumberAttributes

Optional Readonlypage

page?: {
    borders?: IPageBordersOptions;
    margin?: IPageMarginAttributes;
    pageNumbers?: IPageNumberTypeAttributes;
    size?: IPageSizeAttributes;
    textDirection?: "lrTb" | "tbRl";
}

Optional ReadonlytitlePage

titlePage?: boolean

Optional Readonlytype

type?:
    | "continuous"
    | "nextPage"
    | "nextColumn"
    | "evenPage"
    | "oddPage"

Optional ReadonlyverticalAlign

verticalAlign?: "bottom" | "center" | "top"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolumn

column?: IColumnsAttributes

Optional ReadonlyfooterWrapperGroup

footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>

Optional Readonlygrid

grid?: IDocGridAttributesProperties

Optional ReadonlyheaderWrapperGroup

headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>

Optional ReadonlylineNumbers

lineNumbers?: ILineNumberAttributes

Optional Readonlypage

page?: {
    borders?: IPageBordersOptions;
    margin?: IPageMarginAttributes;
    pageNumbers?: IPageNumberTypeAttributes;
    size?: IPageSizeAttributes;
    textDirection?: "lrTb" | "tbRl";
}

Optional ReadonlytitlePage

titlePage?: boolean

Optional Readonlytype

type?:
    | "continuous"
    | "nextPage"
    | "nextColumn"
    | "evenPage"
    | "oddPage"

Optional ReadonlyverticalAlign

verticalAlign?: "bottom" | "center" | "top"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IShadingAttributesProperties.html b/api/interfaces/IShadingAttributesProperties.html index 0f0c8fca31..b9eeb288fb 100644 --- a/api/interfaces/IShadingAttributesProperties.html +++ b/api/interfaces/IShadingAttributesProperties.html @@ -1,4 +1,4 @@ -IShadingAttributesProperties | docx

Interface IShadingAttributesProperties

interface IShadingAttributesProperties {
    color?: string;
    fill?: string;
    type?:
        | "clear"
        | "diagCross"
        | "diagStripe"
        | "horzCross"
        | "horzStripe"
        | "nil"
        | "pct5"
        | "pct10"
        | "pct12"
        | "pct15"
        | "pct20"
        | "pct25"
        | "pct30"
        | "pct35"
        | "pct37"
        | "pct40"
        | "pct45"
        | "pct50"
        | "pct55"
        | "pct60"
        | "pct62"
        | "pct65"
        | "pct70"
        | "pct75"
        | "pct80"
        | "pct85"
        | "pct87"
        | "pct90"
        | "pct95"
        | "reverseDiagStripe"
        | "solid"
        | "thinDiagCross"
        | "thinDiagStripe"
        | "thinHorzCross"
        | "thinReverseDiagStripe"
        | "thinVertStripe"
        | "vertStripe";
}

Properties

color? +IShadingAttributesProperties | docx

Interface IShadingAttributesProperties

interface IShadingAttributesProperties {
    color?: string;
    fill?: string;
    type?:
        | "clear"
        | "diagCross"
        | "diagStripe"
        | "horzCross"
        | "horzStripe"
        | "nil"
        | "pct5"
        | "pct10"
        | "pct12"
        | "pct15"
        | "pct20"
        | "pct25"
        | "pct30"
        | "pct35"
        | "pct37"
        | "pct40"
        | "pct45"
        | "pct50"
        | "pct55"
        | "pct60"
        | "pct62"
        | "pct65"
        | "pct70"
        | "pct75"
        | "pct80"
        | "pct85"
        | "pct87"
        | "pct90"
        | "pct95"
        | "reverseDiagStripe"
        | "solid"
        | "thinDiagCross"
        | "thinDiagStripe"
        | "thinHorzCross"
        | "thinReverseDiagStripe"
        | "thinVertStripe"
        | "vertStripe";
}

Properties

color? fill? type? -

Properties

Optional Readonlycolor

color?: string

Optional Readonlyfill

fill?: string

Optional Readonlytype

type?:
    | "clear"
    | "diagCross"
    | "diagStripe"
    | "horzCross"
    | "horzStripe"
    | "nil"
    | "pct5"
    | "pct10"
    | "pct12"
    | "pct15"
    | "pct20"
    | "pct25"
    | "pct30"
    | "pct35"
    | "pct37"
    | "pct40"
    | "pct45"
    | "pct50"
    | "pct55"
    | "pct60"
    | "pct62"
    | "pct65"
    | "pct70"
    | "pct75"
    | "pct80"
    | "pct85"
    | "pct87"
    | "pct90"
    | "pct95"
    | "reverseDiagStripe"
    | "solid"
    | "thinDiagCross"
    | "thinDiagStripe"
    | "thinHorzCross"
    | "thinReverseDiagStripe"
    | "thinVertStripe"
    | "vertStripe"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolor

color?: string

Optional Readonlyfill

fill?: string

Optional Readonlytype

type?:
    | "clear"
    | "diagCross"
    | "diagStripe"
    | "horzCross"
    | "horzStripe"
    | "nil"
    | "pct5"
    | "pct10"
    | "pct12"
    | "pct15"
    | "pct20"
    | "pct25"
    | "pct30"
    | "pct35"
    | "pct37"
    | "pct40"
    | "pct45"
    | "pct50"
    | "pct55"
    | "pct60"
    | "pct62"
    | "pct65"
    | "pct70"
    | "pct75"
    | "pct80"
    | "pct85"
    | "pct87"
    | "pct90"
    | "pct95"
    | "reverseDiagStripe"
    | "solid"
    | "thinDiagCross"
    | "thinDiagStripe"
    | "thinHorzCross"
    | "thinReverseDiagStripe"
    | "thinVertStripe"
    | "vertStripe"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISpacingProperties.html b/api/interfaces/ISpacingProperties.html index 30a6ce8e97..8bf445e02b 100644 --- a/api/interfaces/ISpacingProperties.html +++ b/api/interfaces/ISpacingProperties.html @@ -1,7 +1,7 @@ -ISpacingProperties | docx

Interface ISpacingProperties

interface ISpacingProperties {
    after?: number;
    afterAutoSpacing?: boolean;
    before?: number;
    beforeAutoSpacing?: boolean;
    line?: number;
    lineRule?:
        | "auto"
        | "atLeast"
        | "exact"
        | "exactly";
}

Properties

after? +ISpacingProperties | docx

Interface ISpacingProperties

interface ISpacingProperties {
    after?: number;
    afterAutoSpacing?: boolean;
    before?: number;
    beforeAutoSpacing?: boolean;
    line?: number;
    lineRule?:
        | "auto"
        | "atLeast"
        | "exact"
        | "exactly";
}

Properties

after? afterAutoSpacing? before? beforeAutoSpacing? line? lineRule? -

Properties

Optional Readonlyafter

after?: number

Optional ReadonlyafterAutoSpacing

afterAutoSpacing?: boolean

Optional Readonlybefore

before?: number

Optional ReadonlybeforeAutoSpacing

beforeAutoSpacing?: boolean

Optional Readonlyline

line?: number

Optional ReadonlylineRule

lineRule?:
    | "auto"
    | "atLeast"
    | "exact"
    | "exactly"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyafter

after?: number

Optional ReadonlyafterAutoSpacing

afterAutoSpacing?: boolean

Optional Readonlybefore

before?: number

Optional ReadonlybeforeAutoSpacing

beforeAutoSpacing?: boolean

Optional Readonlyline

line?: number

Optional ReadonlylineRule

lineRule?:
    | "auto"
    | "atLeast"
    | "exact"
    | "exactly"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IStylesOptions.html b/api/interfaces/IStylesOptions.html index b1cee8eac3..5a01429dd0 100644 --- a/api/interfaces/IStylesOptions.html +++ b/api/interfaces/IStylesOptions.html @@ -1,6 +1,6 @@ -IStylesOptions | docx

Interface IStylesOptions

interface IStylesOptions {
    characterStyles?: readonly ICharacterStyleOptions[];
    default?: IDefaultStylesOptions;
    importedStyles?: readonly (
        | XmlComponent
        | StyleForParagraph
        | StyleForCharacter
        | ImportedXmlComponent)[];
    initialStyles?: BaseXmlComponent;
    paragraphStyles?: readonly IParagraphStyleOptions[];
}

Properties

characterStyles? +IStylesOptions | docx

Interface IStylesOptions

interface IStylesOptions {
    characterStyles?: readonly ICharacterStyleOptions[];
    default?: IDefaultStylesOptions;
    importedStyles?: readonly (
        | XmlComponent
        | StyleForParagraph
        | StyleForCharacter
        | ImportedXmlComponent)[];
    initialStyles?: BaseXmlComponent;
    paragraphStyles?: readonly IParagraphStyleOptions[];
}

Properties

characterStyles? default? importedStyles? initialStyles? paragraphStyles? -

Properties

Optional ReadonlycharacterStyles

characterStyles?: readonly ICharacterStyleOptions[]

Optional Readonlydefault

default?: IDefaultStylesOptions

Optional ReadonlyimportedStyles

importedStyles?: readonly (
    | XmlComponent
    | StyleForParagraph
    | StyleForCharacter
    | ImportedXmlComponent)[]

Optional ReadonlyinitialStyles

initialStyles?: BaseXmlComponent

Optional ReadonlyparagraphStyles

paragraphStyles?: readonly IParagraphStyleOptions[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycharacterStyles

characterStyles?: readonly ICharacterStyleOptions[]

Optional Readonlydefault

default?: IDefaultStylesOptions

Optional ReadonlyimportedStyles

importedStyles?: readonly (
    | XmlComponent
    | StyleForParagraph
    | StyleForCharacter
    | ImportedXmlComponent)[]

Optional ReadonlyinitialStyles

initialStyles?: BaseXmlComponent

Optional ReadonlyparagraphStyles

paragraphStyles?: readonly IParagraphStyleOptions[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISymbolRunOptions.html b/api/interfaces/ISymbolRunOptions.html index 127a1d3c2b..146d21356f 100644 --- a/api/interfaces/ISymbolRunOptions.html +++ b/api/interfaces/ISymbolRunOptions.html @@ -1,4 +1,4 @@ -ISymbolRunOptions | docx

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? +ISymbolRunOptions | docx

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? @@ -39,4 +39,4 @@ text? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Readonlychar

char: string

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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 Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlysymbolfont

symbolfont?: string

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Readonlychar

char: string

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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 Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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 Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlysymbolfont

symbolfont?: string

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableBordersOptions.html b/api/interfaces/ITableBordersOptions.html index c19c5a3ab9..d95d50836e 100644 --- a/api/interfaces/ITableBordersOptions.html +++ b/api/interfaces/ITableBordersOptions.html @@ -1,7 +1,7 @@ -ITableBordersOptions | docx

Interface ITableBordersOptions

interface ITableBordersOptions {
    bottom?: IBorderOptions;
    insideHorizontal?: IBorderOptions;
    insideVertical?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? +ITableBordersOptions | docx

Interface ITableBordersOptions

interface ITableBordersOptions {
    bottom?: IBorderOptions;
    insideHorizontal?: IBorderOptions;
    insideVertical?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? insideHorizontal? insideVertical? left? right? top? -

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional ReadonlyinsideHorizontal

insideHorizontal?: IBorderOptions

Optional ReadonlyinsideVertical

insideVertical?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional ReadonlyinsideHorizontal

insideHorizontal?: IBorderOptions

Optional ReadonlyinsideVertical

insideVertical?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableCellBorders.html b/api/interfaces/ITableCellBorders.html index 428845303f..68c7992bfe 100644 --- a/api/interfaces/ITableCellBorders.html +++ b/api/interfaces/ITableCellBorders.html @@ -1,7 +1,7 @@ -ITableCellBorders | docx

Interface ITableCellBorders

interface ITableCellBorders {
    bottom?: IBorderOptions;
    end?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    start?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? +ITableCellBorders | docx

Interface ITableCellBorders

interface ITableCellBorders {
    bottom?: IBorderOptions;
    end?: IBorderOptions;
    left?: IBorderOptions;
    right?: IBorderOptions;
    start?: IBorderOptions;
    top?: IBorderOptions;
}

Properties

bottom? end? left? right? start? top? -

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyend

end?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlystart

start?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyend

end?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlystart

start?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableCellOptions.html b/api/interfaces/ITableCellOptions.html index c7919dcac3..f65a573a90 100644 --- a/api/interfaces/ITableCellOptions.html +++ b/api/interfaces/ITableCellOptions.html @@ -1,4 +1,4 @@ -ITableCellOptions | docx

Interface ITableCellOptions

interface ITableCellOptions {
    borders?: ITableCellBorders;
    children: readonly (Paragraph | Table)[];
    columnSpan?: number;
    margins?: ITableCellMarginOptions;
    rowSpan?: number;
    shading?: IShadingAttributesProperties;
    textDirection?: "btLr" | "lrTb" | "tbRl";
    verticalAlign?: "bottom" | "center" | "top";
    verticalMerge?: "continue" | "restart";
    width?: ITableWidthProperties;
}

Hierarchy

  • ITableCellPropertiesOptions
    • ITableCellOptions

Properties

borders? +ITableCellOptions | docx

Interface ITableCellOptions

interface ITableCellOptions {
    borders?: ITableCellBorders;
    children: readonly (Paragraph | Table)[];
    columnSpan?: number;
    margins?: ITableCellMarginOptions;
    rowSpan?: number;
    shading?: IShadingAttributesProperties;
    textDirection?: "btLr" | "lrTb" | "tbRl";
    verticalAlign?: "bottom" | "center" | "top";
    verticalMerge?: "continue" | "restart";
    width?: ITableWidthProperties;
}

Hierarchy

  • ITableCellPropertiesOptions
    • ITableCellOptions

Properties

borders? children columnSpan? margins? @@ -8,4 +8,4 @@ verticalAlign? verticalMerge? width? -

Properties

Optional Readonlyborders

borders?: ITableCellBorders

Readonlychildren

children: readonly (Paragraph | Table)[]

Optional ReadonlycolumnSpan

columnSpan?: number

Optional Readonlymargins

margins?: ITableCellMarginOptions

Optional ReadonlyrowSpan

rowSpan?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional ReadonlytextDirection

textDirection?: "btLr" | "lrTb" | "tbRl"

Optional ReadonlyverticalAlign

verticalAlign?: "bottom" | "center" | "top"

Optional ReadonlyverticalMerge

verticalMerge?: "continue" | "restart"

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyborders

borders?: ITableCellBorders

Readonlychildren

children: readonly (Paragraph | Table)[]

Optional ReadonlycolumnSpan

columnSpan?: number

Optional Readonlymargins

margins?: ITableCellMarginOptions

Optional ReadonlyrowSpan

rowSpan?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional ReadonlytextDirection

textDirection?: "btLr" | "lrTb" | "tbRl"

Optional ReadonlyverticalAlign

verticalAlign?: "bottom" | "center" | "top"

Optional ReadonlyverticalMerge

verticalMerge?: "continue" | "restart"

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableOfContentsOptions.html b/api/interfaces/ITableOfContentsOptions.html index 2ad2e0d852..897b56280e 100644 --- a/api/interfaces/ITableOfContentsOptions.html +++ b/api/interfaces/ITableOfContentsOptions.html @@ -3,7 +3,7 @@ Part 1 - Page 1251

Short Guide: http://officeopenxml.com/WPtableOfContents.php

-
interface ITableOfContentsOptions {
    captionLabel?: string;
    captionLabelIncludingNumbers?: string;
    entriesFromBookmark?: string;
    entryAndPageNumberSeparator?: string;
    headingStyleRange?: string;
    hideTabAndPageNumbersInWebView?: boolean;
    hyperlink?: boolean;
    pageNumbersEntryLevelsRange?: string;
    preserveNewLineInEntries?: boolean;
    preserveTabInEntries?: boolean;
    seqFieldIdentifierForPrefix?: string;
    sequenceAndPageNumbersSeparator?: string;
    stylesWithLevels?: readonly StyleLevel[];
    tcFieldIdentifier?: string;
    tcFieldLevelRange?: string;
    useAppliedParagraphOutlineLevel?: boolean;
}

Properties

captionLabel? +
interface ITableOfContentsOptions {
    captionLabel?: string;
    captionLabelIncludingNumbers?: string;
    entriesFromBookmark?: string;
    entryAndPageNumberSeparator?: string;
    headingStyleRange?: string;
    hideTabAndPageNumbersInWebView?: boolean;
    hyperlink?: boolean;
    pageNumbersEntryLevelsRange?: string;
    preserveNewLineInEntries?: boolean;
    preserveTabInEntries?: boolean;
    seqFieldIdentifierForPrefix?: string;
    sequenceAndPageNumbersSeparator?: string;
    stylesWithLevels?: readonly StyleLevel[];
    tcFieldIdentifier?: string;
    tcFieldLevelRange?: string;
    useAppliedParagraphOutlineLevel?: boolean;
}

Properties

captionLabel? captionLabelIncludingNumbers? entriesFromBookmark? entryAndPageNumberSeparator? @@ -22,40 +22,40 @@ Part 1 - Page 1251

Properties

Optional ReadonlycaptionLabel

captionLabel?: string

\a option - Includes captioned items, but omits caption labels and numbers. The identifier designated by text in this switch's field-argument corresponds to the caption label. Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.

-

Optional ReadonlycaptionLabelIncludingNumbers

captionLabelIncludingNumbers?: string

\c option - Includes figures, tables, charts, and other items that are numbered +

Optional ReadonlycaptionLabelIncludingNumbers

captionLabelIncludingNumbers?: string

\c option - Includes figures, tables, charts, and other items that are numbered by a SEQ field (§17.16.5.56). The sequence identifier designated by text in this switch's field-argument, which corresponds to the caption label, shall match the identifier in the corresponding SEQ field.

-

Optional ReadonlyentriesFromBookmark

entriesFromBookmark?: string

\b option - Includes entries only from the portion of the document marked by +

Optional ReadonlyentriesFromBookmark

entriesFromBookmark?: string

\b option - Includes entries only from the portion of the document marked by the bookmark named by text in this switch's field-argument.

-

Optional ReadonlyentryAndPageNumberSeparator

entryAndPageNumberSeparator?: string

\p option - Text in this switch's field-argument specifies a sequence of characters +

Optional ReadonlyentryAndPageNumberSeparator

entryAndPageNumberSeparator?: string

\p option - Text in this switch's field-argument specifies a sequence of characters that separate an entry and its page number. The default is a tab with leader dots.

-

Optional ReadonlyheadingStyleRange

headingStyleRange?: string

\o option - Uses paragraphs formatted with all or the specified range of builtin +

Optional ReadonlyheadingStyleRange

headingStyleRange?: string

\o option - Uses paragraphs formatted with all or the specified range of builtin heading styles. Headings in a style range are specified by text in this switch's field-argument using the notation specified as for \l, where each integer corresponds to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1). If no heading range is specified, all heading levels used in the document are listed.

-

Optional ReadonlyhideTabAndPageNumbersInWebView

hideTabAndPageNumbersInWebView?: boolean

\z Hides tab leader and page numbers in web page view (§17.18.102).

-

Optional Readonlyhyperlink

hyperlink?: boolean

\h option - Makes the table of contents entries hyperlinks.

-

Optional ReadonlypageNumbersEntryLevelsRange

pageNumbersEntryLevelsRange?: string

\n option - Without field-argument, omits page numbers from the table of contents. +

Optional ReadonlyhideTabAndPageNumbersInWebView

hideTabAndPageNumbersInWebView?: boolean

\z Hides tab leader and page numbers in web page view (§17.18.102).

+

Optional Readonlyhyperlink

hyperlink?: boolean

\h option - Makes the table of contents entries hyperlinks.

+

Optional ReadonlypageNumbersEntryLevelsRange

pageNumbersEntryLevelsRange?: string

\n option - Without field-argument, omits page numbers from the table of contents. Page numbers are omitted from all levels unless a range of entry levels is specified by text in this switch's field-argument. A range is specified as for \l.

-

Optional ReadonlypreserveNewLineInEntries

preserveNewLineInEntries?: boolean

\x Preserves newline characters within table entries.

-

Optional ReadonlypreserveTabInEntries

preserveTabInEntries?: boolean

\w Preserves tab entries within table entries.

-

Optional ReadonlyseqFieldIdentifierForPrefix

seqFieldIdentifierForPrefix?: string

\s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number. +

Optional ReadonlypreserveNewLineInEntries

preserveNewLineInEntries?: boolean

\x Preserves newline characters within table entries.

+

Optional ReadonlypreserveTabInEntries

preserveTabInEntries?: boolean

\w Preserves tab entries within table entries.

+

Optional ReadonlyseqFieldIdentifierForPrefix

seqFieldIdentifierForPrefix?: string

\s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number. The prefix depends on the type of entry. text in this switch's field-argument shall match the identifier in the SEQ field.

-

Optional ReadonlysequenceAndPageNumbersSeparator

sequenceAndPageNumbersSeparator?: string

\d option - When used with \s, the text in this switch's field-argument defines +

Optional ReadonlysequenceAndPageNumbersSeparator

sequenceAndPageNumbersSeparator?: string

\d option - When used with \s, the text in this switch's field-argument defines the separator between sequence and page numbers. The default separator is a hyphen (-).

-

Optional ReadonlystylesWithLevels

stylesWithLevels?: readonly StyleLevel[]

\t field-argument Uses paragraphs formatted with styles other than the built-in heading styles. +

Optional ReadonlystylesWithLevels

stylesWithLevels?: readonly StyleLevel[]

\t field-argument Uses paragraphs formatted with styles other than the built-in heading styles. Text in this switch's field-argument specifies those styles as a set of comma-separated doublets, with each doublet being a comma-separated set of style name and table of content level. \t can be combined with \o.

-

Optional ReadonlytcFieldIdentifier

tcFieldIdentifier?: string

\f option - Includes only those TC fields whose identifier exactly matches the +

Optional ReadonlytcFieldIdentifier

tcFieldIdentifier?: string

\f option - Includes only those TC fields whose identifier exactly matches the text in this switch's field-argument (which is typically a letter).

-

Optional ReadonlytcFieldLevelRange

tcFieldLevelRange?: string

\l option - Includes TC fields that assign entries to one of the levels specified +

Optional ReadonlytcFieldLevelRange

tcFieldLevelRange?: string

\l option - Includes TC fields that assign entries to one of the levels specified by text in this switch's field-argument as a range having the form startLevel-endLevel, where startLevel and endLevel are integers, and startLevel has a value equal-to or less-than endLevel. TC fields that assign entries to lower levels are skipped.

-

Optional ReadonlyuseAppliedParagraphOutlineLevel

useAppliedParagraphOutlineLevel?: boolean

\u Uses the applied paragraph outline level.

-

Settings

Member Visibility

On This Page

Properties
+

Optional ReadonlyuseAppliedParagraphOutlineLevel

useAppliedParagraphOutlineLevel?: boolean

\u Uses the applied paragraph outline level.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableOptions.html b/api/interfaces/ITableOptions.html index 6d4e754ab5..348c41a9c7 100644 --- a/api/interfaces/ITableOptions.html +++ b/api/interfaces/ITableOptions.html @@ -1,4 +1,4 @@ -ITableOptions | docx

Interface ITableOptions

interface ITableOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    borders?: ITableBordersOptions;
    columnWidths?: readonly number[];
    float?: ITableFloatOptions;
    indent?: ITableWidthProperties;
    layout?: "fixed" | "autofit";
    margins?: ITableCellMarginOptions;
    rows: readonly TableRow[];
    style?: string;
    visuallyRightToLeft?: boolean;
    width?: ITableWidthProperties;
}

Properties

alignment? +ITableOptions | docx

Interface ITableOptions

interface ITableOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    borders?: ITableBordersOptions;
    columnWidths?: readonly number[];
    float?: ITableFloatOptions;
    indent?: ITableWidthProperties;
    layout?: "fixed" | "autofit";
    margins?: ITableCellMarginOptions;
    rows: readonly TableRow[];
    style?: string;
    visuallyRightToLeft?: boolean;
    width?: ITableWidthProperties;
}

Properties

alignment? borders? columnWidths? float? @@ -9,4 +9,4 @@ style? visuallyRightToLeft? width? -

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycolumnWidths

columnWidths?: readonly number[]

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlymargins

margins?: ITableCellMarginOptions

Readonlyrows

rows: readonly TableRow[]

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycolumnWidths

columnWidths?: readonly number[]

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlymargins

margins?: ITableCellMarginOptions

Readonlyrows

rows: readonly TableRow[]

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITablePropertiesOptions.html b/api/interfaces/ITablePropertiesOptions.html index 0117f44b0a..3ec5d881b1 100644 --- a/api/interfaces/ITablePropertiesOptions.html +++ b/api/interfaces/ITablePropertiesOptions.html @@ -1,4 +1,4 @@ -ITablePropertiesOptions | docx

Interface ITablePropertiesOptions

interface ITablePropertiesOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    borders?: ITableBordersOptions;
    cellMargin?: ITableCellMarginOptions;
    float?: ITableFloatOptions;
    indent?: ITableWidthProperties;
    layout?: "fixed" | "autofit";
    shading?: IShadingAttributesProperties;
    style?: string;
    visuallyRightToLeft?: boolean;
    width?: ITableWidthProperties;
}

Properties

alignment? +ITablePropertiesOptions | docx

Interface ITablePropertiesOptions

interface ITablePropertiesOptions {
    alignment?:
        | "center"
        | "left"
        | "right"
        | "start"
        | "end"
        | "both"
        | "mediumKashida"
        | "distribute"
        | "numTab"
        | "highKashida"
        | "lowKashida"
        | "thaiDistribute";
    borders?: ITableBordersOptions;
    cellMargin?: ITableCellMarginOptions;
    float?: ITableFloatOptions;
    indent?: ITableWidthProperties;
    layout?: "fixed" | "autofit";
    shading?: IShadingAttributesProperties;
    style?: string;
    visuallyRightToLeft?: boolean;
    width?: ITableWidthProperties;
}

Properties

alignment? borders? cellMargin? float? @@ -8,4 +8,4 @@ style? visuallyRightToLeft? width? -

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycellMargin

cellMargin?: ITableCellMarginOptions

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycellMargin

cellMargin?: ITableCellMarginOptions

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableRowOptions.html b/api/interfaces/ITableRowOptions.html index 2815382657..dc579c522c 100644 --- a/api/interfaces/ITableRowOptions.html +++ b/api/interfaces/ITableRowOptions.html @@ -1,5 +1,5 @@ -ITableRowOptions | docx

Interface ITableRowOptions

interface ITableRowOptions {
    cantSplit?: boolean;
    children: readonly TableCell[];
    height?: {
        rule: "auto" | "atLeast" | "exact";
        value:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`;
    };
    tableHeader?: boolean;
}

Hierarchy (view full)

Properties

cantSplit? +ITableRowOptions | docx

Interface ITableRowOptions

interface ITableRowOptions {
    cantSplit?: boolean;
    children: readonly TableCell[];
    height?: {
        rule: "auto" | "atLeast" | "exact";
        value:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`;
    };
    tableHeader?: boolean;
}

Hierarchy (view full)

Properties

cantSplit? children height? tableHeader? -

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Readonlychildren

children: readonly TableCell[]

Optional Readonlyheight

height?: {
    rule: "auto" | "atLeast" | "exact";
    value:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
}

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Readonlychildren

children: readonly TableCell[]

Optional Readonlyheight

height?: {
    rule: "auto" | "atLeast" | "exact";
    value:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
}

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableRowPropertiesOptions.html b/api/interfaces/ITableRowPropertiesOptions.html index c7c58b60df..bb8d44075b 100644 --- a/api/interfaces/ITableRowPropertiesOptions.html +++ b/api/interfaces/ITableRowPropertiesOptions.html @@ -1,4 +1,4 @@ -ITableRowPropertiesOptions | docx

Interface ITableRowPropertiesOptions

interface ITableRowPropertiesOptions {
    cantSplit?: boolean;
    height?: {
        rule: "auto" | "atLeast" | "exact";
        value:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`;
    };
    tableHeader?: boolean;
}

Hierarchy (view full)

Properties

cantSplit? +ITableRowPropertiesOptions | docx

Interface ITableRowPropertiesOptions

interface ITableRowPropertiesOptions {
    cantSplit?: boolean;
    height?: {
        rule: "auto" | "atLeast" | "exact";
        value:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`;
    };
    tableHeader?: boolean;
}

Hierarchy (view full)

Properties

cantSplit? height? tableHeader? -

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Optional Readonlyheight

height?: {
    rule: "auto" | "atLeast" | "exact";
    value:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
}

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Optional Readonlyheight

height?: {
    rule: "auto" | "atLeast" | "exact";
    value:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
}

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITextWrapping.html b/api/interfaces/ITextWrapping.html index 75ab8a4504..6ac8c79df4 100644 --- a/api/interfaces/ITextWrapping.html +++ b/api/interfaces/ITextWrapping.html @@ -1,4 +1,4 @@ -ITextWrapping | docx

Interface ITextWrapping

interface ITextWrapping {
    margins?: IDistance;
    side?:
        | "left"
        | "right"
        | "bothSides"
        | "largest";
    type:
        | 0
        | 1
        | 2
        | 3;
}

Properties

margins? +ITextWrapping | docx

Interface ITextWrapping

interface ITextWrapping {
    margins?: IDistance;
    side?:
        | "left"
        | "right"
        | "bothSides"
        | "largest";
    type:
        | 0
        | 1
        | 2
        | 3;
}

Properties

margins? side? type -

Properties

Optional Readonlymargins

margins?: IDistance

Optional Readonlyside

side?:
    | "left"
    | "right"
    | "bothSides"
    | "largest"

Readonlytype

type:
    | 0
    | 1
    | 2
    | 3

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlymargins

margins?: IDistance

Optional Readonlyside

side?:
    | "left"
    | "right"
    | "bothSides"
    | "largest"

Readonlytype

type:
    | 0
    | 1
    | 2
    | 3

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IVerticalPositionOptions.html b/api/interfaces/IVerticalPositionOptions.html index 05bd3a86cc..ef8ac12536 100644 --- a/api/interfaces/IVerticalPositionOptions.html +++ b/api/interfaces/IVerticalPositionOptions.html @@ -1,4 +1,4 @@ -IVerticalPositionOptions | docx

Interface IVerticalPositionOptions

interface IVerticalPositionOptions {
    align?:
        | "bottom"
        | "center"
        | "top"
        | "inside"
        | "outside";
    offset?: number;
    relative?:
        | "margin"
        | "page"
        | "insideMargin"
        | "outsideMargin"
        | "bottomMargin"
        | "line"
        | "paragraph"
        | "topMargin";
}

Properties

align? +IVerticalPositionOptions | docx

Interface IVerticalPositionOptions

interface IVerticalPositionOptions {
    align?:
        | "bottom"
        | "center"
        | "top"
        | "inside"
        | "outside";
    offset?: number;
    relative?:
        | "margin"
        | "page"
        | "insideMargin"
        | "outsideMargin"
        | "bottomMargin"
        | "line"
        | "paragraph"
        | "topMargin";
}

Properties

align? offset? relative? -

Properties

Optional Readonlyalign

align?:
    | "bottom"
    | "center"
    | "top"
    | "inside"
    | "outside"

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

relative?:
    | "margin"
    | "page"
    | "insideMargin"
    | "outsideMargin"
    | "bottomMargin"
    | "line"
    | "paragraph"
    | "topMargin"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalign

align?:
    | "bottom"
    | "center"
    | "top"
    | "inside"
    | "outside"

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

relative?:
    | "margin"
    | "page"
    | "insideMargin"
    | "outsideMargin"
    | "bottomMargin"
    | "line"
    | "paragraph"
    | "topMargin"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IXYFrameOptions.html b/api/interfaces/IXYFrameOptions.html index e4353be19c..fca6aaf95b 100644 --- a/api/interfaces/IXYFrameOptions.html +++ b/api/interfaces/IXYFrameOptions.html @@ -1,4 +1,4 @@ -IXYFrameOptions | docx

Interface IXYFrameOptions

interface IXYFrameOptions {
    anchor: {
        horizontal: "text" | "margin" | "page";
        vertical: "text" | "margin" | "page";
    };
    anchorLock?: boolean;
    dropCap?: "none" | "margin" | "drop";
    height: number;
    lines?: number;
    position: {
        x: number;
        y: number;
    };
    rule?: "auto" | "atLeast" | "exact";
    space?: {
        horizontal: number;
        vertical: number;
    };
    type: "absolute";
    width: number;
    wrap?:
        | "auto"
        | "none"
        | "around"
        | "notBeside"
        | "through"
        | "tight";
}

Hierarchy

  • IBaseFrameOptions
    • IXYFrameOptions

Properties

anchor +IXYFrameOptions | docx

Interface IXYFrameOptions

interface IXYFrameOptions {
    anchor: {
        horizontal: "text" | "margin" | "page";
        vertical: "text" | "margin" | "page";
    };
    anchorLock?: boolean;
    dropCap?: "none" | "margin" | "drop";
    height: number;
    lines?: number;
    position: {
        x: number;
        y: number;
    };
    rule?: "auto" | "atLeast" | "exact";
    space?: {
        horizontal: number;
        vertical: number;
    };
    type: "absolute";
    width: number;
    wrap?:
        | "auto"
        | "none"
        | "around"
        | "notBeside"
        | "through"
        | "tight";
}

Hierarchy

  • IBaseFrameOptions
    • IXYFrameOptions

Properties

anchor anchorLock? dropCap? height @@ -9,4 +9,4 @@ type width wrap? -

Properties

Readonlyanchor

anchor: {
    horizontal: "text" | "margin" | "page";
    vertical: "text" | "margin" | "page";
}

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

dropCap?: "none" | "margin" | "drop"

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Readonlyposition

position: {
    x: number;
    y: number;
}

Optional Readonlyrule

rule?: "auto" | "atLeast" | "exact"

Optional Readonlyspace

space?: {
    horizontal: number;
    vertical: number;
}

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

wrap?:
    | "auto"
    | "none"
    | "around"
    | "notBeside"
    | "through"
    | "tight"

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyanchor

anchor: {
    horizontal: "text" | "margin" | "page";
    vertical: "text" | "margin" | "page";
}

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

dropCap?: "none" | "margin" | "drop"

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Readonlyposition

position: {
    x: number;
    y: number;
}

Optional Readonlyrule

rule?: "auto" | "atLeast" | "exact"

Optional Readonlyspace

space?: {
    horizontal: number;
    vertical: number;
}

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

wrap?:
    | "auto"
    | "none"
    | "around"
    | "notBeside"
    | "through"
    | "tight"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IXmlAttribute.html b/api/interfaces/IXmlAttribute.html index 7e7c0d923f..414f020195 100644 --- a/api/interfaces/IXmlAttribute.html +++ b/api/interfaces/IXmlAttribute.html @@ -1 +1 @@ -IXmlAttribute | docx

Interface IXmlAttribute

Indexable

  • [key: string]: string | number | boolean

Settings

Member Visibility
+IXmlAttribute | docx

Interface IXmlAttribute

Indexable

  • [key: string]: string | number | boolean

Settings

Member Visibility
diff --git a/api/interfaces/IXmlableObject.html b/api/interfaces/IXmlableObject.html index f621077171..b7977d2be4 100644 --- a/api/interfaces/IXmlableObject.html +++ b/api/interfaces/IXmlableObject.html @@ -1 +1 @@ -IXmlableObject | docx

Interface IXmlableObject

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

  • [key: string]: any

Settings

Member Visibility
+IXmlableObject | docx

Interface IXmlableObject

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

  • [key: string]: any

Settings

Member Visibility
diff --git a/api/interfaces/PositionalTabOptions.html b/api/interfaces/PositionalTabOptions.html index ab9eb31e20..ebb6e11bb5 100644 --- a/api/interfaces/PositionalTabOptions.html +++ b/api/interfaces/PositionalTabOptions.html @@ -1,4 +1,4 @@ -PositionalTabOptions | docx

Interface PositionalTabOptions

interface PositionalTabOptions {
    alignment: "center" | "left" | "right";
    leader:
        | "none"
        | "dot"
        | "hyphen"
        | "underscore"
        | "middleDot";
    relativeTo: "indent" | "margin";
}

Properties

alignment +PositionalTabOptions | docx

Interface PositionalTabOptions

interface PositionalTabOptions {
    alignment: "center" | "left" | "right";
    leader:
        | "none"
        | "dot"
        | "hyphen"
        | "underscore"
        | "middleDot";
    relativeTo: "indent" | "margin";
}

Properties

alignment leader relativeTo -

Properties

Readonlyalignment

alignment: "center" | "left" | "right"

Readonlyleader

leader:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

ReadonlyrelativeTo

relativeTo: "indent" | "margin"

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyalignment

alignment: "center" | "left" | "right"

Readonlyleader

leader:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

ReadonlyrelativeTo

relativeTo: "indent" | "margin"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/TabStopDefinition.html b/api/interfaces/TabStopDefinition.html index 7bdca31cee..4b451f3c4f 100644 --- a/api/interfaces/TabStopDefinition.html +++ b/api/interfaces/TabStopDefinition.html @@ -1,4 +1,4 @@ -TabStopDefinition | docx

Interface TabStopDefinition

interface TabStopDefinition {
    leader?:
        | "none"
        | "dot"
        | "hyphen"
        | "underscore"
        | "middleDot";
    position: number;
    type:
        | "center"
        | "clear"
        | "left"
        | "right"
        | "start"
        | "end"
        | "decimal"
        | "bar"
        | "num";
}

Properties

leader? +TabStopDefinition | docx

Interface TabStopDefinition

interface TabStopDefinition {
    leader?:
        | "none"
        | "dot"
        | "hyphen"
        | "underscore"
        | "middleDot";
    position: number;
    type:
        | "center"
        | "clear"
        | "left"
        | "right"
        | "start"
        | "end"
        | "decimal"
        | "bar"
        | "num";
}

Properties

leader? position type -

Properties

Optional Readonlyleader

leader?:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

Readonlyposition

position: number

Readonlytype

type:
    | "center"
    | "clear"
    | "left"
    | "right"
    | "start"
    | "end"
    | "decimal"
    | "bar"
    | "num"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyleader

leader?:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

Readonlyposition

position: number

Readonlytype

type:
    | "center"
    | "clear"
    | "left"
    | "right"
    | "start"
    | "end"
    | "decimal"
    | "bar"
    | "num"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/types/AttributeData.html b/api/types/AttributeData.html index 05efa414c9..c12cf8b60d 100644 --- a/api/types/AttributeData.html +++ b/api/types/AttributeData.html @@ -1 +1 @@ -AttributeData | docx

Type Alias AttributeData

AttributeData: {
    [key: string]: boolean | number | string;
}

Settings

Member Visibility
+AttributeData | docx

Type Alias AttributeData

AttributeData: {
    [key: string]: boolean | number | string;
}

Settings

Member Visibility
diff --git a/api/types/AttributePayload.html b/api/types/AttributePayload.html index ba178a505d..6ddf345e1d 100644 --- a/api/types/AttributePayload.html +++ b/api/types/AttributePayload.html @@ -1 +1 @@ -AttributePayload | docx

Type Alias AttributePayload<T>

AttributePayload<T>: {
    readonly [P in keyof T]: {
        key: string;
        value: T[P];
    }
}

Type Parameters

  • T

Settings

Member Visibility
+AttributePayload | docx

Type Alias AttributePayload<T>

AttributePayload<T>: {
    readonly [P in keyof T]: {
        key: string;
        value: T[P];
    }
}

Type Parameters

  • T

Settings

Member Visibility
diff --git a/api/types/IColumnsAttributes.html b/api/types/IColumnsAttributes.html index 5454d8e671..a46f7a9ef6 100644 --- a/api/types/IColumnsAttributes.html +++ b/api/types/IColumnsAttributes.html @@ -1 +1 @@ -IColumnsAttributes | docx

Type Alias IColumnsAttributes

IColumnsAttributes: {
    children?: readonly Column[];
    count?: number;
    equalWidth?: boolean;
    separate?: boolean;
    space?: number | PositiveUniversalMeasure;
}

Settings

Member Visibility
+IColumnsAttributes | docx

Type Alias IColumnsAttributes

IColumnsAttributes: {
    children?: readonly Column[];
    count?: number;
    equalWidth?: boolean;
    separate?: boolean;
    space?: number | PositiveUniversalMeasure;
}

Settings

Member Visibility
diff --git a/api/types/IDistance.html b/api/types/IDistance.html index 2ffbcdc5d0..3ce1b962a0 100644 --- a/api/types/IDistance.html +++ b/api/types/IDistance.html @@ -1 +1 @@ -IDistance | docx

Type Alias IDistance

IDistance: {
    distB?: number;
    distL?: number;
    distR?: number;
    distT?: number;
}

Settings

Member Visibility
+IDistance | docx

Type Alias IDistance

IDistance: {
    distB?: number;
    distL?: number;
    distR?: number;
    distT?: number;
}

Settings

Member Visibility
diff --git a/api/types/IFrameOptions.html b/api/types/IFrameOptions.html index f396e74322..12376e9147 100644 --- a/api/types/IFrameOptions.html +++ b/api/types/IFrameOptions.html @@ -1 +1 @@ -IFrameOptions | docx

Type Alias IFrameOptions

IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions

Settings

Member Visibility
+IFrameOptions | docx

Type Alias IFrameOptions

IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions

Settings

Member Visibility
diff --git a/api/types/IImageOptions.html b/api/types/IImageOptions.html index a752dc35df..eebdbbd53b 100644 --- a/api/types/IImageOptions.html +++ b/api/types/IImageOptions.html @@ -1 +1 @@ -IImageOptions | docx

Type Alias IImageOptions

IImageOptions: (RegularImageOptions | SvgMediaOptions) & CoreImageOptions

Settings

Member Visibility
+IImageOptions | docx

Type Alias IImageOptions

IImageOptions: (RegularImageOptions | SvgMediaOptions) & CoreImageOptions

Settings

Member Visibility
diff --git a/api/types/ILineNumberAttributes.html b/api/types/ILineNumberAttributes.html index 7de6f29749..1fefd73b9f 100644 --- a/api/types/ILineNumberAttributes.html +++ b/api/types/ILineNumberAttributes.html @@ -1 +1 @@ -ILineNumberAttributes | docx

Type Alias ILineNumberAttributes

ILineNumberAttributes: {
    countBy?: number;
    distance?: number | PositiveUniversalMeasure;
    restart?: typeof LineNumberRestartFormat[keyof typeof LineNumberRestartFormat];
    start?: number;
}

Settings

Member Visibility
+ILineNumberAttributes | docx

Type Alias ILineNumberAttributes

ILineNumberAttributes: {
    countBy?: number;
    distance?: number | PositiveUniversalMeasure;
    restart?: typeof LineNumberRestartFormat[keyof typeof LineNumberRestartFormat];
    start?: number;
}

Settings

Member Visibility
diff --git a/api/types/IMediaData.html b/api/types/IMediaData.html index 693d2733d2..a4716a89b7 100644 --- a/api/types/IMediaData.html +++ b/api/types/IMediaData.html @@ -1 +1 @@ -IMediaData | docx

Type Alias IMediaData

IMediaData: (RegularMediaData | SvgMediaData) & CoreMediaData

Settings

Member Visibility
+IMediaData | docx

Type Alias IMediaData

IMediaData: (RegularMediaData | SvgMediaData) & CoreMediaData

Settings

Member Visibility
diff --git a/api/types/IPageMarginAttributes.html b/api/types/IPageMarginAttributes.html index 50edf0e9ce..2a9ae77c25 100644 --- a/api/types/IPageMarginAttributes.html +++ b/api/types/IPageMarginAttributes.html @@ -1 +1 @@ -IPageMarginAttributes | docx

Type Alias IPageMarginAttributes

IPageMarginAttributes: {
    bottom?: number | UniversalMeasure;
    footer?: number | PositiveUniversalMeasure;
    gutter?: number | PositiveUniversalMeasure;
    header?: number | PositiveUniversalMeasure;
    left?: number | PositiveUniversalMeasure;
    right?: number | PositiveUniversalMeasure;
    top?: number | UniversalMeasure;
}

Settings

Member Visibility
+IPageMarginAttributes | docx

Type Alias IPageMarginAttributes

IPageMarginAttributes: {
    bottom?: number | UniversalMeasure;
    footer?: number | PositiveUniversalMeasure;
    gutter?: number | PositiveUniversalMeasure;
    header?: number | PositiveUniversalMeasure;
    left?: number | PositiveUniversalMeasure;
    right?: number | PositiveUniversalMeasure;
    top?: number | UniversalMeasure;
}

Settings

Member Visibility
diff --git a/api/types/IPageReferenceOptions.html b/api/types/IPageReferenceOptions.html index 7559831114..0b2cf1c0af 100644 --- a/api/types/IPageReferenceOptions.html +++ b/api/types/IPageReferenceOptions.html @@ -4,4 +4,4 @@ bookmark. If the PAGEREF field is on the same page as the bookmark, it omits "on page #" and returns "above" or "below" only. If the PAGEREF field is not on the same page as the bookmark, the string "on page #" is used.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/types/IPageSizeAttributes.html b/api/types/IPageSizeAttributes.html index 1ec44f3a59..038fb3ade6 100644 --- a/api/types/IPageSizeAttributes.html +++ b/api/types/IPageSizeAttributes.html @@ -1 +1 @@ -IPageSizeAttributes | docx

Type Alias IPageSizeAttributes

IPageSizeAttributes: {
    height?: number | PositiveUniversalMeasure;
    orientation?: typeof PageOrientation[keyof typeof PageOrientation];
    width?: number | PositiveUniversalMeasure;
}

Settings

Member Visibility
+IPageSizeAttributes | docx

Type Alias IPageSizeAttributes

IPageSizeAttributes: {
    height?: number | PositiveUniversalMeasure;
    orientation?: typeof PageOrientation[keyof typeof PageOrientation];
    width?: number | PositiveUniversalMeasure;
}

Settings

Member Visibility
diff --git a/api/types/IPatch.html b/api/types/IPatch.html index 221ebb9066..911c15538d 100644 --- a/api/types/IPatch.html +++ b/api/types/IPatch.html @@ -1 +1 @@ -IPatch | docx

Type Alias IPatch

IPatch: ParagraphPatch | FilePatch

Settings

Member Visibility
+IPatch | docx

Type Alias IPatch

IPatch: ParagraphPatch | FilePatch

Settings

Member Visibility
diff --git a/api/types/ITableFloatOptions.html b/api/types/ITableFloatOptions.html index b621ed351c..3e66e53c0d 100644 --- a/api/types/ITableFloatOptions.html +++ b/api/types/ITableFloatOptions.html @@ -44,4 +44,4 @@ margin - relative to the horizontal edge of the text margin before any text runs page - relative to the horizontal edge of the page before any text runs (top edge for top-to-bottom paragraphs) text - relative to the horizontal edge of the text margin for the column in which the anchor paragraph is located If omitted, the value is assumed to be page.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/types/ITableWidthProperties.html b/api/types/ITableWidthProperties.html index 1ce5f49bd5..cf985f9086 100644 --- a/api/types/ITableWidthProperties.html +++ b/api/types/ITableWidthProperties.html @@ -1 +1 @@ -ITableWidthProperties | docx

Type Alias ITableWidthProperties

ITableWidthProperties: {
    size: number | Percentage | UniversalMeasure;
    type?: typeof WidthType[keyof typeof WidthType];
}

Settings

Member Visibility
+ITableWidthProperties | docx

Type Alias ITableWidthProperties

ITableWidthProperties: {
    size: number | Percentage | UniversalMeasure;
    type?: typeof WidthType[keyof typeof WidthType];
}

Settings

Member Visibility
diff --git a/api/types/InputDataType.html b/api/types/InputDataType.html index d0b7363ea3..8a3ad0c0f2 100644 --- a/api/types/InputDataType.html +++ b/api/types/InputDataType.html @@ -1 +1 @@ -InputDataType | docx

Type Alias InputDataType

InputDataType:
    | Buffer
    | string
    | number[]
    | Uint8Array
    | ArrayBuffer
    | Blob
    | NodeJS.ReadableStream

Settings

Member Visibility
+InputDataType | docx

Type Alias InputDataType

InputDataType:
    | Buffer
    | string
    | number[]
    | Uint8Array
    | ArrayBuffer
    | Blob
    | NodeJS.ReadableStream

Settings

Member Visibility
diff --git a/api/types/MathComponent.html b/api/types/MathComponent.html index e2ec5d78f5..122b45d9fd 100644 --- a/api/types/MathComponent.html +++ b/api/types/MathComponent.html @@ -1 +1 @@ -MathComponent | docx

Type Alias MathComponent

MathComponent:
    | MathRun
    | MathFraction
    | MathSum
    | MathIntegral
    | MathSuperScript
    | MathSubScript
    | MathSubSuperScript
    | MathRadical
    | MathFunction
    | MathRoundBrackets
    | MathCurlyBrackets
    | MathAngledBrackets
    | MathSquareBrackets

Settings

Member Visibility
+MathComponent | docx

Type Alias MathComponent

MathComponent:
    | MathRun
    | MathFraction
    | MathSum
    | MathIntegral
    | MathSuperScript
    | MathSubScript
    | MathSubSuperScript
    | MathRadical
    | MathFunction
    | MathRoundBrackets
    | MathCurlyBrackets
    | MathAngledBrackets
    | MathSquareBrackets

Settings

Member Visibility
diff --git a/api/types/ParagraphChild.html b/api/types/ParagraphChild.html index bbd2137789..af2c3058b6 100644 --- a/api/types/ParagraphChild.html +++ b/api/types/ParagraphChild.html @@ -1 +1 @@ -ParagraphChild | docx

Type Alias ParagraphChild

ParagraphChild:
    | TextRun
    | ImageRun
    | SymbolRun
    | Bookmark
    | PageBreak
    | ColumnBreak
    | SequentialIdentifier
    | FootnoteReferenceRun
    | InternalHyperlink
    | ExternalHyperlink
    | InsertedTextRun
    | DeletedTextRun
    | Math
    | SimpleField
    | SimpleMailMergeField
    | Comments
    | Comment
    | CommentRangeStart
    | CommentRangeEnd
    | CommentReference
    | CheckBox

Settings

Member Visibility
+ParagraphChild | docx

Type Alias ParagraphChild

ParagraphChild:
    | TextRun
    | ImageRun
    | SymbolRun
    | Bookmark
    | PageBreak
    | ColumnBreak
    | SequentialIdentifier
    | FootnoteReferenceRun
    | InternalHyperlink
    | ExternalHyperlink
    | InsertedTextRun
    | DeletedTextRun
    | Math
    | SimpleField
    | SimpleMailMergeField
    | Comments
    | Comment
    | CommentRangeStart
    | CommentRangeEnd
    | CommentReference
    | CheckBox

Settings

Member Visibility
diff --git a/api/types/PatchDocumentOptions.html b/api/types/PatchDocumentOptions.html index 82bd7dec65..70a4908479 100644 --- a/api/types/PatchDocumentOptions.html +++ b/api/types/PatchDocumentOptions.html @@ -1 +1 @@ -PatchDocumentOptions | docx

Type Alias PatchDocumentOptions<T>

PatchDocumentOptions<T>: {
    data: InputDataType;
    keepOriginalStyles?: boolean;
    outputType: T;
    patches: {
        [key: string]: IPatch;
    };
}

Type Parameters

Settings

Member Visibility
+PatchDocumentOptions | docx

Type Alias PatchDocumentOptions<T>

PatchDocumentOptions<T>: {
    data: InputDataType;
    keepOriginalStyles?: boolean;
    outputType: T;
    patches: {
        [key: string]: IPatch;
    };
}

Type Parameters

Settings

Member Visibility
diff --git a/api/types/PatchDocumentOutputType.html b/api/types/PatchDocumentOutputType.html index 96922cf734..7fadb49859 100644 --- a/api/types/PatchDocumentOutputType.html +++ b/api/types/PatchDocumentOutputType.html @@ -1 +1 @@ -PatchDocumentOutputType | docx

Type Alias PatchDocumentOutputType

PatchDocumentOutputType: keyof OutputByType

Settings

Member Visibility
+PatchDocumentOutputType | docx

Type Alias PatchDocumentOutputType

PatchDocumentOutputType: keyof OutputByType

Settings

Member Visibility
diff --git a/api/types/Percentage.html b/api/types/Percentage.html index 5f1a931eba..20a75f6975 100644 --- a/api/types/Percentage.html +++ b/api/types/Percentage.html @@ -1 +1 @@ -Percentage | docx

Type Alias Percentage

Percentage: `${"-" | ""}${number}%`

Settings

Member Visibility
+Percentage | docx

Type Alias Percentage

Percentage: `${"-" | ""}${number}%`

Settings

Member Visibility
diff --git a/api/types/PositiveUniversalMeasure.html b/api/types/PositiveUniversalMeasure.html index f85981f9ee..3bb538fa10 100644 --- a/api/types/PositiveUniversalMeasure.html +++ b/api/types/PositiveUniversalMeasure.html @@ -1 +1 @@ -PositiveUniversalMeasure | docx

Type Alias PositiveUniversalMeasure

PositiveUniversalMeasure: `${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
+PositiveUniversalMeasure | docx

Type Alias PositiveUniversalMeasure

PositiveUniversalMeasure: `${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
diff --git a/api/types/UniqueNumericIdCreator.html b/api/types/UniqueNumericIdCreator.html index 3940cd8db2..aaf5cacea6 100644 --- a/api/types/UniqueNumericIdCreator.html +++ b/api/types/UniqueNumericIdCreator.html @@ -1 +1 @@ -UniqueNumericIdCreator | docx

Type Alias UniqueNumericIdCreator

UniqueNumericIdCreator: (() => number)

Settings

Member Visibility
+UniqueNumericIdCreator | docx

Type Alias UniqueNumericIdCreator

UniqueNumericIdCreator: (() => number)

Settings

Member Visibility
diff --git a/api/types/UniversalMeasure.html b/api/types/UniversalMeasure.html index 0a1218b0b7..ec6c86aadf 100644 --- a/api/types/UniversalMeasure.html +++ b/api/types/UniversalMeasure.html @@ -1 +1 @@ -UniversalMeasure | docx

Type Alias UniversalMeasure

UniversalMeasure: `${"-" | ""}${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
+UniversalMeasure | docx

Type Alias UniversalMeasure

UniversalMeasure: `${"-" | ""}${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
diff --git a/api/variables/AlignmentType.html b/api/variables/AlignmentType.html index 4cc5802cd1..6de16d09d8 100644 --- a/api/variables/AlignmentType.html +++ b/api/variables/AlignmentType.html @@ -11,4 +11,4 @@
  • ReadonlyRIGHT: "right"

    Align Right

  • ReadonlySTART: "start"

    Align Start

  • ReadonlyTHAI_DISTRIBUTE: "thaiDistribute"

    Thai Language Justification

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/variables/BorderStyle.html b/api/variables/BorderStyle.html index ecd4ef32e9..159b23b40c 100644 --- a/api/variables/BorderStyle.html +++ b/api/variables/BorderStyle.html @@ -1 +1 @@ -BorderStyle | docx

    Variable BorderStyleConst

    BorderStyle: {
        DASH_DOT_STROKED: "dashDotStroked";
        DASH_SMALL_GAP: "dashSmallGap";
        DASHED: "dashed";
        DOT_DASH: "dotDash";
        DOT_DOT_DASH: "dotDotDash";
        DOTTED: "dotted";
        DOUBLE: "double";
        DOUBLE_WAVE: "doubleWave";
        INSET: "inset";
        NIL: "nil";
        NONE: "none";
        OUTSET: "outset";
        SINGLE: "single";
        THICK: "thick";
        THICK_THIN_LARGE_GAP: "thickThinLargeGap";
        THICK_THIN_MEDIUM_GAP: "thickThinMediumGap";
        THICK_THIN_SMALL_GAP: "thickThinSmallGap";
        THIN_THICK_LARGE_GAP: "thinThickLargeGap";
        THIN_THICK_MEDIUM_GAP: "thinThickMediumGap";
        THIN_THICK_SMALL_GAP: "thinThickSmallGap";
        THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap";
        THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap";
        THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap";
        THREE_D_EMBOSS: "threeDEmboss";
        THREE_D_ENGRAVE: "threeDEngrave";
        TRIPLE: "triple";
        WAVE: "wave";
    } = ...

    Settings

    Member Visibility
    +BorderStyle | docx

    Variable BorderStyleConst

    BorderStyle: {
        DASH_DOT_STROKED: "dashDotStroked";
        DASH_SMALL_GAP: "dashSmallGap";
        DASHED: "dashed";
        DOT_DASH: "dotDash";
        DOT_DOT_DASH: "dotDotDash";
        DOTTED: "dotted";
        DOUBLE: "double";
        DOUBLE_WAVE: "doubleWave";
        INSET: "inset";
        NIL: "nil";
        NONE: "none";
        OUTSET: "outset";
        SINGLE: "single";
        THICK: "thick";
        THICK_THIN_LARGE_GAP: "thickThinLargeGap";
        THICK_THIN_MEDIUM_GAP: "thickThinMediumGap";
        THICK_THIN_SMALL_GAP: "thickThinSmallGap";
        THIN_THICK_LARGE_GAP: "thinThickLargeGap";
        THIN_THICK_MEDIUM_GAP: "thinThickMediumGap";
        THIN_THICK_SMALL_GAP: "thinThickSmallGap";
        THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap";
        THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap";
        THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap";
        THREE_D_EMBOSS: "threeDEmboss";
        THREE_D_ENGRAVE: "threeDEngrave";
        TRIPLE: "triple";
        WAVE: "wave";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/CharacterSet.html b/api/variables/CharacterSet.html index a15b4fe901..6c0589655c 100644 --- a/api/variables/CharacterSet.html +++ b/api/variables/CharacterSet.html @@ -1 +1 @@ -CharacterSet | docx

    Variable CharacterSetConst

    CharacterSet: {
        ANSI: "00";
        ARABIC: "B2";
        BALTIC: "BA";
        CHINESEBIG5: "88";
        DEFAULT: "01";
        EASTEUROPE: "EE";
        GB_2312: "86";
        GREEK: "A1";
        HANGUL: "81";
        HEBREW: "B1";
        JIS: "80";
        JOHAB: "82";
        MAC: "4D";
        OEM: "FF";
        RUSSIAN: "CC";
        SYMBOL: "02";
        THAI: "DE";
        TURKISH: "A2";
        VIETNAMESE: "A3";
    } = ...

    Settings

    Member Visibility
    +CharacterSet | docx

    Variable CharacterSetConst

    CharacterSet: {
        ANSI: "00";
        ARABIC: "B2";
        BALTIC: "BA";
        CHINESEBIG5: "88";
        DEFAULT: "01";
        EASTEUROPE: "EE";
        GB_2312: "86";
        GREEK: "A1";
        HANGUL: "81";
        HEBREW: "B1";
        JIS: "80";
        JOHAB: "82";
        MAC: "4D";
        OEM: "FF";
        RUSSIAN: "CC";
        SYMBOL: "02";
        THAI: "DE";
        TURKISH: "A2";
        VIETNAMESE: "A3";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/DocumentGridType.html b/api/variables/DocumentGridType.html index 0ab8dcad22..d558e55f04 100644 --- a/api/variables/DocumentGridType.html +++ b/api/variables/DocumentGridType.html @@ -1 +1 @@ -DocumentGridType | docx

    Variable DocumentGridTypeConst

    DocumentGridType: {
        DEFAULT: "default";
        LINES: "lines";
        LINES_AND_CHARS: "linesAndChars";
        SNAP_TO_CHARS: "snapToChars";
    } = ...

    Settings

    Member Visibility
    +DocumentGridType | docx

    Variable DocumentGridTypeConst

    DocumentGridType: {
        DEFAULT: "default";
        LINES: "lines";
        LINES_AND_CHARS: "linesAndChars";
        SNAP_TO_CHARS: "snapToChars";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/DropCapType.html b/api/variables/DropCapType.html index d5cc3d4649..3c4a0b2cf4 100644 --- a/api/variables/DropCapType.html +++ b/api/variables/DropCapType.html @@ -1 +1 @@ -DropCapType | docx

    Variable DropCapTypeConst

    DropCapType: {
        DROP: "drop";
        MARGIN: "margin";
        NONE: "none";
    } = ...

    Settings

    Member Visibility
    +DropCapType | docx

    Variable DropCapTypeConst

    DropCapType: {
        DROP: "drop";
        MARGIN: "margin";
        NONE: "none";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/EMPTY_OBJECT.html b/api/variables/EMPTY_OBJECT.html index a4a92404c5..78df945533 100644 --- a/api/variables/EMPTY_OBJECT.html +++ b/api/variables/EMPTY_OBJECT.html @@ -1 +1 @@ -EMPTY_OBJECT | docx

    Variable EMPTY_OBJECTConst

    EMPTY_OBJECT: {} = ...

    Settings

    Member Visibility
    +EMPTY_OBJECT | docx

    Variable EMPTY_OBJECTConst

    EMPTY_OBJECT: {} = ...

    Settings

    Member Visibility
    diff --git a/api/variables/EmphasisMarkType.html b/api/variables/EmphasisMarkType.html index 362b4f5a5e..3de8ff8463 100644 --- a/api/variables/EmphasisMarkType.html +++ b/api/variables/EmphasisMarkType.html @@ -1 +1 @@ -EmphasisMarkType | docx

    Variable EmphasisMarkTypeConst

    EmphasisMarkType: {
        DOT: "dot";
    } = ...

    Settings

    Member Visibility
    +EmphasisMarkType | docx

    Variable EmphasisMarkTypeConst

    EmphasisMarkType: {
        DOT: "dot";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/FrameAnchorType.html b/api/variables/FrameAnchorType.html index 760a194602..4e4d0c1333 100644 --- a/api/variables/FrameAnchorType.html +++ b/api/variables/FrameAnchorType.html @@ -1 +1 @@ -FrameAnchorType | docx

    Variable FrameAnchorTypeConst

    FrameAnchorType: {
        MARGIN: "margin";
        PAGE: "page";
        TEXT: "text";
    } = ...

    Settings

    Member Visibility
    +FrameAnchorType | docx

    Variable FrameAnchorTypeConst

    FrameAnchorType: {
        MARGIN: "margin";
        PAGE: "page";
        TEXT: "text";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/FrameWrap.html b/api/variables/FrameWrap.html index 07aaa4edb4..d26bfa74e2 100644 --- a/api/variables/FrameWrap.html +++ b/api/variables/FrameWrap.html @@ -1 +1 @@ -FrameWrap | docx

    Variable FrameWrapConst

    FrameWrap: {
        AROUND: "around";
        AUTO: "auto";
        NONE: "none";
        NOT_BESIDE: "notBeside";
        THROUGH: "through";
        TIGHT: "tight";
    } = ...

    Settings

    Member Visibility
    +FrameWrap | docx

    Variable FrameWrapConst

    FrameWrap: {
        AROUND: "around";
        AUTO: "auto";
        NONE: "none";
        NOT_BESIDE: "notBeside";
        THROUGH: "through";
        TIGHT: "tight";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HeaderFooterReferenceType.html b/api/variables/HeaderFooterReferenceType.html index 6ee2ec70db..0a6593d96f 100644 --- a/api/variables/HeaderFooterReferenceType.html +++ b/api/variables/HeaderFooterReferenceType.html @@ -1 +1 @@ -HeaderFooterReferenceType | docx

    Variable HeaderFooterReferenceTypeConst

    HeaderFooterReferenceType: {
        DEFAULT: "default";
        EVEN: "even";
        FIRST: "first";
    } = ...

    Settings

    Member Visibility
    +HeaderFooterReferenceType | docx

    Variable HeaderFooterReferenceTypeConst

    HeaderFooterReferenceType: {
        DEFAULT: "default";
        EVEN: "even";
        FIRST: "first";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HeaderFooterType.html b/api/variables/HeaderFooterType.html index aa7c930cb3..2198329cbf 100644 --- a/api/variables/HeaderFooterType.html +++ b/api/variables/HeaderFooterType.html @@ -1 +1 @@ -HeaderFooterType | docx

    Variable HeaderFooterTypeConst

    HeaderFooterType: {
        FOOTER: "w:footerReference";
        HEADER: "w:headerReference";
    } = ...

    Settings

    Member Visibility
    +HeaderFooterType | docx

    Variable HeaderFooterTypeConst

    HeaderFooterType: {
        FOOTER: "w:footerReference";
        HEADER: "w:headerReference";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HeadingLevel.html b/api/variables/HeadingLevel.html index 7316a9702a..cc97a03d2e 100644 --- a/api/variables/HeadingLevel.html +++ b/api/variables/HeadingLevel.html @@ -1 +1 @@ -HeadingLevel | docx

    Variable HeadingLevelConst

    HeadingLevel: {
        HEADING_1: "Heading1";
        HEADING_2: "Heading2";
        HEADING_3: "Heading3";
        HEADING_4: "Heading4";
        HEADING_5: "Heading5";
        HEADING_6: "Heading6";
        TITLE: "Title";
    } = ...

    Settings

    Member Visibility
    +HeadingLevel | docx

    Variable HeadingLevelConst

    HeadingLevel: {
        HEADING_1: "Heading1";
        HEADING_2: "Heading2";
        HEADING_3: "Heading3";
        HEADING_4: "Heading4";
        HEADING_5: "Heading5";
        HEADING_6: "Heading6";
        TITLE: "Title";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HeightRule.html b/api/variables/HeightRule.html index 6992167add..3983b864fb 100644 --- a/api/variables/HeightRule.html +++ b/api/variables/HeightRule.html @@ -1,4 +1,4 @@ HeightRule | docx

    Variable HeightRuleConst

    HeightRule: {
        ATLEAST: "atLeast";
        AUTO: "auto";
        EXACT: "exact";
    } = ...

    Type declaration

    • ReadonlyATLEAST: "atLeast"

      At least the value specified

    • ReadonlyAUTO: "auto"

      Height is determined based on the content, so value is ignored.

    • ReadonlyEXACT: "exact"

      Exactly the value specified

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/variables/HighlightColor.html b/api/variables/HighlightColor.html index 73d6819173..1e61d978da 100644 --- a/api/variables/HighlightColor.html +++ b/api/variables/HighlightColor.html @@ -1 +1 @@ -HighlightColor | docx

    Variable HighlightColorConst

    HighlightColor: {
        BLACK: "black";
        BLUE: "blue";
        CYAN: "cyan";
        DARK_BLUE: "darkBlue";
        DARK_CYAN: "darkCyan";
        DARK_GRAY: "darkGray";
        DARK_GREEN: "darkGreen";
        DARK_MAGENTA: "darkMagenta";
        DARK_RED: "darkRed";
        DARK_YELLOW: "darkYellow";
        GREEN: "green";
        LIGHT_GRAY: "lightGray";
        MAGENTA: "magenta";
        NONE: "none";
        RED: "red";
        WHITE: "white";
        YELLOW: "yellow";
    } = ...

    Settings

    Member Visibility
    +HighlightColor | docx

    Variable HighlightColorConst

    HighlightColor: {
        BLACK: "black";
        BLUE: "blue";
        CYAN: "cyan";
        DARK_BLUE: "darkBlue";
        DARK_CYAN: "darkCyan";
        DARK_GRAY: "darkGray";
        DARK_GREEN: "darkGreen";
        DARK_MAGENTA: "darkMagenta";
        DARK_RED: "darkRed";
        DARK_YELLOW: "darkYellow";
        GREEN: "green";
        LIGHT_GRAY: "lightGray";
        MAGENTA: "magenta";
        NONE: "none";
        RED: "red";
        WHITE: "white";
        YELLOW: "yellow";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HorizontalPositionAlign.html b/api/variables/HorizontalPositionAlign.html index 39acba94c1..f7dc5a321b 100644 --- a/api/variables/HorizontalPositionAlign.html +++ b/api/variables/HorizontalPositionAlign.html @@ -1 +1 @@ -HorizontalPositionAlign | docx

    Variable HorizontalPositionAlignConst

    HorizontalPositionAlign: {
        CENTER: "center";
        INSIDE: "inside";
        LEFT: "left";
        OUTSIDE: "outside";
        RIGHT: "right";
    } = ...

    Settings

    Member Visibility
    +HorizontalPositionAlign | docx

    Variable HorizontalPositionAlignConst

    HorizontalPositionAlign: {
        CENTER: "center";
        INSIDE: "inside";
        LEFT: "left";
        OUTSIDE: "outside";
        RIGHT: "right";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HorizontalPositionRelativeFrom.html b/api/variables/HorizontalPositionRelativeFrom.html index e99054c3e6..3dbfdc89cd 100644 --- a/api/variables/HorizontalPositionRelativeFrom.html +++ b/api/variables/HorizontalPositionRelativeFrom.html @@ -1 +1 @@ -HorizontalPositionRelativeFrom | docx

    Variable HorizontalPositionRelativeFromConst

    HorizontalPositionRelativeFrom: {
        CHARACTER: "character";
        COLUMN: "column";
        INSIDE_MARGIN: "insideMargin";
        LEFT_MARGIN: "leftMargin";
        MARGIN: "margin";
        OUTSIDE_MARGIN: "outsideMargin";
        PAGE: "page";
        RIGHT_MARGIN: "rightMargin";
    } = ...

    Settings

    Member Visibility
    +HorizontalPositionRelativeFrom | docx

    Variable HorizontalPositionRelativeFromConst

    HorizontalPositionRelativeFrom: {
        CHARACTER: "character";
        COLUMN: "column";
        INSIDE_MARGIN: "insideMargin";
        LEFT_MARGIN: "leftMargin";
        MARGIN: "margin";
        OUTSIDE_MARGIN: "outsideMargin";
        PAGE: "page";
        RIGHT_MARGIN: "rightMargin";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HyperlinkType.html b/api/variables/HyperlinkType.html index f4da54904d..38c1eaa132 100644 --- a/api/variables/HyperlinkType.html +++ b/api/variables/HyperlinkType.html @@ -1 +1 @@ -HyperlinkType | docx

    Variable HyperlinkTypeConst

    HyperlinkType: {
        EXTERNAL: "EXTERNAL";
        INTERNAL: "INTERNAL";
    } = ...

    Settings

    Member Visibility
    +HyperlinkType | docx

    Variable HyperlinkTypeConst

    HyperlinkType: {
        EXTERNAL: "EXTERNAL";
        INTERNAL: "INTERNAL";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/LeaderType.html b/api/variables/LeaderType.html index 2081fba1f4..9eb26f3040 100644 --- a/api/variables/LeaderType.html +++ b/api/variables/LeaderType.html @@ -1 +1 @@ -LeaderType | docx

    Variable LeaderTypeConst

    LeaderType: {
        DOT: "dot";
        HYPHEN: "hyphen";
        MIDDLE_DOT: "middleDot";
        NONE: "none";
        UNDERSCORE: "underscore";
    } = ...

    Settings

    Member Visibility
    +LeaderType | docx

    Variable LeaderTypeConst

    LeaderType: {
        DOT: "dot";
        HYPHEN: "hyphen";
        MIDDLE_DOT: "middleDot";
        NONE: "none";
        UNDERSCORE: "underscore";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/LevelFormat.html b/api/variables/LevelFormat.html index 4cf01b00da..1d89205667 100644 --- a/api/variables/LevelFormat.html +++ b/api/variables/LevelFormat.html @@ -1 +1 @@ -LevelFormat | docx

    Variable LevelFormatConst

    LevelFormat: {
        AIUEO: "aiueo";
        AIUEO_FULL_WIDTH: "aiueoFullWidth";
        ARABIC_ABJAD: "arabicAbjad";
        ARABIC_ALPHA: "arabicAlpha";
        BAHT_TEXT: "bahtText";
        BULLET: "bullet";
        CARDINAL_TEXT: "cardinalText";
        CHICAGO: "chicago";
        CHINESE_COUNTING: "chineseCounting";
        CHINESE_COUNTING_THOUSAND: "chineseCountingThousand";
        CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
        CHOSUNG: "chosung";
        CUSTOM: "custom";
        DECIMAL: "decimal";
        DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
        DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
        DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop";
        DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen";
        DECIMAL_FULL_WIDTH: "decimalFullWidth";
        DECIMAL_FULL_WIDTH2: "decimalFullWidth2";
        DECIMAL_HALF_WIDTH: "decimalHalfWidth";
        DECIMAL_ZERO: "decimalZero";
        DOLLAR_TEXT: "dollarText";
        GANADA: "ganada";
        HEBREW1: "hebrew1";
        HEBREW2: "hebrew2";
        HEX: "hex";
        HINDI_CONSONANTS: "hindiConsonants";
        HINDI_COUNTING: "hindiCounting";
        HINDI_NUMBERS: "hindiNumbers";
        HINDI_VOWELS: "hindiVowels";
        IDEOGRAPH__DIGITAL: "ideographDigital";
        IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
        IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
        IDEOGRAPH_TRADITIONAL: "ideographTraditional";
        IDEOGRAPH_ZODIAC: "ideographZodiac";
        IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
        IROHA: "iroha";
        IROHA_FULL_WIDTH: "irohaFullWidth";
        JAPANESE_COUNTING: "japaneseCounting";
        JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
        JAPANESE_LEGAL: "japaneseLegal";
        KOREAN_COUNTING: "koreanCounting";
        KOREAN_DIGITAL: "koreanDigital";
        KOREAN_DIGITAL2: "koreanDigital2";
        KOREAN_LEGAL: "koreanLegal";
        LOWER_LETTER: "lowerLetter";
        LOWER_ROMAN: "lowerRoman";
        NONE: "none";
        NUMBER_IN_DASH: "numberInDash";
        ORDINAL: "ordinal";
        ORDINAL_TEXT: "ordinalText";
        RUSSIAN_LOWER: "russianLower";
        RUSSIAN_UPPER: "russianUpper";
        TAIWANESE_COUNTING: "taiwaneseCounting";
        TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
        TAIWANESE_DIGITAL: "taiwaneseDigital";
        THAI_COUNTING: "thaiCounting";
        THAI_LETTERS: "thaiLetters";
        THAI_NUMBERS: "thaiNumbers";
        UPPER_LETTER: "upperLetter";
        UPPER_ROMAN: "upperRoman";
        VIETNAMESE_COUNTING: "vietnameseCounting";
    } = ...

    Settings

    Member Visibility
    +LevelFormat | docx

    Variable LevelFormatConst

    LevelFormat: {
        AIUEO: "aiueo";
        AIUEO_FULL_WIDTH: "aiueoFullWidth";
        ARABIC_ABJAD: "arabicAbjad";
        ARABIC_ALPHA: "arabicAlpha";
        BAHT_TEXT: "bahtText";
        BULLET: "bullet";
        CARDINAL_TEXT: "cardinalText";
        CHICAGO: "chicago";
        CHINESE_COUNTING: "chineseCounting";
        CHINESE_COUNTING_THOUSAND: "chineseCountingThousand";
        CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
        CHOSUNG: "chosung";
        CUSTOM: "custom";
        DECIMAL: "decimal";
        DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
        DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
        DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop";
        DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen";
        DECIMAL_FULL_WIDTH: "decimalFullWidth";
        DECIMAL_FULL_WIDTH2: "decimalFullWidth2";
        DECIMAL_HALF_WIDTH: "decimalHalfWidth";
        DECIMAL_ZERO: "decimalZero";
        DOLLAR_TEXT: "dollarText";
        GANADA: "ganada";
        HEBREW1: "hebrew1";
        HEBREW2: "hebrew2";
        HEX: "hex";
        HINDI_CONSONANTS: "hindiConsonants";
        HINDI_COUNTING: "hindiCounting";
        HINDI_NUMBERS: "hindiNumbers";
        HINDI_VOWELS: "hindiVowels";
        IDEOGRAPH__DIGITAL: "ideographDigital";
        IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
        IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
        IDEOGRAPH_TRADITIONAL: "ideographTraditional";
        IDEOGRAPH_ZODIAC: "ideographZodiac";
        IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
        IROHA: "iroha";
        IROHA_FULL_WIDTH: "irohaFullWidth";
        JAPANESE_COUNTING: "japaneseCounting";
        JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
        JAPANESE_LEGAL: "japaneseLegal";
        KOREAN_COUNTING: "koreanCounting";
        KOREAN_DIGITAL: "koreanDigital";
        KOREAN_DIGITAL2: "koreanDigital2";
        KOREAN_LEGAL: "koreanLegal";
        LOWER_LETTER: "lowerLetter";
        LOWER_ROMAN: "lowerRoman";
        NONE: "none";
        NUMBER_IN_DASH: "numberInDash";
        ORDINAL: "ordinal";
        ORDINAL_TEXT: "ordinalText";
        RUSSIAN_LOWER: "russianLower";
        RUSSIAN_UPPER: "russianUpper";
        TAIWANESE_COUNTING: "taiwaneseCounting";
        TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
        TAIWANESE_DIGITAL: "taiwaneseDigital";
        THAI_COUNTING: "thaiCounting";
        THAI_LETTERS: "thaiLetters";
        THAI_NUMBERS: "thaiNumbers";
        UPPER_LETTER: "upperLetter";
        UPPER_ROMAN: "upperRoman";
        VIETNAMESE_COUNTING: "vietnameseCounting";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/LevelSuffix.html b/api/variables/LevelSuffix.html index df13299ec4..400b715383 100644 --- a/api/variables/LevelSuffix.html +++ b/api/variables/LevelSuffix.html @@ -1 +1 @@ -LevelSuffix | docx

    Variable LevelSuffixConst

    LevelSuffix: {
        NOTHING: "nothing";
        SPACE: "space";
        TAB: "tab";
    } = ...

    Settings

    Member Visibility
    +LevelSuffix | docx

    Variable LevelSuffixConst

    LevelSuffix: {
        NOTHING: "nothing";
        SPACE: "space";
        TAB: "tab";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/LineNumberRestartFormat.html b/api/variables/LineNumberRestartFormat.html index b14a96018d..438ef27008 100644 --- a/api/variables/LineNumberRestartFormat.html +++ b/api/variables/LineNumberRestartFormat.html @@ -1 +1 @@ -LineNumberRestartFormat | docx

    Variable LineNumberRestartFormatConst

    LineNumberRestartFormat: {
        CONTINUOUS: "continuous";
        NEW_PAGE: "newPage";
        NEW_SECTION: "newSection";
    } = ...

    Settings

    Member Visibility
    +LineNumberRestartFormat | docx

    Variable LineNumberRestartFormatConst

    LineNumberRestartFormat: {
        CONTINUOUS: "continuous";
        NEW_PAGE: "newPage";
        NEW_SECTION: "newSection";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/LineRuleType.html b/api/variables/LineRuleType.html index f8bff42518..b62cff900e 100644 --- a/api/variables/LineRuleType.html +++ b/api/variables/LineRuleType.html @@ -1 +1 @@ -LineRuleType | docx

    Variable LineRuleTypeConst

    LineRuleType: {
        AT_LEAST: "atLeast";
        AUTO: "auto";
        EXACT: "exact";
        EXACTLY: "exactly";
    } = ...

    Settings

    Member Visibility
    +LineRuleType | docx

    Variable LineRuleTypeConst

    LineRuleType: {
        AT_LEAST: "atLeast";
        AUTO: "auto";
        EXACT: "exact";
        EXACTLY: "exactly";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/NumberFormat.html b/api/variables/NumberFormat.html index b761e2cb61..61039fdc05 100644 --- a/api/variables/NumberFormat.html +++ b/api/variables/NumberFormat.html @@ -1 +1 @@ -NumberFormat | docx

    Variable NumberFormatConst

    NumberFormat: {
        AIUEO: "aiueo";
        AIUEO_FULL_WIDTH: "aiueoFullWidth";
        ARABIC_ABJAD: "arabicAbjad";
        ARABIC_ALPHA: "arabicAlpha";
        BAHT_TEXT: "bahtText";
        BULLET: "bullet";
        CARDINAL_TEXT: "cardinalText";
        CHICAGO: "chicago";
        CHINESE_COUNTING: "chineseCounting";
        CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand";
        CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
        CHOSUNG: "chosung";
        DECIMAL: "decimal";
        DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
        DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
        DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop";
        DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen";
        DECIMAL_FULL_WIDTH: "decimalFullWidth";
        DECIMAL_FULL_WIDTH_2: "decimalFullWidth2";
        DECIMAL_HALF_WIDTH: "decimalHalfWidth";
        DECIMAL_ZERO: "decimalZero";
        DOLLAR_TEXT: "dollarText";
        GANADA: "ganada";
        HEBREW_1: "hebrew1";
        HEBREW_2: "hebrew2";
        HEX: "hex";
        HINDI_CONSONANTS: "hindiConsonants";
        HINDI_COUNTING: "hindiCounting";
        HINDI_NUMBERS: "hindiNumbers";
        HINDI_VOWELS: "hindiVowels";
        IDEOGRAPH_DIGITAL: "ideographDigital";
        IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
        IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
        IDEOGRAPH_TRADITIONAL: "ideographTraditional";
        IDEOGRAPH_ZODIAC: "ideographZodiac";
        IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
        IROHA: "iroha";
        IROHA_FULL_WIDTH: "irohaFullWidth";
        JAPANESE_COUNTING: "japaneseCounting";
        JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
        JAPANESE_LEGAL: "japaneseLegal";
        KOREAN_COUNTING: "koreanCounting";
        KOREAN_DIGITAL: "koreanDigital";
        KOREAN_DIGITAL_2: "koreanDigital2";
        KOREAN_LEGAL: "koreanLegal";
        LOWER_LETTER: "lowerLetter";
        LOWER_ROMAN: "lowerRoman";
        NONE: "none";
        NUMBER_IN_DASH: "numberInDash";
        ORDINAL: "ordinal";
        ORDINAL_TEXT: "ordinalText";
        RUSSIAN_LOWER: "russianLower";
        RUSSIAN_UPPER: "russianUpper";
        TAIWANESE_COUNTING: "taiwaneseCounting";
        TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
        TAIWANESE_DIGITAL: "taiwaneseDigital";
        THAI_COUNTING: "thaiCounting";
        THAI_LETTERS: "thaiLetters";
        THAI_NUMBERS: "thaiNumbers";
        UPPER_LETTER: "upperLetter";
        UPPER_ROMAN: "upperRoman";
        VIETNAMESE_COUNTING: "vietnameseCounting";
    } = ...

    Settings

    Member Visibility
    +NumberFormat | docx

    Variable NumberFormatConst

    NumberFormat: {
        AIUEO: "aiueo";
        AIUEO_FULL_WIDTH: "aiueoFullWidth";
        ARABIC_ABJAD: "arabicAbjad";
        ARABIC_ALPHA: "arabicAlpha";
        BAHT_TEXT: "bahtText";
        BULLET: "bullet";
        CARDINAL_TEXT: "cardinalText";
        CHICAGO: "chicago";
        CHINESE_COUNTING: "chineseCounting";
        CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand";
        CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
        CHOSUNG: "chosung";
        DECIMAL: "decimal";
        DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
        DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
        DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop";
        DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen";
        DECIMAL_FULL_WIDTH: "decimalFullWidth";
        DECIMAL_FULL_WIDTH_2: "decimalFullWidth2";
        DECIMAL_HALF_WIDTH: "decimalHalfWidth";
        DECIMAL_ZERO: "decimalZero";
        DOLLAR_TEXT: "dollarText";
        GANADA: "ganada";
        HEBREW_1: "hebrew1";
        HEBREW_2: "hebrew2";
        HEX: "hex";
        HINDI_CONSONANTS: "hindiConsonants";
        HINDI_COUNTING: "hindiCounting";
        HINDI_NUMBERS: "hindiNumbers";
        HINDI_VOWELS: "hindiVowels";
        IDEOGRAPH_DIGITAL: "ideographDigital";
        IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
        IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
        IDEOGRAPH_TRADITIONAL: "ideographTraditional";
        IDEOGRAPH_ZODIAC: "ideographZodiac";
        IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
        IROHA: "iroha";
        IROHA_FULL_WIDTH: "irohaFullWidth";
        JAPANESE_COUNTING: "japaneseCounting";
        JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
        JAPANESE_LEGAL: "japaneseLegal";
        KOREAN_COUNTING: "koreanCounting";
        KOREAN_DIGITAL: "koreanDigital";
        KOREAN_DIGITAL_2: "koreanDigital2";
        KOREAN_LEGAL: "koreanLegal";
        LOWER_LETTER: "lowerLetter";
        LOWER_ROMAN: "lowerRoman";
        NONE: "none";
        NUMBER_IN_DASH: "numberInDash";
        ORDINAL: "ordinal";
        ORDINAL_TEXT: "ordinalText";
        RUSSIAN_LOWER: "russianLower";
        RUSSIAN_UPPER: "russianUpper";
        TAIWANESE_COUNTING: "taiwaneseCounting";
        TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
        TAIWANESE_DIGITAL: "taiwaneseDigital";
        THAI_COUNTING: "thaiCounting";
        THAI_LETTERS: "thaiLetters";
        THAI_NUMBERS: "thaiNumbers";
        UPPER_LETTER: "upperLetter";
        UPPER_ROMAN: "upperRoman";
        VIETNAMESE_COUNTING: "vietnameseCounting";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/OverlapType.html b/api/variables/OverlapType.html index 35bd5a726b..b69aca23a9 100644 --- a/api/variables/OverlapType.html +++ b/api/variables/OverlapType.html @@ -1 +1 @@ -OverlapType | docx

    Variable OverlapTypeConst

    OverlapType: {
        NEVER: "never";
        OVERLAP: "overlap";
    } = ...

    Settings

    Member Visibility
    +OverlapType | docx

    Variable OverlapTypeConst

    OverlapType: {
        NEVER: "never";
        OVERLAP: "overlap";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PageBorderDisplay.html b/api/variables/PageBorderDisplay.html index 4d49ebe0d4..58b4a5f0d9 100644 --- a/api/variables/PageBorderDisplay.html +++ b/api/variables/PageBorderDisplay.html @@ -1 +1 @@ -PageBorderDisplay | docx

    Variable PageBorderDisplayConst

    PageBorderDisplay: {
        ALL_PAGES: "allPages";
        FIRST_PAGE: "firstPage";
        NOT_FIRST_PAGE: "notFirstPage";
    } = ...

    Settings

    Member Visibility
    +PageBorderDisplay | docx

    Variable PageBorderDisplayConst

    PageBorderDisplay: {
        ALL_PAGES: "allPages";
        FIRST_PAGE: "firstPage";
        NOT_FIRST_PAGE: "notFirstPage";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PageBorderOffsetFrom.html b/api/variables/PageBorderOffsetFrom.html index 43437dd5b4..5de387b1cf 100644 --- a/api/variables/PageBorderOffsetFrom.html +++ b/api/variables/PageBorderOffsetFrom.html @@ -1 +1 @@ -PageBorderOffsetFrom | docx

    Variable PageBorderOffsetFromConst

    PageBorderOffsetFrom: {
        PAGE: "page";
        TEXT: "text";
    } = ...

    Settings

    Member Visibility
    +PageBorderOffsetFrom | docx

    Variable PageBorderOffsetFromConst

    PageBorderOffsetFrom: {
        PAGE: "page";
        TEXT: "text";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PageBorderZOrder.html b/api/variables/PageBorderZOrder.html index a94979e57d..f5827d58fa 100644 --- a/api/variables/PageBorderZOrder.html +++ b/api/variables/PageBorderZOrder.html @@ -1 +1 @@ -PageBorderZOrder | docx

    Variable PageBorderZOrderConst

    PageBorderZOrder: {
        BACK: "back";
        FRONT: "front";
    } = ...

    Settings

    Member Visibility
    +PageBorderZOrder | docx

    Variable PageBorderZOrderConst

    PageBorderZOrder: {
        BACK: "back";
        FRONT: "front";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PageNumber.html b/api/variables/PageNumber.html index 23695d3dc7..5ff4bee654 100644 --- a/api/variables/PageNumber.html +++ b/api/variables/PageNumber.html @@ -1 +1 @@ -PageNumber | docx

    Variable PageNumberConst

    PageNumber: {
        CURRENT: "CURRENT";
        CURRENT_SECTION: "SECTION";
        TOTAL_PAGES: "TOTAL_PAGES";
        TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION";
    } = ...

    Settings

    Member Visibility
    +PageNumber | docx

    Variable PageNumberConst

    PageNumber: {
        CURRENT: "CURRENT";
        CURRENT_SECTION: "SECTION";
        TOTAL_PAGES: "TOTAL_PAGES";
        TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PageNumberSeparator.html b/api/variables/PageNumberSeparator.html index b8f1d7800b..4c6a3dc766 100644 --- a/api/variables/PageNumberSeparator.html +++ b/api/variables/PageNumberSeparator.html @@ -1 +1 @@ -PageNumberSeparator | docx

    Variable PageNumberSeparatorConst

    PageNumberSeparator: {
        COLON: "colon";
        EM_DASH: "emDash";
        EN_DASH: "endash";
        HYPHEN: "hyphen";
        PERIOD: "period";
    } = ...

    Settings

    Member Visibility
    +PageNumberSeparator | docx

    Variable PageNumberSeparatorConst

    PageNumberSeparator: {
        COLON: "colon";
        EM_DASH: "emDash";
        EN_DASH: "endash";
        HYPHEN: "hyphen";
        PERIOD: "period";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PageOrientation.html b/api/variables/PageOrientation.html index b7c81d8ce2..8ed616aa34 100644 --- a/api/variables/PageOrientation.html +++ b/api/variables/PageOrientation.html @@ -1 +1 @@ -PageOrientation | docx

    Variable PageOrientationConst

    PageOrientation: {
        LANDSCAPE: "landscape";
        PORTRAIT: "portrait";
    } = ...

    Settings

    Member Visibility
    +PageOrientation | docx

    Variable PageOrientationConst

    PageOrientation: {
        LANDSCAPE: "landscape";
        PORTRAIT: "portrait";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PageTextDirectionType.html b/api/variables/PageTextDirectionType.html index 00f07f0080..168e7f4208 100644 --- a/api/variables/PageTextDirectionType.html +++ b/api/variables/PageTextDirectionType.html @@ -1 +1 @@ -PageTextDirectionType | docx

    Variable PageTextDirectionTypeConst

    PageTextDirectionType: {
        LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
        TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
    } = ...

    Settings

    Member Visibility
    +PageTextDirectionType | docx

    Variable PageTextDirectionTypeConst

    PageTextDirectionType: {
        LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
        TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PatchType.html b/api/variables/PatchType.html index c5d8e10690..355542dc19 100644 --- a/api/variables/PatchType.html +++ b/api/variables/PatchType.html @@ -1 +1 @@ -PatchType | docx

    Variable PatchTypeConst

    PatchType: {
        DOCUMENT: "file";
        PARAGRAPH: "paragraph";
    } = ...

    Settings

    Member Visibility
    +PatchType | docx

    Variable PatchTypeConst

    PatchType: {
        DOCUMENT: "file";
        PARAGRAPH: "paragraph";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PositionalTabAlignment.html b/api/variables/PositionalTabAlignment.html index 23ee090135..43a09f7339 100644 --- a/api/variables/PositionalTabAlignment.html +++ b/api/variables/PositionalTabAlignment.html @@ -1 +1 @@ -PositionalTabAlignment | docx

    Variable PositionalTabAlignmentConst

    PositionalTabAlignment: {
        CENTER: "center";
        LEFT: "left";
        RIGHT: "right";
    } = ...

    Settings

    Member Visibility
    +PositionalTabAlignment | docx

    Variable PositionalTabAlignmentConst

    PositionalTabAlignment: {
        CENTER: "center";
        LEFT: "left";
        RIGHT: "right";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PositionalTabLeader.html b/api/variables/PositionalTabLeader.html index 6f0a4c29b7..886ab9df5b 100644 --- a/api/variables/PositionalTabLeader.html +++ b/api/variables/PositionalTabLeader.html @@ -1 +1 @@ -PositionalTabLeader | docx

    Variable PositionalTabLeaderConst

    PositionalTabLeader: {
        DOT: "dot";
        HYPHEN: "hyphen";
        MIDDLE_DOT: "middleDot";
        NONE: "none";
        UNDERSCORE: "underscore";
    } = ...

    Settings

    Member Visibility
    +PositionalTabLeader | docx

    Variable PositionalTabLeaderConst

    PositionalTabLeader: {
        DOT: "dot";
        HYPHEN: "hyphen";
        MIDDLE_DOT: "middleDot";
        NONE: "none";
        UNDERSCORE: "underscore";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PositionalTabRelativeTo.html b/api/variables/PositionalTabRelativeTo.html index e1bcf822a2..dda84f68b3 100644 --- a/api/variables/PositionalTabRelativeTo.html +++ b/api/variables/PositionalTabRelativeTo.html @@ -1 +1 @@ -PositionalTabRelativeTo | docx

    Variable PositionalTabRelativeToConst

    PositionalTabRelativeTo: {
        INDENT: "indent";
        MARGIN: "margin";
    } = ...

    Settings

    Member Visibility
    +PositionalTabRelativeTo | docx

    Variable PositionalTabRelativeToConst

    PositionalTabRelativeTo: {
        INDENT: "indent";
        MARGIN: "margin";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PrettifyType.html b/api/variables/PrettifyType.html index 0834c4c572..b6e4d8cc47 100644 --- a/api/variables/PrettifyType.html +++ b/api/variables/PrettifyType.html @@ -1,2 +1,2 @@ PrettifyType | docx

    Variable PrettifyTypeConst

    PrettifyType: {
        NONE: "";
        WITH_2_BLANKS: " ";
        WITH_4_BLANKS: " ";
        WITH_TAB: "\t";
    } = ...

    Use blanks to prettify

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/variables/RelativeHorizontalPosition.html b/api/variables/RelativeHorizontalPosition.html index ebcc170bbc..5f2a5e705f 100644 --- a/api/variables/RelativeHorizontalPosition.html +++ b/api/variables/RelativeHorizontalPosition.html @@ -1 +1 @@ -RelativeHorizontalPosition | docx

    Variable RelativeHorizontalPositionConst

    RelativeHorizontalPosition: {
        CENTER: "center";
        INSIDE: "inside";
        LEFT: "left";
        OUTSIDE: "outside";
        RIGHT: "right";
    } = ...

    Settings

    Member Visibility
    +RelativeHorizontalPosition | docx

    Variable RelativeHorizontalPositionConst

    RelativeHorizontalPosition: {
        CENTER: "center";
        INSIDE: "inside";
        LEFT: "left";
        OUTSIDE: "outside";
        RIGHT: "right";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/RelativeVerticalPosition.html b/api/variables/RelativeVerticalPosition.html index 6e2180a206..b98e28e2aa 100644 --- a/api/variables/RelativeVerticalPosition.html +++ b/api/variables/RelativeVerticalPosition.html @@ -1 +1 @@ -RelativeVerticalPosition | docx

    Variable RelativeVerticalPositionConst

    RelativeVerticalPosition: {
        BOTTOM: "bottom";
        CENTER: "center";
        INLINE: "inline";
        INSIDE: "inside";
        OUTSIDE: "outside";
        TOP: "top";
    } = ...

    Settings

    Member Visibility
    +RelativeVerticalPosition | docx

    Variable RelativeVerticalPositionConst

    RelativeVerticalPosition: {
        BOTTOM: "bottom";
        CENTER: "center";
        INLINE: "inline";
        INSIDE: "inside";
        OUTSIDE: "outside";
        TOP: "top";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/SectionType.html b/api/variables/SectionType.html index 2642d72297..91447d54fd 100644 --- a/api/variables/SectionType.html +++ b/api/variables/SectionType.html @@ -1 +1 @@ -SectionType | docx

    Variable SectionTypeConst

    SectionType: {
        CONTINUOUS: "continuous";
        EVEN_PAGE: "evenPage";
        NEXT_COLUMN: "nextColumn";
        NEXT_PAGE: "nextPage";
        ODD_PAGE: "oddPage";
    } = ...

    Settings

    Member Visibility
    +SectionType | docx

    Variable SectionTypeConst

    SectionType: {
        CONTINUOUS: "continuous";
        EVEN_PAGE: "evenPage";
        NEXT_COLUMN: "nextColumn";
        NEXT_PAGE: "nextPage";
        ODD_PAGE: "oddPage";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/ShadingType.html b/api/variables/ShadingType.html index ba74217eab..621965ab33 100644 --- a/api/variables/ShadingType.html +++ b/api/variables/ShadingType.html @@ -1 +1 @@ -ShadingType | docx

    Variable ShadingTypeConst

    ShadingType: {
        CLEAR: "clear";
        DIAGONAL_CROSS: "diagCross";
        DIAGONAL_STRIPE: "diagStripe";
        HORIZONTAL_CROSS: "horzCross";
        HORIZONTAL_STRIPE: "horzStripe";
        NIL: "nil";
        PERCENT_10: "pct10";
        PERCENT_12: "pct12";
        PERCENT_15: "pct15";
        PERCENT_20: "pct20";
        PERCENT_25: "pct25";
        PERCENT_30: "pct30";
        PERCENT_35: "pct35";
        PERCENT_37: "pct37";
        PERCENT_40: "pct40";
        PERCENT_45: "pct45";
        PERCENT_5: "pct5";
        PERCENT_50: "pct50";
        PERCENT_55: "pct55";
        PERCENT_60: "pct60";
        PERCENT_62: "pct62";
        PERCENT_65: "pct65";
        PERCENT_70: "pct70";
        PERCENT_75: "pct75";
        PERCENT_80: "pct80";
        PERCENT_85: "pct85";
        PERCENT_87: "pct87";
        PERCENT_90: "pct90";
        PERCENT_95: "pct95";
        REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe";
        SOLID: "solid";
        THIN_DIAGONAL_CROSS: "thinDiagCross";
        THIN_DIAGONAL_STRIPE: "thinDiagStripe";
        THIN_HORIZONTAL_CROSS: "thinHorzCross";
        THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe";
        THIN_VERTICAL_STRIPE: "thinVertStripe";
        VERTICAL_STRIPE: "vertStripe";
    } = ...

    Settings

    Member Visibility
    +ShadingType | docx

    Variable ShadingTypeConst

    ShadingType: {
        CLEAR: "clear";
        DIAGONAL_CROSS: "diagCross";
        DIAGONAL_STRIPE: "diagStripe";
        HORIZONTAL_CROSS: "horzCross";
        HORIZONTAL_STRIPE: "horzStripe";
        NIL: "nil";
        PERCENT_10: "pct10";
        PERCENT_12: "pct12";
        PERCENT_15: "pct15";
        PERCENT_20: "pct20";
        PERCENT_25: "pct25";
        PERCENT_30: "pct30";
        PERCENT_35: "pct35";
        PERCENT_37: "pct37";
        PERCENT_40: "pct40";
        PERCENT_45: "pct45";
        PERCENT_5: "pct5";
        PERCENT_50: "pct50";
        PERCENT_55: "pct55";
        PERCENT_60: "pct60";
        PERCENT_62: "pct62";
        PERCENT_65: "pct65";
        PERCENT_70: "pct70";
        PERCENT_75: "pct75";
        PERCENT_80: "pct80";
        PERCENT_85: "pct85";
        PERCENT_87: "pct87";
        PERCENT_90: "pct90";
        PERCENT_95: "pct95";
        REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe";
        SOLID: "solid";
        THIN_DIAGONAL_CROSS: "thinDiagCross";
        THIN_DIAGONAL_STRIPE: "thinDiagStripe";
        THIN_HORIZONTAL_CROSS: "thinHorzCross";
        THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe";
        THIN_VERTICAL_STRIPE: "thinVertStripe";
        VERTICAL_STRIPE: "vertStripe";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/SpaceType.html b/api/variables/SpaceType.html index 925eb645c4..8a5ed066a7 100644 --- a/api/variables/SpaceType.html +++ b/api/variables/SpaceType.html @@ -1 +1 @@ -SpaceType | docx

    Variable SpaceTypeConst

    SpaceType: {
        DEFAULT: "default";
        PRESERVE: "preserve";
    } = ...

    Settings

    Member Visibility
    +SpaceType | docx

    Variable SpaceTypeConst

    SpaceType: {
        DEFAULT: "default";
        PRESERVE: "preserve";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TabStopPosition.html b/api/variables/TabStopPosition.html index 3dc99788bb..0abfc2d548 100644 --- a/api/variables/TabStopPosition.html +++ b/api/variables/TabStopPosition.html @@ -1 +1 @@ -TabStopPosition | docx

    Variable TabStopPositionConst

    TabStopPosition: {
        MAX: 9026;
    } = ...

    Settings

    Member Visibility
    +TabStopPosition | docx

    Variable TabStopPositionConst

    TabStopPosition: {
        MAX: 9026;
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TabStopType.html b/api/variables/TabStopType.html index c14faaf532..5fe1f34e10 100644 --- a/api/variables/TabStopType.html +++ b/api/variables/TabStopType.html @@ -1 +1 @@ -TabStopType | docx

    Variable TabStopTypeConst

    TabStopType: {
        BAR: "bar";
        CENTER: "center";
        CLEAR: "clear";
        DECIMAL: "decimal";
        END: "end";
        LEFT: "left";
        NUM: "num";
        RIGHT: "right";
        START: "start";
    } = ...

    Settings

    Member Visibility
    +TabStopType | docx

    Variable TabStopTypeConst

    TabStopType: {
        BAR: "bar";
        CENTER: "center";
        CLEAR: "clear";
        DECIMAL: "decimal";
        END: "end";
        LEFT: "left";
        NUM: "num";
        RIGHT: "right";
        START: "start";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TableAnchorType.html b/api/variables/TableAnchorType.html index d5eb522072..0f98732fee 100644 --- a/api/variables/TableAnchorType.html +++ b/api/variables/TableAnchorType.html @@ -1 +1 @@ -TableAnchorType | docx

    Variable TableAnchorTypeConst

    TableAnchorType: {
        MARGIN: "margin";
        PAGE: "page";
        TEXT: "text";
    } = ...

    Settings

    Member Visibility
    +TableAnchorType | docx

    Variable TableAnchorTypeConst

    TableAnchorType: {
        MARGIN: "margin";
        PAGE: "page";
        TEXT: "text";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TableLayoutType.html b/api/variables/TableLayoutType.html index c7d4b7a8f5..75c1b46b2a 100644 --- a/api/variables/TableLayoutType.html +++ b/api/variables/TableLayoutType.html @@ -1 +1 @@ -TableLayoutType | docx

    Variable TableLayoutTypeConst

    TableLayoutType: {
        AUTOFIT: "autofit";
        FIXED: "fixed";
    } = ...

    Settings

    Member Visibility
    +TableLayoutType | docx

    Variable TableLayoutTypeConst

    TableLayoutType: {
        AUTOFIT: "autofit";
        FIXED: "fixed";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TextDirection.html b/api/variables/TextDirection.html index 74291ffce2..9ebbb97a0e 100644 --- a/api/variables/TextDirection.html +++ b/api/variables/TextDirection.html @@ -1 +1 @@ -TextDirection | docx

    Variable TextDirectionConst

    TextDirection: {
        BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr";
        LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
        TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
    } = ...

    Settings

    Member Visibility
    +TextDirection | docx

    Variable TextDirectionConst

    TextDirection: {
        BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr";
        LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
        TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TextEffect.html b/api/variables/TextEffect.html index 0b16cd8764..e9876ed963 100644 --- a/api/variables/TextEffect.html +++ b/api/variables/TextEffect.html @@ -1 +1 @@ -TextEffect | docx

    Variable TextEffectConst

    TextEffect: {
        ANTS_BLACK: "antsBlack";
        ANTS_RED: "antsRed";
        BLINK_BACKGROUND: "blinkBackground";
        LIGHTS: "lights";
        NONE: "none";
        SHIMMER: "shimmer";
        SPARKLE: "sparkle";
    } = ...

    Settings

    Member Visibility
    +TextEffect | docx

    Variable TextEffectConst

    TextEffect: {
        ANTS_BLACK: "antsBlack";
        ANTS_RED: "antsRed";
        BLINK_BACKGROUND: "blinkBackground";
        LIGHTS: "lights";
        NONE: "none";
        SHIMMER: "shimmer";
        SPARKLE: "sparkle";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TextWrappingSide.html b/api/variables/TextWrappingSide.html index cb824bdb05..1943867bc4 100644 --- a/api/variables/TextWrappingSide.html +++ b/api/variables/TextWrappingSide.html @@ -1 +1 @@ -TextWrappingSide | docx

    Variable TextWrappingSideConst

    TextWrappingSide: {
        BOTH_SIDES: "bothSides";
        LARGEST: "largest";
        LEFT: "left";
        RIGHT: "right";
    } = ...

    Settings

    Member Visibility
    +TextWrappingSide | docx

    Variable TextWrappingSideConst

    TextWrappingSide: {
        BOTH_SIDES: "bothSides";
        LARGEST: "largest";
        LEFT: "left";
        RIGHT: "right";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TextWrappingType.html b/api/variables/TextWrappingType.html index c59cab0655..dc0683d109 100644 --- a/api/variables/TextWrappingType.html +++ b/api/variables/TextWrappingType.html @@ -1 +1 @@ -TextWrappingType | docx

    Variable TextWrappingTypeConst

    TextWrappingType: {
        NONE: 0;
        SQUARE: 1;
        TIGHT: 2;
        TOP_AND_BOTTOM: 3;
    } = ...

    Settings

    Member Visibility
    +TextWrappingType | docx

    Variable TextWrappingTypeConst

    TextWrappingType: {
        NONE: 0;
        SQUARE: 1;
        TIGHT: 2;
        TOP_AND_BOTTOM: 3;
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/UnderlineType.html b/api/variables/UnderlineType.html index 0cc1646321..81c61cc040 100644 --- a/api/variables/UnderlineType.html +++ b/api/variables/UnderlineType.html @@ -1 +1 @@ -UnderlineType | docx

    Variable UnderlineTypeConst

    UnderlineType: {
        DASH: "dash";
        DASHDOTDOTHEAVY: "dashDotDotHeavy";
        DASHDOTHEAVY: "dashDotHeavy";
        DASHEDHEAVY: "dashedHeavy";
        DASHLONG: "dashLong";
        DASHLONGHEAVY: "dashLongHeavy";
        DOTDASH: "dotDash";
        DOTDOTDASH: "dotDotDash";
        DOTTED: "dotted";
        DOTTEDHEAVY: "dottedHeavy";
        DOUBLE: "double";
        NONE: "none";
        SINGLE: "single";
        THICK: "thick";
        WAVE: "wave";
        WAVYDOUBLE: "wavyDouble";
        WAVYHEAVY: "wavyHeavy";
        WORDS: "words";
    } = ...

    Settings

    Member Visibility
    +UnderlineType | docx

    Variable UnderlineTypeConst

    UnderlineType: {
        DASH: "dash";
        DASHDOTDOTHEAVY: "dashDotDotHeavy";
        DASHDOTHEAVY: "dashDotHeavy";
        DASHEDHEAVY: "dashedHeavy";
        DASHLONG: "dashLong";
        DASHLONGHEAVY: "dashLongHeavy";
        DOTDASH: "dotDash";
        DOTDOTDASH: "dotDotDash";
        DOTTED: "dotted";
        DOTTEDHEAVY: "dottedHeavy";
        DOUBLE: "double";
        NONE: "none";
        SINGLE: "single";
        THICK: "thick";
        WAVE: "wave";
        WAVYDOUBLE: "wavyDouble";
        WAVYHEAVY: "wavyHeavy";
        WORDS: "words";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/VerticalAlign.html b/api/variables/VerticalAlign.html index 9a6e53d5bd..07cc57ab7c 100644 --- a/api/variables/VerticalAlign.html +++ b/api/variables/VerticalAlign.html @@ -1 +1 @@ -VerticalAlign | docx

    Variable VerticalAlignConst

    VerticalAlign: {
        BOTTOM: "bottom";
        CENTER: "center";
        TOP: "top";
    } = ...

    Settings

    Member Visibility
    +VerticalAlign | docx

    Variable VerticalAlignConst

    VerticalAlign: {
        BOTTOM: "bottom";
        CENTER: "center";
        TOP: "top";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/VerticalMergeType.html b/api/variables/VerticalMergeType.html index d4caf9a41f..121d3b09a4 100644 --- a/api/variables/VerticalMergeType.html +++ b/api/variables/VerticalMergeType.html @@ -1,4 +1,4 @@ VerticalMergeType | docx

    Variable VerticalMergeTypeConst

    VerticalMergeType: {
        CONTINUE: "continue";
        RESTART: "restart";
    } = ...

    Vertical merge types.

    Type declaration

    • ReadonlyCONTINUE: "continue"

      Cell that is merged with upper one.

    • ReadonlyRESTART: "restart"

      Cell that is starting the vertical merge.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/variables/VerticalPositionAlign.html b/api/variables/VerticalPositionAlign.html index 9ecb96ad80..e00c113fc2 100644 --- a/api/variables/VerticalPositionAlign.html +++ b/api/variables/VerticalPositionAlign.html @@ -1 +1 @@ -VerticalPositionAlign | docx

    Variable VerticalPositionAlignConst

    VerticalPositionAlign: {
        BOTTOM: "bottom";
        CENTER: "center";
        INSIDE: "inside";
        OUTSIDE: "outside";
        TOP: "top";
    } = ...

    Settings

    Member Visibility
    +VerticalPositionAlign | docx

    Variable VerticalPositionAlignConst

    VerticalPositionAlign: {
        BOTTOM: "bottom";
        CENTER: "center";
        INSIDE: "inside";
        OUTSIDE: "outside";
        TOP: "top";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/VerticalPositionRelativeFrom.html b/api/variables/VerticalPositionRelativeFrom.html index d670ec09c8..7c6946fc69 100644 --- a/api/variables/VerticalPositionRelativeFrom.html +++ b/api/variables/VerticalPositionRelativeFrom.html @@ -1 +1 @@ -VerticalPositionRelativeFrom | docx

    Variable VerticalPositionRelativeFromConst

    VerticalPositionRelativeFrom: {
        BOTTOM_MARGIN: "bottomMargin";
        INSIDE_MARGIN: "insideMargin";
        LINE: "line";
        MARGIN: "margin";
        OUTSIDE_MARGIN: "outsideMargin";
        PAGE: "page";
        PARAGRAPH: "paragraph";
        TOP_MARGIN: "topMargin";
    } = ...

    Settings

    Member Visibility
    +VerticalPositionRelativeFrom | docx

    Variable VerticalPositionRelativeFromConst

    VerticalPositionRelativeFrom: {
        BOTTOM_MARGIN: "bottomMargin";
        INSIDE_MARGIN: "insideMargin";
        LINE: "line";
        MARGIN: "margin";
        OUTSIDE_MARGIN: "outsideMargin";
        PAGE: "page";
        PARAGRAPH: "paragraph";
        TOP_MARGIN: "topMargin";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/WidthType.html b/api/variables/WidthType.html index fd374b7c3d..fce9e1bb2b 100644 --- a/api/variables/WidthType.html +++ b/api/variables/WidthType.html @@ -2,4 +2,4 @@
  • ReadonlyDXA: "dxa"

    Value is in twentieths of a point

  • ReadonlyNIL: "nil"

    No (empty) value.

  • ReadonlyPERCENTAGE: "pct"

    Value is in percentage.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/variables/sectionMarginDefaults.html b/api/variables/sectionMarginDefaults.html index 6a9caa285f..5dcff53768 100644 --- a/api/variables/sectionMarginDefaults.html +++ b/api/variables/sectionMarginDefaults.html @@ -1 +1 @@ -sectionMarginDefaults | docx

    Variable sectionMarginDefaultsConst

    sectionMarginDefaults: {
        BOTTOM: number;
        FOOTER: number;
        GUTTER: number;
        HEADER: number;
        LEFT: number;
        RIGHT: number;
        TOP: number;
    } = ...

    Settings

    Member Visibility
    +sectionMarginDefaults | docx

    Variable sectionMarginDefaultsConst

    sectionMarginDefaults: {
        BOTTOM: number;
        FOOTER: number;
        GUTTER: number;
        HEADER: number;
        LEFT: number;
        RIGHT: number;
        TOP: number;
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/sectionPageSizeDefaults.html b/api/variables/sectionPageSizeDefaults.html index a88a330dc8..f494d5282e 100644 --- a/api/variables/sectionPageSizeDefaults.html +++ b/api/variables/sectionPageSizeDefaults.html @@ -1 +1 @@ -sectionPageSizeDefaults | docx

    Variable sectionPageSizeDefaultsConst

    sectionPageSizeDefaults: {
        HEIGHT: number;
        ORIENTATION: "portrait";
        WIDTH: number;
    } = ...

    Settings

    Member Visibility
    +sectionPageSizeDefaults | docx

    Variable sectionPageSizeDefaultsConst

    sectionPageSizeDefaults: {
        HEIGHT: number;
        ORIENTATION: "portrait";
        WIDTH: number;
    } = ...

    Settings

    Member Visibility