diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index 72b23406eb..132b827e41 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 1f11edfa2a..315ea6fdaf 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 38d9f06cc0..bf8a766eca 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 a73b6ef24f..cb4b77bc60 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 132c7bbb2a..dac346a3f9 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 5c3b400982..f76a777af2 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 7278a6d7a0..f17d433e83 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 bef1eabe53..edb2ce33af 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 395e0f8c5d..4db14a3aea 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 6262ba851f..69224fd5e9 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 9868e506cf..8b2ad84fcc 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 36a70b250e..c229409a11 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 7d09710571..0f0024045f 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 3fafdbf105..b6ad470de4 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 2f2f71be97..1ac49739dc 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 34917f78b4..b0e068a9f1 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 de96f4b56c..38b31d2f71 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 51029f642d..bbd07ab4c7 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 b9519b5cef..dee2937d8f 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 9ea6fa4e7d..38eb85a623 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 ef8417e37c..f2047b4811 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 c31a9bfe75..3180dde173 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 9b26b0940d..c07043cc97 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 2c54966042..5d92ae0bf6 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 8df62fd90e..30903fa9f5 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 23961533b6..e820c9f2a8 100644 --- a/api/classes/Comments.html +++ b/api/classes/Comments.html @@ -1,6 +1,6 @@ -Comments | docx

Class Comments

Hierarchy (View Summary)

Constructors

constructor +Comments | docx

Class Comments

Hierarchy (View Summary)

Constructors

constructor

Accessors

Relationships

Methods

addChildElement prepForXml -

Constructors

constructor

Accessors

Relationships

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

Relationships

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/ConcreteHyperlink.html b/api/classes/ConcreteHyperlink.html index 85dde32a53..1249414422 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 9e1d0a124d..ddbfc5254c 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 59e502f1e3..d49a764d77 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 0b8e6c1181..cdce54ed06 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 4564631779..3af6fcddb2 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 74166b3322..8b02ab93e0 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/Document.html b/api/classes/Document.html index 1fc06e1f80..77fde1c560 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 9c3f51c084..94181185a6 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 84a4e1bbad..3795cf3f73 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 448921e8e7..8a172719da 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 c495edbf2d..3e0d5d3895 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/DotEmphasisMark.html b/api/classes/DotEmphasisMark.html index 14094f2611..ccdca81ee7 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 d789f1e707..dded8e5c11 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 f6239132e6..c747567476 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 6dcc9db814..1a81a4bf5d 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 fc12d9d04c..38ab9a63ce 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 487a401d75..d4f5125e6d 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 a65eff99d9..ce4a2ad4ac 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 5447f8b67b..fc6700c718 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 292de134ae..8975dcf562 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 64f99a5a8c..0194257f60 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 204a07f1cf..f599c5a128 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 ae62bcbb13..4bf0063ad5 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 2f67d2f148..1c4a36c193 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 efb3fd757b..3cbdd6b8fb 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 0c2b890341..deea8cee56 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 1a67752557..44c0e4d014 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 41a1ffc752..4048d1dd8b 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 15d834960c..f1658f45f0 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/HpsMeasureElement.html b/api/classes/HpsMeasureElement.html index b48acf8c52..a8131cc907 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 897724fdd7..54c6ab0d57 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 9ee3cc30c5..6ab0375657 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 a95cd392c8..6da9ba2ee8 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 ececa92002..e2d4f1d8b8 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 8e8db5460a..7666005710 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 26f66f6e0a..ef63d394ee 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 dad46ad422..ece06c1609 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 848f59286b..f2ca0ce3c3 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 4b4cf8c2d9..71dd3e2594 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 b49ff6d9c9..ee76e753d7 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 019981a2a0..96ba3f80a7 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 ecc3756a1d..359920f59e 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 2f1c33dd22..cbcb5f377a 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 349bdf57bd..4c20f18e84 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/MathAngledBrackets.html b/api/classes/MathAngledBrackets.html index 9c56f807ed..093575d7d9 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/MathCurlyBrackets.html b/api/classes/MathCurlyBrackets.html index 19b26bb1b3..83abe5567c 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 bf98f6457b..f5562a381d 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 3df0ee5fce..82b61b03e2 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 bf4132be08..9152f35743 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 dad083b3d3..1c9f51d5bf 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 bb815f0899..0abf4da1e3 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 f4d3b26968..75e54de70d 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 106ac63ac4..e1bb19ff37 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 afde1b2635..8771996f49 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/MathLimitLower.html b/api/classes/MathLimitLower.html index 69d756eba4..e254f59db3 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 aee0f81bc1..eccc41d5e0 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/MathNumerator.html b/api/classes/MathNumerator.html index efb55eb39b..21615c0743 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 135ad58706..df085c68d3 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/MathRadical.html b/api/classes/MathRadical.html index 2bac3e3936..5263fef920 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 924125e151..7b7eafd7c9 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 e138e5335c..eacb730d13 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 d8e05a1ecd..e8f8e758b7 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 04b2836cc0..e4aa5981a9 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 0839199396..f727f9e0c6 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/MathSubSuperScript.html b/api/classes/MathSubSuperScript.html index 2811a51f3b..dab2e6d8a4 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/MathSum.html b/api/classes/MathSum.html index 54c606f997..8993ce1694 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 67c65b2699..689d56e50e 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/Media.html b/api/classes/Media.html index cdc642fbe6..d01e4b0b6d 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 6960139f89..67c4cb9922 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 d22d4c39d9..aab209c34b 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 2b5e687e6a..46ed530c7e 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 5cd51f1d40..5c18f8dce6 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 95a9aaf4db..e81435eec7 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 f0d480ae69..cb10de19b2 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 762b12ebf4..d13044e7cd 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 67af176ed6..e96f496506 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 8c90977917..7476712bc9 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 81f13f60b6..da7ae5221a 100644 --- a/api/classes/Packer.html +++ b/api/classes/Packer.html @@ -1,4 +1,4 @@ -Packer | docx

