diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index 01ded4e7c7..2041aae024 100644 --- a/api/classes/AbstractNumbering.html +++ b/api/classes/AbstractNumbering.html @@ -1,6 +1,6 @@ -AbstractNumbering | docx

Class AbstractNumbering

Hierarchy (View Summary)

Constructors

constructor +AbstractNumbering | docx

Class AbstractNumbering

Hierarchy (View Summary)

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 5d4f3ffbf6..1d2bae77f8 100644 --- a/api/classes/Alignment.html +++ b/api/classes/Alignment.html @@ -1,5 +1,5 @@ -Alignment | docx

Class Alignment

Hierarchy (View Summary)

Constructors

constructor +Alignment | docx

Class Alignment

Hierarchy (View Summary)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new Alignment(
        type:
            | "center"
            | "left"
            | "right"
            | "start"
            | "end"
            | "both"
            | "mediumKashida"
            | "distribute"
            | "numTab"
            | "highKashida"
            | "lowKashida"
            | "thaiDistribute",
    ): Alignment

  • Parameters

    • type:
          | "center"
          | "left"
          | "right"
          | "start"
          | "end"
          | "both"
          | "mediumKashida"
          | "distribute"
          | "numTab"
          | "highKashida"
          | "lowKashida"
          | "thaiDistribute"

    Returns Alignment

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new Alignment(
        type:
            | "center"
            | "left"
            | "right"
            | "start"
            | "end"
            | "both"
            | "mediumKashida"
            | "distribute"
            | "numTab"
            | "highKashida"
            | "lowKashida"
            | "thaiDistribute",
    ): Alignment

  • Parameters

    • type:
          | "center"
          | "left"
          | "right"
          | "start"
          | "end"
          | "both"
          | "mediumKashida"
          | "distribute"
          | "numTab"
          | "highKashida"
          | "lowKashida"
          | "thaiDistribute"

    Returns Alignment

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/AlignmentAttributes.html b/api/classes/AlignmentAttributes.html index 09321f0729..6f8fb23ca8 100644 --- a/api/classes/AlignmentAttributes.html +++ b/api/classes/AlignmentAttributes.html @@ -1,3 +1,3 @@ -AlignmentAttributes | docx

Class AlignmentAttributes

Hierarchy (View Summary)

Constructors

constructor +AlignmentAttributes | docx

Class AlignmentAttributes

Hierarchy (View Summary)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new AlignmentAttributes(
        root: {
            val:
                | "center"
                | "left"
                | "right"
                | "start"
                | "end"
                | "both"
                | "mediumKashida"
                | "distribute"
                | "numTab"
                | "highKashida"
                | "lowKashida"
                | "thaiDistribute";
        },
    ): AlignmentAttributes

  • Parameters

    • root: {
          val:
              | "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: {
            val:
                | "center"
                | "left"
                | "right"
                | "start"
                | "end"
                | "both"
                | "mediumKashida"
                | "distribute"
                | "numTab"
                | "highKashida"
                | "lowKashida"
                | "thaiDistribute";
        },
    ): AlignmentAttributes

  • Parameters

    • root: {
          val:
              | "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 b92db56cf7..d6868d7709 100644 --- a/api/classes/AnnotationReference.html +++ b/api/classes/AnnotationReference.html @@ -1,5 +1,5 @@ -AnnotationReference | docx

Class AnnotationReference

Hierarchy (View Summary)

Constructors

constructor +AnnotationReference | docx

Class AnnotationReference

Hierarchy (View Summary)

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 9ec46eb9b7..55125f87b6 100644 --- a/api/classes/Attributes.html +++ b/api/classes/Attributes.html @@ -1,3 +1,3 @@ -Attributes | docx

Class Attributes

Hierarchy (View Summary)

  • 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 Summary)

  • 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: {
            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

  • 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;
      }

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new Attributes(
        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;
        },
    ): 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;
      }

    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 2ba545e46f..6cadf01674 100644 --- a/api/classes/BaseEmphasisMark.html +++ b/api/classes/BaseEmphasisMark.html @@ -1,4 +1,4 @@ -BaseEmphasisMark | docx

Class BaseEmphasisMarkAbstract

Hierarchy (View Summary)

Methods

addChildElement +BaseEmphasisMark | docx

Class BaseEmphasisMarkAbstract

Hierarchy (View Summary)

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 203aa0ea88..a33932b152 100644 --- a/api/classes/BaseXmlComponent.html +++ b/api/classes/BaseXmlComponent.html @@ -1,3 +1,3 @@ -BaseXmlComponent | docx

Class BaseXmlComponentAbstract

Hierarchy (View Summary)

Constructors

constructor +BaseXmlComponent | docx

Class BaseXmlComponentAbstract

Hierarchy (View Summary)

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 e86edcd8bc..03f9460785 100644 --- a/api/classes/Body.html +++ b/api/classes/Body.html @@ -1,10 +1,10 @@ -Body | docx

Class Body

Hierarchy (View Summary)

Constructors

constructor +Body | docx

Class Body

Hierarchy (View Summary)

Constructors

constructor

Methods

addChildElement addSection prepForXml push -

Constructors

constructor

Methods

addChildElement

addSection

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options: ISectionPropertiesOptions): 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 d74f284185..92d58ccb07 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 137a66abc7..458e268e58 100644 --- a/api/classes/BookmarkEnd.html +++ b/api/classes/BookmarkEnd.html @@ -1,5 +1,5 @@ -BookmarkEnd | docx

Class BookmarkEnd

Hierarchy (View Summary)

Constructors

constructor +BookmarkEnd | docx

Class BookmarkEnd

Hierarchy (View Summary)

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 8406e0873e..4ae0addf50 100644 --- a/api/classes/BookmarkStart.html +++ b/api/classes/BookmarkStart.html @@ -1,5 +1,5 @@ -BookmarkStart | docx

Class BookmarkStart

Hierarchy (View Summary)

Constructors

constructor +BookmarkStart | docx

Class BookmarkStart

Hierarchy (View Summary)

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 91a574cd99..18fd2c5450 100644 --- a/api/classes/Border.html +++ b/api/classes/Border.html @@ -1,5 +1,5 @@ -Border | docx

Class Border

Hierarchy (View Summary)

Constructors

constructor +Border | docx

Class Border

Hierarchy (View Summary)

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 dbd5cd5397..9bac679bf9 100644 --- a/api/classes/BorderElement.html +++ b/api/classes/BorderElement.html @@ -1,5 +1,5 @@ -BorderElement | docx

Class BorderElement

Hierarchy (View Summary)

Constructors

constructor +BorderElement | docx

Class BorderElement

Hierarchy (View Summary)

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 fb07dc6de6..60700e44cd 100644 --- a/api/classes/BuilderElement.html +++ b/api/classes/BuilderElement.html @@ -1,5 +1,5 @@ -BuilderElement | docx

Class BuilderElement<T>

Type Parameters

Hierarchy (View Summary)

Constructors

constructor +BuilderElement | docx

Class BuilderElement<T>

Type Parameters

Hierarchy (View Summary)

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 3e663238ef..3feeb54a6d 100644 --- a/api/classes/CarriageReturn.html +++ b/api/classes/CarriageReturn.html @@ -1,5 +1,5 @@ -CarriageReturn | docx

Class CarriageReturn

Hierarchy (View Summary)

Constructors

constructor +CarriageReturn | docx

Class CarriageReturn

Hierarchy (View Summary)

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 c23cd7b0a7..6d07a887e5 100644 --- a/api/classes/CheckBox.html +++ b/api/classes/CheckBox.html @@ -1,5 +1,5 @@ -CheckBox | docx

Class CheckBox

Hierarchy (View Summary)

Constructors

constructor +CheckBox | docx

Class CheckBox

Hierarchy (View Summary)

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 a8a77348d2..b2d00cebe5 100644 --- a/api/classes/CheckBoxSymbolElement.html +++ b/api/classes/CheckBoxSymbolElement.html @@ -1,5 +1,5 @@ -CheckBoxSymbolElement | docx

Class CheckBoxSymbolElement

Hierarchy (View Summary)

Constructors

constructor +CheckBoxSymbolElement | docx

Class CheckBoxSymbolElement

Hierarchy (View Summary)

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 efc41125c3..cb4a461867 100644 --- a/api/classes/CheckBoxUtil.html +++ b/api/classes/CheckBoxUtil.html @@ -1,5 +1,5 @@ -CheckBoxUtil | docx

Class CheckBoxUtil

Hierarchy (View Summary)

Constructors

constructor +CheckBoxUtil | docx

Class CheckBoxUtil

Hierarchy (View Summary)

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 3a009dfadd..b9cac6226c 100644 --- a/api/classes/Column.html +++ b/api/classes/Column.html @@ -1,5 +1,5 @@ -Column | docx

Class Column

Hierarchy (View Summary)

Constructors

constructor +Column | docx

Class Column

Hierarchy (View Summary)

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 04859d3d02..62699ec857 100644 --- a/api/classes/ColumnBreak.html +++ b/api/classes/ColumnBreak.html @@ -1,5 +1,5 @@ -ColumnBreak | docx

Class ColumnBreak

Hierarchy (View Summary)

Constructors

constructor +ColumnBreak | docx

Class ColumnBreak

Hierarchy (View Summary)

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 91b02238a5..a1c837d90e 100644 --- a/api/classes/Columns.html +++ b/api/classes/Columns.html @@ -1,5 +1,5 @@ -Columns | docx

Class Columns

Hierarchy (View Summary)

Constructors

constructor +Columns | docx

Class Columns

Hierarchy (View Summary)

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 81a6cc9cdf..c588527832 100644 --- a/api/classes/Comment.html +++ b/api/classes/Comment.html @@ -1,5 +1,5 @@ -Comment | docx

Class Comment

Hierarchy (View Summary)

Constructors

constructor +Comment | docx

Class Comment

Hierarchy (View Summary)

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 505215902c..eec61a4004 100644 --- a/api/classes/CommentRangeEnd.html +++ b/api/classes/CommentRangeEnd.html @@ -1,5 +1,5 @@ -CommentRangeEnd | docx

Class CommentRangeEnd

Hierarchy (View Summary)

Constructors

constructor +CommentRangeEnd | docx

Class CommentRangeEnd

Hierarchy (View Summary)

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 f31cc8824f..70e30081ba 100644 --- a/api/classes/CommentRangeStart.html +++ b/api/classes/CommentRangeStart.html @@ -1,5 +1,5 @@ -CommentRangeStart | docx

Class CommentRangeStart

Hierarchy (View Summary)

Constructors

constructor +CommentRangeStart | docx

Class CommentRangeStart

Hierarchy (View Summary)

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 6c1dc170ba..4b1237af6a 100644 --- a/api/classes/CommentReference.html +++ b/api/classes/CommentReference.html @@ -1,5 +1,5 @@ -CommentReference | docx

Class CommentReference

Hierarchy (View Summary)

Constructors

constructor +CommentReference | docx

Class CommentReference

Hierarchy (View Summary)

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 44c1feab2f..ba7f24e3a2 100644 --- a/api/classes/Comments.html +++ b/api/classes/Comments.html @@ -1,5 +1,5 @@ -Comments | docx

Class Comments

Hierarchy (View Summary)

Constructors

constructor +Comments | docx

Class Comments

Hierarchy (View Summary)

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 bb9d5297c4..41071921ae 100644 --- a/api/classes/ConcreteHyperlink.html +++ b/api/classes/ConcreteHyperlink.html @@ -1,6 +1,6 @@ -ConcreteHyperlink | docx

Class ConcreteHyperlink

Hierarchy (View Summary)

Constructors

constructor +ConcreteHyperlink | docx

Class ConcreteHyperlink

Hierarchy (View Summary)

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 3f1e4763a4..f5dda18c3a 100644 --- a/api/classes/ConcreteNumbering.html +++ b/api/classes/ConcreteNumbering.html @@ -1,8 +1,8 @@ -ConcreteNumbering | docx

Class ConcreteNumbering

Hierarchy (View Summary)

Constructors

constructor +ConcreteNumbering | docx

Class ConcreteNumbering

Hierarchy (View Summary)

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 81ccd2307a..faa8eb61ef 100644 --- a/api/classes/ContinuationSeparator.html +++ b/api/classes/ContinuationSeparator.html @@ -1,5 +1,5 @@ -ContinuationSeparator | docx

Class ContinuationSeparator

Hierarchy (View Summary)

Constructors

constructor +ContinuationSeparator | docx

Class ContinuationSeparator

Hierarchy (View Summary)

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 a25f72e226..96f0de1ab7 100644 --- a/api/classes/DayLong.html +++ b/api/classes/DayLong.html @@ -1,5 +1,5 @@ -DayLong | docx

Class DayLong

Hierarchy (View Summary)

Constructors

constructor +DayLong | docx

Class DayLong

Hierarchy (View Summary)

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 8dd9e0d4bb..900c839be4 100644 --- a/api/classes/DayShort.html +++ b/api/classes/DayShort.html @@ -1,5 +1,5 @@ -DayShort | docx

Class DayShort

Hierarchy (View Summary)

Constructors

constructor +DayShort | docx

Class DayShort

Hierarchy (View Summary)

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 2b64109e4d..acd5324bce 100644 --- a/api/classes/DeletedTextRun.html +++ b/api/classes/DeletedTextRun.html @@ -1,5 +1,5 @@ -DeletedTextRun | docx

Class DeletedTextRun

Hierarchy (View Summary)

Constructors

constructor +DeletedTextRun | docx

Class DeletedTextRun

Hierarchy (View Summary)

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 0d0f180d77..6cf2347b5d 100644 --- a/api/classes/DocGridAttributes.html +++ b/api/classes/DocGridAttributes.html @@ -1,3 +1,3 @@ -DocGridAttributes | docx

Class DocGridAttributes

Hierarchy (View Summary)

Constructors

constructor +DocGridAttributes | docx

Class DocGridAttributes

Hierarchy (View Summary)

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 41fd35b210..5a15558b59 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 11ed880548..04f3c252cc 100644 --- a/api/classes/DocumentAttributes.html +++ b/api/classes/DocumentAttributes.html @@ -1,3 +1,3 @@ -DocumentAttributes | docx

Class DocumentAttributes

Hierarchy (View Summary)

Constructors

constructor +DocumentAttributes | docx

Class DocumentAttributes

Hierarchy (View Summary)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new DocumentAttributes(
        ns: readonly (
            | "w"
            | "cx"
            | "r"
            | "wpc"
            | "mc"
            | "o"
            | "m"
            | "v"
            | "wp14"
            | "wp"
            | "w10"
            | "w14"
            | "w15"
            | "wpg"
            | "wpi"
            | "wne"
            | "wps"
            | "cp"
            | "dc"
            | "dcterms"
            | "dcmitype"
            | "xsi"
            | "cx1"
            | "cx2"
            | "cx3"
            | "cx4"
            | "cx5"
            | "cx6"
            | "cx7"
            | "cx8"
            | "w16cid"
            | "w16se"
            | "aink"
            | "am3d"
            | "w16cex"
            | "w16"
            | "w16sdtdh"
        )[],
        Ignorable?: string,
    ): DocumentAttributes

  • Parameters

    • ns: readonly (
          | "w"
          | "cx"
          | "r"
          | "wpc"
          | "mc"
          | "o"
          | "m"
          | "v"
          | "wp14"
          | "wp"
          | "w10"
          | "w14"
          | "w15"
          | "wpg"
          | "wpi"
          | "wne"
          | "wps"
          | "cp"
          | "dc"
          | "dcterms"
          | "dcmitype"
          | "xsi"
          | "cx1"
          | "cx2"
          | "cx3"
          | "cx4"
          | "cx5"
          | "cx6"
          | "cx7"
          | "cx8"
          | "w16cid"
          | "w16se"
          | "aink"
          | "am3d"
          | "w16cex"
          | "w16"
          | "w16sdtdh"
      )[]
    • OptionalIgnorable: string

    Returns DocumentAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new DocumentAttributes(
        ns: readonly (
            | "w"
            | "cx"
            | "r"
            | "wpc"
            | "mc"
            | "o"
            | "m"
            | "v"
            | "wp14"
            | "wp"
            | "w10"
            | "w14"
            | "w15"
            | "wpg"
            | "wpi"
            | "wne"
            | "wps"
            | "cp"
            | "dc"
            | "dcterms"
            | "dcmitype"
            | "xsi"
            | "cx1"
            | "cx2"
            | "cx3"
            | "cx4"
            | "cx5"
            | "cx6"
            | "cx7"
            | "cx8"
            | "w16cid"
            | "w16se"
            | "aink"
            | "am3d"
            | "w16cex"
            | "w16"
            | "w16sdtdh"
        )[],
        Ignorable?: string,
    ): DocumentAttributes

  • Parameters

    • ns: readonly (
          | "w"
          | "cx"
          | "r"
          | "wpc"
          | "mc"
          | "o"
          | "m"
          | "v"
          | "wp14"
          | "wp"
          | "w10"
          | "w14"
          | "w15"
          | "wpg"
          | "wpi"
          | "wne"
          | "wps"
          | "cp"
          | "dc"
          | "dcterms"
          | "dcmitype"
          | "xsi"
          | "cx1"
          | "cx2"
          | "cx3"
          | "cx4"
          | "cx5"
          | "cx6"
          | "cx7"
          | "cx8"
          | "w16cid"
          | "w16se"
          | "aink"
          | "am3d"
          | "w16cex"
          | "w16"
          | "w16sdtdh"
      )[]
    • OptionalIgnorable: string

    Returns DocumentAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentBackground.html b/api/classes/DocumentBackground.html index df8ea80c91..7f2b1f2d41 100644 --- a/api/classes/DocumentBackground.html +++ b/api/classes/DocumentBackground.html @@ -1,5 +1,5 @@ -DocumentBackground | docx

Class DocumentBackground

Hierarchy (View Summary)

Constructors

constructor +DocumentBackground | docx

Class DocumentBackground

Hierarchy (View Summary)

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 1f529892f5..4dd8218481 100644 --- a/api/classes/DocumentBackgroundAttributes.html +++ b/api/classes/DocumentBackgroundAttributes.html @@ -1,3 +1,3 @@ -DocumentBackgroundAttributes | docx

Class DocumentBackgroundAttributes

Hierarchy (View Summary)

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

Constructors

constructor +DocumentBackgroundAttributes | docx

Class DocumentBackgroundAttributes

Hierarchy (View Summary)

  • 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 28644ad4be..ce8846c293 100644 --- a/api/classes/DocumentDefaults.html +++ b/api/classes/DocumentDefaults.html @@ -1,5 +1,5 @@ -DocumentDefaults | docx

Class DocumentDefaults

Hierarchy (View Summary)

Constructors

constructor +DocumentDefaults | docx

Class DocumentDefaults

Hierarchy (View Summary)

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 04fa5e3c4a..bbf122b292 100644 --- a/api/classes/DocumentGrid.html +++ b/api/classes/DocumentGrid.html @@ -1,5 +1,5 @@ -DocumentGrid | docx

Class DocumentGrid

Hierarchy (View Summary)

Constructors

constructor +DocumentGrid | docx

Class DocumentGrid

Hierarchy (View Summary)

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 cedf94064f..3e04a14438 100644 --- a/api/classes/DotEmphasisMark.html +++ b/api/classes/DotEmphasisMark.html @@ -1,5 +1,5 @@ -DotEmphasisMark | docx

Class DotEmphasisMark

Hierarchy (View Summary)

Constructors

constructor +DotEmphasisMark | docx

Class DotEmphasisMark

Hierarchy (View Summary)

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 a4e0364915..e66bd5a511 100644 --- a/api/classes/Drawing.html +++ b/api/classes/Drawing.html @@ -1,5 +1,5 @@ -Drawing | docx

Class Drawing

Hierarchy (View Summary)

Constructors

constructor +Drawing | docx

Class Drawing

Hierarchy (View Summary)

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 dae6ce4cc4..fd70af6cd7 100644 --- a/api/classes/EmphasisMark.html +++ b/api/classes/EmphasisMark.html @@ -1,5 +1,5 @@ -EmphasisMark | docx

Class EmphasisMark

Hierarchy (View Summary)

Constructors

constructor +EmphasisMark | docx

Class EmphasisMark

Hierarchy (View Summary)

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 e3ac87d876..ca64ebbe07 100644 --- a/api/classes/EmptyElement.html +++ b/api/classes/EmptyElement.html @@ -1,5 +1,5 @@ -EmptyElement | docx

Class EmptyElement

Hierarchy (View Summary)

Constructors

constructor +EmptyElement | docx

Class EmptyElement

Hierarchy (View Summary)

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 5fa32b6706..ed31903d32 100644 --- a/api/classes/EndnoteReference.html +++ b/api/classes/EndnoteReference.html @@ -1,5 +1,5 @@ -EndnoteReference | docx

Class EndnoteReference

Hierarchy (View Summary)

Constructors

constructor +EndnoteReference | docx

Class EndnoteReference

Hierarchy (View Summary)

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 5aa10a6d3c..49dd730eda 100644 --- a/api/classes/ExternalHyperlink.html +++ b/api/classes/ExternalHyperlink.html @@ -1,6 +1,6 @@ -ExternalHyperlink | docx

Class ExternalHyperlink

Hierarchy (View Summary)

Constructors

constructor +ExternalHyperlink | docx

Class ExternalHyperlink

Hierarchy (View Summary)

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 e12c8c12de..3ed890e655 100644 --- a/api/classes/FileChild.html +++ b/api/classes/FileChild.html @@ -1,6 +1,6 @@ -FileChild | docx

Class FileChild

Hierarchy (View Summary)

Constructors

constructor +FileChild | docx

Class FileChild

Hierarchy (View Summary)

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 ec55ac4c51..3752b04c46 100644 --- a/api/classes/FootNoteReferenceRunAttributes.html +++ b/api/classes/FootNoteReferenceRunAttributes.html @@ -1,3 +1,3 @@ -FootNoteReferenceRunAttributes | docx

Class FootNoteReferenceRunAttributes

Hierarchy (View Summary)

Constructors

constructor +FootNoteReferenceRunAttributes | docx

Class FootNoteReferenceRunAttributes

Hierarchy (View Summary)

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 f5acb58d18..9ca8e66929 100644 --- a/api/classes/FootNotes.html +++ b/api/classes/FootNotes.html @@ -1,6 +1,6 @@ -FootNotes | docx

Class FootNotes

Hierarchy (View Summary)

Constructors

constructor +FootNotes | docx

Class FootNotes

Hierarchy (View Summary)

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 c8c9e27794..a8b4901013 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 825d37016f..04461e2a82 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 1f1bdbc267..3345444801 100644 --- a/api/classes/FootnoteReference.html +++ b/api/classes/FootnoteReference.html @@ -1,5 +1,5 @@ -FootnoteReference | docx

Class FootnoteReference

Hierarchy (View Summary)

Constructors

constructor +FootnoteReference | docx

Class FootnoteReference

Hierarchy (View Summary)

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 6bb8b654a5..8c12d1bc1b 100644 --- a/api/classes/FootnoteReferenceElement.html +++ b/api/classes/FootnoteReferenceElement.html @@ -1,5 +1,5 @@ -FootnoteReferenceElement | docx

Class FootnoteReferenceElement

Hierarchy (View Summary)

Constructors

constructor +FootnoteReferenceElement | docx

Class FootnoteReferenceElement

Hierarchy (View Summary)

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 41c693f38e..10915f7634 100644 --- a/api/classes/FootnoteReferenceRun.html +++ b/api/classes/FootnoteReferenceRun.html @@ -1,5 +1,5 @@ -FootnoteReferenceRun | docx

Class FootnoteReferenceRun

Hierarchy (View Summary)

  • Run
    • FootnoteReferenceRun

Constructors

constructor +FootnoteReferenceRun | docx

Class FootnoteReferenceRun

Hierarchy (View Summary)

  • 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 5bf4585712..ee848ee897 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 Summary)

Constructors

constructor +

Hierarchy (View Summary)

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 e55f9c4611..f8a553b1a7 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 739da77ed7..13dee6357b 100644 --- a/api/classes/HeaderFooterReference.html +++ b/api/classes/HeaderFooterReference.html @@ -1,5 +1,5 @@ -HeaderFooterReference | docx

Class HeaderFooterReference

Hierarchy (View Summary)

Constructors

constructor +HeaderFooterReference | docx

Class HeaderFooterReference

Hierarchy (View Summary)

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 4a95691030..ca9725bf49 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 781ba5896e..3281b9722f 100644 --- a/api/classes/HorizontalPosition.html +++ b/api/classes/HorizontalPosition.html @@ -1,5 +1,5 @@ -HorizontalPosition | docx

Class HorizontalPosition

Hierarchy (View Summary)

Constructors

constructor +HorizontalPosition | docx

Class HorizontalPosition

Hierarchy (View Summary)

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 a6c75818d6..cafd40129e 100644 --- a/api/classes/HpsMeasureElement.html +++ b/api/classes/HpsMeasureElement.html @@ -1,5 +1,5 @@ -HpsMeasureElement | docx

Class HpsMeasureElement

Hierarchy (View Summary)

Constructors

constructor +HpsMeasureElement | docx

Class HpsMeasureElement

Hierarchy (View Summary)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new HpsMeasureElement(
        name: string,
        val:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`,
    ): HpsMeasureElement

  • Parameters

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

    Returns HpsMeasureElement

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new HpsMeasureElement(
        name: string,
        val:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`,
    ): HpsMeasureElement

  • Parameters

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

    Returns HpsMeasureElement

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/IgnoreIfEmptyXmlComponent.html b/api/classes/IgnoreIfEmptyXmlComponent.html index 02e5d2ec8d..0f7426be02 100644 --- a/api/classes/IgnoreIfEmptyXmlComponent.html +++ b/api/classes/IgnoreIfEmptyXmlComponent.html @@ -1,5 +1,5 @@ -IgnoreIfEmptyXmlComponent | docx

Class IgnoreIfEmptyXmlComponentAbstract

Hierarchy (View Summary)

Constructors

constructor +IgnoreIfEmptyXmlComponent | docx

Class IgnoreIfEmptyXmlComponentAbstract

Hierarchy (View Summary)

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 7365f8335a..15db6831a5 100644 --- a/api/classes/ImageRun.html +++ b/api/classes/ImageRun.html @@ -1,5 +1,5 @@ -ImageRun | docx

Class ImageRun

Hierarchy (View Summary)

Constructors

constructor +ImageRun | docx

Class ImageRun

Hierarchy (View Summary)

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 0d33195bcc..35fe31ebf7 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 Summary)

Constructors

constructor +

Hierarchy (View Summary)

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 3ffa8308be..53a0682362 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 Summary)

Constructors

constructor +

Hierarchy (View Summary)

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 25c1732668..7f192a6c2c 100644 --- a/api/classes/Indent.html +++ b/api/classes/Indent.html @@ -1,5 +1,5 @@ -Indent | docx

Class Indent

Hierarchy (View Summary)

Constructors

constructor +Indent | docx

Class Indent

Hierarchy (View Summary)

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 23067747b5..4d8269b09d 100644 --- a/api/classes/InitializableXmlComponent.html +++ b/api/classes/InitializableXmlComponent.html @@ -1,5 +1,5 @@ -InitializableXmlComponent | docx

Class InitializableXmlComponentAbstract

Hierarchy (View Summary)

Constructors

constructor +InitializableXmlComponent | docx

Class InitializableXmlComponentAbstract

Hierarchy (View Summary)

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 f582846141..f1403f8094 100644 --- a/api/classes/InsertedTextRun.html +++ b/api/classes/InsertedTextRun.html @@ -1,5 +1,5 @@ -InsertedTextRun | docx

Class InsertedTextRun

Hierarchy (View Summary)

Constructors

constructor +InsertedTextRun | docx

Class InsertedTextRun

Hierarchy (View Summary)

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 feed482a6b..77cbba0acd 100644 --- a/api/classes/InternalHyperlink.html +++ b/api/classes/InternalHyperlink.html @@ -1,6 +1,6 @@ -InternalHyperlink | docx

Class InternalHyperlink

Hierarchy (View Summary)

Constructors

constructor +InternalHyperlink | docx

Class InternalHyperlink

Hierarchy (View Summary)

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 f07e43743b..7c7988e14b 100644 --- a/api/classes/LastRenderedPageBreak.html +++ b/api/classes/LastRenderedPageBreak.html @@ -1,5 +1,5 @@ -LastRenderedPageBreak | docx

Class LastRenderedPageBreak

Hierarchy (View Summary)

Constructors

constructor +LastRenderedPageBreak | docx

Class LastRenderedPageBreak

Hierarchy (View Summary)

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 9e90dfaca1..b244f8b76f 100644 --- a/api/classes/Level.html +++ b/api/classes/Level.html @@ -1,5 +1,5 @@ -Level | docx

Class Level

Hierarchy (View Summary)

Constructors

constructor +Level | docx

Class Level

Hierarchy (View Summary)

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 5bfb674678..cfd375eef3 100644 --- a/api/classes/LevelBase.html +++ b/api/classes/LevelBase.html @@ -1,5 +1,5 @@ -LevelBase | docx