Class Packer

Constructors

constructor +Packer | docx

Class Packer

Constructors

constructor

Methods

pack toArrayBuffer toBase64String @@ -6,4 +6,4 @@ toBuffer toStream toString -

Constructors

constructor

Methods

Staticpack

StatictoArrayBuffer

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

  • Parameters

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

    Returns Promise<ArrayBuffer>

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
+

Constructors

constructor

Methods

Staticpack

StatictoArrayBuffer

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

  • Parameters

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

    Returns Promise<ArrayBuffer>

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 4b4bc2c470..c4e49c3ffb 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 60dd77a678..ea38a730fd 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 375d44a82d..b8686768dc 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 865463da57..072946bd7a 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 a8fa446fd5..9dc6713069 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 d1e64f9b20..b7b55159e6 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 addf9bfedd..0457e35825 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 14617c5562..c53ccd3ea1 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/PageTextDirection.html b/api/classes/PageTextDirection.html index f8bf42c04d..cfe3bbc54c 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 d4bce1771b..a662737936 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 02ceac6367..7ae6d63041 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 cfd51fc58f..cf8e8280e0 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 716d4eb263..c6495343a8 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 0a33f5b1c5..461dcc10fe 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 41d74bf7c9..8f505a6178 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 49e1acd3dc..b89169c3e9 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 504b270ddc..7dcf3cb452 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 0480dddae8..f3b2a5e063 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 8061ba7336..e6eee81b4b 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 ce0218f4c7..d7f89a14fa 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 d322958c39..afcc3a70e0 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 1dfb5541c9..58b2a68ae0 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 ad143cc38e..1977341e34 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 2f5fc59bee..e5b04ea06e 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 3e908fb4f3..6d810fd51d 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/SoftHyphen.html b/api/classes/SoftHyphen.html index c73e09d453..7e5d551769 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 c4cd0b2fe5..52c1574f22 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 2b82fe319d..2d8326ac35 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 ceb9c0f262..7ad1d2afa6 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 3771091213..c37bf65c9e 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 2ca32ac026..d5a938624c 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 aef1e56fe8..b4b420b861 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 5ca609c8a2..5fc3a6aeb7 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 2c3985d443..24b32051c7 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 b01996bd60..a1d9f6dcfa 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 7de19425d2..f934336b1b 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 851c07449b..2b5927c1c4 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 d828d808e9..2fd33912f8 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 f7ac2a404c..c9dc0912fa 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 451e8406f4..36659981ae 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 59fa39450e..223a0c5c8f 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 522dab460e..ceaccf2c39 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 868b80d64b..07551192c3 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 194329e554..90647c2dba 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 27512fe9c6..279b0ca359 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 5d66253f05..fe1f0e3139 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 c33a6dc294..7e43e8b22c 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 d68f8af6bb..611ea52439 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 f28bbb71be..f44f6aed1d 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 dd0c0acc06..494cc78da4 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 70cb9c2ffb..30c8191472 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 438c9966a6..da32a7c759 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 dfc0679d29..887040a44f 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 1f7104fcdc..6d785d27c8 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 e16211662b..1028c164c5 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 714b992cc7..3ecffbddb3 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 f18bcc681a..5a91d5ccd5 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 18901e6804..f1847a7be4 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 702f6eb75d..f6d769b476 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 d567fe9e8e..748b8f6ad2 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 467c05997a..ff4a3c4e66 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 b452fb3151..49a17f96d7 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/WrapNone.html b/api/classes/WrapNone.html index a2f1993556..2699a27a51 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 4666eb1911..fe6f89cbae 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 5126b60d5d..30520abf6a 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 6c1b380120..8217189e57 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 4867bdf038..edf26129e2 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 c3b1b2ed1e..e567f00baa 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 ab851d003d..7076560d17 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 0b5087c774..1714f2eeaf 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 f86f5cd4df..462a1a06a6 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 a638635d08..3e5744b46d 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 f7d2d6f150..9cabb956c8 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 a77bf9f8f2..3fd46b18d2 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 bf531a55f7..218ca44ec0 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 005e44d5be..9aa638bea3 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/createDocumentGrid.html b/api/functions/createDocumentGrid.html index ec6edadc46..7d6d9d5ce9 100644 --- a/api/functions/createDocumentGrid.html +++ b/api/functions/createDocumentGrid.html @@ -7,4 +7,4 @@ -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/functions/createFrameProperties.html b/api/functions/createFrameProperties.html index 5093260434..0d387dad83 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/createHorizontalPosition.html b/api/functions/createHorizontalPosition.html index 71e7ee7fbd..9d6b5104d6 100644 --- a/api/functions/createHorizontalPosition.html +++ b/api/functions/createHorizontalPosition.html @@ -1,3 +1,3 @@ createHorizontalPosition | docx

Function createHorizontalPosition

Horizontal Positioning