Class LevelBase

Hierarchy (View Summary)

Constructors

constructor +LevelBase | docx

Class LevelBase

Hierarchy (View Summary)

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 16c2d98166..4c39e125fb 100644 --- a/api/classes/LevelForOverride.html +++ b/api/classes/LevelForOverride.html @@ -1,5 +1,5 @@ -LevelForOverride | docx

Class LevelForOverride

Hierarchy (View Summary)

Constructors

constructor +LevelForOverride | docx

Class LevelForOverride

Hierarchy (View Summary)

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 e0a6c718a0..face291637 100644 --- a/api/classes/LevelOverride.html +++ b/api/classes/LevelOverride.html @@ -1,5 +1,5 @@ -LevelOverride | docx

Class LevelOverride

Hierarchy (View Summary)

Constructors

constructor +LevelOverride | docx

Class LevelOverride

Hierarchy (View Summary)

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 0c241f9d1f..bb59d9b944 100644 --- a/api/classes/Math.html +++ b/api/classes/Math.html @@ -1,5 +1,5 @@ -Math | docx

Class Math

Hierarchy (View Summary)

Constructors

constructor +Math | docx

Class Math

Hierarchy (View Summary)

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 defa8e02bf..c9d61a84ea 100644 --- a/api/classes/MathAccentCharacter.html +++ b/api/classes/MathAccentCharacter.html @@ -1,5 +1,5 @@ -MathAccentCharacter | docx

Class MathAccentCharacter

Hierarchy (View Summary)

Constructors

constructor +MathAccentCharacter | docx

Class MathAccentCharacter

Hierarchy (View Summary)

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 c0fa01ce2f..ba4a20e46d 100644 --- a/api/classes/MathAngledBrackets.html +++ b/api/classes/MathAngledBrackets.html @@ -1,5 +1,5 @@ -MathAngledBrackets | docx

Class MathAngledBrackets

Hierarchy (View Summary)

Constructors

constructor +MathAngledBrackets | docx

Class MathAngledBrackets

Hierarchy (View Summary)

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 15469be4e5..1e5ae51cb7 100644 --- a/api/classes/MathBase.html +++ b/api/classes/MathBase.html @@ -1,5 +1,5 @@ -MathBase | docx

Class MathBase

Hierarchy (View Summary)

Constructors

constructor +MathBase | docx

Class MathBase

Hierarchy (View Summary)

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 a7a23fb247..2fa0058360 100644 --- a/api/classes/MathCurlyBrackets.html +++ b/api/classes/MathCurlyBrackets.html @@ -1,5 +1,5 @@ -MathCurlyBrackets | docx

Class MathCurlyBrackets

Hierarchy (View Summary)

Constructors

constructor +MathCurlyBrackets | docx

Class MathCurlyBrackets

Hierarchy (View Summary)

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 9e4a2532d6..2b94489a2e 100644 --- a/api/classes/MathDegree.html +++ b/api/classes/MathDegree.html @@ -1,5 +1,5 @@ -MathDegree | docx

Class MathDegree

Hierarchy (View Summary)

Constructors

constructor +MathDegree | docx

Class MathDegree

Hierarchy (View Summary)

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 a34c88c9f2..117d32f91e 100644 --- a/api/classes/MathDenominator.html +++ b/api/classes/MathDenominator.html @@ -1,5 +1,5 @@ -MathDenominator | docx

Class MathDenominator

Hierarchy (View Summary)

Constructors

constructor +MathDenominator | docx

Class MathDenominator

Hierarchy (View Summary)

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 d8dca89d32..7cf4253a94 100644 --- a/api/classes/MathFraction.html +++ b/api/classes/MathFraction.html @@ -1,5 +1,5 @@ -MathFraction | docx

Class MathFraction

Hierarchy (View Summary)

Constructors

constructor +MathFraction | docx

Class MathFraction

Hierarchy (View Summary)

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 cf4f31ae9c..bf14260d99 100644 --- a/api/classes/MathFunction.html +++ b/api/classes/MathFunction.html @@ -1,5 +1,5 @@ -MathFunction | docx

Class MathFunction

Hierarchy (View Summary)

Constructors

constructor +MathFunction | docx

Class MathFunction

Hierarchy (View Summary)

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 b7c265f6bb..884dcabb13 100644 --- a/api/classes/MathFunctionName.html +++ b/api/classes/MathFunctionName.html @@ -1,5 +1,5 @@ -MathFunctionName | docx

Class MathFunctionName

Hierarchy (View Summary)

Constructors

constructor +MathFunctionName | docx

Class MathFunctionName

Hierarchy (View Summary)

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 d63f382253..e44a779c0c 100644 --- a/api/classes/MathFunctionProperties.html +++ b/api/classes/MathFunctionProperties.html @@ -1,5 +1,5 @@ -MathFunctionProperties | docx

Class MathFunctionProperties

Hierarchy (View Summary)

Constructors

constructor +MathFunctionProperties | docx

Class MathFunctionProperties

Hierarchy (View Summary)

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 8392e22065..b0955789c9 100644 --- a/api/classes/MathIntegral.html +++ b/api/classes/MathIntegral.html @@ -1,5 +1,5 @@ -MathIntegral | docx

Class MathIntegral

Hierarchy (View Summary)

Constructors

constructor +MathIntegral | docx

Class MathIntegral

Hierarchy (View Summary)

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 24d2bc2766..761911e00c 100644 --- a/api/classes/MathLimit.html +++ b/api/classes/MathLimit.html @@ -1,5 +1,5 @@ -MathLimit | docx

Class MathLimit

Hierarchy (View Summary)

Constructors

constructor +MathLimit | docx

Class MathLimit

Hierarchy (View Summary)

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 3b4b31abba..9c4ef1fe20 100644 --- a/api/classes/MathLimitLocation.html +++ b/api/classes/MathLimitLocation.html @@ -1,5 +1,5 @@ -MathLimitLocation | docx

Class MathLimitLocation

Hierarchy (View Summary)

Constructors

constructor +MathLimitLocation | docx

Class MathLimitLocation

Hierarchy (View Summary)

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 3b72ba6fcd..cb2a277d03 100644 --- a/api/classes/MathLimitLower.html +++ b/api/classes/MathLimitLower.html @@ -1,5 +1,5 @@ -MathLimitLower | docx

Class MathLimitLower

Hierarchy (View Summary)

Constructors

constructor +MathLimitLower | docx

Class MathLimitLower

Hierarchy (View Summary)

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 8552cac9d2..a783971eb1 100644 --- a/api/classes/MathLimitUpper.html +++ b/api/classes/MathLimitUpper.html @@ -1,5 +1,5 @@ -MathLimitUpper | docx

Class MathLimitUpper

Hierarchy (View Summary)

Constructors

constructor +MathLimitUpper | docx

Class MathLimitUpper

Hierarchy (View Summary)

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 afc64381b2..a82c0d6b05 100644 --- a/api/classes/MathNAryProperties.html +++ b/api/classes/MathNAryProperties.html @@ -1,5 +1,5 @@ -MathNAryProperties | docx

Class MathNAryProperties

Hierarchy (View Summary)

Constructors

constructor +MathNAryProperties | docx

Class MathNAryProperties

Hierarchy (View Summary)

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 e0d7a6fd9e..16d53ccca2 100644 --- a/api/classes/MathNumerator.html +++ b/api/classes/MathNumerator.html @@ -1,5 +1,5 @@ -MathNumerator | docx

Class MathNumerator

Hierarchy (View Summary)

Constructors

constructor +MathNumerator | docx

Class MathNumerator

Hierarchy (View Summary)

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 52c54f2ad5..faa2fe8c65 100644 --- a/api/classes/MathPreSubSuperScript.html +++ b/api/classes/MathPreSubSuperScript.html @@ -1,5 +1,5 @@ -MathPreSubSuperScript | docx

Class MathPreSubSuperScript

Hierarchy (View Summary)

Constructors

constructor +MathPreSubSuperScript | docx

Class MathPreSubSuperScript

Hierarchy (View Summary)

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 6ec1695cec..2e8121bb14 100644 --- a/api/classes/MathPreSubSuperScriptProperties.html +++ b/api/classes/MathPreSubSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathPreSubSuperScriptProperties | docx

Class MathPreSubSuperScriptProperties

Hierarchy (View Summary)

Constructors

constructor +MathPreSubSuperScriptProperties | docx

Class MathPreSubSuperScriptProperties

Hierarchy (View Summary)

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 83d9581c54..62c05e4332 100644 --- a/api/classes/MathRadical.html +++ b/api/classes/MathRadical.html @@ -1,5 +1,5 @@ -MathRadical | docx

Class MathRadical

Hierarchy (View Summary)

Constructors

constructor +MathRadical | docx

Class MathRadical

Hierarchy (View Summary)

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 0b0f46a6a2..1721f775df 100644 --- a/api/classes/MathRadicalProperties.html +++ b/api/classes/MathRadicalProperties.html @@ -1,5 +1,5 @@ -MathRadicalProperties | docx

Class MathRadicalProperties

Hierarchy (View Summary)

Constructors

constructor +MathRadicalProperties | docx

Class MathRadicalProperties

Hierarchy (View Summary)

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 ddebe6a4fe..7d4679cf02 100644 --- a/api/classes/MathRoundBrackets.html +++ b/api/classes/MathRoundBrackets.html @@ -1,5 +1,5 @@ -MathRoundBrackets | docx

Class MathRoundBrackets

Hierarchy (View Summary)

Constructors

constructor +MathRoundBrackets | docx

Class MathRoundBrackets

Hierarchy (View Summary)

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 ed3014fd62..c704e9aeaf 100644 --- a/api/classes/MathRun.html +++ b/api/classes/MathRun.html @@ -1,5 +1,5 @@ -MathRun | docx

Class MathRun

Hierarchy (View Summary)

Constructors

constructor +MathRun | docx

Class MathRun

Hierarchy (View Summary)

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 59e944a66b..d0784454cd 100644 --- a/api/classes/MathSquareBrackets.html +++ b/api/classes/MathSquareBrackets.html @@ -1,5 +1,5 @@ -MathSquareBrackets | docx

Class MathSquareBrackets

Hierarchy (View Summary)

Constructors

constructor +MathSquareBrackets | docx

Class MathSquareBrackets

Hierarchy (View Summary)

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 4246ab8194..ab745fae8e 100644 --- a/api/classes/MathSubScript.html +++ b/api/classes/MathSubScript.html @@ -1,5 +1,5 @@ -MathSubScript | docx

Class MathSubScript

Hierarchy (View Summary)

Constructors

constructor +MathSubScript | docx

Class MathSubScript

Hierarchy (View Summary)

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 55798e09c0..96fce76b99 100644 --- a/api/classes/MathSubScriptElement.html +++ b/api/classes/MathSubScriptElement.html @@ -1,5 +1,5 @@ -MathSubScriptElement | docx

Class MathSubScriptElement

Hierarchy (View Summary)

Constructors

constructor +MathSubScriptElement | docx

Class MathSubScriptElement

Hierarchy (View Summary)

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 3177ab14bd..5b26fdff32 100644 --- a/api/classes/MathSubScriptProperties.html +++ b/api/classes/MathSubScriptProperties.html @@ -1,5 +1,5 @@ -MathSubScriptProperties | docx

Class MathSubScriptProperties

Hierarchy (View Summary)

Constructors

constructor +MathSubScriptProperties | docx

Class MathSubScriptProperties

Hierarchy (View Summary)

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 8a96971dbe..ecc6d7a573 100644 --- a/api/classes/MathSubSuperScript.html +++ b/api/classes/MathSubSuperScript.html @@ -1,5 +1,5 @@ -MathSubSuperScript | docx

Class MathSubSuperScript

Hierarchy (View Summary)

Constructors

constructor +MathSubSuperScript | docx

Class MathSubSuperScript

Hierarchy (View Summary)

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 c5c46e21e8..e487524b27 100644 --- a/api/classes/MathSubSuperScriptProperties.html +++ b/api/classes/MathSubSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathSubSuperScriptProperties | docx

Class MathSubSuperScriptProperties

Hierarchy (View Summary)

Constructors

constructor +MathSubSuperScriptProperties | docx

Class MathSubSuperScriptProperties

Hierarchy (View Summary)

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 956aa8ff63..38de2d1cdd 100644 --- a/api/classes/MathSum.html +++ b/api/classes/MathSum.html @@ -1,5 +1,5 @@ -MathSum | docx

Class MathSum

Hierarchy (View Summary)

Constructors

constructor +MathSum | docx

Class MathSum

Hierarchy (View Summary)

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 9bcd266c59..45c8098aac 100644 --- a/api/classes/MathSuperScript.html +++ b/api/classes/MathSuperScript.html @@ -1,5 +1,5 @@ -MathSuperScript | docx

Class MathSuperScript

Hierarchy (View Summary)

Constructors

constructor +MathSuperScript | docx

Class MathSuperScript

Hierarchy (View Summary)

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 679df1bcf0..6f6e0a7794 100644 --- a/api/classes/MathSuperScriptElement.html +++ b/api/classes/MathSuperScriptElement.html @@ -1,5 +1,5 @@ -MathSuperScriptElement | docx

Class MathSuperScriptElement

Hierarchy (View Summary)

Constructors

constructor +MathSuperScriptElement | docx

Class MathSuperScriptElement

Hierarchy (View Summary)

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 e20bdc2cae..b2a4dad478 100644 --- a/api/classes/MathSuperScriptProperties.html +++ b/api/classes/MathSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathSuperScriptProperties | docx

Class MathSuperScriptProperties

Hierarchy (View Summary)

Constructors

constructor +MathSuperScriptProperties | docx

Class MathSuperScriptProperties

Hierarchy (View Summary)

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 b02043cdf4..d7e2b09afa 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 cdf89f9fee..a41816a69a 100644 --- a/api/classes/MonthLong.html +++ b/api/classes/MonthLong.html @@ -1,5 +1,5 @@ -MonthLong | docx

Class MonthLong

Hierarchy (View Summary)

Constructors

constructor +MonthLong | docx

Class MonthLong

Hierarchy (View Summary)

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 79c8ffccde..461ff0d833 100644 --- a/api/classes/MonthShort.html +++ b/api/classes/MonthShort.html @@ -1,5 +1,5 @@ -MonthShort | docx

Class MonthShort

Hierarchy (View Summary)

Constructors

constructor +MonthShort | docx

Class MonthShort

Hierarchy (View Summary)

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 cc3e0ca7ad..62533f9361 100644 --- a/api/classes/NextAttributeComponent.html +++ b/api/classes/NextAttributeComponent.html @@ -1,3 +1,3 @@ -NextAttributeComponent | docx

Class NextAttributeComponent<T>

Type Parameters

Hierarchy (View Summary)

Constructors

constructor +NextAttributeComponent | docx

Class NextAttributeComponent<T>

Type Parameters

Hierarchy (View Summary)

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 805f8468b6..17ba24f92b 100644 --- a/api/classes/NoBreakHyphen.html +++ b/api/classes/NoBreakHyphen.html @@ -1,5 +1,5 @@ -NoBreakHyphen | docx

Class NoBreakHyphen

Hierarchy (View Summary)

Constructors

constructor +NoBreakHyphen | docx

Class NoBreakHyphen

Hierarchy (View Summary)

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 1752985a8f..68bb46c630 100644 --- a/api/classes/NumberProperties.html +++ b/api/classes/NumberProperties.html @@ -1,5 +1,5 @@ -NumberProperties | docx

Class NumberProperties

Hierarchy (View Summary)

Constructors

constructor +NumberProperties | docx

Class NumberProperties

Hierarchy (View Summary)

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 7325bd65b9..04cd061998 100644 --- a/api/classes/NumberValueElement.html +++ b/api/classes/NumberValueElement.html @@ -1,5 +1,5 @@ -NumberValueElement | docx

Class NumberValueElement

Hierarchy (View Summary)

Constructors

constructor +NumberValueElement | docx

Class NumberValueElement

Hierarchy (View Summary)

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 0ad9031629..08d0e52bda 100644 --- a/api/classes/Numbering.html +++ b/api/classes/Numbering.html @@ -1,8 +1,8 @@ -Numbering | docx

Class Numbering

Hierarchy (View Summary)

Constructors

constructor +Numbering | docx

Class Numbering

Hierarchy (View Summary)

Constructors

constructor

Accessors

ConcreteNumbering ReferenceConfig

Methods

addChildElement createConcreteNumberingInstance prepForXml -

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference: string, instance: number): 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: string, instance: number): 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 4c25ff7d32..9484371827 100644 --- a/api/classes/OnOffElement.html +++ b/api/classes/OnOffElement.html @@ -1,5 +1,5 @@ -OnOffElement | docx

Class OnOffElement

Hierarchy (View Summary)

Constructors

constructor +OnOffElement | docx

Class OnOffElement

Hierarchy (View Summary)

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 9febb6ba02..5e2bf4c212 100644 --- a/api/classes/OutlineLevel.html +++ b/api/classes/OutlineLevel.html @@ -1,6 +1,6 @@ -OutlineLevel | docx

Class OutlineLevel

Hierarchy (View Summary)

Constructors

constructor +OutlineLevel | docx

Class OutlineLevel

Hierarchy (View Summary)

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 e9c17b17aa..1377c9a21a 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: Document,
        prettify?: boolean | "" | " " | " " | "\t",
    ): Promise<string>

  • Parameters

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

    Returns Promise<string>

StatictoBlob

  • toBlob(
        file: Document,
        prettify?: boolean | "" | " " | " " | "\t",
    ): Promise<Blob>

  • Parameters

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

    Returns Promise<Blob>

StatictoBuffer

  • toBuffer(
        file: Document,
        prettify?: boolean | "" | " " | " " | "\t",
    ): Promise<Buffer>

  • Parameters

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

    Returns Promise<Buffer>

StatictoStream

StatictoString

  • toString(
        file: Document,
        prettify?: boolean | "" | " " | " " | "\t",
    ): 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: Document,
        prettify?: boolean | "" | " " | " " | "\t",
        overrides?: readonly IXmlifyedFile[],
    ): Promise<string>

  • Parameters

    • file: Document
    • Optionalprettify: boolean | "" | " " | " " | "\t"
    • overrides: readonly IXmlifyedFile[] = []

    Returns Promise<string>

StatictoBlob

  • toBlob(
        file: Document,
        prettify?: boolean | "" | " " | " " | "\t",
        overrides?: readonly IXmlifyedFile[],
    ): Promise<Blob>

  • Parameters

    • file: Document
    • Optionalprettify: boolean | "" | " " | " " | "\t"
    • overrides: readonly IXmlifyedFile[] = []

    Returns Promise<Blob>

StatictoBuffer

  • toBuffer(
        file: Document,
        prettify?: boolean | "" | " " | " " | "\t",
        overrides?: readonly IXmlifyedFile[],
    ): Promise<Buffer>

  • Parameters

    • file: Document
    • Optionalprettify: boolean | "" | " " | " " | "\t"
    • overrides: readonly IXmlifyedFile[] = []

    Returns Promise<Buffer>

StatictoStream

  • toStream(
        file: Document,
        prettify?: boolean | "" | " " | " " | "\t",
        overrides?: readonly IXmlifyedFile[],
    ): Stream

  • Parameters

    • file: Document
    • Optionalprettify: boolean | "" | " " | " " | "\t"
    • overrides: readonly IXmlifyedFile[] = []

    Returns Stream

StatictoString

  • toString(
        file: Document,
        prettify?: boolean | "" | " " | " " | "\t",
        overrides?: readonly IXmlifyedFile[],
    ): Promise<string>

  • Parameters

    • file: Document
    • Optionalprettify: boolean | "" | " " | " " | "\t"
    • overrides: readonly IXmlifyedFile[] = []

    Returns Promise<string>

Settings

Member Visibility

On This Page

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

Class PageBorders

Hierarchy (View Summary)

Constructors

constructor +PageBorders | docx

Class PageBorders

Hierarchy (View Summary)

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 afb5b0834c..55ac1945d8 100644 --- a/api/classes/PageBreak.html +++ b/api/classes/PageBreak.html @@ -1,5 +1,5 @@ -PageBreak | docx

Class PageBreak

Hierarchy (View Summary)

Constructors

constructor +PageBreak | docx

Class PageBreak

Hierarchy (View Summary)

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 e044012a40..7e040908e1 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 Summary)

Constructors

constructor +

Hierarchy (View Summary)

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 420eaa1796..dba80e2acb 100644 --- a/api/classes/PageMargin.html +++ b/api/classes/PageMargin.html @@ -1,5 +1,5 @@ -PageMargin | docx

Class PageMargin

Hierarchy (View Summary)

Constructors

constructor +PageMargin | docx

Class PageMargin

Hierarchy (View Summary)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new PageMargin(
        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`,
    ): 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:
            | 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`,
    ): 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 bf4a4cb17b..63d3fdda67 100644 --- a/api/classes/PageNumberElement.html +++ b/api/classes/PageNumberElement.html @@ -1,5 +1,5 @@ -PageNumberElement | docx

Class PageNumberElement

Hierarchy (View Summary)

Constructors

constructor +PageNumberElement | docx

Class PageNumberElement

Hierarchy (View Summary)

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 d7713b7bbe..13c988c15b 100644 --- a/api/classes/PageNumberType.html +++ b/api/classes/PageNumberType.html @@ -1,5 +1,5 @@ -PageNumberType | docx

Class PageNumberType

Hierarchy (View Summary)

Constructors

constructor +PageNumberType | docx

Class PageNumberType

Hierarchy (View Summary)

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 ed05d8aa1c..9caf20ca99 100644 --- a/api/classes/PageNumberTypeAttributes.html +++ b/api/classes/PageNumberTypeAttributes.html @@ -1,3 +1,3 @@ -PageNumberTypeAttributes | docx

Class PageNumberTypeAttributes

Hierarchy (View Summary)

Constructors

constructor +PageNumberTypeAttributes | docx

Class PageNumberTypeAttributes

Hierarchy (View Summary)

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 f08d608230..aac85406dc 100644 --- a/api/classes/PageReference.html +++ b/api/classes/PageReference.html @@ -1,5 +1,5 @@ -PageReference | docx

Class PageReference

Hierarchy (View Summary)

  • Run
    • PageReference

Constructors

constructor +PageReference | docx

Class PageReference

Hierarchy (View Summary)

  • 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 69eb8f6f47..49f53ffab9 100644 --- a/api/classes/PageSize.html +++ b/api/classes/PageSize.html @@ -1,5 +1,5 @@ -PageSize | docx

Class PageSize

Hierarchy (View Summary)

Constructors

constructor +PageSize | docx

Class PageSize

Hierarchy (View Summary)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new PageSize(
        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",
    ): 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:
            | 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",
    ): 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 1ad59d6e44..42dc891329 100644 --- a/api/classes/PageTextDirection.html +++ b/api/classes/PageTextDirection.html @@ -1,5 +1,5 @@ -PageTextDirection | docx

Class PageTextDirection

Hierarchy (View Summary)

Constructors

constructor +PageTextDirection | docx

Class PageTextDirection

Hierarchy (View Summary)

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 76006a9cff..33bc6661e3 100644 --- a/api/classes/Paragraph.html +++ b/api/classes/Paragraph.html @@ -1,7 +1,7 @@ -Paragraph | docx

Class Paragraph

Hierarchy (View Summary)

Constructors

constructor +Paragraph | docx

Class Paragraph

Hierarchy (View Summary)

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 a26a5e04d8..e2cb9f3093 100644 --- a/api/classes/ParagraphProperties.html +++ b/api/classes/ParagraphProperties.html @@ -1,6 +1,6 @@ -ParagraphProperties | docx

Class ParagraphProperties

Hierarchy (View Summary)

Constructors

constructor +ParagraphProperties | docx

Class ParagraphProperties

Hierarchy (View Summary)

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 5f0ebb6e93..b5cbc1c0f3 100644 --- a/api/classes/ParagraphPropertiesDefaults.html +++ b/api/classes/ParagraphPropertiesDefaults.html @@ -1,5 +1,5 @@ -ParagraphPropertiesDefaults | docx

Class ParagraphPropertiesDefaults

Hierarchy (View Summary)

Constructors

constructor +ParagraphPropertiesDefaults | docx

Class ParagraphPropertiesDefaults

Hierarchy (View Summary)

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 bbc0322c5c..be72248e42 100644 --- a/api/classes/PositionalTab.html +++ b/api/classes/PositionalTab.html @@ -1,5 +1,5 @@ -PositionalTab | docx

Class PositionalTab

Hierarchy (View Summary)

Constructors

constructor +PositionalTab | docx

Class PositionalTab

Hierarchy (View Summary)

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 d9bf6fca63..e1fbcb2e09 100644 --- a/api/classes/Run.html +++ b/api/classes/Run.html @@ -1,5 +1,5 @@ -Run | docx

Class Run

Hierarchy (View Summary)

Constructors

constructor +Run | docx

Class Run

Hierarchy (View Summary)

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 e85bd63942..6db95c8060 100644 --- a/api/classes/RunFonts.html +++ b/api/classes/RunFonts.html @@ -1,5 +1,5 @@ -RunFonts | docx

Class RunFonts

Hierarchy (View Summary)

Constructors

constructor +RunFonts | docx

Class RunFonts

Hierarchy (View Summary)

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 524f30edd9..fcce88a5dd 100644 --- a/api/classes/RunProperties.html +++ b/api/classes/RunProperties.html @@ -1,6 +1,6 @@ -RunProperties | docx

Class RunProperties

Hierarchy (View Summary)

Constructors

constructor +RunProperties | docx

Class RunProperties

Hierarchy (View Summary)

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 bd4be394eb..a083107b3b 100644 --- a/api/classes/RunPropertiesChange.html +++ b/api/classes/RunPropertiesChange.html @@ -1,5 +1,5 @@ -RunPropertiesChange | docx

Class RunPropertiesChange

Hierarchy (View Summary)

Constructors

constructor +RunPropertiesChange | docx

Class RunPropertiesChange

Hierarchy (View Summary)

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 713b654ea5..b197cb3507 100644 --- a/api/classes/RunPropertiesDefaults.html +++ b/api/classes/RunPropertiesDefaults.html @@ -1,5 +1,5 @@ -RunPropertiesDefaults | docx

Class RunPropertiesDefaults

Hierarchy (View Summary)

Constructors

constructor +RunPropertiesDefaults | docx

Class RunPropertiesDefaults

Hierarchy (View Summary)

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 768519bd2b..a112a2b2a8 100644 --- a/api/classes/SectionProperties.html +++ b/api/classes/SectionProperties.html @@ -1,5 +1,5 @@ -SectionProperties | docx

Class SectionProperties

Hierarchy (View Summary)

Constructors

constructor +SectionProperties | docx

Class SectionProperties

Hierarchy (View Summary)

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 a0ee05c1cc..f05a9cb69b 100644 --- a/api/classes/SectionTypeAttributes.html +++ b/api/classes/SectionTypeAttributes.html @@ -1,3 +1,3 @@ -SectionTypeAttributes | docx

Class SectionTypeAttributes

Hierarchy (View Summary)

Constructors

constructor +SectionTypeAttributes | docx

Class SectionTypeAttributes

Hierarchy (View Summary)

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 14b765c850..bb4e6dd322 100644 --- a/api/classes/Separator.html +++ b/api/classes/Separator.html @@ -1,5 +1,5 @@ -Separator | docx

Class Separator

Hierarchy (View Summary)

Constructors

constructor +Separator | docx

Class Separator

Hierarchy (View Summary)

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 e58e7fe44d..b3626228df 100644 --- a/api/classes/SequentialIdentifier.html +++ b/api/classes/SequentialIdentifier.html @@ -1,5 +1,5 @@ -SequentialIdentifier | docx

Class SequentialIdentifier

Hierarchy (View Summary)

  • Run
    • SequentialIdentifier

Constructors

constructor +SequentialIdentifier | docx

Class SequentialIdentifier

Hierarchy (View Summary)

  • 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 8fa24dc065..786336c085 100644 --- a/api/classes/Shading.html +++ b/api/classes/Shading.html @@ -1,5 +1,5 @@ -Shading | docx

Class Shading

Hierarchy (View Summary)

Constructors

constructor +Shading | docx

Class Shading

Hierarchy (View Summary)

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 d6c9ca387a..2b4dbb7421 100644 --- a/api/classes/SimpleField.html +++ b/api/classes/SimpleField.html @@ -1,5 +1,5 @@ -SimpleField | docx

Class SimpleField

Hierarchy (View Summary)

Constructors

constructor +SimpleField | docx

Class SimpleField

Hierarchy (View Summary)

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 4e12254066..daea744b75 100644 --- a/api/classes/SimpleMailMergeField.html +++ b/api/classes/SimpleMailMergeField.html @@ -1,5 +1,5 @@ -SimpleMailMergeField | docx

Class SimpleMailMergeField

Hierarchy (View Summary)

Constructors

constructor +SimpleMailMergeField | docx

Class SimpleMailMergeField