Reference: https://www.datypic.com/sc/ooxml/e-wp_positionH-1.html

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/functions/createLineNumberType.html b/api/functions/createLineNumberType.html index ea2bb17c02..999e12255b 100644 --- a/api/functions/createLineNumberType.html +++ b/api/functions/createLineNumberType.html @@ -12,4 +12,4 @@ -

Settings

Member Visibility

On This Page

XSD Schema
+

Settings

Member Visibility

On This Page

XSD Schema
diff --git a/api/functions/createMathAccentCharacter.html b/api/functions/createMathAccentCharacter.html index 5328594557..f78b0d21f3 100644 --- a/api/functions/createMathAccentCharacter.html +++ b/api/functions/createMathAccentCharacter.html @@ -1 +1 @@ -createMathAccentCharacter | docx

Function createMathAccentCharacter

Settings

Member Visibility
+createMathAccentCharacter | docx

Function createMathAccentCharacter

Settings

Member Visibility
diff --git a/api/functions/createMathBase.html b/api/functions/createMathBase.html index bb0fefc099..21ce24ad2c 100644 --- a/api/functions/createMathBase.html +++ b/api/functions/createMathBase.html @@ -1 +1 @@ -createMathBase | docx

Function createMathBase

Settings

Member Visibility
+createMathBase | docx

Function createMathBase

Settings

Member Visibility
diff --git a/api/functions/createMathLimitLocation.html b/api/functions/createMathLimitLocation.html index 65bf5c670d..818272d418 100644 --- a/api/functions/createMathLimitLocation.html +++ b/api/functions/createMathLimitLocation.html @@ -1 +1 @@ -createMathLimitLocation | docx

Function createMathLimitLocation

Settings

Member Visibility
+createMathLimitLocation | docx

Function createMathLimitLocation

Settings

Member Visibility
diff --git a/api/functions/createMathNAryProperties.html b/api/functions/createMathNAryProperties.html index f70541fee8..ad8de39ada 100644 --- a/api/functions/createMathNAryProperties.html +++ b/api/functions/createMathNAryProperties.html @@ -1 +1 @@ -createMathNAryProperties | docx

Function createMathNAryProperties

Settings

Member Visibility
+createMathNAryProperties | docx

Function createMathNAryProperties

Settings

Member Visibility
diff --git a/api/functions/createMathPreSubSuperScriptProperties.html b/api/functions/createMathPreSubSuperScriptProperties.html index 0117123350..efa7e9b537 100644 --- a/api/functions/createMathPreSubSuperScriptProperties.html +++ b/api/functions/createMathPreSubSuperScriptProperties.html @@ -1 +1 @@ -createMathPreSubSuperScriptProperties | docx

Function createMathPreSubSuperScriptProperties

Settings

Member Visibility
+createMathPreSubSuperScriptProperties | docx

Function createMathPreSubSuperScriptProperties

Settings

Member Visibility
diff --git a/api/functions/createMathSubScriptElement.html b/api/functions/createMathSubScriptElement.html index 53edcc0812..7650cba479 100644 --- a/api/functions/createMathSubScriptElement.html +++ b/api/functions/createMathSubScriptElement.html @@ -1 +1 @@ -createMathSubScriptElement | docx

Function createMathSubScriptElement

Settings

Member Visibility
+createMathSubScriptElement | docx

Function createMathSubScriptElement

Settings

Member Visibility
diff --git a/api/functions/createMathSubScriptProperties.html b/api/functions/createMathSubScriptProperties.html index 4d6c944257..ec24fbbe81 100644 --- a/api/functions/createMathSubScriptProperties.html +++ b/api/functions/createMathSubScriptProperties.html @@ -1 +1 @@ -createMathSubScriptProperties | docx

Function createMathSubScriptProperties

Settings

Member Visibility
+createMathSubScriptProperties | docx

Function createMathSubScriptProperties

Settings

Member Visibility
diff --git a/api/functions/createMathSubSuperScriptProperties.html b/api/functions/createMathSubSuperScriptProperties.html index 3b0e65cac9..291b92ec9a 100644 --- a/api/functions/createMathSubSuperScriptProperties.html +++ b/api/functions/createMathSubSuperScriptProperties.html @@ -1 +1 @@ -createMathSubSuperScriptProperties | docx

Function createMathSubSuperScriptProperties

Settings

Member Visibility
+createMathSubSuperScriptProperties | docx

Function createMathSubSuperScriptProperties

Settings

Member Visibility
diff --git a/api/functions/createMathSuperScriptElement.html b/api/functions/createMathSuperScriptElement.html index 402448b4c7..d9c8f39df5 100644 --- a/api/functions/createMathSuperScriptElement.html +++ b/api/functions/createMathSuperScriptElement.html @@ -1 +1 @@ -createMathSuperScriptElement | docx

Function createMathSuperScriptElement

Settings

Member Visibility
+createMathSuperScriptElement | docx

Function createMathSuperScriptElement

Settings

Member Visibility
diff --git a/api/functions/createMathSuperScriptProperties.html b/api/functions/createMathSuperScriptProperties.html index 399486dc28..6441c1eb3b 100644 --- a/api/functions/createMathSuperScriptProperties.html +++ b/api/functions/createMathSuperScriptProperties.html @@ -1 +1 @@ -createMathSuperScriptProperties | docx

Function createMathSuperScriptProperties

Settings

Member Visibility
+createMathSuperScriptProperties | docx

Function createMathSuperScriptProperties

Settings

Member Visibility
diff --git a/api/functions/createPageSize.html b/api/functions/createPageSize.html index f77796f390..8a9e16cbd1 100644 --- a/api/functions/createPageSize.html +++ b/api/functions/createPageSize.html @@ -8,4 +8,4 @@ -

Settings

Member Visibility

On This Page

XSD Schema
+

Settings

Member Visibility

On This Page

XSD Schema
diff --git a/api/functions/createSimplePos.html b/api/functions/createSimplePos.html index 773c63131f..1b367e26c7 100644 --- a/api/functions/createSimplePos.html +++ b/api/functions/createSimplePos.html @@ -10,4 +10,4 @@ -

Settings

Member Visibility

On This Page

Simple Positioning Coordinates
+

Settings

Member Visibility

On This Page

Simple Positioning Coordinates
diff --git a/api/functions/createStringElement.html b/api/functions/createStringElement.html index c331000f57..514a19f371 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/createVerticalPosition.html b/api/functions/createVerticalPosition.html index 2d8f2e02d1..75b64e7fb6 100644 --- a/api/functions/createVerticalPosition.html +++ b/api/functions/createVerticalPosition.html @@ -1,4 +1,4 @@ createVerticalPosition | docx

Function createVerticalPosition

Vertical Positioning

This simple type specifies the possible values for the base from which the relative vertical positioning of an object shall be calculated.