Hierarchy (View Summary)

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 f033fc25d7..5aa045130c 100644 --- a/api/classes/SimplePos.html +++ b/api/classes/SimplePos.html @@ -1,5 +1,5 @@ -SimplePos | docx

Class SimplePos

Hierarchy (View Summary)

Constructors

constructor +SimplePos | docx

Class SimplePos

Hierarchy (View Summary)

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 da9806624c..a02a740a7b 100644 --- a/api/classes/SoftHyphen.html +++ b/api/classes/SoftHyphen.html @@ -1,5 +1,5 @@ -SoftHyphen | docx

Class SoftHyphen

Hierarchy (View Summary)

Constructors

constructor +SoftHyphen | docx

Class SoftHyphen

Hierarchy (View Summary)

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 dfe4c9574f..90133e3c32 100644 --- a/api/classes/Spacing.html +++ b/api/classes/Spacing.html @@ -1,5 +1,5 @@ -Spacing | docx

Class Spacing

Hierarchy (View Summary)

Constructors

constructor +Spacing | docx

Class Spacing

Hierarchy (View Summary)

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 ec347f4d0e..d3b112ed65 100644 --- a/api/classes/StringContainer.html +++ b/api/classes/StringContainer.html @@ -1,5 +1,5 @@ -StringContainer | docx

Class StringContainer

Hierarchy (View Summary)

Constructors

constructor +StringContainer | docx

Class StringContainer

Hierarchy (View Summary)

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 054c54ad2c..83af34669f 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 Summary)

Constructors

constructor +StringEnumValueElement | docx

Class StringEnumValueElement<T>

Type Parameters

  • T extends string

Hierarchy (View Summary)

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 d13645f292..088944505a 100644 --- a/api/classes/StringValueElement.html +++ b/api/classes/StringValueElement.html @@ -1,5 +1,5 @@ -StringValueElement | docx

Class StringValueElement

Hierarchy (View Summary)

Constructors

constructor +StringValueElement | docx

Class StringValueElement

Hierarchy (View Summary)

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 4ebe232d4c..a82358891b 100644 --- a/api/classes/Style.html +++ b/api/classes/Style.html @@ -1,5 +1,5 @@ -Style | docx

Class Style

Hierarchy (View Summary)

Constructors

constructor +Style | docx

Class Style

Hierarchy (View Summary)

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 2a8e703120..91f9138a3d 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 be3a6e6edf..7b0e5c9597 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 b6d2efcaed..2546e6c265 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 ab04efe405..3525b405c3 100644 --- a/api/classes/Styles.html +++ b/api/classes/Styles.html @@ -1,5 +1,5 @@ -Styles | docx

Class Styles

Hierarchy (View Summary)

Constructors

constructor +Styles | docx

Class Styles

Hierarchy (View Summary)

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 f9100af3ed..e3a5a03baf 100644 --- a/api/classes/SymbolRun.html +++ b/api/classes/SymbolRun.html @@ -1,5 +1,5 @@ -SymbolRun | docx

Class SymbolRun

Hierarchy (View Summary)

Constructors

constructor +SymbolRun | docx

Class SymbolRun

Hierarchy (View Summary)

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 6d33fd401b..4d4dc0b837 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 Summary)

Constructors

constructor +

Hierarchy (View Summary)

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 e2cad20a33..1b8d31e06c 100644 --- a/api/classes/Tab.html +++ b/api/classes/Tab.html @@ -1,5 +1,5 @@ -Tab | docx

Class Tab

Hierarchy (View Summary)

Constructors

constructor +Tab | docx

Class Tab

Hierarchy (View Summary)

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 3880a09a13..7689a6a8fe 100644 --- a/api/classes/TabAttributes.html +++ b/api/classes/TabAttributes.html @@ -1,3 +1,3 @@ -TabAttributes | docx

Class TabAttributes

Hierarchy (View Summary)

Constructors

constructor +TabAttributes | docx

Class TabAttributes

Hierarchy (View Summary)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new TabAttributes(
        root: {
            leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
            pos: string | number;
            val:
                | "center"
                | "clear"
                | "left"
                | "right"
                | "start"
                | "end"
                | "decimal"
                | "bar"
                | "num";
        },
    ): TabAttributes

  • Parameters

    • root: {
          leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
          pos: string | number;
          val:
              | "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: {
            leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
            pos: string | number;
            val:
                | "center"
                | "clear"
                | "left"
                | "right"
                | "start"
                | "end"
                | "decimal"
                | "bar"
                | "num";
        },
    ): TabAttributes

  • Parameters

    • root: {
          leader?: "none" | "dot" | "hyphen" | "underscore" | "middleDot";
          pos: string | number;
          val:
              | "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 568a5411e2..ceab59fbab 100644 --- a/api/classes/TabStop.html +++ b/api/classes/TabStop.html @@ -1,5 +1,5 @@ -TabStop | docx

Class TabStop

Hierarchy (View Summary)

Constructors

constructor +TabStop | docx

Class TabStop

Hierarchy (View Summary)

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 09fcc1f781..7ab93b67c5 100644 --- a/api/classes/TabStopItem.html +++ b/api/classes/TabStopItem.html @@ -1,5 +1,5 @@ -TabStopItem | docx

Class TabStopItem

Hierarchy (View Summary)

Constructors

constructor +TabStopItem | docx

Class TabStopItem

Hierarchy (View Summary)

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 6bfb94f7f1..c09393c160 100644 --- a/api/classes/Table.html +++ b/api/classes/Table.html @@ -1,6 +1,6 @@ -Table | docx

Class Table

Hierarchy (View Summary)

Constructors

constructor +Table | docx

Class Table

Hierarchy (View Summary)

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 9d8ec1180c..1bb8db7154 100644 --- a/api/classes/TableBorders.html +++ b/api/classes/TableBorders.html @@ -1,6 +1,6 @@ -TableBorders | docx

Class TableBorders

Hierarchy (View Summary)

Constructors

constructor +TableBorders | docx

Class TableBorders

Hierarchy (View Summary)

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 de59326588..2908b4bf0a 100644 --- a/api/classes/TableCell.html +++ b/api/classes/TableCell.html @@ -1,6 +1,6 @@ -TableCell | docx

Class TableCell

Hierarchy (View Summary)

Constructors

constructor +TableCell | docx

Class TableCell

Hierarchy (View Summary)

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 e630531075..4ee2107804 100644 --- a/api/classes/TableCellBorders.html +++ b/api/classes/TableCellBorders.html @@ -1,5 +1,5 @@ -TableCellBorders | docx

Class TableCellBorders

Hierarchy (View Summary)

Constructors

constructor +TableCellBorders | docx

Class TableCellBorders

Hierarchy (View Summary)

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 cd2f8e6942..2d805f6abe 100644 --- a/api/classes/TableFloatProperties.html +++ b/api/classes/TableFloatProperties.html @@ -1,5 +1,5 @@ -TableFloatProperties | docx

Class TableFloatProperties

Hierarchy (View Summary)

Constructors

constructor +TableFloatProperties | docx

Class TableFloatProperties

Hierarchy (View Summary)

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 397a73db4b..c582f1e545 100644 --- a/api/classes/TableLayout.html +++ b/api/classes/TableLayout.html @@ -1,5 +1,5 @@ -TableLayout | docx

Class TableLayout

Hierarchy (View Summary)

Constructors

constructor +TableLayout | docx

Class TableLayout

Hierarchy (View Summary)

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 da1600dd64..222eedef55 100644 --- a/api/classes/TableOfContents.html +++ b/api/classes/TableOfContents.html @@ -1,6 +1,6 @@ -TableOfContents | docx

Class TableOfContents

Hierarchy (View Summary)

Constructors

constructor +TableOfContents | docx

Class TableOfContents

Hierarchy (View Summary)

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 fe0a53b9cd..3459777db0 100644 --- a/api/classes/TableProperties.html +++ b/api/classes/TableProperties.html @@ -1,5 +1,5 @@ -TableProperties | docx

Class TableProperties

Hierarchy (View Summary)

Constructors

constructor +TableProperties | docx

Class TableProperties

Hierarchy (View Summary)

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 53aff49c66..01f8fc736f 100644 --- a/api/classes/TableRow.html +++ b/api/classes/TableRow.html @@ -1,4 +1,4 @@ -TableRow | docx

Class TableRow

Hierarchy (View Summary)

Constructors

constructor +TableRow | docx

Class TableRow

Hierarchy (View Summary)

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: number, allowEndNewCell?: boolean): 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: number, allowEndNewCell?: boolean): 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 6b60a41181..1e6d4e1bbb 100644 --- a/api/classes/TableRowHeight.html +++ b/api/classes/TableRowHeight.html @@ -1,5 +1,5 @@ -TableRowHeight | docx

Class TableRowHeight

Hierarchy (View Summary)

Constructors

constructor +TableRowHeight | docx

Class TableRowHeight

Hierarchy (View Summary)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new TableRowHeight(
        value:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`,
        rule: "auto" | "atLeast" | "exact",
    ): TableRowHeight

  • Parameters

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

    Returns TableRowHeight

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new TableRowHeight(
        value:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`,
        rule: "auto" | "atLeast" | "exact",
    ): TableRowHeight

  • Parameters

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

    Returns TableRowHeight

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRowHeightAttributes.html b/api/classes/TableRowHeightAttributes.html index e947147ac0..72d450e478 100644 --- a/api/classes/TableRowHeightAttributes.html +++ b/api/classes/TableRowHeightAttributes.html @@ -1,3 +1,3 @@ -TableRowHeightAttributes | docx

Class TableRowHeightAttributes

Hierarchy (View Summary)

Constructors

constructor +TableRowHeightAttributes | docx

Class TableRowHeightAttributes

Hierarchy (View Summary)

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 2c161928cf..2db3e2508b 100644 --- a/api/classes/TableRowProperties.html +++ b/api/classes/TableRowProperties.html @@ -1,5 +1,5 @@ -TableRowProperties | docx

Class TableRowProperties

Hierarchy (View Summary)

Constructors

constructor +TableRowProperties | docx

Class TableRowProperties

Hierarchy (View Summary)

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 b232e24bb0..c0ea9b0423 100644 --- a/api/classes/TableWidthElement.html +++ b/api/classes/TableWidthElement.html @@ -1,5 +1,5 @@ -TableWidthElement | docx

Class TableWidthElement

Hierarchy (View Summary)

Constructors

constructor +TableWidthElement | docx

Class TableWidthElement

Hierarchy (View Summary)

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 66561765f7..c0cbe3b80a 100644 --- a/api/classes/TextRun.html +++ b/api/classes/TextRun.html @@ -1,5 +1,5 @@ -TextRun | docx

Class TextRun

Hierarchy (View Summary)

Constructors

constructor +TextRun | docx

Class TextRun

Hierarchy (View Summary)

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/Textbox.html b/api/classes/Textbox.html index f97a6d57ab..7ed1025f02 100644 --- a/api/classes/Textbox.html +++ b/api/classes/Textbox.html @@ -1,6 +1,6 @@ -Textbox | docx

Class Textbox

Hierarchy (View Summary)

Constructors

constructor +Textbox | docx

Class Textbox

Hierarchy (View Summary)

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/ThematicBreak.html b/api/classes/ThematicBreak.html index 15f27a1a35..9174069adb 100644 --- a/api/classes/ThematicBreak.html +++ b/api/classes/ThematicBreak.html @@ -1,5 +1,5 @@ -ThematicBreak | docx

Class ThematicBreak

Hierarchy (View Summary)

Constructors

constructor +ThematicBreak | docx

Class ThematicBreak

Hierarchy (View Summary)

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 dadf7797df..d6624d4ae3 100644 --- a/api/classes/Type.html +++ b/api/classes/Type.html @@ -1,5 +1,5 @@ -Type | docx

Class Type

Hierarchy (View Summary)

Constructors

constructor +Type | docx

Class Type

Hierarchy (View Summary)

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 d8794685fe..b3f399edf8 100644 --- a/api/classes/Underline.html +++ b/api/classes/Underline.html @@ -1,5 +1,5 @@ -Underline | docx

Class Underline

Hierarchy (View Summary)

Constructors

constructor +Underline | docx

Class Underline

Hierarchy (View Summary)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

  • new Underline(
        underlineType?:
            | "single"
            | "dotDash"
            | "dotDotDash"
            | "dotted"
            | "double"
            | "none"
            | "thick"
            | "wave"
            | "words"
            | "dottedHeavy"
            | "dash"
            | "dashedHeavy"
            | "dashLong"
            | "dashLongHeavy"
            | "dashDotHeavy"
            | "dashDotDotHeavy"
            | "wavyHeavy"
            | "wavyDouble",
        color?: string,
    ): 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?:
            | "single"
            | "dotDash"
            | "dotDotDash"
            | "dotted"
            | "double"
            | "none"
            | "thick"
            | "wave"
            | "words"
            | "dottedHeavy"
            | "dash"
            | "dashedHeavy"
            | "dashLong"
            | "dashLongHeavy"
            | "dashDotHeavy"
            | "dashDotDotHeavy"
            | "wavyHeavy"
            | "wavyDouble",
        color?: string,
    ): 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 63ba21eb0e..c5a799e53e 100644 --- a/api/classes/VerticalAlignAttributes.html +++ b/api/classes/VerticalAlignAttributes.html @@ -1,3 +1,3 @@ -VerticalAlignAttributes | docx

Class VerticalAlignAttributes

Hierarchy (View Summary)

Constructors

constructor +VerticalAlignAttributes | docx

Class VerticalAlignAttributes

Hierarchy (View Summary)

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 fc96e0841d..69403cfda2 100644 --- a/api/classes/VerticalAlignElement.html +++ b/api/classes/VerticalAlignElement.html @@ -1,5 +1,5 @@ -VerticalAlignElement | docx

Class VerticalAlignElement

Hierarchy (View Summary)

Constructors

constructor +VerticalAlignElement | docx

Class VerticalAlignElement

Hierarchy (View Summary)

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 9964d75d9e..9f663c54d1 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 Summary)

Constructors

constructor +

Hierarchy (View Summary)

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 355eaf0336..7f3c11ddcd 100644 --- a/api/classes/VerticalPosition.html +++ b/api/classes/VerticalPosition.html @@ -1,5 +1,5 @@ -VerticalPosition | docx

Class VerticalPosition

Hierarchy (View Summary)

Constructors

constructor +VerticalPosition | docx

Class VerticalPosition

Hierarchy (View Summary)

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 81ba31b8e2..a80cc29034 100644 --- a/api/classes/WrapNone.html +++ b/api/classes/WrapNone.html @@ -1,5 +1,5 @@ -WrapNone | docx

Class WrapNone

Hierarchy (View Summary)

Constructors

constructor +WrapNone | docx

Class WrapNone

Hierarchy (View Summary)

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 a1c4f9d7ea..98460dbb5a 100644 --- a/api/classes/WrapSquare.html +++ b/api/classes/WrapSquare.html @@ -1,5 +1,5 @@ -WrapSquare | docx

Class WrapSquare

Hierarchy (View Summary)

Constructors

constructor +WrapSquare | docx

Class WrapSquare

Hierarchy (View Summary)

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 6558eccbbd..0b3367df48 100644 --- a/api/classes/WrapTight.html +++ b/api/classes/WrapTight.html @@ -1,5 +1,5 @@ -WrapTight | docx

Class WrapTight

Hierarchy (View Summary)

Constructors

constructor +WrapTight | docx

Class WrapTight

Hierarchy (View Summary)

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 ff590edca5..aab9e225cc 100644 --- a/api/classes/WrapTopAndBottom.html +++ b/api/classes/WrapTopAndBottom.html @@ -1,5 +1,5 @@ -WrapTopAndBottom | docx

Class WrapTopAndBottom

Hierarchy (View Summary)

Constructors

constructor +WrapTopAndBottom | docx

Class WrapTopAndBottom

Hierarchy (View Summary)

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 0f13a19bed..8671af3c8a 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 Record<string, any>

Hierarchy (View Summary)

Constructors

constructor +XmlAttributeComponent | docx

Class XmlAttributeComponent<T>Abstract

Type Parameters

  • T extends Record<string, any>

Hierarchy (View Summary)

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 8f2b17a8fe..63813768cd 100644 --- a/api/classes/XmlComponent.html +++ b/api/classes/XmlComponent.html @@ -1,5 +1,5 @@ -XmlComponent | docx

Class XmlComponentAbstract

Hierarchy (View Summary)

Constructors

constructor +XmlComponent | docx

Class XmlComponentAbstract

Hierarchy (View Summary)

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 1fb2682db1..8d30f5c5e6 100644 --- a/api/classes/YearLong.html +++ b/api/classes/YearLong.html @@ -1,5 +1,5 @@ -YearLong | docx

Class YearLong

Hierarchy (View Summary)

Constructors

constructor +YearLong | docx

Class YearLong

Hierarchy (View Summary)

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 e5024cbd1f..b29d046759 100644 --- a/api/classes/YearShort.html +++ b/api/classes/YearShort.html @@ -1,5 +1,5 @@ -YearShort | docx

Class YearShort

Hierarchy (View Summary)

Constructors

constructor +YearShort | docx

Class YearShort

Hierarchy (View Summary)

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 5b27d4e2f5..56cd6c7867 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 09c1240961..06d819bbdc 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 0fd4dfc567..7de848fa0e 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 185a41f542..3b9c855389 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 340712fcdf..fbad78787f 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 9e148ea2e0..43a776da35 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 8b8a384a82..12330fccac 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 8db0cf5685..ec1b1ce144 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 ad31ee1213..6f6bf38d25 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 1090947f6b..5501541067 100644 --- a/api/functions/dateTimeValue.html +++ b/api/functions/dateTimeValue.html @@ -1 +1 @@ -dateTimeValue | docx

Function dateTimeValue

  • dateTimeValue(val: Date): string

  • Parameters

    • val: Date

    Returns string

Settings

Member Visibility
+dateTimeValue | docx

Function dateTimeValue

  • dateTimeValue(val: Date): string

  • Parameters

    • val: Date

    Returns string

Settings

Member Visibility
diff --git a/api/functions/decimalNumber.html b/api/functions/decimalNumber.html index 86a8cbce52..3f582ff3e9 100644 --- a/api/functions/decimalNumber.html +++ b/api/functions/decimalNumber.html @@ -1 +1 @@ -decimalNumber | docx

Function decimalNumber

  • decimalNumber(val: number): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+decimalNumber | docx

Function decimalNumber

  • decimalNumber(val: number): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/docPropertiesUniqueNumericIdGen.html b/api/functions/docPropertiesUniqueNumericIdGen.html index 70c5605bcf..0c28064d36 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 7c25c9c91c..18decd33a4 100644 --- a/api/functions/eighthPointMeasureValue.html +++ b/api/functions/eighthPointMeasureValue.html @@ -1 +1 @@ -eighthPointMeasureValue | docx

Function eighthPointMeasureValue

  • eighthPointMeasureValue(val: number): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+eighthPointMeasureValue | docx

Function eighthPointMeasureValue

  • eighthPointMeasureValue(val: number): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/hashedId.html b/api/functions/hashedId.html index 565aeaae53..330b848cd9 100644 --- a/api/functions/hashedId.html +++ b/api/functions/hashedId.html @@ -1 +1 @@ -hashedId | docx

Function hashedId

  • hashedId(data: string | Buffer | Uint8Array | ArrayBuffer): string

  • Parameters

    • data: string | Buffer | Uint8Array | ArrayBuffer

    Returns string

Settings

Member Visibility
+hashedId | docx

Function hashedId

  • hashedId(data: string | Buffer | Uint8Array | ArrayBuffer): 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 ec8c96fc43..1c4962ca75 100644 --- a/api/functions/hexColorValue.html +++ b/api/functions/hexColorValue.html @@ -1 +1 @@ -hexColorValue | docx

Function hexColorValue

  • hexColorValue(val: string): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+hexColorValue | docx

Function hexColorValue

  • hexColorValue(val: string): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/hpsMeasureValue.html b/api/functions/hpsMeasureValue.html index a3aee7bd16..d01ed7c4f6 100644 --- a/api/functions/hpsMeasureValue.html +++ b/api/functions/hpsMeasureValue.html @@ -1 +1 @@ -hpsMeasureValue | docx

Function hpsMeasureValue

  • hpsMeasureValue(
        val:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`,
    ): 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:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`,
    ): 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 7634768ece..69ea6502fc 100644 --- a/api/functions/longHexNumber.html +++ b/api/functions/longHexNumber.html @@ -1 +1 @@ -longHexNumber | docx

Function longHexNumber

  • longHexNumber(val: string): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+longHexNumber | docx

Function longHexNumber

  • longHexNumber(val: string): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/measurementOrPercentValue.html b/api/functions/measurementOrPercentValue.html index 5dab70b33e..8851adf6a3 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}%`,
    ): | 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}%`,
    ): | 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 283b80eb62..576f2756d3 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: PatchDetectorOptions,
    ): 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 de8ca14e44..1e2dd1faf3 100644 --- a/api/functions/patchDocument.html +++ b/api/functions/patchDocument.html @@ -1 +1 @@ -patchDocument | docx

Function patchDocument

Settings

Member Visibility
+patchDocument | docx

Function patchDocument

Settings

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

Function percentageValue

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

  • Parameters

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

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

Settings

Member Visibility
+percentageValue | docx