Reference: https://www.datypic.com/sc/ooxml/e-wp_positionV-1.html

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/functions/dateTimeValue.html b/api/functions/dateTimeValue.html index b8b3d29c12..93672800c8 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 c08e67e05b..f5cb52da2d 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 8f46cc77ab..21c36a00d7 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 92d77fdee3..9e70955d56 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 019dc5c4d6..6e7d74cb70 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 023e151c0a..4a444de466 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 344664dd86..217804b0cb 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 0214429154..b07607e16d 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 906592ffa2..aac81d109c 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 211f6d4aad..9584fe72dc 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 69a9662974..ffd4f90162 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 8a2adc313e..165769616c 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 75f7dd0bff..2abb1ccf9d 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 eda5929720..334d536bd1 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 0a4f2f30e2..7de8957e8e 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 dca983e99f..59df3a4a60 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 283f2f1fe6..882f48adcc 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 23c1db628b..037c1447e7 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 fca292de8d..fce21c90b3 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 ad1d959997..7b8fd6c310 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 421edae9e4..a41698e50a 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 5c2d43d2cb..e512c93361 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 85b2b95088..73f97a22aa 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 3006a63adb..2fffcf910b 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 031fcb4ed6..8f271f4e55 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 10eb37b85d..faf69d564b 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 c558b728e3..1dbf20e78e 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 3e1a4485ae..e1e3183b8a 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 55233e871b..a920012290 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 d0f094c011..52be98c048 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 916116f1f6..2b60d3bc77 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 65a837c307..694841989b 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 39e5c073a3..f1a2f9e798 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 23fb6dacf8..c96cd3cb71 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 1b229e3b24..03c9e7ecdf 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 886102671a..7d80d2e768 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 381b1bbcc8..bd4038988a 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 284742fdf1..ed99b60ed0 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 d3bcdd442a..95f2774b68 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 bf72fbeef4..0c30c140d1 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 b7fb724ae1..b47dedba25 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 652daacc86..1a6130bb33 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 677713add8..4499a90bc1 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 3ac0eb259a..6314a5677e 100644 --- a/api/types/IDocGridAttributesProperties.html +++ b/api/types/IDocGridAttributesProperties.html @@ -19,4 +19,4 @@

    The possible values for this attribute are defined by the ST_DecimalNumber simple type (§2.18.16).

  • Optional Readonlytype?: typeof DocumentGridType[keyof typeof DocumentGridType]

    Specifies the type of the current document grid, which defines the grid behavior.

    The grid can define a grid which snaps all East Asian characters to grid positions, but leaves Latin text with its default spacing; a grid which adds the specified character pitch to each character on each row; or a grid which affects only the line pitch for the current section.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/types/IDocumentAttributesProperties.html b/api/types/IDocumentAttributesProperties.html index 81fe9589c8..979ddc7600 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 895666a546..e810107579 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 9f8550d3ee..31e63886df 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 d092222659..bc19d9c478 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 79dc174e17..ea2c1f4fc9 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 b6d8b185df..97f6086df3 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 6fa4822c8b..f5b284057b 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 dea50c9bed..ee0d312808 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 f5fe3d872f..290e9f124e 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 7a938f9448..d201a903c9 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 36f3487581..a96ba78943 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 8fc5a94e33..ab1fd6864a 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 e5f58ae33a..424825b584 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 6d2403abdb..0d8bc360d4 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 b28e1317e6..d082759bf5 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 65ea4fca82..a2bd11cc65 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 d2e626d62b..59a1cd743b 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 95a77457c5..df5fb01ffc 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 56962151c7..6313156a92 100644 --- a/api/types/ILineNumberAttributes.html +++ b/api/types/ILineNumberAttributes.html @@ -26,4 +26,4 @@

    The start attribute specifies that line numbers shall be counted starting from the number 3.

    The possible values for this attribute are defined by the ST_DecimalNumber simple type (§2.18.16).

    -

    Settings

    Member Visibility

    On This Page

    Line Numbering Restart SettingLine Numbering Starting Value
    +

    Settings

    Member Visibility

    On This Page

    Line Numbering Restart SettingLine Numbering Starting Value
    diff --git a/api/types/IMargins.html b/api/types/IMargins.html index 4dcd4a9e1c..aa53f96871 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 50d998cb22..8712e8bfd4 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 c79c68679a..07bc90066e 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 5f1302361b..5783872cda 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 5028d3db45..0e3870b762 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 2a78588868..d6588a95f3 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 5c1413fd98..a840c21674 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 0dfaeb64a2..ba9435216f 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 eee8e364e5..ea7ef8566a 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 10fdb7395c..4f62aef934 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 8449a776f9..82856142be 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 a4698224ba..220b7474d8 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 738af2d122..a9945692eb 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 eaf87512dc..8c8f4dfd40 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 3cae9e8d08..d452f3fabb 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 b32bb3afd6..2b9fdaee22 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 87148640a9..f48a2580e3 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 422472ed56..cb0cb27783 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 5070f5c686..d5fbd339d5 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 221350833d..b049b6177d 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 5983d40d98..30a938ee47 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 9011c574d0..548995b248 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 88e75c68c6..0466cbb732 100644 --- a/api/types/IPageSizeAttributes.html +++ b/api/types/IPageSizeAttributes.html @@ -23,4 +23,4 @@

    All pages in this section are displayed on a page that is 15840 twentieths of a point (11") wide.

    The possible values for this attribute are defined by the ST_TwipsMeasure simple type (§2.18.105).

    -

    Settings

    Member Visibility

    On This Page

    Printer Paper CodePage HeightPage OrientationPage Width
    +

    Settings

    Member Visibility

    On This Page

    Printer Paper CodePage HeightPage OrientationPage Width
    diff --git a/api/types/IParagraphOptions.html b/api/types/IParagraphOptions.html index 7dfe1c0a64..a063da14c8 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 e1739af4d8..5ea8e979a6 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;
        bullet?: { level: number };
        frame?: IFrameOptions;
        heading?: typeof HeadingLevel[keyof typeof HeadingLevel];
        overflowPunctuation?: boolean;
        pageBreakBefore?: boolean;
        run?: IRunOptions;
        scale?: number;
        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 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 Readonlystyle?: string
    • Optional ReadonlysuppressLineNumbers?: boolean
    • Optional ReadonlytabStops?: readonly TabStopDefinition[]
    • Optional ReadonlywidowControl?: boolean
    • Optional ReadonlywordWrap?: boolean

    Settings

    Member Visibility
    +
  • Optional Readonlyscale?: number
  • 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 873a94236f..002390940d 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 f475b137a5..2d60f5f0f9 100644 --- a/api/types/IParagraphStylePropertiesOptions.html +++ b/api/types/IParagraphStylePropertiesOptions.html @@ -1 +1 @@ -IParagraphStylePropertiesOptions | docx

    Type Alias IParagraphStylePropertiesOptions

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

    Settings

    Member Visibility
    +IParagraphStylePropertiesOptions | docx

    Type Alias IParagraphStylePropertiesOptions

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

    Settings

    Member Visibility
    diff --git a/api/types/IPatch.html b/api/types/IPatch.html index c138249373..eff7cbc2f1 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/IPropertiesOptions.html b/api/types/IPropertiesOptions.html index 4d40a244a2..4213ff7ef1 100644 --- a/api/types/IPropertiesOptions.html +++ b/api/types/IPropertiesOptions.html @@ -1 +1 @@ -IPropertiesOptions | docx

    Type Alias IPropertiesOptions

    IPropertiesOptions: {
        background?: IDocumentBackgroundOptions;
        comments?: ICommentsOptions;
        compatabilityModeVersion?: number;
        compatibility?: ICompatibilityOptions;
        creator?: string;
        customProperties?: readonly ICustomPropertyOptions[];
        defaultTabStop?: number;
        description?: string;
        evenAndOddHeaderAndFooters?: boolean;
        externalStyles?: string;
        features?: { trackRevisions?: boolean; updateFields?: boolean };
        fonts?: readonly FontOptions[];
        footnotes?: Readonly<Record<string, { children: readonly Paragraph[] }>>;
        hyphenation?: IHyphenationOptions;
        keywords?: string;
        lastModifiedBy?: string;
        numbering?: INumberingOptions;
        revision?: number;
        sections: readonly ISectionOptions[];
        styles?: IStylesOptions;
        subject?: string;
        title?: string;
    }

    Type declaration

    • Optional Readonlybackground?: IDocumentBackgroundOptions
    • Optional Readonlycomments?: ICommentsOptions
    • Optional ReadonlycompatabilityModeVersion?: number
    • Optional Readonlycompatibility?: ICompatibilityOptions
    • Optional Readonlycreator?: string
    • Optional ReadonlycustomProperties?: readonly ICustomPropertyOptions[]
    • Optional ReadonlydefaultTabStop?: number
    • Optional Readonlydescription?: string
    • Optional ReadonlyevenAndOddHeaderAndFooters?: boolean
    • Optional ReadonlyexternalStyles?: string
    • Optional Readonlyfeatures?: { trackRevisions?: boolean; updateFields?: boolean }
    • Optional Readonlyfonts?: readonly FontOptions[]
    • Optional Readonlyfootnotes?: Readonly<Record<string, { children: readonly Paragraph[] }>>
    • Optional Readonlyhyphenation?: IHyphenationOptions
    • Optional Readonlykeywords?: string
    • Optional ReadonlylastModifiedBy?: string
    • Optional Readonlynumbering?: INumberingOptions
    • Optional Readonlyrevision?: number
    • Readonlysections: readonly ISectionOptions[]
    • Optional Readonlystyles?: IStylesOptions
    • Optional Readonlysubject?: string
    • Optional Readonlytitle?: string

    Settings

    Member Visibility
    +IPropertiesOptions | docx

    Type Alias IPropertiesOptions

    IPropertiesOptions: {
        background?: IDocumentBackgroundOptions;
        comments?: ICommentsOptions;
        compatabilityModeVersion?: number;
        compatibility?: ICompatibilityOptions;
        creator?: string;
        customProperties?: readonly ICustomPropertyOptions[];
        defaultTabStop?: number;
        description?: string;
        evenAndOddHeaderAndFooters?: boolean;
        externalStyles?: string;
        features?: { trackRevisions?: boolean; updateFields?: boolean };
        fonts?: readonly FontOptions[];
        footnotes?: Readonly<Record<string, { children: readonly Paragraph[] }>>;
        hyphenation?: IHyphenationOptions;
        keywords?: string;
        lastModifiedBy?: string;
        numbering?: INumberingOptions;
        revision?: number;
        sections: readonly ISectionOptions[];
        styles?: IStylesOptions;
        subject?: string;
        title?: string;
    }

    Type declaration

    • Optional Readonlybackground?: IDocumentBackgroundOptions
    • Optional Readonlycomments?: ICommentsOptions
    • Optional ReadonlycompatabilityModeVersion?: number
    • Optional Readonlycompatibility?: ICompatibilityOptions
    • Optional Readonlycreator?: string
    • Optional ReadonlycustomProperties?: readonly ICustomPropertyOptions[]
    • Optional ReadonlydefaultTabStop?: number
    • Optional Readonlydescription?: string
    • Optional ReadonlyevenAndOddHeaderAndFooters?: boolean
    • Optional ReadonlyexternalStyles?: string
    • Optional Readonlyfeatures?: { trackRevisions?: boolean; updateFields?: boolean }
    • Optional Readonlyfonts?: readonly FontOptions[]
    • Optional Readonlyfootnotes?: Readonly<Record<string, { children: readonly Paragraph[] }>>
    • Optional Readonlyhyphenation?: IHyphenationOptions
    • Optional Readonlykeywords?: string
    • Optional ReadonlylastModifiedBy?: string
    • Optional Readonlynumbering?: INumberingOptions
    • Optional Readonlyrevision?: number
    • Readonlysections: readonly ISectionOptions[]
    • Optional Readonlystyles?: IStylesOptions
    • Optional Readonlysubject?: string
    • Optional Readonlytitle?: string

    Settings

    Member Visibility
    diff --git a/api/types/IRunOptions.html b/api/types/IRunOptions.html index 64eb036739..cf26e1c09f 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 3b9feac073..18df9ebed2 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 7fa8c58326..4e36e76b8d 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 ea9cd13f80..435f7d10e2 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 e03858ee70..bc2a55b765 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 a49754b7f7..4296f99d86 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?: Partial<IDocGridAttributesProperties>;
        headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
        lineNumbers?: ILineNumberAttributes;
        page?: {
            borders?: IPageBordersOptions;
            margin?: IPageMarginAttributes;
            pageNumbers?: IPageNumberTypeAttributes;
            size?: Partial<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?: Partial<IDocGridAttributesProperties>;
        headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>;
        lineNumbers?: ILineNumberAttributes;
        page?: {
            borders?: IPageBordersOptions;
            margin?: IPageMarginAttributes;
            pageNumbers?: IPageNumberTypeAttributes;
            size?: Partial<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 11c8b294b5..0c1036dc04 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 691e76fd62..5b3a018159 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 bc87fbee74..98ad710d06 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 685fc553cc..cdac4b0839 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 e1038a2f63..cb399e7564 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 0d03292897..29f1b4381b 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 7ee1af0725..49b50ff22b 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 bcdac35062..c27261e082 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 2783f7b46e..1f1ddc3f6a 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 170efd7692..a6de7492b1 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 e0efd7d00f..0a13e6479a 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 613eee2bd1..d9d136bbb7 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 4223e3da11..8aaa07cfab 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 850393a2ca..6a2f8244fb 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 6d60440205..ad972f58d9 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 bc90ac98e7..62c1c850f4 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 40707594b9..40fe97f81f 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 25b3439854..bd69ccc85e 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 82711772c5..2046210f11 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 08953e8c7d..87fe04a546 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/OutputByType.html b/api/types/OutputByType.html index 947d6029a5..c82b92d5d9 100644 --- a/api/types/OutputByType.html +++ b/api/types/OutputByType.html @@ -1 +1 @@ -OutputByType | docx

    Type Alias OutputByType

    OutputByType: {
        array: readonly number[];
        arraybuffer: ArrayBuffer;
        base64: string;
        binarystring: string;
        blob: Blob;
        nodebuffer: Buffer;
        string: string;
        text: string;
        uint8array: Uint8Array;
    }

    Type declaration

    • Readonlyarray: readonly number[]
    • Readonlyarraybuffer: ArrayBuffer
    • Readonlybase64: string
    • Readonlybinarystring: string
    • Readonlyblob: Blob
    • Readonlynodebuffer: Buffer
    • Readonlystring: string
    • Readonlytext: string
    • Readonlyuint8array: Uint8Array

    Settings

    Member Visibility
    +OutputByType | docx

    Type Alias OutputByType

    OutputByType: {
        array: readonly number[];
        arraybuffer: ArrayBuffer;
        base64: string;
        binarystring: string;
        blob: Blob;
        nodebuffer: Buffer;
        string: string;
        text: string;
        uint8array: Uint8Array;
    }

    Type declaration

    • Readonlyarray: readonly number[]
    • Readonlyarraybuffer: ArrayBuffer
    • Readonlybase64: string
    • Readonlybinarystring: string
    • Readonlyblob: Blob
    • Readonlynodebuffer: Buffer
    • Readonlystring: string
    • Readonlytext: string
    • Readonlyuint8array: Uint8Array

    Settings

    Member Visibility
    diff --git a/api/types/OutputType.html b/api/types/OutputType.html index e6d260431e..f761c94ef8 100644 --- a/api/types/OutputType.html +++ b/api/types/OutputType.html @@ -1 +1 @@ -OutputType | docx

    Type Alias OutputType

    OutputType: keyof OutputByType

    Settings

    Member Visibility
    +OutputType | docx

    Type Alias OutputType

    OutputType: keyof OutputByType

    Settings

    Member Visibility
    diff --git a/api/types/ParagraphChild.html b/api/types/ParagraphChild.html index 7d477027ea..23c7132915 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 20de488de2..4d0f36b12b 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>>;
        placeholderDelimiters?: Readonly<{ end: string; start: string }>;
    }

    Type Parameters

    Type declaration

    • Readonlydata: InputDataType
    • Optional ReadonlykeepOriginalStyles?: boolean
    • ReadonlyoutputType: T
    • Readonlypatches: Readonly<Record<string, IPatch>>
    • Optional ReadonlyplaceholderDelimiters?: Readonly<{ end: string; start: string }>

    Settings

    Member Visibility
    +PatchDocumentOptions | docx

    Type Alias PatchDocumentOptions<T>

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

    Type Parameters

    Type declaration

    • Readonlydata: InputDataType
    • Optional ReadonlykeepOriginalStyles?: boolean
    • ReadonlyoutputType: T
    • Readonlypatches: Readonly<Record<string, IPatch>>
    • Optional ReadonlyplaceholderDelimiters?: Readonly<{ end: string; start: string }>

    Settings

    Member Visibility
    diff --git a/api/types/PatchDocumentOutputType.html b/api/types/PatchDocumentOutputType.html index dee7999bfb..70548d9c7f 100644 --- a/api/types/PatchDocumentOutputType.html +++ b/api/types/PatchDocumentOutputType.html @@ -1 +1 @@ -PatchDocumentOutputType | docx

    Type Alias PatchDocumentOutputType

    PatchDocumentOutputType: OutputType

    Settings

    Member Visibility
    +PatchDocumentOutputType | docx

    Type Alias PatchDocumentOutputType

    PatchDocumentOutputType: OutputType

    Settings

    Member Visibility
    diff --git a/api/types/Percentage.html b/api/types/Percentage.html index 8047269eba..4bda8d1ad6 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 30d8c676a5..5bf2e3354b 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 79087da03f..ced8206c5d 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 a0289518ed..cd89f804cc 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 c89d6c2141..c4616b3a98 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 92036b0d58..df10cac557 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 c1144c9d69..5659f8e165 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 ee01efab0e..88cff91453 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 1e59c3b6cf..4fee6922ce 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 8172221fa1..e161f8069c 100644 --- a/api/variables/BorderStyle.html +++ b/api/variables/BorderStyle.html @@ -61,4 +61,4 @@
  • ReadonlyTHREE_D_ENGRAVE: "threeDEngrave"

    a three-staged gradient like, getting darker away from the paragraph

  • ReadonlyTRIPLE: "triple"

    a triple line

  • ReadonlyWAVE: "wave"

    a wavy line

    -

    • Settings

    Member Visibility

    On This Page

    XSD Schema
    +

    Settings

    Member Visibility

    On This Page

    XSD Schema
    diff --git a/api/variables/CharacterSet.html b/api/variables/CharacterSet.html index 24d8aa8917..4f7ad53461 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 771d4b1e59..afb78c08a4 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 cd4f448546..bd94ce4b41 100644 --- a/api/variables/DocumentGridType.html +++ b/api/variables/DocumentGridType.html @@ -17,4 +17,4 @@

    When this value is set, the input specified via the user interface may be allowed in exact number of line/character pitch units.

  • ReadonlySNAP_TO_CHARS: "snapToChars"

    Specifies that the parent section shall have both the additional line pitch and character pitch added to each line and character within it (as specified on the element (§2.6.5)) in order to maintain a specific number of lines per page and characters per line.

    When this value is set, the input specified via the user interface may be restricted to the number of lines per page and characters per line, with the consumer or producer translating this information based on the current font data to get the resulting line and character pitch values

    -

    • Settings

    Member Visibility

    On This Page

    XSD Schema
    +

    Settings

    Member Visibility

    On This Page

    XSD Schema
    diff --git a/api/variables/DropCapType.html b/api/variables/DropCapType.html index fe5808e307..40d8562ba9 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 ac08b315c8..c0b4e8295a 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 210363e0bb..9982c6c24c 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 6b02db66f3..b962b88a92 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 62bf9de901..287cc97021 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 ce6bada7f2..2613764389 100644 --- a/api/variables/HeaderFooterReferenceType.html +++ b/api/variables/HeaderFooterReferenceType.html @@ -12,4 +12,4 @@

        Type declaration

        Settings

        Member Visibility

        On This Page

        XSD Schema
        +

        Settings

        Member Visibility

        On This Page

        XSD Schema
        diff --git a/api/variables/HeaderFooterType.html b/api/variables/HeaderFooterType.html index 6031d13baa..3c8cdbec03 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 ee9bdb0713..e6e38fbccb 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 dc0157993f..604f31b49f 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 f96fb06882..30db705da0 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 17f5fa6de6..7af53fba7a 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 bc1a609e31..27d77f5ee0 100644 --- a/api/variables/HorizontalPositionRelativeFrom.html +++ b/api/variables/HorizontalPositionRelativeFrom.html @@ -8,4 +8,4 @@
      • ReadonlyOUTSIDE_MARGIN: "outsideMargin"

        Outside Margin

        Specifies that the horizontal positioning shall be relative to the outside margin of the current page (the right margin on odd pages, left on even pages).

      • ReadonlyPAGE: "page"

        Page Edge

        Specifies that the horizontal positioning shall be relative to the edge of the page.

      • ReadonlyRIGHT_MARGIN: "rightMargin"

        Right Margin

        Specifies that the horizontal positioning shall be relative to the right margin of the page.

        -

        • Settings

        Member Visibility

        On This Page

        CharacterColumnInside MarginLeft MarginPage MarginOutside MarginPage EdgeRight Margin
        +

        Settings

        Member Visibility

        On This Page

        CharacterColumnInside MarginLeft MarginPage MarginOutside MarginPage EdgeRight Margin
        diff --git a/api/variables/HyperlinkType.html b/api/variables/HyperlinkType.html index f4b11fc1ab..9579233a88 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 5e292c7d04..02410aed69 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 b2132e4bee..b1f0056574 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 078270bfca..da655ebf50 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 a89a5f1210..e6dd133f04 100644 --- a/api/variables/LineNumberRestartFormat.html +++ b/api/variables/LineNumberRestartFormat.html @@ -12,4 +12,4 @@

        Type declaration

        Settings

        Member Visibility

        On This Page

        XSD SchemaContinue Line Numbering From Previous SectionRestart Line Numbering on Each PageRestart Line Numbering for Each Section
        +

        Settings

        Member Visibility

        On This Page

        XSD SchemaContinue Line Numbering From Previous SectionRestart Line Numbering on Each PageRestart Line Numbering for Each Section
        diff --git a/api/variables/LineRuleType.html b/api/variables/LineRuleType.html index 91e4354c85..08e9774a38 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 250a2f82f7..bf082f38b6 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 bdbd1437ff..ae1c2e0ba7 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 79a1930fbc..e3d3413bb7 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 6f369cec3b..bcee9752ff 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 874c6a9aec..5d72e1060a 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 9276415105..aac531384a 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 a48ea00685..c99567a352 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 1298b10c2b..69b2d8d1d7 100644 --- a/api/variables/PageOrientation.html +++ b/api/variables/PageOrientation.html @@ -10,4 +10,4 @@

        Type declaration

        Settings

        Member Visibility

        On This Page

        XSD SchemaLandscape ModePortrait Mode
        +

        Settings

        Member Visibility

        On This Page

        XSD SchemaLandscape ModePortrait Mode
        diff --git a/api/variables/PageTextDirectionType.html b/api/variables/PageTextDirectionType.html index dc0be9130f..92d45d9ea9 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 3bc5091a6d..6689e3ff3a 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 3b8669a2c0..be21bc5fe8 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 6bdea08a45..7321ae9917 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 56a79f942f..e7bbc56e92 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 bd9acad0ee..e93a988675 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 d6705e4be4..40b1e92b0c 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 6847a8cd39..72da1d1c7e 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 1a5fa49335..4830e0d87d 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 f32aac187c..cb02697df2 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 01bf3b4d6a..b1248fbd88 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 71efcdfbe5..2f28e0a1cd 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 63c2f3340e..b38525fe45 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 93d348ade1..807fa5acf1 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 c00033ab29..0c1bce8f6c 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 67f8449fcf..bea920d559 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 66a30f5c44..160867de18 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 660e3eed45..c518b27611 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 7ed44a1ff5..950df190b4 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 ec1659fac7..0b731c2f10 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 337e998dd6..e803c78a3a 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 6a45c78143..bed84dc1d6 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 3a65305e4c..85b6fee78b 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 0eabd2a044..b9b8da8f18 100644 --- a/api/variables/VerticalPositionRelativeFrom.html +++ b/api/variables/VerticalPositionRelativeFrom.html @@ -8,4 +8,4 @@
      • ReadonlyPAGE: "page"

        Page Edge

        Specifies that the vertical positioning shall be relative to the edge of the page.

      • ReadonlyPARAGRAPH: "paragraph"

        Paragraph

        Specifies that the vertical positioning shall be relative to the paragraph which contains the drawing anchor.

      • ReadonlyTOP_MARGIN: "topMargin"

        Top Margin

        Specifies that the vertical positioning shall be relative to the top margin of the current page.

        -

        • Settings

        Member Visibility

        On This Page

        Bottom MarginInside MarginLinePage MarginOutside MarginPage EdgeParagraphTop Margin
        +

        Settings

        Member Visibility

        On This Page

        Bottom MarginInside MarginLinePage MarginOutside MarginPage EdgeParagraphTop Margin
        diff --git a/api/variables/WidthType.html b/api/variables/WidthType.html index b9a84fa0b3..3f83ee3ae5 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 2d994170d8..23047a562d 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 e41f2525ad..57413850bc 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