Function percentageValue

  • percentageValue(val: `${number}%` | `-${number}%`): `${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 e259098a10..f4266ed78e 100644 --- a/api/functions/pointMeasureValue.html +++ b/api/functions/pointMeasureValue.html @@ -1 +1 @@ -pointMeasureValue | docx

Function pointMeasureValue

  • pointMeasureValue(val: number): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+pointMeasureValue | docx

Function pointMeasureValue

  • pointMeasureValue(val: number): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/positiveUniversalMeasureValue.html b/api/functions/positiveUniversalMeasureValue.html index 6c71039850..39d0399a28 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`,
    ): | `${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`,
    ): | `${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 d00319aed6..03cb6d1e21 100644 --- a/api/functions/shortHexNumber.html +++ b/api/functions/shortHexNumber.html @@ -1 +1 @@ -shortHexNumber | docx

Function shortHexNumber

  • shortHexNumber(val: string): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+shortHexNumber | docx

Function shortHexNumber

  • shortHexNumber(val: string): string

  • Parameters

    • val: string

    Returns string

Settings

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

Function signedHpsMeasureValue

  • signedHpsMeasureValue(
        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`,
    ): 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:
            | 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`,
    ): 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 333e891a40..e9b5826b04 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`,
    ): | 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`,
    ): | 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 9c5921a14c..030dc632cc 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`,
    ): | 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`,
    ): | 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 0a6712a68f..15a69ac3ff 100644 --- a/api/functions/uCharHexNumber.html +++ b/api/functions/uCharHexNumber.html @@ -1 +1 @@ -uCharHexNumber | docx

Function uCharHexNumber

  • uCharHexNumber(val: string): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+uCharHexNumber | docx

Function uCharHexNumber

  • uCharHexNumber(val: string): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/uniqueId.html b/api/functions/uniqueId.html index 52e53ff5e8..8402fc71d1 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 90dbaa5dd4..d205f35c51 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 0b3845769e..c00e54641e 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 7ee71f636d..4d6fc68f97 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`,
    ): | `${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`,
    ): | `${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 775becfd2a..98ab3cdf17 100644 --- a/api/functions/unsignedDecimalNumber.html +++ b/api/functions/unsignedDecimalNumber.html @@ -1 +1 @@ -unsignedDecimalNumber | docx

Function unsignedDecimalNumber

  • unsignedDecimalNumber(val: number): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+unsignedDecimalNumber | docx

Function unsignedDecimalNumber

  • unsignedDecimalNumber(val: number): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/interfaces/IXmlableObject.html b/api/interfaces/IXmlableObject.html index 8f2374380f..5271cffbc8 100644 --- a/api/interfaces/IXmlableObject.html +++ b/api/interfaces/IXmlableObject.html @@ -1 +1 @@ -IXmlableObject | docx

Interface IXmlableObject

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

  • readonly [key: string]: any

Settings

Member Visibility
+IXmlableObject | docx

Interface IXmlableObject

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

  • readonly [key: string]: any

Settings

Member Visibility
diff --git a/api/types/AttributeData.html b/api/types/AttributeData.html index 448b87bfbb..a46ca14b3b 100644 --- a/api/types/AttributeData.html +++ b/api/types/AttributeData.html @@ -1 +1 @@ -AttributeData | docx

Type Alias AttributeData

AttributeData: Record<string, boolean | number | string>

Settings

Member Visibility
+AttributeData | docx

Type Alias AttributeData

AttributeData: Record<string, boolean | number | string>

Settings

Member Visibility
diff --git a/api/types/AttributeMap.html b/api/types/AttributeMap.html index 627acddd2c..6da9385782 100644 --- a/api/types/AttributeMap.html +++ b/api/types/AttributeMap.html @@ -1 +1 @@ -AttributeMap | docx

Type Alias AttributeMap<T>

AttributeMap: Record<keyof T, string>

Type Parameters

  • T

Settings

Member Visibility
+AttributeMap | docx

Type Alias AttributeMap<T>

AttributeMap: Record<keyof T, string>

Type Parameters

  • T

Settings

Member Visibility
diff --git a/api/types/AttributePayload.html b/api/types/AttributePayload.html index 41e9ab05ff..f9b9cab68e 100644 --- a/api/types/AttributePayload.html +++ b/api/types/AttributePayload.html @@ -1 +1 @@ -AttributePayload | docx

Type Alias AttributePayload<T>

AttributePayload: { readonly [P in keyof T]: { key: string; value: T[P] } }

Type Parameters

  • T

Settings

Member Visibility
+AttributePayload | docx

Type Alias AttributePayload<T>

AttributePayload: { readonly [P in keyof T]: { key: string; value: T[P] } }

Type Parameters

  • T

Settings

Member Visibility
diff --git a/api/types/DocumentAttributeNamespace.html b/api/types/DocumentAttributeNamespace.html index 0c9a60ae98..27b9d67f99 100644 --- a/api/types/DocumentAttributeNamespace.html +++ b/api/types/DocumentAttributeNamespace.html @@ -1 +1 @@ -DocumentAttributeNamespace | docx

Type Alias DocumentAttributeNamespace

DocumentAttributeNamespace: keyof typeof DocumentAttributeNamespaces

Settings

Member Visibility
+DocumentAttributeNamespace | docx

Type Alias DocumentAttributeNamespace

DocumentAttributeNamespace: keyof typeof DocumentAttributeNamespaces

Settings

Member Visibility
diff --git a/api/types/IAlignmentFrameOptions.html b/api/types/IAlignmentFrameOptions.html index e1129015b0..40c3806c29 100644 --- a/api/types/IAlignmentFrameOptions.html +++ b/api/types/IAlignmentFrameOptions.html @@ -1 +1 @@ -IAlignmentFrameOptions | docx

Type Alias IAlignmentFrameOptions

IAlignmentFrameOptions: {
    alignment: {
        x: typeof HorizontalPositionAlign[keyof typeof HorizontalPositionAlign];
        y: typeof VerticalPositionAlign[keyof typeof VerticalPositionAlign];
    };
    type: "alignment";
} & IBaseFrameOptions

Settings

Member Visibility
+IAlignmentFrameOptions | docx

Type Alias IAlignmentFrameOptions

IAlignmentFrameOptions: {
    alignment: {
        x: typeof HorizontalPositionAlign[keyof typeof HorizontalPositionAlign];
        y: typeof VerticalPositionAlign[keyof typeof VerticalPositionAlign];
    };
    type: "alignment";
} & IBaseFrameOptions

Settings

Member Visibility
diff --git a/api/types/IBaseCharacterStyleOptions.html b/api/types/IBaseCharacterStyleOptions.html index bb3b3b54d3..6848c56ed4 100644 --- a/api/types/IBaseCharacterStyleOptions.html +++ b/api/types/IBaseCharacterStyleOptions.html @@ -1 +1 @@ -IBaseCharacterStyleOptions | docx

Type Alias IBaseCharacterStyleOptions

IBaseCharacterStyleOptions: { run?: IRunStylePropertiesOptions } & IStyleOptions

Settings

Member Visibility
+IBaseCharacterStyleOptions | docx

Type Alias IBaseCharacterStyleOptions

IBaseCharacterStyleOptions: { run?: IRunStylePropertiesOptions } & IStyleOptions

Settings

Member Visibility
diff --git a/api/types/IBaseParagraphStyleOptions.html b/api/types/IBaseParagraphStyleOptions.html index e40f54b8fb..bdf48eb00b 100644 --- a/api/types/IBaseParagraphStyleOptions.html +++ b/api/types/IBaseParagraphStyleOptions.html @@ -1 +1 @@ -IBaseParagraphStyleOptions | docx

Type Alias IBaseParagraphStyleOptions

IBaseParagraphStyleOptions: {
    paragraph?: IParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
} & IStyleOptions

Settings

Member Visibility
+IBaseParagraphStyleOptions | docx

Type Alias IBaseParagraphStyleOptions

IBaseParagraphStyleOptions: {
    paragraph?: IParagraphStylePropertiesOptions;
    run?: IRunStylePropertiesOptions;
} & IStyleOptions

Settings

Member Visibility
diff --git a/api/types/IBorderOptions.html b/api/types/IBorderOptions.html index 6dd6d3571c..0c6d8a9b5c 100644 --- a/api/types/IBorderOptions.html +++ b/api/types/IBorderOptions.html @@ -1,4 +1,4 @@ IBorderOptions | docx

Type Alias IBorderOptions

IBorderOptions: {
    color?: string;
    size?: number;
    space?: number;
    style: typeof BorderStyle[keyof typeof BorderStyle];
}

Type declaration

  • Optional Readonlycolor?: string

    Border color, in hex (eg 'FF00AA')

  • Optional Readonlysize?: number

    Size of the border in 1/8 pt

  • Optional Readonlyspace?: number

    Spacing offset. Values are specified in pt

    -
  • Readonlystyle: typeof BorderStyle[keyof typeof BorderStyle]

Settings

Member Visibility
+
  • Readonlystyle: typeof BorderStyle[keyof typeof BorderStyle]

    • Settings

    Member Visibility
    diff --git a/api/types/IBordersOptions.html b/api/types/IBordersOptions.html index e09f6df622..806ece7701 100644 --- a/api/types/IBordersOptions.html +++ b/api/types/IBordersOptions.html @@ -1 +1 @@ -IBordersOptions | docx

    Type Alias IBordersOptions

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

    Type declaration

    Settings

    Member Visibility
    +IBordersOptions | docx

    Type Alias IBordersOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ICharacterStyleOptions.html b/api/types/ICharacterStyleOptions.html index a5510b43c3..f4f36a7ac7 100644 --- a/api/types/ICharacterStyleOptions.html +++ b/api/types/ICharacterStyleOptions.html @@ -1 +1 @@ -ICharacterStyleOptions | docx

    Type Alias ICharacterStyleOptions

    ICharacterStyleOptions: { id: string } & IBaseCharacterStyleOptions

    Settings

    Member Visibility
    +ICharacterStyleOptions | docx

    Type Alias ICharacterStyleOptions

    ICharacterStyleOptions: { id: string } & IBaseCharacterStyleOptions

    Settings

    Member Visibility
    diff --git a/api/types/ICheckboxSymbolOptions.html b/api/types/ICheckboxSymbolOptions.html index 223bb9022a..2ee7269f85 100644 --- a/api/types/ICheckboxSymbolOptions.html +++ b/api/types/ICheckboxSymbolOptions.html @@ -1 +1 @@ -ICheckboxSymbolOptions | docx

    Type Alias ICheckboxSymbolOptions

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

    Type declaration

    Settings

    Member Visibility
    +ICheckboxSymbolOptions | docx

    Type Alias ICheckboxSymbolOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ICheckboxSymbolProperties.html b/api/types/ICheckboxSymbolProperties.html index 09e5168f28..2bfa0de2dc 100644 --- a/api/types/ICheckboxSymbolProperties.html +++ b/api/types/ICheckboxSymbolProperties.html @@ -1 +1 @@ -ICheckboxSymbolProperties | docx

    Type Alias ICheckboxSymbolProperties

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

    Type declaration

    • Optional Readonlyfont?: string
    • Optional Readonlyvalue?: string

    Settings

    Member Visibility
    +ICheckboxSymbolProperties | docx

    Type Alias ICheckboxSymbolProperties

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

    Type declaration

    • Optional Readonlyfont?: string
    • Optional Readonlyvalue?: string

    Settings

    Member Visibility
    diff --git a/api/types/IColumnsAttributes.html b/api/types/IColumnsAttributes.html index 2f7c695459..bf0663bbc7 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;
    }

    Type declaration

    • Optional Readonlychildren?: readonly Column[]
    • Optional Readonlycount?: number
    • Optional ReadonlyequalWidth?: boolean
    • Optional Readonlyseparate?: boolean
    • Optional Readonlyspace?: number | PositiveUniversalMeasure

    Settings

    Member Visibility
    +IColumnsAttributes | docx

    Type Alias IColumnsAttributes

    IColumnsAttributes: {
        children?: readonly Column[];
        count?: number;
        equalWidth?: boolean;
        separate?: boolean;
        space?: number | PositiveUniversalMeasure;
    }

    Type declaration

    • Optional Readonlychildren?: readonly Column[]
    • Optional Readonlycount?: number
    • Optional ReadonlyequalWidth?: boolean
    • Optional Readonlyseparate?: boolean
    • Optional Readonlyspace?: number | PositiveUniversalMeasure

    Settings

    Member Visibility
    diff --git a/api/types/ICommentOptions.html b/api/types/ICommentOptions.html index 446c4620bd..19602dfc04 100644 --- a/api/types/ICommentOptions.html +++ b/api/types/ICommentOptions.html @@ -1 +1 @@ -ICommentOptions | docx

    Type Alias ICommentOptions

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

    Type declaration

    • Optional Readonlyauthor?: string
    • Readonlychildren: readonly FileChild[]
    • Optional Readonlydate?: Date
    • Readonlyid: number
    • Optional Readonlyinitials?: string

    Settings

    Member Visibility
    +ICommentOptions | docx

    Type Alias ICommentOptions

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

    Type declaration

    • Optional Readonlyauthor?: string
    • Readonlychildren: readonly FileChild[]
    • Optional Readonlydate?: Date
    • Readonlyid: number
    • Optional Readonlyinitials?: string

    Settings

    Member Visibility
    diff --git a/api/types/ICommentsOptions.html b/api/types/ICommentsOptions.html index d0cec27844..57cff10bf1 100644 --- a/api/types/ICommentsOptions.html +++ b/api/types/ICommentsOptions.html @@ -1 +1 @@ -ICommentsOptions | docx

    Type Alias ICommentsOptions

    ICommentsOptions: { children: readonly ICommentOptions[] }

    Type declaration

    Settings

    Member Visibility
    +ICommentsOptions | docx

    Type Alias ICommentsOptions

    ICommentsOptions: { children: readonly ICommentOptions[] }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IConcreteNumberingOptions.html b/api/types/IConcreteNumberingOptions.html index 163b12f8e0..0746ebfaf2 100644 --- a/api/types/IConcreteNumberingOptions.html +++ b/api/types/IConcreteNumberingOptions.html @@ -1 +1 @@ -IConcreteNumberingOptions | docx

    Type Alias IConcreteNumberingOptions

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

    Type declaration

    • ReadonlyabstractNumId: number
    • Readonlyinstance: number
    • ReadonlynumId: number
    • Optional ReadonlyoverrideLevels?: readonly IOverrideLevel[]
    • Readonlyreference: string

    Settings

    Member Visibility
    +IConcreteNumberingOptions | docx

    Type Alias IConcreteNumberingOptions

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

    Type declaration

    • ReadonlyabstractNumId: number
    • Readonlyinstance: number
    • ReadonlynumId: number
    • Optional ReadonlyoverrideLevels?: readonly IOverrideLevel[]
    • Readonlyreference: string

    Settings

    Member Visibility
    diff --git a/api/types/IContext.html b/api/types/IContext.html index 1f37d90d5e..1b764769d1 100644 --- a/api/types/IContext.html +++ b/api/types/IContext.html @@ -1 +1 @@ -IContext | docx

    Type Alias IContext

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

    Type declaration

    Settings

    Member Visibility
    +IContext | docx

    Type Alias IContext

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IDistance.html b/api/types/IDistance.html index e9a67a3730..c8beb54cca 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 }

    Type declaration

    • Optional ReadonlydistB?: number
    • Optional ReadonlydistL?: number
    • Optional ReadonlydistR?: number
    • Optional ReadonlydistT?: number

    Settings

    Member Visibility
    +IDistance | docx

    Type Alias IDistance

    IDistance: { distB?: number; distL?: number; distR?: number; distT?: number }

    Type declaration

    • Optional ReadonlydistB?: number
    • Optional ReadonlydistL?: number
    • Optional ReadonlydistR?: number
    • Optional ReadonlydistT?: number

    Settings

    Member Visibility
    diff --git a/api/types/IDocGridAttributesProperties.html b/api/types/IDocGridAttributesProperties.html index 3582f697df..353ddaeb1a 100644 --- a/api/types/IDocGridAttributesProperties.html +++ b/api/types/IDocGridAttributesProperties.html @@ -1 +1 @@ -IDocGridAttributesProperties | docx

    Type Alias IDocGridAttributesProperties

    IDocGridAttributesProperties: {
        charSpace?: number;
        linePitch?: number;
        type?: typeof DocumentGridType[keyof typeof DocumentGridType];
    }

    Type declaration

    Settings

    Member Visibility
    +IDocGridAttributesProperties | docx

    Type Alias IDocGridAttributesProperties

    IDocGridAttributesProperties: {
        charSpace?: number;
        linePitch?: number;
        type?: typeof DocumentGridType[keyof typeof DocumentGridType];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IDocumentAttributesProperties.html b/api/types/IDocumentAttributesProperties.html index 97642d5d16..e8cab31464 100644 --- a/api/types/IDocumentAttributesProperties.html +++ b/api/types/IDocumentAttributesProperties.html @@ -1 +1 @@ -IDocumentAttributesProperties | docx

    Type Alias IDocumentAttributesProperties

    IDocumentAttributesProperties: Partial<
        Record<DocumentAttributeNamespace, string>,
    > & { Ignorable?: string }

    Settings

    Member Visibility
    +IDocumentAttributesProperties | docx

    Type Alias IDocumentAttributesProperties

    IDocumentAttributesProperties: Partial<
        Record<DocumentAttributeNamespace, string>,
    > & { Ignorable?: string }

    Settings

    Member Visibility
    diff --git a/api/types/IDocumentBackgroundOptions.html b/api/types/IDocumentBackgroundOptions.html index 44372d9b1f..0f1f1c234b 100644 --- a/api/types/IDocumentBackgroundOptions.html +++ b/api/types/IDocumentBackgroundOptions.html @@ -1 +1 @@ -IDocumentBackgroundOptions | docx

    Type Alias IDocumentBackgroundOptions

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

    Type declaration

    • Optional Readonlycolor?: string
    • Optional ReadonlythemeColor?: string
    • Optional ReadonlythemeShade?: string
    • Optional ReadonlythemeTint?: string

    Settings

    Member Visibility
    +IDocumentBackgroundOptions | docx

    Type Alias IDocumentBackgroundOptions

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

    Type declaration

    • Optional Readonlycolor?: string
    • Optional ReadonlythemeColor?: string
    • Optional ReadonlythemeShade?: string
    • Optional ReadonlythemeTint?: string

    Settings

    Member Visibility
    diff --git a/api/types/IDocumentDefaultsOptions.html b/api/types/IDocumentDefaultsOptions.html index 1717300f4f..1698d59ecb 100644 --- a/api/types/IDocumentDefaultsOptions.html +++ b/api/types/IDocumentDefaultsOptions.html @@ -1 +1 @@ -IDocumentDefaultsOptions | docx

    Type Alias IDocumentDefaultsOptions

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

    Type declaration

    Settings

    Member Visibility
    +IDocumentDefaultsOptions | docx

    Type Alias IDocumentDefaultsOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IDocumentFooter.html b/api/types/IDocumentFooter.html index 8f05ada4fc..3e61da794a 100644 --- a/api/types/IDocumentFooter.html +++ b/api/types/IDocumentFooter.html @@ -1 +1 @@ -IDocumentFooter | docx

    Type Alias IDocumentFooter

    IDocumentFooter: {
        footer: FooterWrapper;
        type: typeof HeaderFooterReferenceType[keyof typeof HeaderFooterReferenceType];
    }

    Type declaration

    Settings

    Member Visibility
    +IDocumentFooter | docx

    Type Alias IDocumentFooter

    IDocumentFooter: {
        footer: FooterWrapper;
        type: typeof HeaderFooterReferenceType[keyof typeof HeaderFooterReferenceType];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IDocumentHeader.html b/api/types/IDocumentHeader.html index a2f9ce924b..9f555bdf0b 100644 --- a/api/types/IDocumentHeader.html +++ b/api/types/IDocumentHeader.html @@ -1 +1 @@ -IDocumentHeader | docx

    Type Alias IDocumentHeader

    IDocumentHeader: {
        header: HeaderWrapper;
        type: typeof HeaderFooterReferenceType[keyof typeof HeaderFooterReferenceType];
    }

    Type declaration

    Settings

    Member Visibility
    +IDocumentHeader | docx

    Type Alias IDocumentHeader

    IDocumentHeader: {
        header: HeaderWrapper;
        type: typeof HeaderFooterReferenceType[keyof typeof HeaderFooterReferenceType];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IDocumentOptions.html b/api/types/IDocumentOptions.html index 8730d22097..55c565ccb6 100644 --- a/api/types/IDocumentOptions.html +++ b/api/types/IDocumentOptions.html @@ -1 +1 @@ -IDocumentOptions | docx

    Type Alias IDocumentOptions

    IDocumentOptions: { background?: IDocumentBackgroundOptions }

    Type declaration

    Settings

    Member Visibility
    +IDocumentOptions | docx

    Type Alias IDocumentOptions

    IDocumentOptions: { background?: IDocumentBackgroundOptions }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IDrawingOptions.html b/api/types/IDrawingOptions.html index 0fb50eb0d0..e3d1e43a93 100644 --- a/api/types/IDrawingOptions.html +++ b/api/types/IDrawingOptions.html @@ -1 +1 @@ -IDrawingOptions | docx

    Type Alias IDrawingOptions

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

    Type declaration

    • Optional ReadonlydocProperties?: DocPropertiesOptions
    • Optional Readonlyfloating?: IFloating
    • Optional Readonlyoutline?: OutlineOptions

    Settings

    Member Visibility
    +IDrawingOptions | docx

    Type Alias IDrawingOptions

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

    Type declaration

    • Optional ReadonlydocProperties?: DocPropertiesOptions
    • Optional Readonlyfloating?: IFloating
    • Optional Readonlyoutline?: OutlineOptions

    Settings

    Member Visibility
    diff --git a/api/types/IFloating.html b/api/types/IFloating.html index bd67826b09..11e68123ce 100644 --- a/api/types/IFloating.html +++ b/api/types/IFloating.html @@ -1 +1 @@ -IFloating | docx

    Type Alias IFloating

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

    Type declaration

    • Optional ReadonlyallowOverlap?: boolean
    • Optional ReadonlybehindDocument?: boolean
    • ReadonlyhorizontalPosition: IHorizontalPositionOptions
    • Optional ReadonlylayoutInCell?: boolean
    • Optional ReadonlylockAnchor?: boolean
    • Optional Readonlymargins?: IMargins
    • ReadonlyverticalPosition: IVerticalPositionOptions
    • Optional Readonlywrap?: ITextWrapping
    • Optional ReadonlyzIndex?: number

    Settings

    Member Visibility
    +IFloating | docx

    Type Alias IFloating

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

    Type declaration

    • Optional ReadonlyallowOverlap?: boolean
    • Optional ReadonlybehindDocument?: boolean
    • ReadonlyhorizontalPosition: IHorizontalPositionOptions
    • Optional ReadonlylayoutInCell?: boolean
    • Optional ReadonlylockAnchor?: boolean
    • Optional Readonlymargins?: IMargins
    • ReadonlyverticalPosition: IVerticalPositionOptions
    • Optional Readonlywrap?: ITextWrapping
    • Optional ReadonlyzIndex?: number

    Settings

    Member Visibility
    diff --git a/api/types/IFontAttributesProperties.html b/api/types/IFontAttributesProperties.html index 7e91121785..0336942211 100644 --- a/api/types/IFontAttributesProperties.html +++ b/api/types/IFontAttributesProperties.html @@ -1 +1 @@ -IFontAttributesProperties | docx

    Type Alias IFontAttributesProperties

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

    Type declaration

    • Optional Readonlyascii?: string
    • Optional Readonlycs?: string
    • Optional ReadonlyeastAsia?: string
    • Optional ReadonlyhAnsi?: string
    • Optional Readonlyhint?: string

    Settings

    Member Visibility
    +IFontAttributesProperties | docx

    Type Alias IFontAttributesProperties

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

    Type declaration

    • Optional Readonlyascii?: string
    • Optional Readonlycs?: string
    • Optional ReadonlyeastAsia?: string
    • Optional ReadonlyhAnsi?: string
    • Optional Readonlyhint?: string

    Settings

    Member Visibility
    diff --git a/api/types/IFrameOptions.html b/api/types/IFrameOptions.html index 6b6edbd5c4..0d2ccb3148 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/IHeaderFooterGroup.html b/api/types/IHeaderFooterGroup.html index 1d12324260..3dfcc2abf4 100644 --- a/api/types/IHeaderFooterGroup.html +++ b/api/types/IHeaderFooterGroup.html @@ -1 +1 @@ -IHeaderFooterGroup | docx

    Type Alias IHeaderFooterGroup<T>

    IHeaderFooterGroup: { default?: T; even?: T; first?: T }

    Type Parameters

    • T

    Type declaration

    • Optional Readonlydefault?: T
    • Optional Readonlyeven?: T
    • Optional Readonlyfirst?: T

    Settings

    Member Visibility
    +IHeaderFooterGroup | docx

    Type Alias IHeaderFooterGroup<T>

    IHeaderFooterGroup: { default?: T; even?: T; first?: T }

    Type Parameters

    • T

    Type declaration

    • Optional Readonlydefault?: T
    • Optional Readonlyeven?: T
    • Optional Readonlyfirst?: T

    Settings

    Member Visibility
    diff --git a/api/types/IHeaderFooterOptions.html b/api/types/IHeaderFooterOptions.html index 597e0e81e6..9f8640373f 100644 --- a/api/types/IHeaderFooterOptions.html +++ b/api/types/IHeaderFooterOptions.html @@ -1 +1 @@ -IHeaderFooterOptions | docx

    Type Alias IHeaderFooterOptions

    IHeaderFooterOptions: {
        id?: number;
        type?: typeof HeaderFooterReferenceType[keyof typeof HeaderFooterReferenceType];
    }

    Type declaration

    Settings

    Member Visibility
    +IHeaderFooterOptions | docx

    Type Alias IHeaderFooterOptions

    IHeaderFooterOptions: {
        id?: number;
        type?: typeof HeaderFooterReferenceType[keyof typeof HeaderFooterReferenceType];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IHeaderOptions.html b/api/types/IHeaderOptions.html index 43ef241b23..0b27788a62 100644 --- a/api/types/IHeaderOptions.html +++ b/api/types/IHeaderOptions.html @@ -1 +1 @@ -IHeaderOptions | docx

    Type Alias IHeaderOptions

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

    Type declaration

    Settings

    Member Visibility
    +IHeaderOptions | docx

    Type Alias IHeaderOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IHorizontalPositionOptions.html b/api/types/IHorizontalPositionOptions.html index d254fa1359..997cddece2 100644 --- a/api/types/IHorizontalPositionOptions.html +++ b/api/types/IHorizontalPositionOptions.html @@ -1 +1 @@ -IHorizontalPositionOptions | docx

    Type Alias IHorizontalPositionOptions

    IHorizontalPositionOptions: {
        align?: typeof HorizontalPositionAlign[keyof typeof HorizontalPositionAlign];
        offset?: number;
        relative?: typeof HorizontalPositionRelativeFrom[keyof typeof HorizontalPositionRelativeFrom];
    }

    Type declaration

    Settings

    Member Visibility
    +IHorizontalPositionOptions | docx

    Type Alias IHorizontalPositionOptions

    IHorizontalPositionOptions: {
        align?: typeof HorizontalPositionAlign[keyof typeof HorizontalPositionAlign];
        offset?: number;
        relative?: typeof HorizontalPositionRelativeFrom[keyof typeof HorizontalPositionRelativeFrom];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IImageOptions.html b/api/types/IImageOptions.html index 9d35ee235e..d75d09945a 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/IIndentAttributesProperties.html b/api/types/IIndentAttributesProperties.html index 67cf07c24d..7033bd81da 100644 --- a/api/types/IIndentAttributesProperties.html +++ b/api/types/IIndentAttributesProperties.html @@ -1 +1 @@ -IIndentAttributesProperties | docx

    Type Alias IIndentAttributesProperties

    IIndentAttributesProperties: {
        end?: number | UniversalMeasure;
        firstLine?: number | PositiveUniversalMeasure;
        hanging?: number | PositiveUniversalMeasure;
        left?: number | UniversalMeasure;
        right?: number | UniversalMeasure;
        start?: number | UniversalMeasure;
    }

    Type declaration

    Settings

    Member Visibility
    +IIndentAttributesProperties | docx

    Type Alias IIndentAttributesProperties

    IIndentAttributesProperties: {
        end?: number | UniversalMeasure;
        firstLine?: number | PositiveUniversalMeasure;
        hanging?: number | PositiveUniversalMeasure;
        left?: number | UniversalMeasure;
        right?: number | UniversalMeasure;
        start?: number | UniversalMeasure;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ILevelParagraphStylePropertiesOptions.html b/api/types/ILevelParagraphStylePropertiesOptions.html index 8148bfe635..51a3481315 100644 --- a/api/types/ILevelParagraphStylePropertiesOptions.html +++ b/api/types/ILevelParagraphStylePropertiesOptions.html @@ -1,3 +1,3 @@ ILevelParagraphStylePropertiesOptions | docx

    Type Alias ILevelParagraphStylePropertiesOptions

    ILevelParagraphStylePropertiesOptions: {
        alignment?: typeof AlignmentType[keyof typeof AlignmentType];
        contextualSpacing?: boolean;
        indent?: IIndentAttributesProperties;
        keepLines?: boolean;
        keepNext?: boolean;
        leftTabStop?: number;
        outlineLevel?: number;
        rightTabStop?: number;
        spacing?: ISpacingProperties;
        thematicBreak?: boolean;
    }

    Type declaration

    • Optional Readonlyalignment?: typeof AlignmentType[keyof typeof AlignmentType]
    • Optional ReadonlycontextualSpacing?: boolean
    • Optional Readonlyindent?: IIndentAttributesProperties
    • Optional ReadonlykeepLines?: boolean

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

    • Optional ReadonlykeepNext?: 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?: number
    • Optional ReadonlyoutlineLevel?: number
    • Optional ReadonlyrightTabStop?: number
    • Optional Readonlyspacing?: ISpacingProperties
    • Optional ReadonlythematicBreak?: boolean

    Settings

    Member Visibility
    +
  • Optional ReadonlyleftTabStop?: number
  • Optional ReadonlyoutlineLevel?: number
  • Optional ReadonlyrightTabStop?: number
  • Optional Readonlyspacing?: ISpacingProperties
  • Optional ReadonlythematicBreak?: boolean

    • Settings

    Member Visibility
    diff --git a/api/types/ILevelsOptions.html b/api/types/ILevelsOptions.html index 2a78af5639..19153e22b9 100644 --- a/api/types/ILevelsOptions.html +++ b/api/types/ILevelsOptions.html @@ -1 +1 @@ -ILevelsOptions | docx

    Type Alias ILevelsOptions

    ILevelsOptions: {
        alignment?: typeof AlignmentType[keyof typeof AlignmentType];
        format?: typeof LevelFormat[keyof typeof LevelFormat];
        isLegalNumberingStyle?: boolean;
        level: number;
        start?: number;
        style?: {
            paragraph?: ILevelParagraphStylePropertiesOptions;
            run?: IRunStylePropertiesOptions;
        };
        suffix?: typeof LevelSuffix[keyof typeof LevelSuffix];
        text?: string;
    }

    Type declaration

    Settings

    Member Visibility
    +ILevelsOptions | docx

    Type Alias ILevelsOptions

    ILevelsOptions: {
        alignment?: typeof AlignmentType[keyof typeof AlignmentType];
        format?: typeof LevelFormat[keyof typeof LevelFormat];
        isLegalNumberingStyle?: boolean;
        level: number;
        start?: number;
        style?: {
            paragraph?: ILevelParagraphStylePropertiesOptions;
            run?: IRunStylePropertiesOptions;
        };
        suffix?: typeof LevelSuffix[keyof typeof LevelSuffix];
        text?: string;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ILineNumberAttributes.html b/api/types/ILineNumberAttributes.html index aba2fdce9b..01ec2b2bb9 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;
    }

    Type declaration

    Settings

    Member Visibility
    +ILineNumberAttributes | docx

    Type Alias ILineNumberAttributes

    ILineNumberAttributes: {
        countBy?: number;
        distance?: number | PositiveUniversalMeasure;
        restart?: typeof LineNumberRestartFormat[keyof typeof LineNumberRestartFormat];
        start?: number;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMargins.html b/api/types/IMargins.html index efd2776327..b6cc912fa7 100644 --- a/api/types/IMargins.html +++ b/api/types/IMargins.html @@ -1 +1 @@ -IMargins | docx

    Type Alias IMargins

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

    Type declaration

    • Optional Readonlybottom?: number
    • Optional Readonlyleft?: number
    • Optional Readonlyright?: number
    • Optional Readonlytop?: number

    Settings

    Member Visibility
    +IMargins | docx

    Type Alias IMargins

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

    Type declaration

    • Optional Readonlybottom?: number
    • Optional Readonlyleft?: number
    • Optional Readonlyright?: number
    • Optional Readonlytop?: number

    Settings

    Member Visibility
    diff --git a/api/types/IMathFractionOptions.html b/api/types/IMathFractionOptions.html index 63e5bdbc37..4e13cafee4 100644 --- a/api/types/IMathFractionOptions.html +++ b/api/types/IMathFractionOptions.html @@ -1 +1 @@ -IMathFractionOptions | docx

    Type Alias IMathFractionOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathFractionOptions | docx

    Type Alias IMathFractionOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathFunctionOptions.html b/api/types/IMathFunctionOptions.html index 65934ff0f2..f4007db815 100644 --- a/api/types/IMathFunctionOptions.html +++ b/api/types/IMathFunctionOptions.html @@ -1 +1 @@ -IMathFunctionOptions | docx

    Type Alias IMathFunctionOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathFunctionOptions | docx

    Type Alias IMathFunctionOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathIntegralOptions.html b/api/types/IMathIntegralOptions.html index e7d8344ee9..2c417486fa 100644 --- a/api/types/IMathIntegralOptions.html +++ b/api/types/IMathIntegralOptions.html @@ -1 +1 @@ -IMathIntegralOptions | docx

    Type Alias IMathIntegralOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathIntegralOptions | docx

    Type Alias IMathIntegralOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathLimitLowerOptions.html b/api/types/IMathLimitLowerOptions.html index 78290ff7d4..82fef0957a 100644 --- a/api/types/IMathLimitLowerOptions.html +++ b/api/types/IMathLimitLowerOptions.html @@ -1 +1 @@ -IMathLimitLowerOptions | docx

    Type Alias IMathLimitLowerOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathLimitLowerOptions | docx

    Type Alias IMathLimitLowerOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathLimitUpperOptions.html b/api/types/IMathLimitUpperOptions.html index 056ea57548..6851b92abd 100644 --- a/api/types/IMathLimitUpperOptions.html +++ b/api/types/IMathLimitUpperOptions.html @@ -1 +1 @@ -IMathLimitUpperOptions | docx

    Type Alias IMathLimitUpperOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathLimitUpperOptions | docx

    Type Alias IMathLimitUpperOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathOptions.html b/api/types/IMathOptions.html index 5a26a4e92a..1a3c1fbe56 100644 --- a/api/types/IMathOptions.html +++ b/api/types/IMathOptions.html @@ -1 +1 @@ -IMathOptions | docx

    Type Alias IMathOptions

    IMathOptions: { children: readonly MathComponent[] }

    Type declaration

    Settings

    Member Visibility
    +IMathOptions | docx

    Type Alias IMathOptions

    IMathOptions: { children: readonly MathComponent[] }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathPreSubSuperScriptOptions.html b/api/types/IMathPreSubSuperScriptOptions.html index fca7f47ca4..24f0143a14 100644 --- a/api/types/IMathPreSubSuperScriptOptions.html +++ b/api/types/IMathPreSubSuperScriptOptions.html @@ -1 +1 @@ -IMathPreSubSuperScriptOptions | docx

    Type Alias IMathPreSubSuperScriptOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathPreSubSuperScriptOptions | docx

    Type Alias IMathPreSubSuperScriptOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathRadicalOptions.html b/api/types/IMathRadicalOptions.html index fd03afda91..fa69aa1243 100644 --- a/api/types/IMathRadicalOptions.html +++ b/api/types/IMathRadicalOptions.html @@ -1 +1 @@ -IMathRadicalOptions | docx

    Type Alias IMathRadicalOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathRadicalOptions | docx

    Type Alias IMathRadicalOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathSubScriptOptions.html b/api/types/IMathSubScriptOptions.html index da16e7c7e4..5faa4b806e 100644 --- a/api/types/IMathSubScriptOptions.html +++ b/api/types/IMathSubScriptOptions.html @@ -1 +1 @@ -IMathSubScriptOptions | docx

    Type Alias IMathSubScriptOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathSubScriptOptions | docx

    Type Alias IMathSubScriptOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathSubSuperScriptOptions.html b/api/types/IMathSubSuperScriptOptions.html index 1f3d95675d..f9b72fc0f8 100644 --- a/api/types/IMathSubSuperScriptOptions.html +++ b/api/types/IMathSubSuperScriptOptions.html @@ -1 +1 @@ -IMathSubSuperScriptOptions | docx

    Type Alias IMathSubSuperScriptOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathSubSuperScriptOptions | docx

    Type Alias IMathSubSuperScriptOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathSumOptions.html b/api/types/IMathSumOptions.html index ae64b44c9e..1152a94358 100644 --- a/api/types/IMathSumOptions.html +++ b/api/types/IMathSumOptions.html @@ -1 +1 @@ -IMathSumOptions | docx

    Type Alias IMathSumOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathSumOptions | docx

    Type Alias IMathSumOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMathSuperScriptOptions.html b/api/types/IMathSuperScriptOptions.html index 7d6435991b..7017c07111 100644 --- a/api/types/IMathSuperScriptOptions.html +++ b/api/types/IMathSuperScriptOptions.html @@ -1 +1 @@ -IMathSuperScriptOptions | docx

    Type Alias IMathSuperScriptOptions

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

    Type declaration

    Settings

    Member Visibility
    +IMathSuperScriptOptions | docx

    Type Alias IMathSuperScriptOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IMediaData.html b/api/types/IMediaData.html index ab5c15f795..47312c58de 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/IMediaDataTransformation.html b/api/types/IMediaDataTransformation.html index 8069c765aa..01dafdb8ee 100644 --- a/api/types/IMediaDataTransformation.html +++ b/api/types/IMediaDataTransformation.html @@ -1 +1 @@ -IMediaDataTransformation | docx

    Type Alias IMediaDataTransformation

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

    Type declaration

    • Readonlyemus: { x: number; y: number }
    • Optional Readonlyflip?: { horizontal?: boolean; vertical?: boolean }
    • Readonlypixels: { x: number; y: number }
    • Optional Readonlyrotation?: number

    Settings

    Member Visibility
    +IMediaDataTransformation | docx

    Type Alias IMediaDataTransformation

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

    Type declaration

    • Readonlyemus: { x: number; y: number }
    • Optional Readonlyflip?: { horizontal?: boolean; vertical?: boolean }
    • Readonlypixels: { x: number; y: number }
    • Optional Readonlyrotation?: number

    Settings

    Member Visibility
    diff --git a/api/types/IMediaTransformation.html b/api/types/IMediaTransformation.html index 6852f3428a..01fb576bb6 100644 --- a/api/types/IMediaTransformation.html +++ b/api/types/IMediaTransformation.html @@ -1 +1 @@ -IMediaTransformation | docx

    Type Alias IMediaTransformation

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

    Type declaration

    • Optional Readonlyflip?: { horizontal?: boolean; vertical?: boolean }
    • Readonlyheight: number
    • Optional Readonlyrotation?: number
    • Readonlywidth: number

    Settings

    Member Visibility
    +IMediaTransformation | docx

    Type Alias IMediaTransformation

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

    Type declaration

    • Optional Readonlyflip?: { horizontal?: boolean; vertical?: boolean }
    • Readonlyheight: number
    • Optional Readonlyrotation?: number
    • Readonlywidth: number

    Settings

    Member Visibility
    diff --git a/api/types/INumberingOptions.html b/api/types/INumberingOptions.html index 3c99756a95..333d5fa61c 100644 --- a/api/types/INumberingOptions.html +++ b/api/types/INumberingOptions.html @@ -1 +1 @@ -INumberingOptions | docx

    Type Alias INumberingOptions

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

    Type declaration

    • Readonlyconfig: readonly { levels: readonly ILevelsOptions[]; reference: string }[]

    Settings

    Member Visibility
    +INumberingOptions | docx

    Type Alias INumberingOptions

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

    Type declaration

    • Readonlyconfig: readonly { levels: readonly ILevelsOptions[]; reference: string }[]

    Settings

    Member Visibility
    diff --git a/api/types/IPageBorderAttributes.html b/api/types/IPageBorderAttributes.html index b6bb9fb807..68a63e0879 100644 --- a/api/types/IPageBorderAttributes.html +++ b/api/types/IPageBorderAttributes.html @@ -1 +1 @@ -IPageBorderAttributes | docx

    Type Alias IPageBorderAttributes

    IPageBorderAttributes: {
        display?: typeof PageBorderDisplay[keyof typeof PageBorderDisplay];
        offsetFrom?: typeof PageBorderOffsetFrom[keyof typeof PageBorderOffsetFrom];
        zOrder?: typeof PageBorderZOrder[keyof typeof PageBorderZOrder];
    }

    Type declaration

    Settings

    Member Visibility
    +IPageBorderAttributes | docx

    Type Alias IPageBorderAttributes

    IPageBorderAttributes: {
        display?: typeof PageBorderDisplay[keyof typeof PageBorderDisplay];
        offsetFrom?: typeof PageBorderOffsetFrom[keyof typeof PageBorderOffsetFrom];
        zOrder?: typeof PageBorderZOrder[keyof typeof PageBorderZOrder];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IPageBordersOptions.html b/api/types/IPageBordersOptions.html index 1a263eb338..9f5a0835bb 100644 --- a/api/types/IPageBordersOptions.html +++ b/api/types/IPageBordersOptions.html @@ -1 +1 @@ -IPageBordersOptions | docx

    Type Alias IPageBordersOptions

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

    Type declaration

    Settings

    Member Visibility
    +IPageBordersOptions | docx

    Type Alias IPageBordersOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IPageMarginAttributes.html b/api/types/IPageMarginAttributes.html index a6e2e9d811..3acfa3daec 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;
    }

    Type declaration

    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;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IPageNumberTypeAttributes.html b/api/types/IPageNumberTypeAttributes.html index 261840ba7c..f9e7ece633 100644 --- a/api/types/IPageNumberTypeAttributes.html +++ b/api/types/IPageNumberTypeAttributes.html @@ -1 +1 @@ -IPageNumberTypeAttributes | docx

    Type Alias IPageNumberTypeAttributes

    IPageNumberTypeAttributes: {
        formatType?: typeof NumberFormat[keyof typeof NumberFormat];
        separator?: typeof PageNumberSeparator[keyof typeof PageNumberSeparator];
        start?: number;
    }

    Type declaration

    Settings

    Member Visibility
    +IPageNumberTypeAttributes | docx

    Type Alias IPageNumberTypeAttributes

    IPageNumberTypeAttributes: {
        formatType?: typeof NumberFormat[keyof typeof NumberFormat];
        separator?: typeof PageNumberSeparator[keyof typeof PageNumberSeparator];
        start?: number;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IPageReferenceOptions.html b/api/types/IPageReferenceOptions.html index bc29e1ede6..79b42d795e 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 0bce797112..76b19af735 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;
    }

    Type declaration

    Settings

    Member Visibility
    +IPageSizeAttributes | docx

    Type Alias IPageSizeAttributes

    IPageSizeAttributes: {
        height?: number | PositiveUniversalMeasure;
        orientation?: typeof PageOrientation[keyof typeof PageOrientation];
        width?: number | PositiveUniversalMeasure;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IParagraphOptions.html b/api/types/IParagraphOptions.html index 166292ddb0..f9fdebadc8 100644 --- a/api/types/IParagraphOptions.html +++ b/api/types/IParagraphOptions.html @@ -1 +1 @@ -IParagraphOptions | docx

    Type Alias IParagraphOptions

    IParagraphOptions: { children?: readonly ParagraphChild[]; text?: string } & IParagraphPropertiesOptions

    Settings

    Member Visibility
    +IParagraphOptions | docx

    Type Alias IParagraphOptions

    IParagraphOptions: { children?: readonly ParagraphChild[]; text?: string } & IParagraphPropertiesOptions

    Settings

    Member Visibility
    diff --git a/api/types/IParagraphPropertiesOptions.html b/api/types/IParagraphPropertiesOptions.html index 316148f2fe..5a0a8af480 100644 --- a/api/types/IParagraphPropertiesOptions.html +++ b/api/types/IParagraphPropertiesOptions.html @@ -1,4 +1,4 @@ IParagraphPropertiesOptions | docx

    Type Alias IParagraphPropertiesOptions

    IParagraphPropertiesOptions: {
        autoSpaceEastAsianText?: boolean;
        bidirectional?: boolean;
        border?: IBordersOptions;
        bullet?: { level: number };
        frame?: IFrameOptions;
        heading?: typeof HeadingLevel[keyof typeof HeadingLevel];
        overflowPunctuation?: boolean;
        pageBreakBefore?: boolean;
        run?: IRunOptions;
        scale?: number;
        shading?: IShadingAttributesProperties;
        style?: string;
        suppressLineNumbers?: boolean;
        tabStops?: readonly TabStopDefinition[];
        widowControl?: boolean;
        wordWrap?: boolean;
    } & IParagraphStylePropertiesOptions

    Type declaration

    • Optional ReadonlyautoSpaceEastAsianText?: 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?: boolean
    • Optional Readonlyborder?: IBordersOptions
    • Optional Readonlybullet?: { level: number }
    • Optional Readonlyframe?: IFrameOptions
    • Optional Readonlyheading?: typeof HeadingLevel[keyof typeof HeadingLevel]
    • Optional ReadonlyoverflowPunctuation?: boolean
    • Optional ReadonlypageBreakBefore?: boolean
    • Optional Readonlyrun?: IRunOptions

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

      -
    • Optional Readonlyscale?: number
    • Optional Readonlyshading?: IShadingAttributesProperties
    • Optional Readonlystyle?: string
    • Optional ReadonlysuppressLineNumbers?: boolean
    • Optional ReadonlytabStops?: readonly TabStopDefinition[]
    • Optional ReadonlywidowControl?: boolean
    • Optional ReadonlywordWrap?: boolean

    Settings

    Member Visibility
    +
  • Optional Readonlyscale?: number
  • Optional Readonlyshading?: IShadingAttributesProperties
  • Optional Readonlystyle?: string
  • Optional ReadonlysuppressLineNumbers?: boolean
  • Optional ReadonlytabStops?: readonly TabStopDefinition[]
  • Optional ReadonlywidowControl?: boolean
  • Optional ReadonlywordWrap?: boolean

    • Settings

    Member Visibility
    diff --git a/api/types/IParagraphStyleOptions.html b/api/types/IParagraphStyleOptions.html index 6a1eb8c240..c3b94fe398 100644 --- a/api/types/IParagraphStyleOptions.html +++ b/api/types/IParagraphStyleOptions.html @@ -1 +1 @@ -IParagraphStyleOptions | docx

    Type Alias IParagraphStyleOptions

    IParagraphStyleOptions: { id: string } & IBaseParagraphStyleOptions

    Settings

    Member Visibility
    +IParagraphStyleOptions | docx

    Type Alias IParagraphStyleOptions

    IParagraphStyleOptions: { id: string } & IBaseParagraphStyleOptions

    Settings

    Member Visibility
    diff --git a/api/types/IParagraphStylePropertiesOptions.html b/api/types/IParagraphStylePropertiesOptions.html index e913e9e212..6c8ce1d112 100644 --- a/api/types/IParagraphStylePropertiesOptions.html +++ b/api/types/IParagraphStylePropertiesOptions.html @@ -1 +1 @@ -IParagraphStylePropertiesOptions | docx

    Type Alias IParagraphStylePropertiesOptions

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

    Settings

    Member Visibility
    +IParagraphStylePropertiesOptions | docx

    Type Alias IParagraphStylePropertiesOptions

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

    Settings

    Member Visibility
    diff --git a/api/types/IPatch.html b/api/types/IPatch.html index ccd45c585a..2c412b08ab 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/IRunOptions.html b/api/types/IRunOptions.html index c8fb2dd6b5..93b72c578f 100644 --- a/api/types/IRunOptions.html +++ b/api/types/IRunOptions.html @@ -1 +1 @@ -IRunOptions | docx

    Type Alias IRunOptions

    IRunOptions: {
        break?: number;
        children?: readonly (
            | Begin
            | FieldInstruction
            | Separate
            | End
            | typeof PageNumber[keyof typeof PageNumber]
            | FootnoteReferenceRun
            | Break
            | AnnotationReference
            | CarriageReturn
            | ContinuationSeparator
            | DayLong
            | DayShort
            | EndnoteReference
            | FootnoteReferenceElement
            | LastRenderedPageBreak
            | MonthLong
            | MonthShort
            | NoBreakHyphen
            | PageNumberElement
            | Separator
            | SoftHyphen
            | Tab
            | YearLong
            | YearShort
            | PositionalTab
            | string
        )[];
        text?: string;
    } & IRunPropertiesOptions

    Settings

    Member Visibility
    +IRunOptions | docx

    Type Alias IRunOptions

    IRunOptions: {
        break?: number;
        children?: readonly (
            | Begin
            | FieldInstruction
            | Separate
            | End
            | typeof PageNumber[keyof typeof PageNumber]
            | FootnoteReferenceRun
            | Break
            | AnnotationReference
            | CarriageReturn
            | ContinuationSeparator
            | DayLong
            | DayShort
            | EndnoteReference
            | FootnoteReferenceElement
            | LastRenderedPageBreak
            | MonthLong
            | MonthShort
            | NoBreakHyphen
            | PageNumberElement
            | Separator
            | SoftHyphen
            | Tab
            | YearLong
            | YearShort
            | PositionalTab
            | string
        )[];
        text?: string;
    } & IRunPropertiesOptions

    Settings

    Member Visibility
    diff --git a/api/types/IRunPropertiesChangeOptions.html b/api/types/IRunPropertiesChangeOptions.html index 0690d6ff23..3b1d9badbb 100644 --- a/api/types/IRunPropertiesChangeOptions.html +++ b/api/types/IRunPropertiesChangeOptions.html @@ -1 +1 @@ -IRunPropertiesChangeOptions | docx

    Type Alias IRunPropertiesChangeOptions

    IRunPropertiesChangeOptions: {} & IRunPropertiesOptions & IChangedAttributesProperties

    Settings

    Member Visibility
    +IRunPropertiesChangeOptions | docx

    Type Alias IRunPropertiesChangeOptions

    IRunPropertiesChangeOptions: {} & IRunPropertiesOptions & IChangedAttributesProperties

    Settings

    Member Visibility
    diff --git a/api/types/IRunPropertiesOptions.html b/api/types/IRunPropertiesOptions.html index ee7eb0c074..c44152faa1 100644 --- a/api/types/IRunPropertiesOptions.html +++ b/api/types/IRunPropertiesOptions.html @@ -1 +1 @@ -IRunPropertiesOptions | docx

    Type Alias IRunPropertiesOptions

    IRunPropertiesOptions: { style?: string } & IRunStylePropertiesOptions

    Settings

    Member Visibility
    +IRunPropertiesOptions | docx

    Type Alias IRunPropertiesOptions

    IRunPropertiesOptions: { style?: string } & IRunStylePropertiesOptions

    Settings

    Member Visibility
    diff --git a/api/types/IRunStylePropertiesOptions.html b/api/types/IRunStylePropertiesOptions.html index b05f66d063..c3c79237b1 100644 --- a/api/types/IRunStylePropertiesOptions.html +++ b/api/types/IRunStylePropertiesOptions.html @@ -1 +1 @@ -IRunStylePropertiesOptions | docx

    Type Alias IRunStylePropertiesOptions

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

    Type declaration

    • Optional ReadonlyallCaps?: boolean
    • Optional Readonlybold?: boolean
    • Optional ReadonlyboldComplexScript?: boolean
    • Optional Readonlyborder?: IBorderOptions
    • Optional ReadonlycharacterSpacing?: number
    • Optional Readonlycolor?: string
    • Optional ReadonlydoubleStrike?: boolean
    • Optional Readonlyeffect?: typeof TextEffect[keyof typeof TextEffect]
    • Optional Readonlyemboss?: boolean
    • Optional ReadonlyemphasisMark?: { type?: typeof EmphasisMarkType[keyof typeof EmphasisMarkType] }
    • Optional Readonlyfont?: string | IFontOptions | IFontAttributesProperties
    • Optional Readonlyhighlight?: typeof HighlightColor[keyof typeof HighlightColor]
    • Optional ReadonlyhighlightComplexScript?: boolean | string
    • Optional Readonlyimprint?: boolean
    • Optional Readonlyitalics?: boolean
    • Optional ReadonlyitalicsComplexScript?: boolean
    • Optional Readonlykern?: number | PositiveUniversalMeasure
    • Optional Readonlylanguage?: ILanguageOptions
    • Optional Readonlymath?: boolean
    • Optional ReadonlynoProof?: boolean
    • Optional Readonlyposition?: UniversalMeasure
    • Optional Readonlyrevision?: IRunPropertiesChangeOptions
    • Optional ReadonlyrightToLeft?: boolean
    • Optional Readonlyscale?: number
    • Optional Readonlyshading?: IShadingAttributesProperties
    • Optional Readonlysize?: number | PositiveUniversalMeasure
    • Optional ReadonlysizeComplexScript?: boolean | number | PositiveUniversalMeasure
    • Optional ReadonlysmallCaps?: boolean
    • Optional ReadonlysnapToGrid?: boolean
    • Optional ReadonlyspecVanish?: boolean
    • Optional Readonlystrike?: boolean
    • Optional ReadonlysubScript?: boolean
    • Optional ReadonlysuperScript?: boolean
    • Optional Readonlyunderline?: { color?: string; type?: typeof UnderlineType[keyof typeof UnderlineType] }
    • Optional Readonlyvanish?: boolean

    Settings

    Member Visibility
    +IRunStylePropertiesOptions | docx

    Type Alias IRunStylePropertiesOptions

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

    Type declaration

    • Optional ReadonlyallCaps?: boolean
    • Optional Readonlybold?: boolean
    • Optional ReadonlyboldComplexScript?: boolean
    • Optional Readonlyborder?: IBorderOptions
    • Optional ReadonlycharacterSpacing?: number
    • Optional Readonlycolor?: string
    • Optional ReadonlydoubleStrike?: boolean
    • Optional Readonlyeffect?: typeof TextEffect[keyof typeof TextEffect]
    • Optional Readonlyemboss?: boolean
    • Optional ReadonlyemphasisMark?: { type?: typeof EmphasisMarkType[keyof typeof EmphasisMarkType] }
    • Optional Readonlyfont?: string | IFontOptions | IFontAttributesProperties
    • Optional Readonlyhighlight?: typeof HighlightColor[keyof typeof HighlightColor]
    • Optional ReadonlyhighlightComplexScript?: boolean | string
    • Optional Readonlyimprint?: boolean
    • Optional Readonlyitalics?: boolean
    • Optional ReadonlyitalicsComplexScript?: boolean
    • Optional Readonlykern?: number | PositiveUniversalMeasure
    • Optional Readonlylanguage?: ILanguageOptions
    • Optional Readonlymath?: boolean
    • Optional ReadonlynoProof?: boolean
    • Optional Readonlyposition?: UniversalMeasure
    • Optional Readonlyrevision?: IRunPropertiesChangeOptions
    • Optional ReadonlyrightToLeft?: boolean
    • Optional Readonlyscale?: number
    • Optional Readonlyshading?: IShadingAttributesProperties
    • Optional Readonlysize?: number | PositiveUniversalMeasure
    • Optional ReadonlysizeComplexScript?: boolean | number | PositiveUniversalMeasure
    • Optional ReadonlysmallCaps?: boolean
    • Optional ReadonlysnapToGrid?: boolean
    • Optional ReadonlyspecVanish?: boolean
    • Optional Readonlystrike?: boolean
    • Optional ReadonlysubScript?: boolean
    • Optional ReadonlysuperScript?: boolean
    • Optional Readonlyunderline?: { color?: string; type?: typeof UnderlineType[keyof typeof UnderlineType] }
    • Optional Readonlyvanish?: boolean

    Settings

    Member Visibility
    diff --git a/api/types/ISectionOptions.html b/api/types/ISectionOptions.html index f0a3b37e4f..6385682117 100644 --- a/api/types/ISectionOptions.html +++ b/api/types/ISectionOptions.html @@ -1 +1 @@ -ISectionOptions | docx

    Type Alias ISectionOptions

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

    Type declaration

    Settings

    Member Visibility
    +ISectionOptions | docx

    Type Alias ISectionOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ISectionPropertiesOptions.html b/api/types/ISectionPropertiesOptions.html index b2d3992392..938f77d79a 100644 --- a/api/types/ISectionPropertiesOptions.html +++ b/api/types/ISectionPropertiesOptions.html @@ -1 +1 @@ -ISectionPropertiesOptions | docx

    Type Alias ISectionPropertiesOptions

    ISectionPropertiesOptions: {
        column?: IColumnsAttributes;
        footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
        grid?: IDocGridAttributesProperties;
        headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
        lineNumbers?: ILineNumberAttributes;
        page?: {
            borders?: IPageBordersOptions;
            margin?: IPageMarginAttributes;
            pageNumbers?: IPageNumberTypeAttributes;
            size?: IPageSizeAttributes;
            textDirection?: typeof PageTextDirectionType[keyof typeof PageTextDirectionType];
        };
        titlePage?: boolean;
        type?: typeof SectionType[keyof typeof SectionType];
        verticalAlign?: typeof VerticalAlign[keyof typeof VerticalAlign];
    }

    Type declaration

    Settings

    Member Visibility
    +ISectionPropertiesOptions | docx

    Type Alias ISectionPropertiesOptions

    ISectionPropertiesOptions: {
        column?: IColumnsAttributes;
        footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>;
        grid?: IDocGridAttributesProperties;
        headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
        lineNumbers?: ILineNumberAttributes;
        page?: {
            borders?: IPageBordersOptions;
            margin?: IPageMarginAttributes;
            pageNumbers?: IPageNumberTypeAttributes;
            size?: IPageSizeAttributes;
            textDirection?: typeof PageTextDirectionType[keyof typeof PageTextDirectionType];
        };
        titlePage?: boolean;
        type?: typeof SectionType[keyof typeof SectionType];
        verticalAlign?: typeof VerticalAlign[keyof typeof VerticalAlign];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IShadingAttributesProperties.html b/api/types/IShadingAttributesProperties.html index 3bbd6aaaec..7ebd62abe4 100644 --- a/api/types/IShadingAttributesProperties.html +++ b/api/types/IShadingAttributesProperties.html @@ -1 +1 @@ -IShadingAttributesProperties | docx

    Type Alias IShadingAttributesProperties

    IShadingAttributesProperties: {
        color?: string;
        fill?: string;
        type?: typeof ShadingType[keyof typeof ShadingType];
    }

    Type declaration

    • Optional Readonlycolor?: string
    • Optional Readonlyfill?: string
    • Optional Readonlytype?: typeof ShadingType[keyof typeof ShadingType]

    Settings

    Member Visibility
    +IShadingAttributesProperties | docx

    Type Alias IShadingAttributesProperties

    IShadingAttributesProperties: {
        color?: string;
        fill?: string;
        type?: typeof ShadingType[keyof typeof ShadingType];
    }

    Type declaration

    • Optional Readonlycolor?: string
    • Optional Readonlyfill?: string
    • Optional Readonlytype?: typeof ShadingType[keyof typeof ShadingType]

    Settings

    Member Visibility
    diff --git a/api/types/ISpacingProperties.html b/api/types/ISpacingProperties.html index 50da62ed03..02cf1dd11f 100644 --- a/api/types/ISpacingProperties.html +++ b/api/types/ISpacingProperties.html @@ -1 +1 @@ -ISpacingProperties | docx

    Type Alias ISpacingProperties

    ISpacingProperties: {
        after?: number;
        afterAutoSpacing?: boolean;
        before?: number;
        beforeAutoSpacing?: boolean;
        line?: number;
        lineRule?: typeof LineRuleType[keyof typeof LineRuleType];
    }

    Type declaration

    • Optional Readonlyafter?: number
    • Optional ReadonlyafterAutoSpacing?: boolean
    • Optional Readonlybefore?: number
    • Optional ReadonlybeforeAutoSpacing?: boolean
    • Optional Readonlyline?: number
    • Optional ReadonlylineRule?: typeof LineRuleType[keyof typeof LineRuleType]

    Settings

    Member Visibility
    +ISpacingProperties | docx

    Type Alias ISpacingProperties

    ISpacingProperties: {
        after?: number;
        afterAutoSpacing?: boolean;
        before?: number;
        beforeAutoSpacing?: boolean;
        line?: number;
        lineRule?: typeof LineRuleType[keyof typeof LineRuleType];
    }

    Type declaration

    • Optional Readonlyafter?: number
    • Optional ReadonlyafterAutoSpacing?: boolean
    • Optional Readonlybefore?: number
    • Optional ReadonlybeforeAutoSpacing?: boolean
    • Optional Readonlyline?: number
    • Optional ReadonlylineRule?: typeof LineRuleType[keyof typeof LineRuleType]

    Settings

    Member Visibility
    diff --git a/api/types/IStylesOptions.html b/api/types/IStylesOptions.html index 83a2d21b4e..4d7165aac8 100644 --- a/api/types/IStylesOptions.html +++ b/api/types/IStylesOptions.html @@ -1 +1 @@ -IStylesOptions | docx

    Type Alias IStylesOptions

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

    Type declaration

    Settings

    Member Visibility
    +IStylesOptions | docx

    Type Alias IStylesOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ISymbolRunOptions.html b/api/types/ISymbolRunOptions.html index 1dcf7904ac..90c29fba0a 100644 --- a/api/types/ISymbolRunOptions.html +++ b/api/types/ISymbolRunOptions.html @@ -1 +1 @@ -ISymbolRunOptions | docx

    Type Alias ISymbolRunOptions

    ISymbolRunOptions: { char: string; symbolfont?: string } & IRunOptions

    Settings

    Member Visibility
    +ISymbolRunOptions | docx

    Type Alias ISymbolRunOptions

    ISymbolRunOptions: { char: string; symbolfont?: string } & IRunOptions

    Settings

    Member Visibility
    diff --git a/api/types/ITableBordersOptions.html b/api/types/ITableBordersOptions.html index fb2d689a0b..8a2f3049df 100644 --- a/api/types/ITableBordersOptions.html +++ b/api/types/ITableBordersOptions.html @@ -1 +1 @@ -ITableBordersOptions | docx

    Type Alias ITableBordersOptions

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

    Type declaration

    Settings

    Member Visibility
    +ITableBordersOptions | docx

    Type Alias ITableBordersOptions

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ITableCellBorders.html b/api/types/ITableCellBorders.html index 9dfb1a47d3..6d790fd907 100644 --- a/api/types/ITableCellBorders.html +++ b/api/types/ITableCellBorders.html @@ -1 +1 @@ -ITableCellBorders | docx

    Type Alias ITableCellBorders

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

    Type declaration

    Settings

    Member Visibility
    +ITableCellBorders | docx

    Type Alias ITableCellBorders

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

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ITableCellOptions.html b/api/types/ITableCellOptions.html index bdc18f34c1..6f48534be6 100644 --- a/api/types/ITableCellOptions.html +++ b/api/types/ITableCellOptions.html @@ -1 +1 @@ -ITableCellOptions | docx

    Type Alias ITableCellOptions

    ITableCellOptions: { children: readonly (Paragraph | Table)[] } & ITableCellPropertiesOptions

    Settings

    Member Visibility
    +ITableCellOptions | docx

    Type Alias ITableCellOptions

    ITableCellOptions: { children: readonly (Paragraph | Table)[] } & ITableCellPropertiesOptions

    Settings

    Member Visibility
    diff --git a/api/types/ITableFloatOptions.html b/api/types/ITableFloatOptions.html index db48bcf780..0c4e9d1c90 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/ITableOfContentsOptions.html b/api/types/ITableOfContentsOptions.html index 75140dedeb..f8a52b7886 100644 --- a/api/types/ITableOfContentsOptions.html +++ b/api/types/ITableOfContentsOptions.html @@ -42,4 +42,4 @@ by text in this switch's field-argument as a range having the form startLevel-en 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?: boolean

    \u Uses the applied paragraph outline level.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/types/ITableOptions.html b/api/types/ITableOptions.html index 054ee3cf4b..c0f512b336 100644 --- a/api/types/ITableOptions.html +++ b/api/types/ITableOptions.html @@ -1 +1 @@ -ITableOptions | docx

    Type Alias ITableOptions

    ITableOptions: {
        alignment?: typeof AlignmentType[keyof typeof AlignmentType];
        borders?: ITableBordersOptions;
        columnWidths?: readonly number[];
        float?: ITableFloatOptions;
        indent?: ITableWidthProperties;
        layout?: typeof TableLayoutType[keyof typeof TableLayoutType];
        margins?: ITableCellMarginOptions;
        rows: readonly TableRow[];
        style?: string;
        visuallyRightToLeft?: boolean;
        width?: ITableWidthProperties;
    }

    Type declaration

    Settings

    Member Visibility
    +ITableOptions | docx

    Type Alias ITableOptions

    ITableOptions: {
        alignment?: typeof AlignmentType[keyof typeof AlignmentType];
        borders?: ITableBordersOptions;
        columnWidths?: readonly number[];
        float?: ITableFloatOptions;
        indent?: ITableWidthProperties;
        layout?: typeof TableLayoutType[keyof typeof TableLayoutType];
        margins?: ITableCellMarginOptions;
        rows: readonly TableRow[];
        style?: string;
        visuallyRightToLeft?: boolean;
        width?: ITableWidthProperties;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ITablePropertiesOptions.html b/api/types/ITablePropertiesOptions.html index 429e9b185b..d5c1fb9306 100644 --- a/api/types/ITablePropertiesOptions.html +++ b/api/types/ITablePropertiesOptions.html @@ -1 +1 @@ -ITablePropertiesOptions | docx

    Type Alias ITablePropertiesOptions

    ITablePropertiesOptions: {
        alignment?: typeof AlignmentType[keyof typeof AlignmentType];
        borders?: ITableBordersOptions;
        cellMargin?: ITableCellMarginOptions;
        float?: ITableFloatOptions;
        indent?: ITableWidthProperties;
        layout?: typeof TableLayoutType[keyof typeof TableLayoutType];
        shading?: IShadingAttributesProperties;
        style?: string;
        visuallyRightToLeft?: boolean;
        width?: ITableWidthProperties;
    }

    Type declaration

    Settings

    Member Visibility
    +ITablePropertiesOptions | docx

    Type Alias ITablePropertiesOptions

    ITablePropertiesOptions: {
        alignment?: typeof AlignmentType[keyof typeof AlignmentType];
        borders?: ITableBordersOptions;
        cellMargin?: ITableCellMarginOptions;
        float?: ITableFloatOptions;
        indent?: ITableWidthProperties;
        layout?: typeof TableLayoutType[keyof typeof TableLayoutType];
        shading?: IShadingAttributesProperties;
        style?: string;
        visuallyRightToLeft?: boolean;
        width?: ITableWidthProperties;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ITableRowOptions.html b/api/types/ITableRowOptions.html index ca6aa46477..1918e25fd6 100644 --- a/api/types/ITableRowOptions.html +++ b/api/types/ITableRowOptions.html @@ -1 +1 @@ -ITableRowOptions | docx

    Type Alias ITableRowOptions

    ITableRowOptions: { children: readonly TableCell[] } & ITableRowPropertiesOptions

    Settings

    Member Visibility
    +ITableRowOptions | docx

    Type Alias ITableRowOptions

    ITableRowOptions: { children: readonly TableCell[] } & ITableRowPropertiesOptions

    Settings

    Member Visibility
    diff --git a/api/types/ITableRowPropertiesOptions.html b/api/types/ITableRowPropertiesOptions.html index 82c6e61f71..4381e854b5 100644 --- a/api/types/ITableRowPropertiesOptions.html +++ b/api/types/ITableRowPropertiesOptions.html @@ -1 +1 @@ -ITableRowPropertiesOptions | docx

    Type Alias ITableRowPropertiesOptions

    ITableRowPropertiesOptions: {
        cantSplit?: boolean;
        height?: {
            rule: typeof HeightRule[keyof typeof HeightRule];
            value: number | PositiveUniversalMeasure;
        };
        tableHeader?: boolean;
    }

    Type declaration

    Settings

    Member Visibility
    +ITableRowPropertiesOptions | docx

    Type Alias ITableRowPropertiesOptions

    ITableRowPropertiesOptions: {
        cantSplit?: boolean;
        height?: {
            rule: typeof HeightRule[keyof typeof HeightRule];
            value: number | PositiveUniversalMeasure;
        };
        tableHeader?: boolean;
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ITableWidthProperties.html b/api/types/ITableWidthProperties.html index 60643e05af..bd03fd804d 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];
    }

    Type declaration

    Settings

    Member Visibility
    +ITableWidthProperties | docx

    Type Alias ITableWidthProperties

    ITableWidthProperties: {
        size: number | Percentage | UniversalMeasure;
        type?: typeof WidthType[keyof typeof WidthType];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/ITextWrapping.html b/api/types/ITextWrapping.html index 7d8fd6a5d4..b2ab16c632 100644 --- a/api/types/ITextWrapping.html +++ b/api/types/ITextWrapping.html @@ -1 +1 @@ -ITextWrapping | docx

    Type Alias ITextWrapping

    ITextWrapping: {
        margins?: IDistance;
        side?: typeof TextWrappingSide[keyof typeof TextWrappingSide];
        type: typeof TextWrappingType[keyof typeof TextWrappingType];
    }

    Type declaration

    Settings

    Member Visibility
    +ITextWrapping | docx

    Type Alias ITextWrapping

    ITextWrapping: {
        margins?: IDistance;
        side?: typeof TextWrappingSide[keyof typeof TextWrappingSide];
        type: typeof TextWrappingType[keyof typeof TextWrappingType];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IVerticalPositionOptions.html b/api/types/IVerticalPositionOptions.html index ca5758e019..bccf59c305 100644 --- a/api/types/IVerticalPositionOptions.html +++ b/api/types/IVerticalPositionOptions.html @@ -1 +1 @@ -IVerticalPositionOptions | docx

    Type Alias IVerticalPositionOptions

    IVerticalPositionOptions: {
        align?: typeof VerticalPositionAlign[keyof typeof VerticalPositionAlign];
        offset?: number;
        relative?: typeof VerticalPositionRelativeFrom[keyof typeof VerticalPositionRelativeFrom];
    }

    Type declaration

    Settings

    Member Visibility
    +IVerticalPositionOptions | docx

    Type Alias IVerticalPositionOptions

    IVerticalPositionOptions: {
        align?: typeof VerticalPositionAlign[keyof typeof VerticalPositionAlign];
        offset?: number;
        relative?: typeof VerticalPositionRelativeFrom[keyof typeof VerticalPositionRelativeFrom];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/IXYFrameOptions.html b/api/types/IXYFrameOptions.html index 066cddd5a8..ec6ebfdae1 100644 --- a/api/types/IXYFrameOptions.html +++ b/api/types/IXYFrameOptions.html @@ -1 +1 @@ -IXYFrameOptions | docx

    Type Alias IXYFrameOptions

    IXYFrameOptions: { position: { x: number; y: number }; type: "absolute" } & IBaseFrameOptions

    Settings

    Member Visibility
    +IXYFrameOptions | docx

    Type Alias IXYFrameOptions

    IXYFrameOptions: { position: { x: number; y: number }; type: "absolute" } & IBaseFrameOptions

    Settings

    Member Visibility
    diff --git a/api/types/IXmlAttribute.html b/api/types/IXmlAttribute.html index 28ee195590..57aedd375e 100644 --- a/api/types/IXmlAttribute.html +++ b/api/types/IXmlAttribute.html @@ -1 +1 @@ -IXmlAttribute | docx

    Type Alias IXmlAttribute

    IXmlAttribute: Readonly<Record<string, string | number | boolean>>

    Settings

    Member Visibility
    +IXmlAttribute | docx

    Type Alias IXmlAttribute

    IXmlAttribute: Readonly<Record<string, string | number | boolean>>

    Settings

    Member Visibility
    diff --git a/api/types/InputDataType.html b/api/types/InputDataType.html index 8949754695..006951b560 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 5c66b6d12d..03f8c38344 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 443b3602f2..88a011d9f1 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 7416061eb1..86a56a7130 100644 --- a/api/types/PatchDocumentOptions.html +++ b/api/types/PatchDocumentOptions.html @@ -1 +1 @@ -PatchDocumentOptions | docx

    Type Alias PatchDocumentOptions<T>

    PatchDocumentOptions: {
        data: InputDataType;
        keepOriginalStyles?: boolean;
        outputType: T;
        patches: Readonly<Record<string, IPatch>>;
    }

    Type Parameters

    Type declaration

    • Readonlydata: InputDataType
    • Optional ReadonlykeepOriginalStyles?: boolean
    • ReadonlyoutputType: T
    • Readonlypatches: Readonly<Record<string, IPatch>>

    Settings

    Member Visibility
    +PatchDocumentOptions | docx

    Type Alias PatchDocumentOptions<T>

    PatchDocumentOptions: {
        data: InputDataType;
        keepOriginalStyles?: boolean;
        outputType: T;
        patches: Readonly<Record<string, IPatch>>;
    }

    Type Parameters

    Type declaration

    • Readonlydata: InputDataType
    • Optional ReadonlykeepOriginalStyles?: boolean
    • ReadonlyoutputType: T
    • Readonlypatches: Readonly<Record<string, IPatch>>

    Settings

    Member Visibility
    diff --git a/api/types/PatchDocumentOutputType.html b/api/types/PatchDocumentOutputType.html index 4858a4235f..53b1a645ed 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 8c5a4095a5..b05a915204 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/PositionalTabOptions.html b/api/types/PositionalTabOptions.html index 0b9b7bbc46..e627801222 100644 --- a/api/types/PositionalTabOptions.html +++ b/api/types/PositionalTabOptions.html @@ -1 +1 @@ -PositionalTabOptions | docx

    Type Alias PositionalTabOptions

    PositionalTabOptions: {
        alignment: typeof PositionalTabAlignment[keyof typeof PositionalTabAlignment];
        leader: typeof PositionalTabLeader[keyof typeof PositionalTabLeader];
        relativeTo: typeof PositionalTabRelativeTo[keyof typeof PositionalTabRelativeTo];
    }

    Type declaration

    Settings

    Member Visibility
    +PositionalTabOptions | docx

    Type Alias PositionalTabOptions

    PositionalTabOptions: {
        alignment: typeof PositionalTabAlignment[keyof typeof PositionalTabAlignment];
        leader: typeof PositionalTabLeader[keyof typeof PositionalTabLeader];
        relativeTo: typeof PositionalTabRelativeTo[keyof typeof PositionalTabRelativeTo];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/PositivePercentage.html b/api/types/PositivePercentage.html index 767f9ca756..a07bb2e150 100644 --- a/api/types/PositivePercentage.html +++ b/api/types/PositivePercentage.html @@ -1 +1 @@ -PositivePercentage | docx

    Type Alias PositivePercentage

    PositivePercentage: `${number}%`

    Settings

    Member Visibility
    +PositivePercentage | docx

    Type Alias PositivePercentage

    PositivePercentage: `${number}%`

    Settings

    Member Visibility
    diff --git a/api/types/PositiveUniversalMeasure.html b/api/types/PositiveUniversalMeasure.html index 074f38bbe0..f101111fa1 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/RelativeMeasure.html b/api/types/RelativeMeasure.html index bc6f313625..8e0456b798 100644 --- a/api/types/RelativeMeasure.html +++ b/api/types/RelativeMeasure.html @@ -1 +1 @@ -RelativeMeasure | docx

    Type Alias RelativeMeasure

    RelativeMeasure: `${"-" | ""}${number}${"em" | "ex"}`

    Settings

    Member Visibility
    +RelativeMeasure | docx

    Type Alias RelativeMeasure

    RelativeMeasure: `${"-" | ""}${number}${"em" | "ex"}`

    Settings

    Member Visibility
    diff --git a/api/types/TabStopDefinition.html b/api/types/TabStopDefinition.html index 27ec231736..01572dc02b 100644 --- a/api/types/TabStopDefinition.html +++ b/api/types/TabStopDefinition.html @@ -1 +1 @@ -TabStopDefinition | docx

    Type Alias TabStopDefinition

    TabStopDefinition: {
        leader?: typeof LeaderType[keyof typeof LeaderType];
        position: number | typeof TabStopPosition[keyof typeof TabStopPosition];
        type: typeof TabStopType[keyof typeof TabStopType];
    }

    Type declaration

    Settings

    Member Visibility
    +TabStopDefinition | docx

    Type Alias TabStopDefinition

    TabStopDefinition: {
        leader?: typeof LeaderType[keyof typeof LeaderType];
        position: number | typeof TabStopPosition[keyof typeof TabStopPosition];
        type: typeof TabStopType[keyof typeof TabStopType];
    }

    Type declaration

    Settings

    Member Visibility
    diff --git a/api/types/UniqueNumericIdCreator.html b/api/types/UniqueNumericIdCreator.html index c6880d2697..873e838f58 100644 --- a/api/types/UniqueNumericIdCreator.html +++ b/api/types/UniqueNumericIdCreator.html @@ -1 +1 @@ -UniqueNumericIdCreator | docx

    Type Alias UniqueNumericIdCreator

    UniqueNumericIdCreator: () => number

    Type declaration

      • (): number

      • Returns number

    Settings

    Member Visibility
    +UniqueNumericIdCreator | docx

    Type Alias UniqueNumericIdCreator

    UniqueNumericIdCreator: () => number

    Type declaration

      • (): number

      • Returns number

    Settings

    Member Visibility
    diff --git a/api/types/UniversalMeasure.html b/api/types/UniversalMeasure.html index 398dcb63ec..dcec13786d 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 804c26c8b1..03bc975513 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 6ba4ac03f5..89809c4a07 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";
    } = ...

    Type declaration

    • ReadonlyDASH_DOT_STROKED: "dashDotStroked"
    • ReadonlyDASH_SMALL_GAP: "dashSmallGap"
    • ReadonlyDASHED: "dashed"
    • ReadonlyDOT_DASH: "dotDash"
    • ReadonlyDOT_DOT_DASH: "dotDotDash"
    • ReadonlyDOTTED: "dotted"
    • ReadonlyDOUBLE: "double"
    • ReadonlyDOUBLE_WAVE: "doubleWave"
    • ReadonlyINSET: "inset"
    • ReadonlyNIL: "nil"
    • ReadonlyNONE: "none"
    • ReadonlyOUTSET: "outset"
    • ReadonlySINGLE: "single"
    • ReadonlyTHICK: "thick"
    • ReadonlyTHICK_THIN_LARGE_GAP: "thickThinLargeGap"
    • ReadonlyTHICK_THIN_MEDIUM_GAP: "thickThinMediumGap"
    • ReadonlyTHICK_THIN_SMALL_GAP: "thickThinSmallGap"
    • ReadonlyTHIN_THICK_LARGE_GAP: "thinThickLargeGap"
    • ReadonlyTHIN_THICK_MEDIUM_GAP: "thinThickMediumGap"
    • ReadonlyTHIN_THICK_SMALL_GAP: "thinThickSmallGap"
    • ReadonlyTHIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap"
    • ReadonlyTHIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap"
    • ReadonlyTHIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap"
    • ReadonlyTHREE_D_EMBOSS: "threeDEmboss"
    • ReadonlyTHREE_D_ENGRAVE: "threeDEngrave"
    • ReadonlyTRIPLE: "triple"
    • ReadonlyWAVE: "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";
    } = ...

    Type declaration

    • ReadonlyDASH_DOT_STROKED: "dashDotStroked"
    • ReadonlyDASH_SMALL_GAP: "dashSmallGap"
    • ReadonlyDASHED: "dashed"
    • ReadonlyDOT_DASH: "dotDash"
    • ReadonlyDOT_DOT_DASH: "dotDotDash"
    • ReadonlyDOTTED: "dotted"
    • ReadonlyDOUBLE: "double"
    • ReadonlyDOUBLE_WAVE: "doubleWave"
    • ReadonlyINSET: "inset"
    • ReadonlyNIL: "nil"
    • ReadonlyNONE: "none"
    • ReadonlyOUTSET: "outset"
    • ReadonlySINGLE: "single"
    • ReadonlyTHICK: "thick"
    • ReadonlyTHICK_THIN_LARGE_GAP: "thickThinLargeGap"
    • ReadonlyTHICK_THIN_MEDIUM_GAP: "thickThinMediumGap"
    • ReadonlyTHICK_THIN_SMALL_GAP: "thickThinSmallGap"
    • ReadonlyTHIN_THICK_LARGE_GAP: "thinThickLargeGap"
    • ReadonlyTHIN_THICK_MEDIUM_GAP: "thinThickMediumGap"
    • ReadonlyTHIN_THICK_SMALL_GAP: "thinThickSmallGap"
    • ReadonlyTHIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap"
    • ReadonlyTHIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap"
    • ReadonlyTHIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap"
    • ReadonlyTHREE_D_EMBOSS: "threeDEmboss"
    • ReadonlyTHREE_D_ENGRAVE: "threeDEngrave"
    • ReadonlyTRIPLE: "triple"
    • ReadonlyWAVE: "wave"

    Settings

    Member Visibility
    diff --git a/api/variables/CharacterSet.html b/api/variables/CharacterSet.html index 42619a9a7e..f3304d6f7c 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";
    } = ...

    Type declaration

    • ReadonlyANSI: "00"
    • ReadonlyARABIC: "B2"
    • ReadonlyBALTIC: "BA"
    • ReadonlyCHINESEBIG5: "88"
    • ReadonlyDEFAULT: "01"
    • ReadonlyEASTEUROPE: "EE"
    • ReadonlyGB_2312: "86"
    • ReadonlyGREEK: "A1"
    • ReadonlyHANGUL: "81"
    • ReadonlyHEBREW: "B1"
    • ReadonlyJIS: "80"
    • ReadonlyJOHAB: "82"
    • ReadonlyMAC: "4D"
    • ReadonlyOEM: "FF"
    • ReadonlyRUSSIAN: "CC"
    • ReadonlySYMBOL: "02"
    • ReadonlyTHAI: "DE"
    • ReadonlyTURKISH: "A2"
    • ReadonlyVIETNAMESE: "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";
    } = ...

    Type declaration

    • ReadonlyANSI: "00"
    • ReadonlyARABIC: "B2"
    • ReadonlyBALTIC: "BA"
    • ReadonlyCHINESEBIG5: "88"
    • ReadonlyDEFAULT: "01"
    • ReadonlyEASTEUROPE: "EE"
    • ReadonlyGB_2312: "86"
    • ReadonlyGREEK: "A1"
    • ReadonlyHANGUL: "81"
    • ReadonlyHEBREW: "B1"
    • ReadonlyJIS: "80"
    • ReadonlyJOHAB: "82"
    • ReadonlyMAC: "4D"
    • ReadonlyOEM: "FF"
    • ReadonlyRUSSIAN: "CC"
    • ReadonlySYMBOL: "02"
    • ReadonlyTHAI: "DE"
    • ReadonlyTURKISH: "A2"
    • ReadonlyVIETNAMESE: "A3"

    Settings

    Member Visibility
    diff --git a/api/variables/DocumentAttributeNamespaces.html b/api/variables/DocumentAttributeNamespaces.html index 42a5859264..ee557b6854 100644 --- a/api/variables/DocumentAttributeNamespaces.html +++ b/api/variables/DocumentAttributeNamespaces.html @@ -1 +1 @@ -DocumentAttributeNamespaces | docx

    Variable DocumentAttributeNamespacesConst

    DocumentAttributeNamespaces: {
        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;
        m: string;
        mc: string;
        o: string;
        r: 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;
    } = ...

    Type declaration

    • 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
    • m: string
    • mc: string
    • o: string
    • r: 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

    Settings

    Member Visibility
    +DocumentAttributeNamespaces | docx

    Variable DocumentAttributeNamespacesConst

    DocumentAttributeNamespaces: {
        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;
        m: string;
        mc: string;
        o: string;
        r: 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;
    } = ...

    Type declaration

    • 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
    • m: string
    • mc: string
    • o: string
    • r: 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

    Settings

    Member Visibility
    diff --git a/api/variables/DocumentGridType.html b/api/variables/DocumentGridType.html index 27ad38715b..35f9b9d503 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";
    } = ...

    Type declaration

    • ReadonlyDEFAULT: "default"
    • ReadonlyLINES: "lines"
    • ReadonlyLINES_AND_CHARS: "linesAndChars"
    • ReadonlySNAP_TO_CHARS: "snapToChars"

    Settings

    Member Visibility
    +DocumentGridType | docx

    Variable DocumentGridTypeConst

    DocumentGridType: {
        DEFAULT: "default";
        LINES: "lines";
        LINES_AND_CHARS: "linesAndChars";
        SNAP_TO_CHARS: "snapToChars";
    } = ...

    Type declaration

    • ReadonlyDEFAULT: "default"
    • ReadonlyLINES: "lines"
    • ReadonlyLINES_AND_CHARS: "linesAndChars"
    • ReadonlySNAP_TO_CHARS: "snapToChars"

    Settings

    Member Visibility
    diff --git a/api/variables/DropCapType.html b/api/variables/DropCapType.html index b86ca6edfc..a35c80bc12 100644 --- a/api/variables/DropCapType.html +++ b/api/variables/DropCapType.html @@ -1 +1 @@ -DropCapType | docx

    Variable DropCapTypeConst

    DropCapType: { DROP: "drop"; MARGIN: "margin"; NONE: "none" } = ...

    Type declaration

    • ReadonlyDROP: "drop"
    • ReadonlyMARGIN: "margin"
    • ReadonlyNONE: "none"

    Settings

    Member Visibility
    +DropCapType | docx

    Variable DropCapTypeConst

    DropCapType: { DROP: "drop"; MARGIN: "margin"; NONE: "none" } = ...

    Type declaration

    • ReadonlyDROP: "drop"
    • ReadonlyMARGIN: "margin"
    • ReadonlyNONE: "none"

    Settings

    Member Visibility
    diff --git a/api/variables/EMPTY_OBJECT.html b/api/variables/EMPTY_OBJECT.html index 84aa0d1f2a..4e56006eca 100644 --- a/api/variables/EMPTY_OBJECT.html +++ b/api/variables/EMPTY_OBJECT.html @@ -1 +1 @@ -EMPTY_OBJECT | docx

    Variable EMPTY_OBJECTConst

    EMPTY_OBJECT: {} = ...

    Type declaration

      Settings

      Member Visibility
      +EMPTY_OBJECT | docx

      Variable EMPTY_OBJECTConst

      EMPTY_OBJECT: {} = ...

      Type declaration

        Settings

        Member Visibility
        diff --git a/api/variables/EmphasisMarkType.html b/api/variables/EmphasisMarkType.html index 6e5fe5def7..f1a8fb2c2c 100644 --- a/api/variables/EmphasisMarkType.html +++ b/api/variables/EmphasisMarkType.html @@ -1 +1 @@ -EmphasisMarkType | docx

        Variable EmphasisMarkTypeConst

        EmphasisMarkType: { DOT: "dot" } = ...

        Type declaration

        • ReadonlyDOT: "dot"

        Settings

        Member Visibility
        +EmphasisMarkType | docx

        Variable EmphasisMarkTypeConst

        EmphasisMarkType: { DOT: "dot" } = ...

        Type declaration

        • ReadonlyDOT: "dot"

        Settings

        Member Visibility
        diff --git a/api/variables/FrameAnchorType.html b/api/variables/FrameAnchorType.html index 4493da2892..7736036915 100644 --- a/api/variables/FrameAnchorType.html +++ b/api/variables/FrameAnchorType.html @@ -1 +1 @@ -FrameAnchorType | docx

        Variable FrameAnchorTypeConst

        FrameAnchorType: { MARGIN: "margin"; PAGE: "page"; TEXT: "text" } = ...

        Type declaration

        • ReadonlyMARGIN: "margin"
        • ReadonlyPAGE: "page"
        • ReadonlyTEXT: "text"

        Settings

        Member Visibility
        +FrameAnchorType | docx

        Variable FrameAnchorTypeConst

        FrameAnchorType: { MARGIN: "margin"; PAGE: "page"; TEXT: "text" } = ...

        Type declaration

        • ReadonlyMARGIN: "margin"
        • ReadonlyPAGE: "page"
        • ReadonlyTEXT: "text"

        Settings

        Member Visibility
        diff --git a/api/variables/FrameWrap.html b/api/variables/FrameWrap.html index e25fc7239b..6d1afde3c3 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";
        } = ...

        Type declaration

        • ReadonlyAROUND: "around"
        • ReadonlyAUTO: "auto"
        • ReadonlyNONE: "none"
        • ReadonlyNOT_BESIDE: "notBeside"
        • ReadonlyTHROUGH: "through"
        • ReadonlyTIGHT: "tight"

        Settings

        Member Visibility
        +FrameWrap | docx

        Variable FrameWrapConst

        FrameWrap: {
            AROUND: "around";
            AUTO: "auto";
            NONE: "none";
            NOT_BESIDE: "notBeside";
            THROUGH: "through";
            TIGHT: "tight";
        } = ...

        Type declaration

        • ReadonlyAROUND: "around"
        • ReadonlyAUTO: "auto"
        • ReadonlyNONE: "none"
        • ReadonlyNOT_BESIDE: "notBeside"
        • ReadonlyTHROUGH: "through"
        • ReadonlyTIGHT: "tight"

        Settings

        Member Visibility
        diff --git a/api/variables/HeaderFooterReferenceType.html b/api/variables/HeaderFooterReferenceType.html index 963b66f360..9b998da886 100644 --- a/api/variables/HeaderFooterReferenceType.html +++ b/api/variables/HeaderFooterReferenceType.html @@ -1 +1 @@ -HeaderFooterReferenceType | docx

        Variable HeaderFooterReferenceTypeConst

        HeaderFooterReferenceType: { DEFAULT: "default"; EVEN: "even"; FIRST: "first" } = ...

        Type declaration

        • ReadonlyDEFAULT: "default"
        • ReadonlyEVEN: "even"
        • ReadonlyFIRST: "first"

        Settings

        Member Visibility
        +HeaderFooterReferenceType | docx

        Variable HeaderFooterReferenceTypeConst

        HeaderFooterReferenceType: { DEFAULT: "default"; EVEN: "even"; FIRST: "first" } = ...

        Type declaration

        • ReadonlyDEFAULT: "default"
        • ReadonlyEVEN: "even"
        • ReadonlyFIRST: "first"

        Settings

        Member Visibility
        diff --git a/api/variables/HeaderFooterType.html b/api/variables/HeaderFooterType.html index 9d31081aa5..01d61d3b92 100644 --- a/api/variables/HeaderFooterType.html +++ b/api/variables/HeaderFooterType.html @@ -1 +1 @@ -HeaderFooterType | docx

        Variable HeaderFooterTypeConst

        HeaderFooterType: { FOOTER: "w:footerReference"; HEADER: "w:headerReference" } = ...

        Type declaration

        • ReadonlyFOOTER: "w:footerReference"
        • ReadonlyHEADER: "w:headerReference"

        Settings

        Member Visibility
        +HeaderFooterType | docx

        Variable HeaderFooterTypeConst

        HeaderFooterType: { FOOTER: "w:footerReference"; HEADER: "w:headerReference" } = ...

        Type declaration

        • ReadonlyFOOTER: "w:footerReference"
        • ReadonlyHEADER: "w:headerReference"

        Settings

        Member Visibility
        diff --git a/api/variables/HeadingLevel.html b/api/variables/HeadingLevel.html index b7f553aab4..22a808428a 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";
        } = ...

        Type declaration

        • ReadonlyHEADING_1: "Heading1"
        • ReadonlyHEADING_2: "Heading2"
        • ReadonlyHEADING_3: "Heading3"
        • ReadonlyHEADING_4: "Heading4"
        • ReadonlyHEADING_5: "Heading5"
        • ReadonlyHEADING_6: "Heading6"
        • ReadonlyTITLE: "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";
        } = ...

        Type declaration

        • ReadonlyHEADING_1: "Heading1"
        • ReadonlyHEADING_2: "Heading2"
        • ReadonlyHEADING_3: "Heading3"
        • ReadonlyHEADING_4: "Heading4"
        • ReadonlyHEADING_5: "Heading5"
        • ReadonlyHEADING_6: "Heading6"
        • ReadonlyTITLE: "Title"

        Settings

        Member Visibility
        diff --git a/api/variables/HeightRule.html b/api/variables/HeightRule.html index e8b8c06586..e5d1a61890 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 c32b781c39..9b71947c8a 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";
        } = ...

        Type declaration

        • ReadonlyBLACK: "black"
        • ReadonlyBLUE: "blue"
        • ReadonlyCYAN: "cyan"
        • ReadonlyDARK_BLUE: "darkBlue"
        • ReadonlyDARK_CYAN: "darkCyan"
        • ReadonlyDARK_GRAY: "darkGray"
        • ReadonlyDARK_GREEN: "darkGreen"
        • ReadonlyDARK_MAGENTA: "darkMagenta"
        • ReadonlyDARK_RED: "darkRed"
        • ReadonlyDARK_YELLOW: "darkYellow"
        • ReadonlyGREEN: "green"
        • ReadonlyLIGHT_GRAY: "lightGray"
        • ReadonlyMAGENTA: "magenta"
        • ReadonlyNONE: "none"
        • ReadonlyRED: "red"
        • ReadonlyWHITE: "white"
        • ReadonlyYELLOW: "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";
        } = ...

        Type declaration

        • ReadonlyBLACK: "black"
        • ReadonlyBLUE: "blue"
        • ReadonlyCYAN: "cyan"
        • ReadonlyDARK_BLUE: "darkBlue"
        • ReadonlyDARK_CYAN: "darkCyan"
        • ReadonlyDARK_GRAY: "darkGray"
        • ReadonlyDARK_GREEN: "darkGreen"
        • ReadonlyDARK_MAGENTA: "darkMagenta"
        • ReadonlyDARK_RED: "darkRed"
        • ReadonlyDARK_YELLOW: "darkYellow"
        • ReadonlyGREEN: "green"
        • ReadonlyLIGHT_GRAY: "lightGray"
        • ReadonlyMAGENTA: "magenta"
        • ReadonlyNONE: "none"
        • ReadonlyRED: "red"
        • ReadonlyWHITE: "white"
        • ReadonlyYELLOW: "yellow"

        Settings

        Member Visibility
        diff --git a/api/variables/HorizontalPositionAlign.html b/api/variables/HorizontalPositionAlign.html index a2ff947572..05670e7a9e 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";
        } = ...

        Type declaration

        • ReadonlyCENTER: "center"
        • ReadonlyINSIDE: "inside"
        • ReadonlyLEFT: "left"
        • ReadonlyOUTSIDE: "outside"
        • ReadonlyRIGHT: "right"

        Settings

        Member Visibility
        +HorizontalPositionAlign | docx

        Variable HorizontalPositionAlignConst

        HorizontalPositionAlign: {
            CENTER: "center";
            INSIDE: "inside";
            LEFT: "left";
            OUTSIDE: "outside";
            RIGHT: "right";
        } = ...

        Type declaration

        • ReadonlyCENTER: "center"
        • ReadonlyINSIDE: "inside"
        • ReadonlyLEFT: "left"
        • ReadonlyOUTSIDE: "outside"
        • ReadonlyRIGHT: "right"

        Settings

        Member Visibility
        diff --git a/api/variables/HorizontalPositionRelativeFrom.html b/api/variables/HorizontalPositionRelativeFrom.html index 41ca48c0be..26c293fad0 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";
        } = ...

        Type declaration

        • ReadonlyCHARACTER: "character"
        • ReadonlyCOLUMN: "column"
        • ReadonlyINSIDE_MARGIN: "insideMargin"
        • ReadonlyLEFT_MARGIN: "leftMargin"
        • ReadonlyMARGIN: "margin"
        • ReadonlyOUTSIDE_MARGIN: "outsideMargin"
        • ReadonlyPAGE: "page"
        • ReadonlyRIGHT_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";
        } = ...

        Type declaration

        • ReadonlyCHARACTER: "character"
        • ReadonlyCOLUMN: "column"
        • ReadonlyINSIDE_MARGIN: "insideMargin"
        • ReadonlyLEFT_MARGIN: "leftMargin"
        • ReadonlyMARGIN: "margin"
        • ReadonlyOUTSIDE_MARGIN: "outsideMargin"
        • ReadonlyPAGE: "page"
        • ReadonlyRIGHT_MARGIN: "rightMargin"

        Settings

        Member Visibility
        diff --git a/api/variables/HyperlinkType.html b/api/variables/HyperlinkType.html index 8da46ca2a6..9b0767460f 100644 --- a/api/variables/HyperlinkType.html +++ b/api/variables/HyperlinkType.html @@ -1 +1 @@ -HyperlinkType | docx

        Variable HyperlinkTypeConst

        HyperlinkType: { EXTERNAL: "EXTERNAL"; INTERNAL: "INTERNAL" } = ...

        Type declaration

        • ReadonlyEXTERNAL: "EXTERNAL"
        • ReadonlyINTERNAL: "INTERNAL"

        Settings

        Member Visibility
        +HyperlinkType | docx

        Variable HyperlinkTypeConst

        HyperlinkType: { EXTERNAL: "EXTERNAL"; INTERNAL: "INTERNAL" } = ...

        Type declaration

        • ReadonlyEXTERNAL: "EXTERNAL"
        • ReadonlyINTERNAL: "INTERNAL"

        Settings

        Member Visibility
        diff --git a/api/variables/LeaderType.html b/api/variables/LeaderType.html index 43ce74159f..fd93008990 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";
        } = ...

        Type declaration

        • ReadonlyDOT: "dot"
        • ReadonlyHYPHEN: "hyphen"
        • ReadonlyMIDDLE_DOT: "middleDot"
        • ReadonlyNONE: "none"
        • ReadonlyUNDERSCORE: "underscore"

        Settings

        Member Visibility
        +LeaderType | docx

        Variable LeaderTypeConst

        LeaderType: {
            DOT: "dot";
            HYPHEN: "hyphen";
            MIDDLE_DOT: "middleDot";
            NONE: "none";
            UNDERSCORE: "underscore";
        } = ...

        Type declaration

        • ReadonlyDOT: "dot"
        • ReadonlyHYPHEN: "hyphen"
        • ReadonlyMIDDLE_DOT: "middleDot"
        • ReadonlyNONE: "none"
        • ReadonlyUNDERSCORE: "underscore"

        Settings

        Member Visibility
        diff --git a/api/variables/LevelFormat.html b/api/variables/LevelFormat.html index a3d833c2ab..1534e03144 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";
        } = ...

        Type declaration

        • ReadonlyAIUEO: "aiueo"
        • ReadonlyAIUEO_FULL_WIDTH: "aiueoFullWidth"
        • ReadonlyARABIC_ABJAD: "arabicAbjad"
        • ReadonlyARABIC_ALPHA: "arabicAlpha"
        • ReadonlyBAHT_TEXT: "bahtText"
        • ReadonlyBULLET: "bullet"
        • ReadonlyCARDINAL_TEXT: "cardinalText"
        • ReadonlyCHICAGO: "chicago"
        • ReadonlyCHINESE_COUNTING: "chineseCounting"
        • ReadonlyCHINESE_COUNTING_THOUSAND: "chineseCountingThousand"
        • ReadonlyCHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
        • ReadonlyCHOSUNG: "chosung"
        • ReadonlyCUSTOM: "custom"
        • ReadonlyDECIMAL: "decimal"
        • ReadonlyDECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
        • ReadonlyDECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
        • ReadonlyDECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop"
        • ReadonlyDECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen"
        • ReadonlyDECIMAL_FULL_WIDTH: "decimalFullWidth"
        • ReadonlyDECIMAL_FULL_WIDTH2: "decimalFullWidth2"
        • ReadonlyDECIMAL_HALF_WIDTH: "decimalHalfWidth"
        • ReadonlyDECIMAL_ZERO: "decimalZero"
        • ReadonlyDOLLAR_TEXT: "dollarText"
        • ReadonlyGANADA: "ganada"
        • ReadonlyHEBREW1: "hebrew1"
        • ReadonlyHEBREW2: "hebrew2"
        • ReadonlyHEX: "hex"
        • ReadonlyHINDI_CONSONANTS: "hindiConsonants"
        • ReadonlyHINDI_COUNTING: "hindiCounting"
        • ReadonlyHINDI_NUMBERS: "hindiNumbers"
        • ReadonlyHINDI_VOWELS: "hindiVowels"
        • ReadonlyIDEOGRAPH__DIGITAL: "ideographDigital"
        • ReadonlyIDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
        • ReadonlyIDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
        • ReadonlyIDEOGRAPH_TRADITIONAL: "ideographTraditional"
        • ReadonlyIDEOGRAPH_ZODIAC: "ideographZodiac"
        • ReadonlyIDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
        • ReadonlyIROHA: "iroha"
        • ReadonlyIROHA_FULL_WIDTH: "irohaFullWidth"
        • ReadonlyJAPANESE_COUNTING: "japaneseCounting"
        • ReadonlyJAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
        • ReadonlyJAPANESE_LEGAL: "japaneseLegal"
        • ReadonlyKOREAN_COUNTING: "koreanCounting"
        • ReadonlyKOREAN_DIGITAL: "koreanDigital"
        • ReadonlyKOREAN_DIGITAL2: "koreanDigital2"
        • ReadonlyKOREAN_LEGAL: "koreanLegal"
        • ReadonlyLOWER_LETTER: "lowerLetter"
        • ReadonlyLOWER_ROMAN: "lowerRoman"
        • ReadonlyNONE: "none"
        • ReadonlyNUMBER_IN_DASH: "numberInDash"
        • ReadonlyORDINAL: "ordinal"
        • ReadonlyORDINAL_TEXT: "ordinalText"
        • ReadonlyRUSSIAN_LOWER: "russianLower"
        • ReadonlyRUSSIAN_UPPER: "russianUpper"
        • ReadonlyTAIWANESE_COUNTING: "taiwaneseCounting"
        • ReadonlyTAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
        • ReadonlyTAIWANESE_DIGITAL: "taiwaneseDigital"
        • ReadonlyTHAI_COUNTING: "thaiCounting"
        • ReadonlyTHAI_LETTERS: "thaiLetters"
        • ReadonlyTHAI_NUMBERS: "thaiNumbers"
        • ReadonlyUPPER_LETTER: "upperLetter"
        • ReadonlyUPPER_ROMAN: "upperRoman"
        • ReadonlyVIETNAMESE_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";
        } = ...

        Type declaration

        • ReadonlyAIUEO: "aiueo"
        • ReadonlyAIUEO_FULL_WIDTH: "aiueoFullWidth"
        • ReadonlyARABIC_ABJAD: "arabicAbjad"
        • ReadonlyARABIC_ALPHA: "arabicAlpha"
        • ReadonlyBAHT_TEXT: "bahtText"
        • ReadonlyBULLET: "bullet"
        • ReadonlyCARDINAL_TEXT: "cardinalText"
        • ReadonlyCHICAGO: "chicago"
        • ReadonlyCHINESE_COUNTING: "chineseCounting"
        • ReadonlyCHINESE_COUNTING_THOUSAND: "chineseCountingThousand"
        • ReadonlyCHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
        • ReadonlyCHOSUNG: "chosung"
        • ReadonlyCUSTOM: "custom"
        • ReadonlyDECIMAL: "decimal"
        • ReadonlyDECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
        • ReadonlyDECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
        • ReadonlyDECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop"
        • ReadonlyDECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen"
        • ReadonlyDECIMAL_FULL_WIDTH: "decimalFullWidth"
        • ReadonlyDECIMAL_FULL_WIDTH2: "decimalFullWidth2"
        • ReadonlyDECIMAL_HALF_WIDTH: "decimalHalfWidth"
        • ReadonlyDECIMAL_ZERO: "decimalZero"
        • ReadonlyDOLLAR_TEXT: "dollarText"
        • ReadonlyGANADA: "ganada"
        • ReadonlyHEBREW1: "hebrew1"
        • ReadonlyHEBREW2: "hebrew2"
        • ReadonlyHEX: "hex"
        • ReadonlyHINDI_CONSONANTS: "hindiConsonants"
        • ReadonlyHINDI_COUNTING: "hindiCounting"
        • ReadonlyHINDI_NUMBERS: "hindiNumbers"
        • ReadonlyHINDI_VOWELS: "hindiVowels"
        • ReadonlyIDEOGRAPH__DIGITAL: "ideographDigital"
        • ReadonlyIDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
        • ReadonlyIDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
        • ReadonlyIDEOGRAPH_TRADITIONAL: "ideographTraditional"
        • ReadonlyIDEOGRAPH_ZODIAC: "ideographZodiac"
        • ReadonlyIDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
        • ReadonlyIROHA: "iroha"
        • ReadonlyIROHA_FULL_WIDTH: "irohaFullWidth"
        • ReadonlyJAPANESE_COUNTING: "japaneseCounting"
        • ReadonlyJAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
        • ReadonlyJAPANESE_LEGAL: "japaneseLegal"
        • ReadonlyKOREAN_COUNTING: "koreanCounting"
        • ReadonlyKOREAN_DIGITAL: "koreanDigital"
        • ReadonlyKOREAN_DIGITAL2: "koreanDigital2"
        • ReadonlyKOREAN_LEGAL: "koreanLegal"
        • ReadonlyLOWER_LETTER: "lowerLetter"
        • ReadonlyLOWER_ROMAN: "lowerRoman"
        • ReadonlyNONE: "none"
        • ReadonlyNUMBER_IN_DASH: "numberInDash"
        • ReadonlyORDINAL: "ordinal"
        • ReadonlyORDINAL_TEXT: "ordinalText"
        • ReadonlyRUSSIAN_LOWER: "russianLower"
        • ReadonlyRUSSIAN_UPPER: "russianUpper"
        • ReadonlyTAIWANESE_COUNTING: "taiwaneseCounting"
        • ReadonlyTAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
        • ReadonlyTAIWANESE_DIGITAL: "taiwaneseDigital"
        • ReadonlyTHAI_COUNTING: "thaiCounting"
        • ReadonlyTHAI_LETTERS: "thaiLetters"
        • ReadonlyTHAI_NUMBERS: "thaiNumbers"
        • ReadonlyUPPER_LETTER: "upperLetter"
        • ReadonlyUPPER_ROMAN: "upperRoman"
        • ReadonlyVIETNAMESE_COUNTING: "vietnameseCounting"

        Settings

        Member Visibility
        diff --git a/api/variables/LevelSuffix.html b/api/variables/LevelSuffix.html index 680aa32883..c2542c6283 100644 --- a/api/variables/LevelSuffix.html +++ b/api/variables/LevelSuffix.html @@ -1 +1 @@ -LevelSuffix | docx

        Variable LevelSuffixConst

        LevelSuffix: { NOTHING: "nothing"; SPACE: "space"; TAB: "tab" } = ...

        Type declaration

        • ReadonlyNOTHING: "nothing"
        • ReadonlySPACE: "space"
        • ReadonlyTAB: "tab"

        Settings

        Member Visibility
        +LevelSuffix | docx

        Variable LevelSuffixConst

        LevelSuffix: { NOTHING: "nothing"; SPACE: "space"; TAB: "tab" } = ...

        Type declaration

        • ReadonlyNOTHING: "nothing"
        • ReadonlySPACE: "space"
        • ReadonlyTAB: "tab"

        Settings

        Member Visibility
        diff --git a/api/variables/LineNumberRestartFormat.html b/api/variables/LineNumberRestartFormat.html index a0ee2a2b37..7c80d902d2 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";
        } = ...

        Type declaration

        • ReadonlyCONTINUOUS: "continuous"
        • ReadonlyNEW_PAGE: "newPage"
        • ReadonlyNEW_SECTION: "newSection"

        Settings

        Member Visibility
        +LineNumberRestartFormat | docx

        Variable LineNumberRestartFormatConst

        LineNumberRestartFormat: {
            CONTINUOUS: "continuous";
            NEW_PAGE: "newPage";
            NEW_SECTION: "newSection";
        } = ...

        Type declaration

        • ReadonlyCONTINUOUS: "continuous"
        • ReadonlyNEW_PAGE: "newPage"
        • ReadonlyNEW_SECTION: "newSection"

        Settings

        Member Visibility
        diff --git a/api/variables/LineRuleType.html b/api/variables/LineRuleType.html index 8ea5c440c8..e2de3a9c0c 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";
        } = ...

        Type declaration

        • ReadonlyAT_LEAST: "atLeast"
        • ReadonlyAUTO: "auto"
        • ReadonlyEXACT: "exact"
        • ReadonlyEXACTLY: "exactly"

        Settings

        Member Visibility
        +LineRuleType | docx

        Variable LineRuleTypeConst

        LineRuleType: {
            AT_LEAST: "atLeast";
            AUTO: "auto";
            EXACT: "exact";
            EXACTLY: "exactly";
        } = ...

        Type declaration

        • ReadonlyAT_LEAST: "atLeast"
        • ReadonlyAUTO: "auto"
        • ReadonlyEXACT: "exact"
        • ReadonlyEXACTLY: "exactly"

        Settings

        Member Visibility
        diff --git a/api/variables/NumberFormat.html b/api/variables/NumberFormat.html index aac903c267..b315e56528 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";
        } = ...

        Type declaration

        • ReadonlyAIUEO: "aiueo"
        • ReadonlyAIUEO_FULL_WIDTH: "aiueoFullWidth"
        • ReadonlyARABIC_ABJAD: "arabicAbjad"
        • ReadonlyARABIC_ALPHA: "arabicAlpha"
        • ReadonlyBAHT_TEXT: "bahtText"
        • ReadonlyBULLET: "bullet"
        • ReadonlyCARDINAL_TEXT: "cardinalText"
        • ReadonlyCHICAGO: "chicago"
        • ReadonlyCHINESE_COUNTING: "chineseCounting"
        • ReadonlyCHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand"
        • ReadonlyCHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
        • ReadonlyCHOSUNG: "chosung"
        • ReadonlyDECIMAL: "decimal"
        • ReadonlyDECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
        • ReadonlyDECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
        • ReadonlyDECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop"
        • ReadonlyDECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen"
        • ReadonlyDECIMAL_FULL_WIDTH: "decimalFullWidth"
        • ReadonlyDECIMAL_FULL_WIDTH_2: "decimalFullWidth2"
        • ReadonlyDECIMAL_HALF_WIDTH: "decimalHalfWidth"
        • ReadonlyDECIMAL_ZERO: "decimalZero"
        • ReadonlyDOLLAR_TEXT: "dollarText"
        • ReadonlyGANADA: "ganada"
        • ReadonlyHEBREW_1: "hebrew1"
        • ReadonlyHEBREW_2: "hebrew2"
        • ReadonlyHEX: "hex"
        • ReadonlyHINDI_CONSONANTS: "hindiConsonants"
        • ReadonlyHINDI_COUNTING: "hindiCounting"
        • ReadonlyHINDI_NUMBERS: "hindiNumbers"
        • ReadonlyHINDI_VOWELS: "hindiVowels"
        • ReadonlyIDEOGRAPH_DIGITAL: "ideographDigital"
        • ReadonlyIDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
        • ReadonlyIDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
        • ReadonlyIDEOGRAPH_TRADITIONAL: "ideographTraditional"
        • ReadonlyIDEOGRAPH_ZODIAC: "ideographZodiac"
        • ReadonlyIDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
        • ReadonlyIROHA: "iroha"
        • ReadonlyIROHA_FULL_WIDTH: "irohaFullWidth"
        • ReadonlyJAPANESE_COUNTING: "japaneseCounting"
        • ReadonlyJAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
        • ReadonlyJAPANESE_LEGAL: "japaneseLegal"
        • ReadonlyKOREAN_COUNTING: "koreanCounting"
        • ReadonlyKOREAN_DIGITAL: "koreanDigital"
        • ReadonlyKOREAN_DIGITAL_2: "koreanDigital2"
        • ReadonlyKOREAN_LEGAL: "koreanLegal"
        • ReadonlyLOWER_LETTER: "lowerLetter"
        • ReadonlyLOWER_ROMAN: "lowerRoman"
        • ReadonlyNONE: "none"
        • ReadonlyNUMBER_IN_DASH: "numberInDash"
        • ReadonlyORDINAL: "ordinal"
        • ReadonlyORDINAL_TEXT: "ordinalText"
        • ReadonlyRUSSIAN_LOWER: "russianLower"
        • ReadonlyRUSSIAN_UPPER: "russianUpper"
        • ReadonlyTAIWANESE_COUNTING: "taiwaneseCounting"
        • ReadonlyTAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
        • ReadonlyTAIWANESE_DIGITAL: "taiwaneseDigital"
        • ReadonlyTHAI_COUNTING: "thaiCounting"
        • ReadonlyTHAI_LETTERS: "thaiLetters"
        • ReadonlyTHAI_NUMBERS: "thaiNumbers"
        • ReadonlyUPPER_LETTER: "upperLetter"
        • ReadonlyUPPER_ROMAN: "upperRoman"
        • ReadonlyVIETNAMESE_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";
        } = ...

        Type declaration

        • ReadonlyAIUEO: "aiueo"
        • ReadonlyAIUEO_FULL_WIDTH: "aiueoFullWidth"
        • ReadonlyARABIC_ABJAD: "arabicAbjad"
        • ReadonlyARABIC_ALPHA: "arabicAlpha"
        • ReadonlyBAHT_TEXT: "bahtText"
        • ReadonlyBULLET: "bullet"
        • ReadonlyCARDINAL_TEXT: "cardinalText"
        • ReadonlyCHICAGO: "chicago"
        • ReadonlyCHINESE_COUNTING: "chineseCounting"
        • ReadonlyCHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand"
        • ReadonlyCHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified"
        • ReadonlyCHOSUNG: "chosung"
        • ReadonlyDECIMAL: "decimal"
        • ReadonlyDECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle"
        • ReadonlyDECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese"
        • ReadonlyDECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop"
        • ReadonlyDECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen"
        • ReadonlyDECIMAL_FULL_WIDTH: "decimalFullWidth"
        • ReadonlyDECIMAL_FULL_WIDTH_2: "decimalFullWidth2"
        • ReadonlyDECIMAL_HALF_WIDTH: "decimalHalfWidth"
        • ReadonlyDECIMAL_ZERO: "decimalZero"
        • ReadonlyDOLLAR_TEXT: "dollarText"
        • ReadonlyGANADA: "ganada"
        • ReadonlyHEBREW_1: "hebrew1"
        • ReadonlyHEBREW_2: "hebrew2"
        • ReadonlyHEX: "hex"
        • ReadonlyHINDI_CONSONANTS: "hindiConsonants"
        • ReadonlyHINDI_COUNTING: "hindiCounting"
        • ReadonlyHINDI_NUMBERS: "hindiNumbers"
        • ReadonlyHINDI_VOWELS: "hindiVowels"
        • ReadonlyIDEOGRAPH_DIGITAL: "ideographDigital"
        • ReadonlyIDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle"
        • ReadonlyIDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional"
        • ReadonlyIDEOGRAPH_TRADITIONAL: "ideographTraditional"
        • ReadonlyIDEOGRAPH_ZODIAC: "ideographZodiac"
        • ReadonlyIDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional"
        • ReadonlyIROHA: "iroha"
        • ReadonlyIROHA_FULL_WIDTH: "irohaFullWidth"
        • ReadonlyJAPANESE_COUNTING: "japaneseCounting"
        • ReadonlyJAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand"
        • ReadonlyJAPANESE_LEGAL: "japaneseLegal"
        • ReadonlyKOREAN_COUNTING: "koreanCounting"
        • ReadonlyKOREAN_DIGITAL: "koreanDigital"
        • ReadonlyKOREAN_DIGITAL_2: "koreanDigital2"
        • ReadonlyKOREAN_LEGAL: "koreanLegal"
        • ReadonlyLOWER_LETTER: "lowerLetter"
        • ReadonlyLOWER_ROMAN: "lowerRoman"
        • ReadonlyNONE: "none"
        • ReadonlyNUMBER_IN_DASH: "numberInDash"
        • ReadonlyORDINAL: "ordinal"
        • ReadonlyORDINAL_TEXT: "ordinalText"
        • ReadonlyRUSSIAN_LOWER: "russianLower"
        • ReadonlyRUSSIAN_UPPER: "russianUpper"
        • ReadonlyTAIWANESE_COUNTING: "taiwaneseCounting"
        • ReadonlyTAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand"
        • ReadonlyTAIWANESE_DIGITAL: "taiwaneseDigital"
        • ReadonlyTHAI_COUNTING: "thaiCounting"
        • ReadonlyTHAI_LETTERS: "thaiLetters"
        • ReadonlyTHAI_NUMBERS: "thaiNumbers"
        • ReadonlyUPPER_LETTER: "upperLetter"
        • ReadonlyUPPER_ROMAN: "upperRoman"
        • ReadonlyVIETNAMESE_COUNTING: "vietnameseCounting"

        Settings

        Member Visibility
        diff --git a/api/variables/OverlapType.html b/api/variables/OverlapType.html index 54b6c1cd1e..f76564ef8c 100644 --- a/api/variables/OverlapType.html +++ b/api/variables/OverlapType.html @@ -1 +1 @@ -OverlapType | docx

        Variable OverlapTypeConst

        OverlapType: { NEVER: "never"; OVERLAP: "overlap" } = ...

        Type declaration

        • ReadonlyNEVER: "never"
        • ReadonlyOVERLAP: "overlap"

        Settings

        Member Visibility
        +OverlapType | docx

        Variable OverlapTypeConst

        OverlapType: { NEVER: "never"; OVERLAP: "overlap" } = ...

        Type declaration

        • ReadonlyNEVER: "never"
        • ReadonlyOVERLAP: "overlap"

        Settings

        Member Visibility
        diff --git a/api/variables/PageBorderDisplay.html b/api/variables/PageBorderDisplay.html index 5ea199f0af..45861af3c5 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";
        } = ...

        Type declaration

        • ReadonlyALL_PAGES: "allPages"
        • ReadonlyFIRST_PAGE: "firstPage"
        • ReadonlyNOT_FIRST_PAGE: "notFirstPage"

        Settings

        Member Visibility
        +PageBorderDisplay | docx

        Variable PageBorderDisplayConst

        PageBorderDisplay: {
            ALL_PAGES: "allPages";
            FIRST_PAGE: "firstPage";
            NOT_FIRST_PAGE: "notFirstPage";
        } = ...

        Type declaration

        • ReadonlyALL_PAGES: "allPages"
        • ReadonlyFIRST_PAGE: "firstPage"
        • ReadonlyNOT_FIRST_PAGE: "notFirstPage"

        Settings

        Member Visibility
        diff --git a/api/variables/PageBorderOffsetFrom.html b/api/variables/PageBorderOffsetFrom.html index 333c88e8d0..56daf390db 100644 --- a/api/variables/PageBorderOffsetFrom.html +++ b/api/variables/PageBorderOffsetFrom.html @@ -1 +1 @@ -PageBorderOffsetFrom | docx

        Variable PageBorderOffsetFromConst

        PageBorderOffsetFrom: { PAGE: "page"; TEXT: "text" } = ...

        Type declaration

        • ReadonlyPAGE: "page"
        • ReadonlyTEXT: "text"

        Settings

        Member Visibility
        +PageBorderOffsetFrom | docx

        Variable PageBorderOffsetFromConst

        PageBorderOffsetFrom: { PAGE: "page"; TEXT: "text" } = ...

        Type declaration

        • ReadonlyPAGE: "page"
        • ReadonlyTEXT: "text"

        Settings

        Member Visibility
        diff --git a/api/variables/PageBorderZOrder.html b/api/variables/PageBorderZOrder.html index e2f7b767c7..f6d2c5fadb 100644 --- a/api/variables/PageBorderZOrder.html +++ b/api/variables/PageBorderZOrder.html @@ -1 +1 @@ -PageBorderZOrder | docx

        Variable PageBorderZOrderConst

        PageBorderZOrder: { BACK: "back"; FRONT: "front" } = ...

        Type declaration

        • ReadonlyBACK: "back"
        • ReadonlyFRONT: "front"

        Settings

        Member Visibility
        +PageBorderZOrder | docx

        Variable PageBorderZOrderConst

        PageBorderZOrder: { BACK: "back"; FRONT: "front" } = ...

        Type declaration

        • ReadonlyBACK: "back"
        • ReadonlyFRONT: "front"

        Settings

        Member Visibility
        diff --git a/api/variables/PageNumber.html b/api/variables/PageNumber.html index 89f75b5134..f7a0e4c5d9 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";
        } = ...

        Type declaration

        • ReadonlyCURRENT: "CURRENT"
        • ReadonlyCURRENT_SECTION: "SECTION"
        • ReadonlyTOTAL_PAGES: "TOTAL_PAGES"
        • ReadonlyTOTAL_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";
        } = ...

        Type declaration

        • ReadonlyCURRENT: "CURRENT"
        • ReadonlyCURRENT_SECTION: "SECTION"
        • ReadonlyTOTAL_PAGES: "TOTAL_PAGES"
        • ReadonlyTOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION"

        Settings

        Member Visibility
        diff --git a/api/variables/PageNumberSeparator.html b/api/variables/PageNumberSeparator.html index e298381a66..ed018ff652 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";
        } = ...

        Type declaration

        • ReadonlyCOLON: "colon"
        • ReadonlyEM_DASH: "emDash"
        • ReadonlyEN_DASH: "endash"
        • ReadonlyHYPHEN: "hyphen"
        • ReadonlyPERIOD: "period"

        Settings

        Member Visibility
        +PageNumberSeparator | docx

        Variable PageNumberSeparatorConst

        PageNumberSeparator: {
            COLON: "colon";
            EM_DASH: "emDash";
            EN_DASH: "endash";
            HYPHEN: "hyphen";
            PERIOD: "period";
        } = ...

        Type declaration

        • ReadonlyCOLON: "colon"
        • ReadonlyEM_DASH: "emDash"
        • ReadonlyEN_DASH: "endash"
        • ReadonlyHYPHEN: "hyphen"
        • ReadonlyPERIOD: "period"

        Settings

        Member Visibility
        diff --git a/api/variables/PageOrientation.html b/api/variables/PageOrientation.html index 51007e4a97..dd7d47498b 100644 --- a/api/variables/PageOrientation.html +++ b/api/variables/PageOrientation.html @@ -1 +1 @@ -PageOrientation | docx

        Variable PageOrientationConst

        PageOrientation: { LANDSCAPE: "landscape"; PORTRAIT: "portrait" } = ...

        Type declaration

        • ReadonlyLANDSCAPE: "landscape"
        • ReadonlyPORTRAIT: "portrait"

        Settings

        Member Visibility
        +PageOrientation | docx

        Variable PageOrientationConst

        PageOrientation: { LANDSCAPE: "landscape"; PORTRAIT: "portrait" } = ...

        Type declaration

        • ReadonlyLANDSCAPE: "landscape"
        • ReadonlyPORTRAIT: "portrait"

        Settings

        Member Visibility
        diff --git a/api/variables/PageTextDirectionType.html b/api/variables/PageTextDirectionType.html index 2fd8b298bc..b88fa2cb62 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";
        } = ...

        Type declaration

        • ReadonlyLEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
        • ReadonlyTOP_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";
        } = ...

        Type declaration

        • ReadonlyLEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
        • ReadonlyTOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"

        Settings

        Member Visibility
        diff --git a/api/variables/PatchType.html b/api/variables/PatchType.html index 6e99b4f2e3..3571405afc 100644 --- a/api/variables/PatchType.html +++ b/api/variables/PatchType.html @@ -1 +1 @@ -PatchType | docx

        Variable PatchTypeConst

        PatchType: { DOCUMENT: "file"; PARAGRAPH: "paragraph" } = ...

        Type declaration

        • ReadonlyDOCUMENT: "file"
        • ReadonlyPARAGRAPH: "paragraph"

        Settings

        Member Visibility
        +PatchType | docx

        Variable PatchTypeConst

        PatchType: { DOCUMENT: "file"; PARAGRAPH: "paragraph" } = ...

        Type declaration

        • ReadonlyDOCUMENT: "file"
        • ReadonlyPARAGRAPH: "paragraph"

        Settings

        Member Visibility
        diff --git a/api/variables/PositionalTabAlignment.html b/api/variables/PositionalTabAlignment.html index c19c70da2c..14e571ad13 100644 --- a/api/variables/PositionalTabAlignment.html +++ b/api/variables/PositionalTabAlignment.html @@ -1 +1 @@ -PositionalTabAlignment | docx

        Variable PositionalTabAlignmentConst

        PositionalTabAlignment: { CENTER: "center"; LEFT: "left"; RIGHT: "right" } = ...

        Type declaration

        • ReadonlyCENTER: "center"
        • ReadonlyLEFT: "left"
        • ReadonlyRIGHT: "right"

        Settings

        Member Visibility
        +PositionalTabAlignment | docx

        Variable PositionalTabAlignmentConst

        PositionalTabAlignment: { CENTER: "center"; LEFT: "left"; RIGHT: "right" } = ...

        Type declaration

        • ReadonlyCENTER: "center"
        • ReadonlyLEFT: "left"
        • ReadonlyRIGHT: "right"

        Settings

        Member Visibility
        diff --git a/api/variables/PositionalTabLeader.html b/api/variables/PositionalTabLeader.html index a6c2bf5db2..a9b7a04eda 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";
        } = ...

        Type declaration

        • ReadonlyDOT: "dot"
        • ReadonlyHYPHEN: "hyphen"
        • ReadonlyMIDDLE_DOT: "middleDot"
        • ReadonlyNONE: "none"
        • ReadonlyUNDERSCORE: "underscore"

        Settings

        Member Visibility
        +PositionalTabLeader | docx

        Variable PositionalTabLeaderConst

        PositionalTabLeader: {
            DOT: "dot";
            HYPHEN: "hyphen";
            MIDDLE_DOT: "middleDot";
            NONE: "none";
            UNDERSCORE: "underscore";
        } = ...

        Type declaration

        • ReadonlyDOT: "dot"
        • ReadonlyHYPHEN: "hyphen"
        • ReadonlyMIDDLE_DOT: "middleDot"
        • ReadonlyNONE: "none"
        • ReadonlyUNDERSCORE: "underscore"

        Settings

        Member Visibility
        diff --git a/api/variables/PositionalTabRelativeTo.html b/api/variables/PositionalTabRelativeTo.html index 11c7aa3b6c..be405d1dd0 100644 --- a/api/variables/PositionalTabRelativeTo.html +++ b/api/variables/PositionalTabRelativeTo.html @@ -1 +1 @@ -PositionalTabRelativeTo | docx

        Variable PositionalTabRelativeToConst

        PositionalTabRelativeTo: { INDENT: "indent"; MARGIN: "margin" } = ...

        Type declaration

        • ReadonlyINDENT: "indent"
        • ReadonlyMARGIN: "margin"

        Settings

        Member Visibility
        +PositionalTabRelativeTo | docx

        Variable PositionalTabRelativeToConst

        PositionalTabRelativeTo: { INDENT: "indent"; MARGIN: "margin" } = ...

        Type declaration

        • ReadonlyINDENT: "indent"
        • ReadonlyMARGIN: "margin"

        Settings

        Member Visibility
        diff --git a/api/variables/PrettifyType.html b/api/variables/PrettifyType.html index 1416aff84c..e1f350df81 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

        -

        Type declaration

        • ReadonlyNONE: ""
        • ReadonlyWITH_2_BLANKS: " "
        • ReadonlyWITH_4_BLANKS: " "
        • ReadonlyWITH_TAB: "\t"

        Settings

        Member Visibility
        +

        Type declaration

        Settings

        Member Visibility
        diff --git a/api/variables/RelativeHorizontalPosition.html b/api/variables/RelativeHorizontalPosition.html index bfef08df42..3f14eb91fd 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";
        } = ...

        Type declaration

        • ReadonlyCENTER: "center"
        • ReadonlyINSIDE: "inside"
        • ReadonlyLEFT: "left"
        • ReadonlyOUTSIDE: "outside"
        • ReadonlyRIGHT: "right"

        Settings

        Member Visibility
        +RelativeHorizontalPosition | docx

        Variable RelativeHorizontalPositionConst

        RelativeHorizontalPosition: {
            CENTER: "center";
            INSIDE: "inside";
            LEFT: "left";
            OUTSIDE: "outside";
            RIGHT: "right";
        } = ...

        Type declaration

        • ReadonlyCENTER: "center"
        • ReadonlyINSIDE: "inside"
        • ReadonlyLEFT: "left"
        • ReadonlyOUTSIDE: "outside"
        • ReadonlyRIGHT: "right"

        Settings

        Member Visibility
        diff --git a/api/variables/RelativeVerticalPosition.html b/api/variables/RelativeVerticalPosition.html index 765a22d054..d8ddc0965a 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";
        } = ...

        Type declaration

        • ReadonlyBOTTOM: "bottom"
        • ReadonlyCENTER: "center"
        • ReadonlyINLINE: "inline"
        • ReadonlyINSIDE: "inside"
        • ReadonlyOUTSIDE: "outside"
        • ReadonlyTOP: "top"

        Settings

        Member Visibility
        +RelativeVerticalPosition | docx

        Variable RelativeVerticalPositionConst

        RelativeVerticalPosition: {
            BOTTOM: "bottom";
            CENTER: "center";
            INLINE: "inline";
            INSIDE: "inside";
            OUTSIDE: "outside";
            TOP: "top";
        } = ...

        Type declaration

        • ReadonlyBOTTOM: "bottom"
        • ReadonlyCENTER: "center"
        • ReadonlyINLINE: "inline"
        • ReadonlyINSIDE: "inside"
        • ReadonlyOUTSIDE: "outside"
        • ReadonlyTOP: "top"

        Settings

        Member Visibility
        diff --git a/api/variables/SectionType.html b/api/variables/SectionType.html index 05d54739a7..529e050ccf 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";
        } = ...

        Type declaration

        • ReadonlyCONTINUOUS: "continuous"
        • ReadonlyEVEN_PAGE: "evenPage"
        • ReadonlyNEXT_COLUMN: "nextColumn"
        • ReadonlyNEXT_PAGE: "nextPage"
        • ReadonlyODD_PAGE: "oddPage"

        Settings

        Member Visibility
        +SectionType | docx

        Variable SectionTypeConst

        SectionType: {
            CONTINUOUS: "continuous";
            EVEN_PAGE: "evenPage";
            NEXT_COLUMN: "nextColumn";
            NEXT_PAGE: "nextPage";
            ODD_PAGE: "oddPage";
        } = ...

        Type declaration

        • ReadonlyCONTINUOUS: "continuous"
        • ReadonlyEVEN_PAGE: "evenPage"
        • ReadonlyNEXT_COLUMN: "nextColumn"
        • ReadonlyNEXT_PAGE: "nextPage"
        • ReadonlyODD_PAGE: "oddPage"

        Settings

        Member Visibility
        diff --git a/api/variables/ShadingType.html b/api/variables/ShadingType.html index afa45d1662..d96d3a65ef 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";
        } = ...

        Type declaration

        • ReadonlyCLEAR: "clear"
        • ReadonlyDIAGONAL_CROSS: "diagCross"
        • ReadonlyDIAGONAL_STRIPE: "diagStripe"
        • ReadonlyHORIZONTAL_CROSS: "horzCross"
        • ReadonlyHORIZONTAL_STRIPE: "horzStripe"
        • ReadonlyNIL: "nil"
        • ReadonlyPERCENT_10: "pct10"
        • ReadonlyPERCENT_12: "pct12"
        • ReadonlyPERCENT_15: "pct15"
        • ReadonlyPERCENT_20: "pct20"
        • ReadonlyPERCENT_25: "pct25"
        • ReadonlyPERCENT_30: "pct30"
        • ReadonlyPERCENT_35: "pct35"
        • ReadonlyPERCENT_37: "pct37"
        • ReadonlyPERCENT_40: "pct40"
        • ReadonlyPERCENT_45: "pct45"
        • ReadonlyPERCENT_5: "pct5"
        • ReadonlyPERCENT_50: "pct50"
        • ReadonlyPERCENT_55: "pct55"
        • ReadonlyPERCENT_60: "pct60"
        • ReadonlyPERCENT_62: "pct62"
        • ReadonlyPERCENT_65: "pct65"
        • ReadonlyPERCENT_70: "pct70"
        • ReadonlyPERCENT_75: "pct75"
        • ReadonlyPERCENT_80: "pct80"
        • ReadonlyPERCENT_85: "pct85"
        • ReadonlyPERCENT_87: "pct87"
        • ReadonlyPERCENT_90: "pct90"
        • ReadonlyPERCENT_95: "pct95"
        • ReadonlyREVERSE_DIAGONAL_STRIPE: "reverseDiagStripe"
        • ReadonlySOLID: "solid"
        • ReadonlyTHIN_DIAGONAL_CROSS: "thinDiagCross"
        • ReadonlyTHIN_DIAGONAL_STRIPE: "thinDiagStripe"
        • ReadonlyTHIN_HORIZONTAL_CROSS: "thinHorzCross"
        • ReadonlyTHIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe"
        • ReadonlyTHIN_VERTICAL_STRIPE: "thinVertStripe"
        • ReadonlyVERTICAL_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";
        } = ...

        Type declaration

        • ReadonlyCLEAR: "clear"
        • ReadonlyDIAGONAL_CROSS: "diagCross"
        • ReadonlyDIAGONAL_STRIPE: "diagStripe"
        • ReadonlyHORIZONTAL_CROSS: "horzCross"
        • ReadonlyHORIZONTAL_STRIPE: "horzStripe"
        • ReadonlyNIL: "nil"
        • ReadonlyPERCENT_10: "pct10"
        • ReadonlyPERCENT_12: "pct12"
        • ReadonlyPERCENT_15: "pct15"
        • ReadonlyPERCENT_20: "pct20"
        • ReadonlyPERCENT_25: "pct25"
        • ReadonlyPERCENT_30: "pct30"
        • ReadonlyPERCENT_35: "pct35"
        • ReadonlyPERCENT_37: "pct37"
        • ReadonlyPERCENT_40: "pct40"
        • ReadonlyPERCENT_45: "pct45"
        • ReadonlyPERCENT_5: "pct5"
        • ReadonlyPERCENT_50: "pct50"
        • ReadonlyPERCENT_55: "pct55"
        • ReadonlyPERCENT_60: "pct60"
        • ReadonlyPERCENT_62: "pct62"
        • ReadonlyPERCENT_65: "pct65"
        • ReadonlyPERCENT_70: "pct70"
        • ReadonlyPERCENT_75: "pct75"
        • ReadonlyPERCENT_80: "pct80"
        • ReadonlyPERCENT_85: "pct85"
        • ReadonlyPERCENT_87: "pct87"
        • ReadonlyPERCENT_90: "pct90"
        • ReadonlyPERCENT_95: "pct95"
        • ReadonlyREVERSE_DIAGONAL_STRIPE: "reverseDiagStripe"
        • ReadonlySOLID: "solid"
        • ReadonlyTHIN_DIAGONAL_CROSS: "thinDiagCross"
        • ReadonlyTHIN_DIAGONAL_STRIPE: "thinDiagStripe"
        • ReadonlyTHIN_HORIZONTAL_CROSS: "thinHorzCross"
        • ReadonlyTHIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe"
        • ReadonlyTHIN_VERTICAL_STRIPE: "thinVertStripe"
        • ReadonlyVERTICAL_STRIPE: "vertStripe"

        Settings

        Member Visibility
        diff --git a/api/variables/SpaceType.html b/api/variables/SpaceType.html index f4c1785d44..a6ce836f9b 100644 --- a/api/variables/SpaceType.html +++ b/api/variables/SpaceType.html @@ -1 +1 @@ -SpaceType | docx

        Variable SpaceTypeConst

        SpaceType: { DEFAULT: "default"; PRESERVE: "preserve" } = ...

        Type declaration

        • ReadonlyDEFAULT: "default"
        • ReadonlyPRESERVE: "preserve"

        Settings

        Member Visibility
        +SpaceType | docx

        Variable SpaceTypeConst

        SpaceType: { DEFAULT: "default"; PRESERVE: "preserve" } = ...

        Type declaration

        • ReadonlyDEFAULT: "default"
        • ReadonlyPRESERVE: "preserve"

        Settings

        Member Visibility
        diff --git a/api/variables/TabStopPosition.html b/api/variables/TabStopPosition.html index c9b73ad91a..87a09b2079 100644 --- a/api/variables/TabStopPosition.html +++ b/api/variables/TabStopPosition.html @@ -1 +1 @@ -TabStopPosition | docx

        Variable TabStopPositionConst

        TabStopPosition: { MAX: 9026 } = ...

        Type declaration

        • ReadonlyMAX: 9026

        Settings

        Member Visibility
        +TabStopPosition | docx

        Variable TabStopPositionConst

        TabStopPosition: { MAX: 9026 } = ...

        Type declaration

        • ReadonlyMAX: 9026

        Settings

        Member Visibility
        diff --git a/api/variables/TabStopType.html b/api/variables/TabStopType.html index ea5a18e256..f2971f6d64 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";
        } = ...

        Type declaration

        • ReadonlyBAR: "bar"
        • ReadonlyCENTER: "center"
        • ReadonlyCLEAR: "clear"
        • ReadonlyDECIMAL: "decimal"
        • ReadonlyEND: "end"
        • ReadonlyLEFT: "left"
        • ReadonlyNUM: "num"
        • ReadonlyRIGHT: "right"
        • ReadonlySTART: "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";
        } = ...

        Type declaration

        • ReadonlyBAR: "bar"
        • ReadonlyCENTER: "center"
        • ReadonlyCLEAR: "clear"
        • ReadonlyDECIMAL: "decimal"
        • ReadonlyEND: "end"
        • ReadonlyLEFT: "left"
        • ReadonlyNUM: "num"
        • ReadonlyRIGHT: "right"
        • ReadonlySTART: "start"

        Settings

        Member Visibility
        diff --git a/api/variables/TableAnchorType.html b/api/variables/TableAnchorType.html index 8a73e3d431..09de4de21a 100644 --- a/api/variables/TableAnchorType.html +++ b/api/variables/TableAnchorType.html @@ -1 +1 @@ -TableAnchorType | docx

        Variable TableAnchorTypeConst

        TableAnchorType: { MARGIN: "margin"; PAGE: "page"; TEXT: "text" } = ...

        Type declaration

        • ReadonlyMARGIN: "margin"
        • ReadonlyPAGE: "page"
        • ReadonlyTEXT: "text"

        Settings

        Member Visibility
        +TableAnchorType | docx

        Variable TableAnchorTypeConst

        TableAnchorType: { MARGIN: "margin"; PAGE: "page"; TEXT: "text" } = ...

        Type declaration

        • ReadonlyMARGIN: "margin"
        • ReadonlyPAGE: "page"
        • ReadonlyTEXT: "text"

        Settings

        Member Visibility
        diff --git a/api/variables/TableLayoutType.html b/api/variables/TableLayoutType.html index 5c31a87112..7a666057d0 100644 --- a/api/variables/TableLayoutType.html +++ b/api/variables/TableLayoutType.html @@ -1 +1 @@ -TableLayoutType | docx

        Variable TableLayoutTypeConst

        TableLayoutType: { AUTOFIT: "autofit"; FIXED: "fixed" } = ...

        Type declaration

        • ReadonlyAUTOFIT: "autofit"
        • ReadonlyFIXED: "fixed"

        Settings

        Member Visibility
        +TableLayoutType | docx

        Variable TableLayoutTypeConst

        TableLayoutType: { AUTOFIT: "autofit"; FIXED: "fixed" } = ...

        Type declaration

        • ReadonlyAUTOFIT: "autofit"
        • ReadonlyFIXED: "fixed"

        Settings

        Member Visibility
        diff --git a/api/variables/TextDirection.html b/api/variables/TextDirection.html index ca59294657..3305c9fc08 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";
        } = ...

        Type declaration

        • ReadonlyBOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr"
        • ReadonlyLEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
        • ReadonlyTOP_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";
        } = ...

        Type declaration

        • ReadonlyBOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr"
        • ReadonlyLEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb"
        • ReadonlyTOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl"

        Settings

        Member Visibility
        diff --git a/api/variables/TextEffect.html b/api/variables/TextEffect.html index 6dd47c5dca..f1ea9f48f6 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";
        } = ...

        Type declaration

        • ReadonlyANTS_BLACK: "antsBlack"
        • ReadonlyANTS_RED: "antsRed"
        • ReadonlyBLINK_BACKGROUND: "blinkBackground"
        • ReadonlyLIGHTS: "lights"
        • ReadonlyNONE: "none"
        • ReadonlySHIMMER: "shimmer"
        • ReadonlySPARKLE: "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";
        } = ...

        Type declaration

        • ReadonlyANTS_BLACK: "antsBlack"
        • ReadonlyANTS_RED: "antsRed"
        • ReadonlyBLINK_BACKGROUND: "blinkBackground"
        • ReadonlyLIGHTS: "lights"
        • ReadonlyNONE: "none"
        • ReadonlySHIMMER: "shimmer"
        • ReadonlySPARKLE: "sparkle"

        Settings

        Member Visibility
        diff --git a/api/variables/TextWrappingSide.html b/api/variables/TextWrappingSide.html index 58ecf01b82..40f7ceceeb 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";
        } = ...

        Type declaration

        • ReadonlyBOTH_SIDES: "bothSides"
        • ReadonlyLARGEST: "largest"
        • ReadonlyLEFT: "left"
        • ReadonlyRIGHT: "right"

        Settings

        Member Visibility
        +TextWrappingSide | docx

        Variable TextWrappingSideConst

        TextWrappingSide: {
            BOTH_SIDES: "bothSides";
            LARGEST: "largest";
            LEFT: "left";
            RIGHT: "right";
        } = ...

        Type declaration

        • ReadonlyBOTH_SIDES: "bothSides"
        • ReadonlyLARGEST: "largest"
        • ReadonlyLEFT: "left"
        • ReadonlyRIGHT: "right"

        Settings

        Member Visibility
        diff --git a/api/variables/TextWrappingType.html b/api/variables/TextWrappingType.html index 0b469bdf57..e534f09878 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 } = ...

        Type declaration

        • ReadonlyNONE: 0
        • ReadonlySQUARE: 1
        • ReadonlyTIGHT: 2
        • ReadonlyTOP_AND_BOTTOM: 3

        Settings

        Member Visibility
        +TextWrappingType | docx

        Variable TextWrappingTypeConst

        TextWrappingType: { NONE: 0; SQUARE: 1; TIGHT: 2; TOP_AND_BOTTOM: 3 } = ...

        Type declaration

        • ReadonlyNONE: 0
        • ReadonlySQUARE: 1
        • ReadonlyTIGHT: 2
        • ReadonlyTOP_AND_BOTTOM: 3

        Settings

        Member Visibility
        diff --git a/api/variables/UnderlineType.html b/api/variables/UnderlineType.html index fc30f975a4..769fa38ccf 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";
        } = ...

        Type declaration

        • ReadonlyDASH: "dash"
        • ReadonlyDASHDOTDOTHEAVY: "dashDotDotHeavy"
        • ReadonlyDASHDOTHEAVY: "dashDotHeavy"
        • ReadonlyDASHEDHEAVY: "dashedHeavy"
        • ReadonlyDASHLONG: "dashLong"
        • ReadonlyDASHLONGHEAVY: "dashLongHeavy"
        • ReadonlyDOTDASH: "dotDash"
        • ReadonlyDOTDOTDASH: "dotDotDash"
        • ReadonlyDOTTED: "dotted"
        • ReadonlyDOTTEDHEAVY: "dottedHeavy"
        • ReadonlyDOUBLE: "double"
        • ReadonlyNONE: "none"
        • ReadonlySINGLE: "single"
        • ReadonlyTHICK: "thick"
        • ReadonlyWAVE: "wave"
        • ReadonlyWAVYDOUBLE: "wavyDouble"
        • ReadonlyWAVYHEAVY: "wavyHeavy"
        • ReadonlyWORDS: "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";
        } = ...

        Type declaration

        • ReadonlyDASH: "dash"
        • ReadonlyDASHDOTDOTHEAVY: "dashDotDotHeavy"
        • ReadonlyDASHDOTHEAVY: "dashDotHeavy"
        • ReadonlyDASHEDHEAVY: "dashedHeavy"
        • ReadonlyDASHLONG: "dashLong"
        • ReadonlyDASHLONGHEAVY: "dashLongHeavy"
        • ReadonlyDOTDASH: "dotDash"
        • ReadonlyDOTDOTDASH: "dotDotDash"
        • ReadonlyDOTTED: "dotted"
        • ReadonlyDOTTEDHEAVY: "dottedHeavy"
        • ReadonlyDOUBLE: "double"
        • ReadonlyNONE: "none"
        • ReadonlySINGLE: "single"
        • ReadonlyTHICK: "thick"
        • ReadonlyWAVE: "wave"
        • ReadonlyWAVYDOUBLE: "wavyDouble"
        • ReadonlyWAVYHEAVY: "wavyHeavy"
        • ReadonlyWORDS: "words"

        Settings

        Member Visibility
        diff --git a/api/variables/VerticalAlign.html b/api/variables/VerticalAlign.html index c90053b5c9..bc09ad1ebb 100644 --- a/api/variables/VerticalAlign.html +++ b/api/variables/VerticalAlign.html @@ -1 +1 @@ -VerticalAlign | docx

        Variable VerticalAlignConst

        VerticalAlign: { BOTTOM: "bottom"; CENTER: "center"; TOP: "top" } = ...

        Type declaration

        • ReadonlyBOTTOM: "bottom"
        • ReadonlyCENTER: "center"
        • ReadonlyTOP: "top"

        Settings

        Member Visibility
        +VerticalAlign | docx

        Variable VerticalAlignConst

        VerticalAlign: { BOTTOM: "bottom"; CENTER: "center"; TOP: "top" } = ...

        Type declaration

        • ReadonlyBOTTOM: "bottom"
        • ReadonlyCENTER: "center"
        • ReadonlyTOP: "top"

        Settings

        Member Visibility
        diff --git a/api/variables/VerticalMergeType.html b/api/variables/VerticalMergeType.html index adc1fcee3d..e6d389c5ea 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 614534543f..c11b455b72 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";
        } = ...

        Type declaration

        • ReadonlyBOTTOM: "bottom"
        • ReadonlyCENTER: "center"
        • ReadonlyINSIDE: "inside"
        • ReadonlyOUTSIDE: "outside"
        • ReadonlyTOP: "top"

        Settings

        Member Visibility
        +VerticalPositionAlign | docx

        Variable VerticalPositionAlignConst

        VerticalPositionAlign: {
            BOTTOM: "bottom";
            CENTER: "center";
            INSIDE: "inside";
            OUTSIDE: "outside";
            TOP: "top";
        } = ...

        Type declaration

        • ReadonlyBOTTOM: "bottom"
        • ReadonlyCENTER: "center"
        • ReadonlyINSIDE: "inside"
        • ReadonlyOUTSIDE: "outside"
        • ReadonlyTOP: "top"

        Settings

        Member Visibility
        diff --git a/api/variables/VerticalPositionRelativeFrom.html b/api/variables/VerticalPositionRelativeFrom.html index 9a03c08d38..231caae992 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";
        } = ...

        Type declaration

        • ReadonlyBOTTOM_MARGIN: "bottomMargin"
        • ReadonlyINSIDE_MARGIN: "insideMargin"
        • ReadonlyLINE: "line"
        • ReadonlyMARGIN: "margin"
        • ReadonlyOUTSIDE_MARGIN: "outsideMargin"
        • ReadonlyPAGE: "page"
        • ReadonlyPARAGRAPH: "paragraph"
        • ReadonlyTOP_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";
        } = ...

        Type declaration

        • ReadonlyBOTTOM_MARGIN: "bottomMargin"
        • ReadonlyINSIDE_MARGIN: "insideMargin"
        • ReadonlyLINE: "line"
        • ReadonlyMARGIN: "margin"
        • ReadonlyOUTSIDE_MARGIN: "outsideMargin"
        • ReadonlyPAGE: "page"
        • ReadonlyPARAGRAPH: "paragraph"
        • ReadonlyTOP_MARGIN: "topMargin"

        Settings

        Member Visibility
        diff --git a/api/variables/WidthType.html b/api/variables/WidthType.html index 4e77c4a977..09ddf615b6 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 af0e25679e..b566fc52b7 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;
        } = ...

        Type declaration

        • 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;
        } = ...

        Type declaration

        • 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 e65e537c98..ed737abdce 100644 --- a/api/variables/sectionPageSizeDefaults.html +++ b/api/variables/sectionPageSizeDefaults.html @@ -1 +1 @@ -sectionPageSizeDefaults | docx

        Variable sectionPageSizeDefaultsConst

        sectionPageSizeDefaults: {
            HEIGHT: number;
            ORIENTATION: "portrait";
            WIDTH: number;
        } = ...

        Type declaration

        • HEIGHT: number
        • ORIENTATION: "portrait"
        • WIDTH: number

        Settings

        Member Visibility
        +sectionPageSizeDefaults | docx

        Variable sectionPageSizeDefaultsConst

        sectionPageSizeDefaults: {
            HEIGHT: number;
            ORIENTATION: "portrait";
            WIDTH: number;
        } = ...

        Type declaration

        • HEIGHT: number
        • ORIENTATION: "portrait"
        • WIDTH: number

        Settings

        Member Visibility
        diff --git a/usage/packers.md b/usage/packers.md index 236494bf96..4b281fb4a5 100644 --- a/usage/packers.md +++ b/usage/packers.md @@ -2,7 +2,7 @@ > Packers are the way in which `docx` turns your code into `.docx` format. It is completely decoupled from the `docx.Document`. -Packers works in both a node and browser environment (Angular etc). Now, the packer returns a `Buffer`, `Blob` or `base64 string`. It is up to you to take that and persist it with node's `fs`, send it down as a downloadable file, or anything else you wish. As of `version 4+`, this library will not have options to export to PDF. +Packers works in both a node and browser environment (Angular etc). Now, the packer returns a `Buffer`, `Blob`, `string`, `base64 string`, or `Stream`. It is up to you to take that and persist it with node's `fs`, send it down as a downloadable file, or anything else you wish. As of `version 4+`, this library will not have options to export to PDF. ### Export as Buffer @@ -14,6 +14,14 @@ Packer.toBuffer(doc).then((buffer) => { }); ``` +### Export as string + +```ts +Packer.toString(doc).then((string) => { + console.log(string); +}); +``` + ### Export as a `base64` string ```ts @@ -32,3 +40,26 @@ Packer.toBlob(doc).then((blob) => { saveAs(blob, "example.docx"); }); ``` + +### Export as a Stream + +```ts +Packer.toStream(doc).then((stream) => { + // read from stream +}); +``` + +### Export using optional arguments + +The `Packer` methods support 2 optional arguments. + +The first is for controlling the indentation of the xml and should be a `boolean` or `keyof typeof PrettifyType`. + +The second is an array of subfile overrides (`{path: string, data: string}[]`). These overrides can be used to write additional subfiles to the result or even override default subfiles in the case that the default handling of these subfiles does not meet your needs. + +```ts +const overrides = [{ path: "word/commentsExtended.xml", data: "string_data" }]; +Packer.toString(doc, true, overrides).then((string) => { + console.log(string); +}); +```