diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index 3a6b697e50..1c1ff5a2b0 100644 --- a/api/classes/AbstractNumbering.html +++ b/api/classes/AbstractNumbering.html @@ -1,6 +1,6 @@ -AbstractNumbering | docx

ClassAbstractNumbering

Hierarchy (view full)

Constructors

constructor +AbstractNumbering | docx

ClassAbstractNumbering

Hierarchy (view full)

Constructors

constructor

Properties

id

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyid

id: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyid

id: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Alignment.html b/api/classes/Alignment.html index d6264b2583..1f3eca459d 100644 --- a/api/classes/Alignment.html +++ b/api/classes/Alignment.html @@ -1,5 +1,5 @@ -Alignment | docx

ClassAlignment

Hierarchy (view full)

Constructors

constructor +Alignment | docx

ClassAlignment

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/AlignmentAttributes.html b/api/classes/AlignmentAttributes.html index 16642a07fe..d550402ba8 100644 --- a/api/classes/AlignmentAttributes.html +++ b/api/classes/AlignmentAttributes.html @@ -1,3 +1,3 @@ -AlignmentAttributes | docx

ClassAlignmentAttributes

Hierarchy (view full)

Constructors

constructor +AlignmentAttributes | docx

ClassAlignmentAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new AlignmentAttributes(root): AlignmentAttributes

  • Parameters

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

    Returns AlignmentAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new AlignmentAttributes(root): AlignmentAttributes

  • Parameters

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

    Returns AlignmentAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/AnnotationReference.html b/api/classes/AnnotationReference.html index fdad01ea9d..3b9d56e5c6 100644 --- a/api/classes/AnnotationReference.html +++ b/api/classes/AnnotationReference.html @@ -1,5 +1,5 @@ -AnnotationReference | docx

ClassAnnotationReference

Hierarchy (view full)

Constructors

constructor +AnnotationReference | docx

ClassAnnotationReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Attributes.html b/api/classes/Attributes.html index df78d4b26f..9d90e1869d 100644 --- a/api/classes/Attributes.html +++ b/api/classes/Attributes.html @@ -1,3 +1,3 @@ -Attributes | docx

ClassAttributes

Hierarchy (view full)

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

Constructors

constructor +Attributes | docx

ClassAttributes

Hierarchy (view full)

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

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new Attributes(root): Attributes

  • Parameters

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

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new Attributes(root): Attributes

  • Parameters

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

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

On This Page

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

ClassBaseEmphasisMarkAbstract

Hierarchy (view full)

Methods

addChildElement +BaseEmphasisMark | docx

ClassBaseEmphasisMarkAbstract

Hierarchy (view full)

Methods

addChildElement prepForXml

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Methods
+

prepForXml

Settings

Member Visibility

On This Page

Methods
diff --git a/api/classes/BaseXmlComponent.html b/api/classes/BaseXmlComponent.html index 0af138ce42..4c9b09f587 100644 --- a/api/classes/BaseXmlComponent.html +++ b/api/classes/BaseXmlComponent.html @@ -1,3 +1,3 @@ -BaseXmlComponent | docx

ClassBaseXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor +BaseXmlComponent | docx

ClassBaseXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

AbstractprepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

AbstractprepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Body.html b/api/classes/Body.html index 66f1cbeeeb..0e1733f636 100644 --- a/api/classes/Body.html +++ b/api/classes/Body.html @@ -1,10 +1,10 @@ -Body | docx

ClassBody

Hierarchy (view full)

Constructors

constructor +Body | docx

ClassBody

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement addSection prepForXml push -

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options): void

  • Adds new section properties. +

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options): void

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

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

    • last section should be direct child of body

    Parameters

    Returns void

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns void

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Bookmark.html b/api/classes/Bookmark.html index 59db8cef83..df27b060e8 100644 --- a/api/classes/Bookmark.html +++ b/api/classes/Bookmark.html @@ -1,5 +1,5 @@ -Bookmark | docx

ClassBookmark

Constructors

constructor +Bookmark | docx

ClassBookmark

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 6dca78b042..b4a55d2148 100644 --- a/api/classes/BookmarkEnd.html +++ b/api/classes/BookmarkEnd.html @@ -1,5 +1,5 @@ -BookmarkEnd | docx

ClassBookmarkEnd

Hierarchy (view full)

Constructors

constructor +BookmarkEnd | docx

ClassBookmarkEnd

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassBookmarkStart

Hierarchy (view full)

Constructors

constructor +BookmarkStart | docx

ClassBookmarkStart

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Border.html b/api/classes/Border.html index da142c1b63..8853db6040 100644 --- a/api/classes/Border.html +++ b/api/classes/Border.html @@ -1,5 +1,5 @@ -Border | docx

ClassBorder

Hierarchy (view full)

Constructors

constructor +Border | docx

ClassBorder

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BorderElement.html b/api/classes/BorderElement.html index 54f8e01c5a..aba0ca1b08 100644 --- a/api/classes/BorderElement.html +++ b/api/classes/BorderElement.html @@ -1,5 +1,5 @@ -BorderElement | docx

ClassBorderElement

Hierarchy (view full)

Constructors

constructor +BorderElement | docx

ClassBorderElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BuilderElement.html b/api/classes/BuilderElement.html index 2dbb90aa29..33426e7946 100644 --- a/api/classes/BuilderElement.html +++ b/api/classes/BuilderElement.html @@ -1,5 +1,5 @@ -BuilderElement | docx

ClassBuilderElement<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor +BuilderElement | docx

ClassBuilderElement<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CarriageReturn.html b/api/classes/CarriageReturn.html index 25c80c0686..c66199a1b1 100644 --- a/api/classes/CarriageReturn.html +++ b/api/classes/CarriageReturn.html @@ -1,5 +1,5 @@ -CarriageReturn | docx

ClassCarriageReturn

Hierarchy (view full)

Constructors

constructor +CarriageReturn | docx

ClassCarriageReturn

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CheckBox.html b/api/classes/CheckBox.html index 3998e91a47..336bda196e 100644 --- a/api/classes/CheckBox.html +++ b/api/classes/CheckBox.html @@ -1,5 +1,5 @@ -CheckBox | docx

ClassCheckBox

Hierarchy (view full)

Constructors

constructor +CheckBox | docx

ClassCheckBox

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CheckBoxSymbolElement.html b/api/classes/CheckBoxSymbolElement.html index d379cbbd24..398674c01e 100644 --- a/api/classes/CheckBoxSymbolElement.html +++ b/api/classes/CheckBoxSymbolElement.html @@ -1,5 +1,5 @@ -CheckBoxSymbolElement | docx

ClassCheckBoxSymbolElement

Hierarchy (view full)

Constructors

constructor +CheckBoxSymbolElement | docx

ClassCheckBoxSymbolElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassCheckBoxUtil

Hierarchy (view full)

Constructors

constructor +CheckBoxUtil | docx

ClassCheckBoxUtil

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Column.html b/api/classes/Column.html index 091f8c5f3e..aa2f4acf35 100644 --- a/api/classes/Column.html +++ b/api/classes/Column.html @@ -1,5 +1,5 @@ -Column | docx

ClassColumn

Hierarchy (view full)

Constructors

constructor +Column | docx

ClassColumn

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ColumnBreak.html b/api/classes/ColumnBreak.html index 9d43bfd47b..21af9993fd 100644 --- a/api/classes/ColumnBreak.html +++ b/api/classes/ColumnBreak.html @@ -1,5 +1,5 @@ -ColumnBreak | docx

ClassColumnBreak

Hierarchy (view full)

Constructors

constructor +ColumnBreak | docx

ClassColumnBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Columns.html b/api/classes/Columns.html index bbfaf79b92..54267cd3d6 100644 --- a/api/classes/Columns.html +++ b/api/classes/Columns.html @@ -1,5 +1,5 @@ -Columns | docx

ClassColumns

Hierarchy (view full)

Constructors

constructor +Columns | docx

ClassColumns

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassComment

Hierarchy (view full)

Constructors

constructor +Comment | docx

ClassComment

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CommentRangeEnd.html b/api/classes/CommentRangeEnd.html index 55aee8e976..3487813e70 100644 --- a/api/classes/CommentRangeEnd.html +++ b/api/classes/CommentRangeEnd.html @@ -1,5 +1,5 @@ -CommentRangeEnd | docx

ClassCommentRangeEnd

Hierarchy (view full)

Constructors

constructor +CommentRangeEnd | docx

ClassCommentRangeEnd

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassCommentRangeStart

Hierarchy (view full)

Constructors

constructor +CommentRangeStart | docx

ClassCommentRangeStart

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CommentReference.html b/api/classes/CommentReference.html index c2c369f72f..afab18a1ac 100644 --- a/api/classes/CommentReference.html +++ b/api/classes/CommentReference.html @@ -1,5 +1,5 @@ -CommentReference | docx

ClassCommentReference

Hierarchy (view full)

Constructors

constructor +CommentReference | docx

ClassCommentReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassComments

Hierarchy (view full)

Constructors

constructor +Comments | docx

ClassComments

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ConcreteHyperlink.html b/api/classes/ConcreteHyperlink.html index 6389644b66..77023c32ef 100644 --- a/api/classes/ConcreteHyperlink.html +++ b/api/classes/ConcreteHyperlink.html @@ -1,6 +1,6 @@ -ConcreteHyperlink | docx

ClassConcreteHyperlink

Hierarchy (view full)

Constructors

constructor +ConcreteHyperlink | docx

ClassConcreteHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

linkId

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ConcreteNumbering.html b/api/classes/ConcreteNumbering.html index 0da6a880ee..c5d7b1c70b 100644 --- a/api/classes/ConcreteNumbering.html +++ b/api/classes/ConcreteNumbering.html @@ -1,8 +1,8 @@ -ConcreteNumbering | docx

ClassConcreteNumbering

Hierarchy (view full)

Constructors

constructor +ConcreteNumbering | docx

ClassConcreteNumbering

Hierarchy (view full)

Constructors

constructor

Properties

instance numId reference

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Readonlyreference

reference: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Readonlyreference

reference: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ContinuationSeparator.html b/api/classes/ContinuationSeparator.html index 7ac42e51b4..40b96549dd 100644 --- a/api/classes/ContinuationSeparator.html +++ b/api/classes/ContinuationSeparator.html @@ -1,5 +1,5 @@ -ContinuationSeparator | docx

ClassContinuationSeparator

Hierarchy (view full)

Constructors

constructor +ContinuationSeparator | docx

ClassContinuationSeparator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DayLong.html b/api/classes/DayLong.html index 92156c7720..d9774115f9 100644 --- a/api/classes/DayLong.html +++ b/api/classes/DayLong.html @@ -1,5 +1,5 @@ -DayLong | docx

ClassDayLong

Hierarchy (view full)

Constructors

constructor +DayLong | docx

ClassDayLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DayShort.html b/api/classes/DayShort.html index 664434c8a0..f54985b155 100644 --- a/api/classes/DayShort.html +++ b/api/classes/DayShort.html @@ -1,5 +1,5 @@ -DayShort | docx

ClassDayShort

Hierarchy (view full)

Constructors

constructor +DayShort | docx

ClassDayShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DeletedTextRun.html b/api/classes/DeletedTextRun.html index 403027825b..9cb917c3b4 100644 --- a/api/classes/DeletedTextRun.html +++ b/api/classes/DeletedTextRun.html @@ -1,5 +1,5 @@ -DeletedTextRun | docx

ClassDeletedTextRun

Hierarchy (view full)

Constructors

constructor +DeletedTextRun | docx

ClassDeletedTextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassDocGridAttributes

Hierarchy (view full)

Constructors

constructor +DocGridAttributes | docx

ClassDocGridAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Document.html b/api/classes/Document.html index 8ed7f29215..d038c68f04 100644 --- a/api/classes/Document.html +++ b/api/classes/Document.html @@ -1,4 +1,4 @@ -Document | docx

ClassDocument

Constructors

constructor +Document | docx

ClassDocument

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 f8f45eebc2..dd1d62a7f6 100644 --- a/api/classes/DocumentAttributes.html +++ b/api/classes/DocumentAttributes.html @@ -1,3 +1,3 @@ -DocumentAttributes | docx

ClassDocumentAttributes

Hierarchy (view full)

Constructors

constructor +DocumentAttributes | docx

ClassDocumentAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentBackground.html b/api/classes/DocumentBackground.html index 3f668454da..64c8d8744b 100644 --- a/api/classes/DocumentBackground.html +++ b/api/classes/DocumentBackground.html @@ -1,5 +1,5 @@ -DocumentBackground | docx

ClassDocumentBackground

Hierarchy (view full)

Constructors

constructor +DocumentBackground | docx

ClassDocumentBackground

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassDocumentBackgroundAttributes

Hierarchy (view full)

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

Constructors

constructor +DocumentBackgroundAttributes | docx

ClassDocumentBackgroundAttributes

Hierarchy (view full)

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

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

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

ClassDocumentDefaults

Hierarchy (view full)

Constructors

constructor +DocumentDefaults | docx

ClassDocumentDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentGrid.html b/api/classes/DocumentGrid.html index 890b214ce8..565f01178f 100644 --- a/api/classes/DocumentGrid.html +++ b/api/classes/DocumentGrid.html @@ -1,5 +1,5 @@ -DocumentGrid | docx

ClassDocumentGrid

Hierarchy (view full)

Constructors

constructor +DocumentGrid | docx

ClassDocumentGrid

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassDotEmphasisMark

Hierarchy (view full)

Constructors

constructor +DotEmphasisMark | docx

ClassDotEmphasisMark

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Drawing.html b/api/classes/Drawing.html index eb17d1abb6..f2f2a4d8c3 100644 --- a/api/classes/Drawing.html +++ b/api/classes/Drawing.html @@ -1,5 +1,5 @@ -Drawing | docx

ClassDrawing

Hierarchy (view full)

Constructors

constructor +Drawing | docx

ClassDrawing

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/EmphasisMark.html b/api/classes/EmphasisMark.html index 5ca5a5ef14..3f83e68fa9 100644 --- a/api/classes/EmphasisMark.html +++ b/api/classes/EmphasisMark.html @@ -1,5 +1,5 @@ -EmphasisMark | docx

ClassEmphasisMark

Hierarchy (view full)

Constructors

constructor +EmphasisMark | docx

ClassEmphasisMark

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/EmptyElement.html b/api/classes/EmptyElement.html index 32d65cae79..73c0028ade 100644 --- a/api/classes/EmptyElement.html +++ b/api/classes/EmptyElement.html @@ -1,5 +1,5 @@ -EmptyElement | docx

ClassEmptyElement

Hierarchy (view full)

Constructors

constructor +EmptyElement | docx

ClassEmptyElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassEndnoteReference

Hierarchy (view full)

Constructors

constructor +EndnoteReference | docx

ClassEndnoteReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ExternalHyperlink.html b/api/classes/ExternalHyperlink.html index 233709d3fe..c382f8b1c5 100644 --- a/api/classes/ExternalHyperlink.html +++ b/api/classes/ExternalHyperlink.html @@ -1,6 +1,6 @@ -ExternalHyperlink | docx

ClassExternalHyperlink

Hierarchy (view full)

Constructors

constructor +ExternalHyperlink | docx

ClassExternalHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

options

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyoptions

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

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyoptions

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

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/FileChild.html b/api/classes/FileChild.html index 122716e2a6..0be22936e8 100644 --- a/api/classes/FileChild.html +++ b/api/classes/FileChild.html @@ -1,6 +1,6 @@ -FileChild | docx

ClassFileChild

Hierarchy (view full)

Constructors

constructor +FileChild | docx

ClassFileChild

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/FootNoteReferenceRunAttributes.html b/api/classes/FootNoteReferenceRunAttributes.html index 53a1e38f7b..5c78d7d73a 100644 --- a/api/classes/FootNoteReferenceRunAttributes.html +++ b/api/classes/FootNoteReferenceRunAttributes.html @@ -1,3 +1,3 @@ -FootNoteReferenceRunAttributes | docx

ClassFootNoteReferenceRunAttributes

Hierarchy (view full)

Constructors

constructor +FootNoteReferenceRunAttributes | docx

ClassFootNoteReferenceRunAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootNotes.html b/api/classes/FootNotes.html index 2f3599c97b..2f1c51534e 100644 --- a/api/classes/FootNotes.html +++ b/api/classes/FootNotes.html @@ -1,6 +1,6 @@ -FootNotes | docx

ClassFootNotes

Hierarchy (view full)

Constructors

constructor +FootNotes | docx

ClassFootNotes

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement createFootNote prepForXml -

Constructors

constructor

Methods

addChildElement

createFootNote

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

createFootNote

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Footer.html b/api/classes/Footer.html index 18b1a63ce4..19b4d6dc8e 100644 --- a/api/classes/Footer.html +++ b/api/classes/Footer.html @@ -1,3 +1,3 @@ -Footer | docx

ClassFooter

Constructors

constructor +Footer | docx

ClassFooter

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 3510972a33..adff21ab8d 100644 --- a/api/classes/FooterWrapper.html +++ b/api/classes/FooterWrapper.html @@ -1,7 +1,7 @@ -FooterWrapper | docx

ClassFooterWrapper

Implements

  • IViewWrapper

Constructors

constructor +FooterWrapper | docx

ClassFooterWrapper

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 3c3dd3736f..c25726b2c3 100644 --- a/api/classes/FootnoteReference.html +++ b/api/classes/FootnoteReference.html @@ -1,5 +1,5 @@ -FootnoteReference | docx

ClassFootnoteReference

Hierarchy (view full)

Constructors

constructor +FootnoteReference | docx

ClassFootnoteReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootnoteReferenceElement.html b/api/classes/FootnoteReferenceElement.html index 028460161e..65e9e23f4b 100644 --- a/api/classes/FootnoteReferenceElement.html +++ b/api/classes/FootnoteReferenceElement.html @@ -1,5 +1,5 @@ -FootnoteReferenceElement | docx

ClassFootnoteReferenceElement

Hierarchy (view full)

Constructors

constructor +FootnoteReferenceElement | docx

ClassFootnoteReferenceElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootnoteReferenceRun.html b/api/classes/FootnoteReferenceRun.html index 3904fa724e..e430bdd12a 100644 --- a/api/classes/FootnoteReferenceRun.html +++ b/api/classes/FootnoteReferenceRun.html @@ -1,5 +1,5 @@ -FootnoteReferenceRun | docx

ClassFootnoteReferenceRun

Hierarchy (view full)

  • Run
    • FootnoteReferenceRun

Constructors

constructor +FootnoteReferenceRun | docx

ClassFootnoteReferenceRun

Hierarchy (view full)

  • Run
    • FootnoteReferenceRun

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/GridSpan.html b/api/classes/GridSpan.html index d85eabdd40..c6a86fbb9d 100644 --- a/api/classes/GridSpan.html +++ b/api/classes/GridSpan.html @@ -1,6 +1,6 @@ GridSpan | docx

ClassGridSpan

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Header.html b/api/classes/Header.html index 0e8709ffdc..8bdc2718a2 100644 --- a/api/classes/Header.html +++ b/api/classes/Header.html @@ -1,3 +1,3 @@ -Header | docx

ClassHeader

Constructors

constructor +Header | docx

ClassHeader

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 389bd5a1d1..02e41507f8 100644 --- a/api/classes/HeaderFooterReference.html +++ b/api/classes/HeaderFooterReference.html @@ -1,5 +1,5 @@ -HeaderFooterReference | docx

ClassHeaderFooterReference

Hierarchy (view full)

Constructors

constructor +HeaderFooterReference | docx

ClassHeaderFooterReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/HeaderWrapper.html b/api/classes/HeaderWrapper.html index 8a60738f9f..326091b574 100644 --- a/api/classes/HeaderWrapper.html +++ b/api/classes/HeaderWrapper.html @@ -1,7 +1,7 @@ -HeaderWrapper | docx

ClassHeaderWrapper

Implements

  • IViewWrapper

Constructors

constructor +HeaderWrapper | docx

ClassHeaderWrapper

Implements

  • IViewWrapper

Constructors

constructor

Accessors

Media Relationships View

Methods

add addChildElement -

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/HorizontalPosition.html b/api/classes/HorizontalPosition.html index a4454f8303..58429261c9 100644 --- a/api/classes/HorizontalPosition.html +++ b/api/classes/HorizontalPosition.html @@ -1,5 +1,5 @@ -HorizontalPosition | docx

ClassHorizontalPosition

Hierarchy (view full)

Constructors

constructor +HorizontalPosition | docx

ClassHorizontalPosition

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassHpsMeasureElement

Hierarchy (view full)

Constructors

constructor +HpsMeasureElement | docx

ClassHpsMeasureElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/IgnoreIfEmptyXmlComponent.html b/api/classes/IgnoreIfEmptyXmlComponent.html index db6a6a5469..cae623bbc8 100644 --- a/api/classes/IgnoreIfEmptyXmlComponent.html +++ b/api/classes/IgnoreIfEmptyXmlComponent.html @@ -1,5 +1,5 @@ -IgnoreIfEmptyXmlComponent | docx

ClassIgnoreIfEmptyXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor +IgnoreIfEmptyXmlComponent | docx

ClassIgnoreIfEmptyXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ImageRun.html b/api/classes/ImageRun.html index ad7c26922d..7cf7d12c1f 100644 --- a/api/classes/ImageRun.html +++ b/api/classes/ImageRun.html @@ -1,5 +1,5 @@ -ImageRun | docx

ClassImageRun

Hierarchy (view full)

Constructors

constructor +ImageRun | docx

ClassImageRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ImportedRootElementAttributes.html b/api/classes/ImportedRootElementAttributes.html index 3af980b08d..52851016ad 100644 --- a/api/classes/ImportedRootElementAttributes.html +++ b/api/classes/ImportedRootElementAttributes.html @@ -1,6 +1,6 @@ ImportedRootElementAttributes | docx

ClassImportedRootElementAttributes

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ImportedXmlComponent.html b/api/classes/ImportedXmlComponent.html index 5adbfb2bb5..a3b6eccf11 100644 --- a/api/classes/ImportedXmlComponent.html +++ b/api/classes/ImportedXmlComponent.html @@ -1,11 +1,11 @@ ImportedXmlComponent | docx

ClassImportedXmlComponent

Represents imported xml component from xml file.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml push fromXmlString

Constructors

constructor

Methods

addChildElement

prepForXml

push

StaticfromXmlString

Methods

addChildElement

prepForXml

push

StaticfromXmlString

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns ImportedXmlComponent

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Indent.html b/api/classes/Indent.html index f48367c513..90259944bc 100644 --- a/api/classes/Indent.html +++ b/api/classes/Indent.html @@ -1,5 +1,5 @@ -Indent | docx

ClassIndent

Hierarchy (view full)

Constructors

constructor +Indent | docx

ClassIndent

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/InitializableXmlComponent.html b/api/classes/InitializableXmlComponent.html index 1961fc2563..7b9c015bed 100644 --- a/api/classes/InitializableXmlComponent.html +++ b/api/classes/InitializableXmlComponent.html @@ -1,5 +1,5 @@ -InitializableXmlComponent | docx

ClassInitializableXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor +InitializableXmlComponent | docx

ClassInitializableXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/InsertedTextRun.html b/api/classes/InsertedTextRun.html index 9ad55fe48b..074ce6eb4d 100644 --- a/api/classes/InsertedTextRun.html +++ b/api/classes/InsertedTextRun.html @@ -1,5 +1,5 @@ -InsertedTextRun | docx

ClassInsertedTextRun

Hierarchy (view full)

Constructors

constructor +InsertedTextRun | docx

ClassInsertedTextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassInternalHyperlink

Hierarchy (view full)

Constructors

constructor +InternalHyperlink | docx

ClassInternalHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

linkId

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/LastRenderedPageBreak.html b/api/classes/LastRenderedPageBreak.html index 288da7baf9..e14489bb6c 100644 --- a/api/classes/LastRenderedPageBreak.html +++ b/api/classes/LastRenderedPageBreak.html @@ -1,5 +1,5 @@ -LastRenderedPageBreak | docx

ClassLastRenderedPageBreak

Hierarchy (view full)

Constructors

constructor +LastRenderedPageBreak | docx

ClassLastRenderedPageBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassLevel

Hierarchy (view full)

Constructors

constructor +Level | docx

ClassLevel

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelBase.html b/api/classes/LevelBase.html index f69f536198..1299f91b56 100644 --- a/api/classes/LevelBase.html +++ b/api/classes/LevelBase.html @@ -1,5 +1,5 @@ -LevelBase | docx

ClassLevelBase

Hierarchy (view full)

Constructors

constructor +LevelBase | docx

ClassLevelBase

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelForOverride.html b/api/classes/LevelForOverride.html index 96a9c3d0ac..651289c17b 100644 --- a/api/classes/LevelForOverride.html +++ b/api/classes/LevelForOverride.html @@ -1,5 +1,5 @@ -LevelForOverride | docx

ClassLevelForOverride

Hierarchy (view full)

Constructors

constructor +LevelForOverride | docx

ClassLevelForOverride

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelOverride.html b/api/classes/LevelOverride.html index 601a6a6283..aa6de54b54 100644 --- a/api/classes/LevelOverride.html +++ b/api/classes/LevelOverride.html @@ -1,5 +1,5 @@ -LevelOverride | docx

ClassLevelOverride

Hierarchy (view full)

Constructors

constructor +LevelOverride | docx

ClassLevelOverride

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Math.html b/api/classes/Math.html index 3b447680ab..80c04dcfac 100644 --- a/api/classes/Math.html +++ b/api/classes/Math.html @@ -1,5 +1,5 @@ -Math | docx

ClassMath

Hierarchy (view full)

Constructors

constructor +Math | docx

ClassMath

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathAccentCharacter

Hierarchy (view full)

Constructors

constructor +MathAccentCharacter | docx

ClassMathAccentCharacter

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathAngledBrackets

Hierarchy (view full)

Constructors

constructor +MathAngledBrackets | docx

ClassMathAngledBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathBase

Hierarchy (view full)

Constructors

constructor +MathBase | docx

ClassMathBase

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathCurlyBrackets

Hierarchy (view full)

Constructors

constructor +MathCurlyBrackets | docx

ClassMathCurlyBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathDegree.html b/api/classes/MathDegree.html index 0ed70df4ab..04cbc4400d 100644 --- a/api/classes/MathDegree.html +++ b/api/classes/MathDegree.html @@ -1,5 +1,5 @@ -MathDegree | docx

ClassMathDegree

Hierarchy (view full)

Constructors

constructor +MathDegree | docx

ClassMathDegree

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathDenominator.html b/api/classes/MathDenominator.html index 3a3ea3f014..ca756e90d2 100644 --- a/api/classes/MathDenominator.html +++ b/api/classes/MathDenominator.html @@ -1,5 +1,5 @@ -MathDenominator | docx

ClassMathDenominator

Hierarchy (view full)

Constructors

constructor +MathDenominator | docx

ClassMathDenominator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFraction.html b/api/classes/MathFraction.html index 9c591ed543..00692e3bf2 100644 --- a/api/classes/MathFraction.html +++ b/api/classes/MathFraction.html @@ -1,5 +1,5 @@ -MathFraction | docx

ClassMathFraction

Hierarchy (view full)

Constructors

constructor +MathFraction | docx

ClassMathFraction

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunction.html b/api/classes/MathFunction.html index 8311332eb6..9ec7604b41 100644 --- a/api/classes/MathFunction.html +++ b/api/classes/MathFunction.html @@ -1,5 +1,5 @@ -MathFunction | docx

ClassMathFunction

Hierarchy (view full)

Constructors

constructor +MathFunction | docx

ClassMathFunction

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunctionName.html b/api/classes/MathFunctionName.html index 68f216e8d9..349ca1c477 100644 --- a/api/classes/MathFunctionName.html +++ b/api/classes/MathFunctionName.html @@ -1,5 +1,5 @@ -MathFunctionName | docx

ClassMathFunctionName

Hierarchy (view full)

Constructors

constructor +MathFunctionName | docx

ClassMathFunctionName

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunctionProperties.html b/api/classes/MathFunctionProperties.html index 2f8471a40c..7ea66d233b 100644 --- a/api/classes/MathFunctionProperties.html +++ b/api/classes/MathFunctionProperties.html @@ -1,5 +1,5 @@ -MathFunctionProperties | docx

ClassMathFunctionProperties

Hierarchy (view full)

Constructors

constructor +MathFunctionProperties | docx

ClassMathFunctionProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathIntegral.html b/api/classes/MathIntegral.html index 9a573ca868..49cb120392 100644 --- a/api/classes/MathIntegral.html +++ b/api/classes/MathIntegral.html @@ -1,5 +1,5 @@ -MathIntegral | docx

ClassMathIntegral

Hierarchy (view full)

Constructors

constructor +MathIntegral | docx

ClassMathIntegral

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathLimit

Hierarchy (view full)

Constructors

constructor +MathLimit | docx

ClassMathLimit

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitLocation.html b/api/classes/MathLimitLocation.html index 860e185bf0..972a6323a3 100644 --- a/api/classes/MathLimitLocation.html +++ b/api/classes/MathLimitLocation.html @@ -1,5 +1,5 @@ -MathLimitLocation | docx

ClassMathLimitLocation

Hierarchy (view full)

Constructors

constructor +MathLimitLocation | docx

ClassMathLimitLocation

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitLower.html b/api/classes/MathLimitLower.html index c8aa9b74a7..a6f250cdb6 100644 --- a/api/classes/MathLimitLower.html +++ b/api/classes/MathLimitLower.html @@ -1,5 +1,5 @@ -MathLimitLower | docx

ClassMathLimitLower

Hierarchy (view full)

Constructors

constructor +MathLimitLower | docx

ClassMathLimitLower

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitUpper.html b/api/classes/MathLimitUpper.html index c2bce6c588..f6648cbd63 100644 --- a/api/classes/MathLimitUpper.html +++ b/api/classes/MathLimitUpper.html @@ -1,5 +1,5 @@ -MathLimitUpper | docx

ClassMathLimitUpper

Hierarchy (view full)

Constructors

constructor +MathLimitUpper | docx

ClassMathLimitUpper

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathNAryProperties

Hierarchy (view full)

Constructors

constructor +MathNAryProperties | docx

ClassMathNAryProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathNumerator.html b/api/classes/MathNumerator.html index 8d86be167f..793b042138 100644 --- a/api/classes/MathNumerator.html +++ b/api/classes/MathNumerator.html @@ -1,5 +1,5 @@ -MathNumerator | docx

ClassMathNumerator

Hierarchy (view full)

Constructors

constructor +MathNumerator | docx

ClassMathNumerator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathPreSubSuperScript.html b/api/classes/MathPreSubSuperScript.html index 166b5136b6..dc55c0a1de 100644 --- a/api/classes/MathPreSubSuperScript.html +++ b/api/classes/MathPreSubSuperScript.html @@ -1,5 +1,5 @@ -MathPreSubSuperScript | docx

ClassMathPreSubSuperScript

Hierarchy (view full)

Constructors

constructor +MathPreSubSuperScript | docx

ClassMathPreSubSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathPreSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor +MathPreSubSuperScriptProperties | docx

ClassMathPreSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRadical.html b/api/classes/MathRadical.html index 28a57ce5c7..c99908162b 100644 --- a/api/classes/MathRadical.html +++ b/api/classes/MathRadical.html @@ -1,5 +1,5 @@ -MathRadical | docx

ClassMathRadical

Hierarchy (view full)

Constructors

constructor +MathRadical | docx

ClassMathRadical

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRadicalProperties.html b/api/classes/MathRadicalProperties.html index aa0ccf2c78..36f3a56d21 100644 --- a/api/classes/MathRadicalProperties.html +++ b/api/classes/MathRadicalProperties.html @@ -1,5 +1,5 @@ -MathRadicalProperties | docx

ClassMathRadicalProperties

Hierarchy (view full)

Constructors

constructor +MathRadicalProperties | docx

ClassMathRadicalProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRoundBrackets.html b/api/classes/MathRoundBrackets.html index 2a8ba7f4f3..43ca17f68a 100644 --- a/api/classes/MathRoundBrackets.html +++ b/api/classes/MathRoundBrackets.html @@ -1,5 +1,5 @@ -MathRoundBrackets | docx

ClassMathRoundBrackets

Hierarchy (view full)

Constructors

constructor +MathRoundBrackets | docx

ClassMathRoundBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRun.html b/api/classes/MathRun.html index e480098b07..0da2b4a509 100644 --- a/api/classes/MathRun.html +++ b/api/classes/MathRun.html @@ -1,5 +1,5 @@ -MathRun | docx

ClassMathRun

Hierarchy (view full)

Constructors

constructor +MathRun | docx

ClassMathRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSquareBrackets.html b/api/classes/MathSquareBrackets.html index 0e3324b833..03fbe0a966 100644 --- a/api/classes/MathSquareBrackets.html +++ b/api/classes/MathSquareBrackets.html @@ -1,5 +1,5 @@ -MathSquareBrackets | docx

ClassMathSquareBrackets

Hierarchy (view full)

Constructors

constructor +MathSquareBrackets | docx

ClassMathSquareBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubScript.html b/api/classes/MathSubScript.html index 32e5a4ea1b..6add76cae9 100644 --- a/api/classes/MathSubScript.html +++ b/api/classes/MathSubScript.html @@ -1,5 +1,5 @@ -MathSubScript | docx

ClassMathSubScript

Hierarchy (view full)

Constructors

constructor +MathSubScript | docx

ClassMathSubScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathSubScriptElement

Hierarchy (view full)

Constructors

constructor +MathSubScriptElement | docx

ClassMathSubScriptElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathSubScriptProperties

Hierarchy (view full)

Constructors

constructor +MathSubScriptProperties | docx

ClassMathSubScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubSuperScript.html b/api/classes/MathSubSuperScript.html index dd43ee6704..4fe6b1b81d 100644 --- a/api/classes/MathSubSuperScript.html +++ b/api/classes/MathSubSuperScript.html @@ -1,5 +1,5 @@ -MathSubSuperScript | docx

ClassMathSubSuperScript

Hierarchy (view full)

Constructors

constructor +MathSubSuperScript | docx

ClassMathSubSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubSuperScriptProperties.html b/api/classes/MathSubSuperScriptProperties.html index 3aeb706f6c..55ea00029c 100644 --- a/api/classes/MathSubSuperScriptProperties.html +++ b/api/classes/MathSubSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathSubSuperScriptProperties | docx

ClassMathSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor +MathSubSuperScriptProperties | docx

ClassMathSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSum.html b/api/classes/MathSum.html index fa28986287..34081fa3c9 100644 --- a/api/classes/MathSum.html +++ b/api/classes/MathSum.html @@ -1,5 +1,5 @@ -MathSum | docx

ClassMathSum

Hierarchy (view full)

Constructors

constructor +MathSum | docx

ClassMathSum

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassMathSuperScript

Hierarchy (view full)

Constructors

constructor +MathSuperScript | docx

ClassMathSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSuperScriptElement.html b/api/classes/MathSuperScriptElement.html index 7f3547f3ec..8c54482a62 100644 --- a/api/classes/MathSuperScriptElement.html +++ b/api/classes/MathSuperScriptElement.html @@ -1,5 +1,5 @@ -MathSuperScriptElement | docx

ClassMathSuperScriptElement

Hierarchy (view full)

Constructors

constructor +MathSuperScriptElement | docx

ClassMathSuperScriptElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSuperScriptProperties.html b/api/classes/MathSuperScriptProperties.html index c183ccb9fa..e8404c3cc0 100644 --- a/api/classes/MathSuperScriptProperties.html +++ b/api/classes/MathSuperScriptProperties.html @@ -1,5 +1,5 @@ -MathSuperScriptProperties | docx

ClassMathSuperScriptProperties

Hierarchy (view full)

Constructors

constructor +MathSuperScriptProperties | docx

ClassMathSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Media.html b/api/classes/Media.html index f59368f265..42cdd65627 100644 --- a/api/classes/Media.html +++ b/api/classes/Media.html @@ -1,4 +1,4 @@ -Media | docx

ClassMedia

Constructors

constructor +Media | docx

ClassMedia

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 8f7e886240..f14ab8a1f3 100644 --- a/api/classes/MonthLong.html +++ b/api/classes/MonthLong.html @@ -1,5 +1,5 @@ -MonthLong | docx

ClassMonthLong

Hierarchy (view full)

Constructors

constructor +MonthLong | docx

ClassMonthLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MonthShort.html b/api/classes/MonthShort.html index 49975941a7..8459d25692 100644 --- a/api/classes/MonthShort.html +++ b/api/classes/MonthShort.html @@ -1,5 +1,5 @@ -MonthShort | docx

ClassMonthShort

Hierarchy (view full)

Constructors

constructor +MonthShort | docx

ClassMonthShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NextAttributeComponent.html b/api/classes/NextAttributeComponent.html index d0ec53f6e2..f405c2e453 100644 --- a/api/classes/NextAttributeComponent.html +++ b/api/classes/NextAttributeComponent.html @@ -1,3 +1,3 @@ -NextAttributeComponent | docx

ClassNextAttributeComponent<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor +NextAttributeComponent | docx

ClassNextAttributeComponent<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NoBreakHyphen.html b/api/classes/NoBreakHyphen.html index 54f670583b..3a799d02c3 100644 --- a/api/classes/NoBreakHyphen.html +++ b/api/classes/NoBreakHyphen.html @@ -1,5 +1,5 @@ -NoBreakHyphen | docx

ClassNoBreakHyphen

Hierarchy (view full)

Constructors

constructor +NoBreakHyphen | docx

ClassNoBreakHyphen

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NumberProperties.html b/api/classes/NumberProperties.html index a3e2c64176..8b41f1788a 100644 --- a/api/classes/NumberProperties.html +++ b/api/classes/NumberProperties.html @@ -1,5 +1,5 @@ -NumberProperties | docx

ClassNumberProperties

Hierarchy (view full)

Constructors

constructor +NumberProperties | docx

ClassNumberProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NumberValueElement.html b/api/classes/NumberValueElement.html index 00814a30ff..ee19b4754d 100644 --- a/api/classes/NumberValueElement.html +++ b/api/classes/NumberValueElement.html @@ -1,5 +1,5 @@ -NumberValueElement | docx

ClassNumberValueElement

Hierarchy (view full)

Constructors

constructor +NumberValueElement | docx

ClassNumberValueElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassNumbering

Hierarchy (view full)

Constructors

constructor +Numbering | docx

ClassNumbering

Hierarchy (view full)

Constructors

constructor

Accessors

ConcreteNumbering ReferenceConfig

Methods

addChildElement createConcreteNumberingInstance prepForXml -

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference, instance): void

  • Parameters

    • reference: string
    • instance: number

    Returns void

prepForXml

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference, instance): void

  • Parameters

    • reference: string
    • instance: number

    Returns void

prepForXml

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/OnOffElement.html b/api/classes/OnOffElement.html index a35cf288cf..566872c191 100644 --- a/api/classes/OnOffElement.html +++ b/api/classes/OnOffElement.html @@ -1,5 +1,5 @@ -OnOffElement | docx

ClassOnOffElement

Hierarchy (view full)

Constructors

constructor +OnOffElement | docx

ClassOnOffElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassOutlineLevel

Hierarchy (view full)

Constructors

constructor +OutlineLevel | docx

ClassOutlineLevel

Hierarchy (view full)

Constructors

constructor

Properties

level

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlylevel

level: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlylevel

level: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Packer.html b/api/classes/Packer.html index 3533ce2424..46388f414e 100644 --- a/api/classes/Packer.html +++ b/api/classes/Packer.html @@ -1,7 +1,7 @@ -Packer | docx

ClassPacker

Constructors

constructor +Packer | docx

ClassPacker

Constructors

constructor

Methods

toBase64String toBlob toBuffer toStream toString -

Constructors

constructor

Methods

StatictoBase64String

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

  • Parameters

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

    Returns Promise<string>

StatictoBlob

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

  • Parameters

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

    Returns Promise<Blob>

StatictoBuffer

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

  • Parameters

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

    Returns Promise<Buffer>

StatictoStream

  • toStream(file, prettify?): Stream

  • Parameters

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

    Returns Stream

StatictoString

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

  • Parameters

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

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

StatictoBase64String

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

  • Parameters

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

    Returns Promise<string>

StatictoBlob

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

  • Parameters

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

    Returns Promise<Blob>

StatictoBuffer

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

  • Parameters

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

    Returns Promise<Buffer>

StatictoStream

  • toStream(file, prettify?): Stream

  • Parameters

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

    Returns Stream

StatictoString

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

  • Parameters

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

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBorders.html b/api/classes/PageBorders.html index 00144ceb28..447ce82593 100644 --- a/api/classes/PageBorders.html +++ b/api/classes/PageBorders.html @@ -1,5 +1,5 @@ -PageBorders | docx

ClassPageBorders

Hierarchy (view full)

Constructors

constructor +PageBorders | docx

ClassPageBorders

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBreak.html b/api/classes/PageBreak.html index 541cf2f47e..3f7c89fa3e 100644 --- a/api/classes/PageBreak.html +++ b/api/classes/PageBreak.html @@ -1,5 +1,5 @@ -PageBreak | docx

ClassPageBreak

Hierarchy (view full)

Constructors

constructor +PageBreak | docx

ClassPageBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBreakBefore.html b/api/classes/PageBreakBefore.html index 439cfcad63..4728d8e190 100644 --- a/api/classes/PageBreakBefore.html +++ b/api/classes/PageBreakBefore.html @@ -1,6 +1,6 @@ PageBreakBefore | docx

ClassPageBreakBefore

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageMargin.html b/api/classes/PageMargin.html index d78231d6a2..03ccd5e97a 100644 --- a/api/classes/PageMargin.html +++ b/api/classes/PageMargin.html @@ -1,5 +1,5 @@ -PageMargin | docx

ClassPageMargin

Hierarchy (view full)

Constructors

constructor +PageMargin | docx

ClassPageMargin

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

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

  • Parameters

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

    Returns PageMargin

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

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

  • Parameters

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

    Returns PageMargin

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageNumberElement.html b/api/classes/PageNumberElement.html index b7086f7fe6..109276d652 100644 --- a/api/classes/PageNumberElement.html +++ b/api/classes/PageNumberElement.html @@ -1,5 +1,5 @@ -PageNumberElement | docx

ClassPageNumberElement

Hierarchy (view full)

Constructors

constructor +PageNumberElement | docx

ClassPageNumberElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassPageNumberType

Hierarchy (view full)

Constructors

constructor +PageNumberType | docx

ClassPageNumberType

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageNumberTypeAttributes.html b/api/classes/PageNumberTypeAttributes.html index 085ad8639d..5028078d39 100644 --- a/api/classes/PageNumberTypeAttributes.html +++ b/api/classes/PageNumberTypeAttributes.html @@ -1,3 +1,3 @@ -PageNumberTypeAttributes | docx

ClassPageNumberTypeAttributes

Hierarchy (view full)

Constructors

constructor +PageNumberTypeAttributes | docx

ClassPageNumberTypeAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageReference.html b/api/classes/PageReference.html index eff1687262..74ab2ccdb0 100644 --- a/api/classes/PageReference.html +++ b/api/classes/PageReference.html @@ -1,5 +1,5 @@ -PageReference | docx

ClassPageReference

Hierarchy (view full)

  • Run
    • PageReference

Constructors

constructor +PageReference | docx

ClassPageReference

Hierarchy (view full)

  • Run
    • PageReference

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassPageSize

Hierarchy (view full)

Constructors

constructor +PageSize | docx

ClassPageSize

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

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

  • Parameters

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

    Returns PageSize

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

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

  • Parameters

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

    Returns PageSize

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageTextDirection.html b/api/classes/PageTextDirection.html index 1c9d23061d..481c033e0e 100644 --- a/api/classes/PageTextDirection.html +++ b/api/classes/PageTextDirection.html @@ -1,5 +1,5 @@ -PageTextDirection | docx

ClassPageTextDirection

Hierarchy (view full)

Constructors

constructor +PageTextDirection | docx

ClassPageTextDirection

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Paragraph.html b/api/classes/Paragraph.html index f406fb1ff4..16e6138eca 100644 --- a/api/classes/Paragraph.html +++ b/api/classes/Paragraph.html @@ -1,7 +1,7 @@ -Paragraph | docx

ClassParagraph

Hierarchy (view full)

Constructors

constructor +Paragraph | docx

ClassParagraph

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement addRunToFront prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

addRunToFront

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

addRunToFront

prepForXml

Settings

Member Visibility

On This Page

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

ClassParagraphProperties

Hierarchy (view full)

Constructors

constructor +ParagraphProperties | docx

ClassParagraphProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml push -

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ParagraphPropertiesDefaults.html b/api/classes/ParagraphPropertiesDefaults.html index 86fd1a3c49..ae8a69516c 100644 --- a/api/classes/ParagraphPropertiesDefaults.html +++ b/api/classes/ParagraphPropertiesDefaults.html @@ -1,5 +1,5 @@ -ParagraphPropertiesDefaults | docx

ClassParagraphPropertiesDefaults

Hierarchy (view full)

Constructors

constructor +ParagraphPropertiesDefaults | docx

ClassParagraphPropertiesDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PositionalTab.html b/api/classes/PositionalTab.html index da5aa0df1e..92b0782868 100644 --- a/api/classes/PositionalTab.html +++ b/api/classes/PositionalTab.html @@ -1,5 +1,5 @@ -PositionalTab | docx

ClassPositionalTab

Hierarchy (view full)

Constructors

constructor +PositionalTab | docx

ClassPositionalTab

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassRun

Hierarchy (view full)

Constructors

constructor +Run | docx

ClassRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunFonts.html b/api/classes/RunFonts.html index bfc0e9de1c..f9daca4a0a 100644 --- a/api/classes/RunFonts.html +++ b/api/classes/RunFonts.html @@ -1,5 +1,5 @@ -RunFonts | docx

ClassRunFonts

Hierarchy (view full)

Constructors

constructor +RunFonts | docx

ClassRunFonts

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunProperties.html b/api/classes/RunProperties.html index 9de03a5f0e..0d2f3f24ff 100644 --- a/api/classes/RunProperties.html +++ b/api/classes/RunProperties.html @@ -1,6 +1,6 @@ -RunProperties | docx

ClassRunProperties

Hierarchy (view full)

Constructors

constructor +RunProperties | docx

ClassRunProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml push -

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunPropertiesChange.html b/api/classes/RunPropertiesChange.html index 1fab51e167..f863a1d760 100644 --- a/api/classes/RunPropertiesChange.html +++ b/api/classes/RunPropertiesChange.html @@ -1,5 +1,5 @@ -RunPropertiesChange | docx

ClassRunPropertiesChange

Hierarchy (view full)

Constructors

constructor +RunPropertiesChange | docx

ClassRunPropertiesChange

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassRunPropertiesDefaults

Hierarchy (view full)

Constructors

constructor +RunPropertiesDefaults | docx

ClassRunPropertiesDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassSectionProperties

Hierarchy (view full)

Constructors

constructor +SectionProperties | docx

ClassSectionProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassSectionTypeAttributes

Hierarchy (view full)

Constructors

constructor +SectionTypeAttributes | docx

ClassSectionTypeAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

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

ClassSeparator

Hierarchy (view full)

Constructors

constructor +Separator | docx

ClassSeparator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SequentialIdentifier.html b/api/classes/SequentialIdentifier.html index 861c402783..9c58f5af57 100644 --- a/api/classes/SequentialIdentifier.html +++ b/api/classes/SequentialIdentifier.html @@ -1,5 +1,5 @@ -SequentialIdentifier | docx

ClassSequentialIdentifier

Hierarchy (view full)

  • Run
    • SequentialIdentifier

Constructors

constructor +SequentialIdentifier | docx

ClassSequentialIdentifier

Hierarchy (view full)

  • Run
    • SequentialIdentifier

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Shading.html b/api/classes/Shading.html index 9f807c2853..7104184f6f 100644 --- a/api/classes/Shading.html +++ b/api/classes/Shading.html @@ -1,5 +1,5 @@ -Shading | docx

ClassShading

Hierarchy (view full)

Constructors

constructor +Shading | docx

ClassShading

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimpleField.html b/api/classes/SimpleField.html index d0c02fc31d..912e9635ce 100644 --- a/api/classes/SimpleField.html +++ b/api/classes/SimpleField.html @@ -1,5 +1,5 @@ -SimpleField | docx

ClassSimpleField

Hierarchy (view full)

Constructors

constructor +SimpleField | docx

ClassSimpleField

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimpleMailMergeField.html b/api/classes/SimpleMailMergeField.html index 4392ba692d..7f4e70521d 100644 --- a/api/classes/SimpleMailMergeField.html +++ b/api/classes/SimpleMailMergeField.html @@ -1,5 +1,5 @@ -SimpleMailMergeField | docx

ClassSimpleMailMergeField

Hierarchy (view full)

Constructors

constructor +SimpleMailMergeField | docx

ClassSimpleMailMergeField

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimplePos.html b/api/classes/SimplePos.html index 7fca43882e..610fab9cc0 100644 --- a/api/classes/SimplePos.html +++ b/api/classes/SimplePos.html @@ -1,5 +1,5 @@ -SimplePos | docx

ClassSimplePos

Hierarchy (view full)

Constructors

constructor +SimplePos | docx

ClassSimplePos

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SoftHyphen.html b/api/classes/SoftHyphen.html index 213f2c007f..191adcead9 100644 --- a/api/classes/SoftHyphen.html +++ b/api/classes/SoftHyphen.html @@ -1,5 +1,5 @@ -SoftHyphen | docx

ClassSoftHyphen

Hierarchy (view full)

Constructors

constructor +SoftHyphen | docx

ClassSoftHyphen

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Spacing.html b/api/classes/Spacing.html index 5414d724ab..2fabad0a69 100644 --- a/api/classes/Spacing.html +++ b/api/classes/Spacing.html @@ -1,5 +1,5 @@ -Spacing | docx

ClassSpacing

Hierarchy (view full)

Constructors

constructor +Spacing | docx

ClassSpacing

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringContainer.html b/api/classes/StringContainer.html index 1215d010b6..4eceb86adf 100644 --- a/api/classes/StringContainer.html +++ b/api/classes/StringContainer.html @@ -1,5 +1,5 @@ -StringContainer | docx

ClassStringContainer

Hierarchy (view full)

Constructors

constructor +StringContainer | docx

ClassStringContainer

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringEnumValueElement.html b/api/classes/StringEnumValueElement.html index 980af41b8c..25228fbf01 100644 --- a/api/classes/StringEnumValueElement.html +++ b/api/classes/StringEnumValueElement.html @@ -1,5 +1,5 @@ -StringEnumValueElement | docx

ClassStringEnumValueElement<T>

Type Parameters

  • T extends string

Hierarchy (view full)

Constructors

constructor +StringEnumValueElement | docx

ClassStringEnumValueElement<T>

Type Parameters

  • T extends string

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringValueElement.html b/api/classes/StringValueElement.html index 5471a6e868..8bad7f91fe 100644 --- a/api/classes/StringValueElement.html +++ b/api/classes/StringValueElement.html @@ -1,5 +1,5 @@ -StringValueElement | docx

ClassStringValueElement

Hierarchy (view full)

Constructors

constructor +StringValueElement | docx

ClassStringValueElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Style.html b/api/classes/Style.html index 25d1caeed2..4d3f71a5c8 100644 --- a/api/classes/Style.html +++ b/api/classes/Style.html @@ -1,5 +1,5 @@ -Style | docx

ClassStyle

Hierarchy (view full)

Constructors

constructor +Style | docx

ClassStyle

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StyleForCharacter.html b/api/classes/StyleForCharacter.html index 313cd6876a..a3d7b12f44 100644 --- a/api/classes/StyleForCharacter.html +++ b/api/classes/StyleForCharacter.html @@ -1,5 +1,5 @@ -StyleForCharacter | docx

ClassStyleForCharacter

Hierarchy

  • Style
    • StyleForCharacter

Constructors

constructor +StyleForCharacter | docx

ClassStyleForCharacter

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 ec8847d7c9..10070bb518 100644 --- a/api/classes/StyleForParagraph.html +++ b/api/classes/StyleForParagraph.html @@ -1,5 +1,5 @@ -StyleForParagraph | docx

ClassStyleForParagraph

Hierarchy

  • Style
    • StyleForParagraph

Constructors

constructor +StyleForParagraph | docx

ClassStyleForParagraph

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 8cf383f145..ae111736f3 100644 --- a/api/classes/StyleLevel.html +++ b/api/classes/StyleLevel.html @@ -1,4 +1,4 @@ -StyleLevel | docx

ClassStyleLevel

Constructors

constructor +StyleLevel | docx

ClassStyleLevel

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 e1d11a37f6..45cca83a78 100644 --- a/api/classes/Styles.html +++ b/api/classes/Styles.html @@ -1,5 +1,5 @@ -Styles | docx

ClassStyles

Hierarchy (view full)

Constructors

constructor +Styles | docx

ClassStyles

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SymbolRun.html b/api/classes/SymbolRun.html index 93445fa8df..5b0327da27 100644 --- a/api/classes/SymbolRun.html +++ b/api/classes/SymbolRun.html @@ -1,5 +1,5 @@ -SymbolRun | docx

ClassSymbolRun

Hierarchy (view full)

Constructors

constructor +SymbolRun | docx

ClassSymbolRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TDirection.html b/api/classes/TDirection.html index a927fe48a2..75547c5901 100644 --- a/api/classes/TDirection.html +++ b/api/classes/TDirection.html @@ -1,6 +1,6 @@ TDirection | docx

ClassTDirection

Text Direction within a table cell

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Tab.html b/api/classes/Tab.html index 49c44bfca2..3d4037dc13 100644 --- a/api/classes/Tab.html +++ b/api/classes/Tab.html @@ -1,5 +1,5 @@ -Tab | docx

ClassTab

Hierarchy (view full)

Constructors

constructor +Tab | docx

ClassTab

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TabAttributes.html b/api/classes/TabAttributes.html index 59e677d6b5..2c0e0b7940 100644 --- a/api/classes/TabAttributes.html +++ b/api/classes/TabAttributes.html @@ -1,3 +1,3 @@ -TabAttributes | docx

ClassTabAttributes

Hierarchy (view full)

Constructors

constructor +TabAttributes | docx

ClassTabAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new TabAttributes(root): TabAttributes

  • Parameters

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

    Returns TabAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new TabAttributes(root): TabAttributes

  • Parameters

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

    Returns TabAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

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

ClassTabStop

Hierarchy (view full)

Constructors

constructor +TabStop | docx

ClassTabStop

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassTabStopItem

Hierarchy (view full)

Constructors

constructor +TabStopItem | docx

ClassTabStopItem

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassTable

Hierarchy (view full)

Constructors

constructor +Table | docx

ClassTable

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassTableBorders

Hierarchy (view full)

Constructors

constructor +TableBorders | docx

ClassTableBorders

Hierarchy (view full)

Constructors

constructor

Properties

NONE

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Static ReadonlyNONE

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

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Static ReadonlyNONE

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

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableCell.html b/api/classes/TableCell.html index c86451d1eb..36af7bcb18 100644 --- a/api/classes/TableCell.html +++ b/api/classes/TableCell.html @@ -1,6 +1,6 @@ -TableCell | docx

ClassTableCell

Hierarchy (view full)

Constructors

constructor +TableCell | docx

ClassTableCell

Hierarchy (view full)

Constructors

constructor

Properties

options

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyoptions

options: ITableCellOptions

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyoptions

options: ITableCellOptions

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableCellBorders.html b/api/classes/TableCellBorders.html index 6a2bb9f6e9..1590345432 100644 --- a/api/classes/TableCellBorders.html +++ b/api/classes/TableCellBorders.html @@ -1,5 +1,5 @@ -TableCellBorders | docx

ClassTableCellBorders

Hierarchy (view full)

Constructors

constructor +TableCellBorders | docx

ClassTableCellBorders

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableFloatProperties.html b/api/classes/TableFloatProperties.html index 1a4d39c220..971575b731 100644 --- a/api/classes/TableFloatProperties.html +++ b/api/classes/TableFloatProperties.html @@ -1,5 +1,5 @@ -TableFloatProperties | docx

ClassTableFloatProperties

Hierarchy (view full)

Constructors

constructor +TableFloatProperties | docx

ClassTableFloatProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableLayout.html b/api/classes/TableLayout.html index a32cb96042..b9c099493d 100644 --- a/api/classes/TableLayout.html +++ b/api/classes/TableLayout.html @@ -1,5 +1,5 @@ -TableLayout | docx

ClassTableLayout

Hierarchy (view full)

Constructors

constructor +TableLayout | docx

ClassTableLayout

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableOfContents.html b/api/classes/TableOfContents.html index 39cc2540ef..5a11bc2999 100644 --- a/api/classes/TableOfContents.html +++ b/api/classes/TableOfContents.html @@ -1,6 +1,6 @@ -TableOfContents | docx

ClassTableOfContents

Hierarchy (view full)

Constructors

constructor +TableOfContents | docx

ClassTableOfContents

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableProperties.html b/api/classes/TableProperties.html index b5d87353f6..560ce72f2c 100644 --- a/api/classes/TableProperties.html +++ b/api/classes/TableProperties.html @@ -1,5 +1,5 @@ -TableProperties | docx

ClassTableProperties

Hierarchy (view full)

Constructors

constructor +TableProperties | docx

ClassTableProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRow.html b/api/classes/TableRow.html index b844ca1616..7acf486882 100644 --- a/api/classes/TableRow.html +++ b/api/classes/TableRow.html @@ -1,4 +1,4 @@ -TableRow | docx

ClassTableRow

Hierarchy (view full)

Constructors

constructor +TableRow | docx

ClassTableRow

Hierarchy (view full)

Constructors

constructor

Accessors

CellCount cells

Methods

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

Constructors

constructor

Accessors

CellCount

cells

Methods

addCellToColumnIndex

addCellToIndex

addChildElement

columnIndexToRootIndex

  • columnIndexToRootIndex(columnIndex, allowEndNewCell?): number

  • Parameters

    • columnIndex: number
    • allowEndNewCell: boolean = false

    Returns number

prepForXml

rootIndexToColumnIndex

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

CellCount

cells

Methods

addCellToColumnIndex

addCellToIndex

addChildElement

columnIndexToRootIndex

  • columnIndexToRootIndex(columnIndex, allowEndNewCell?): number

  • Parameters

    • columnIndex: number
    • allowEndNewCell: boolean = false

    Returns number

prepForXml

rootIndexToColumnIndex

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/TableRowHeight.html b/api/classes/TableRowHeight.html index 4f7e881855..ed11881116 100644 --- a/api/classes/TableRowHeight.html +++ b/api/classes/TableRowHeight.html @@ -1,5 +1,5 @@ -TableRowHeight | docx

ClassTableRowHeight

Hierarchy (view full)

Constructors

constructor +TableRowHeight | docx

ClassTableRowHeight

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRowHeightAttributes.html b/api/classes/TableRowHeightAttributes.html index ea018cede4..490e6ac60e 100644 --- a/api/classes/TableRowHeightAttributes.html +++ b/api/classes/TableRowHeightAttributes.html @@ -1,3 +1,3 @@ -TableRowHeightAttributes | docx

ClassTableRowHeightAttributes

Hierarchy (view full)

Constructors

constructor +TableRowHeightAttributes | docx

ClassTableRowHeightAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRowProperties.html b/api/classes/TableRowProperties.html index 84667642e7..abfab9a350 100644 --- a/api/classes/TableRowProperties.html +++ b/api/classes/TableRowProperties.html @@ -1,5 +1,5 @@ -TableRowProperties | docx

ClassTableRowProperties

Hierarchy (view full)

Constructors

constructor +TableRowProperties | docx

ClassTableRowProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableWidthElement.html b/api/classes/TableWidthElement.html index 5a0bcd50c9..27998eeeae 100644 --- a/api/classes/TableWidthElement.html +++ b/api/classes/TableWidthElement.html @@ -1,5 +1,5 @@ -TableWidthElement | docx

ClassTableWidthElement

Hierarchy (view full)

Constructors

constructor +TableWidthElement | docx

ClassTableWidthElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TextRun.html b/api/classes/TextRun.html index e92b840984..5689b7f437 100644 --- a/api/classes/TextRun.html +++ b/api/classes/TextRun.html @@ -1,5 +1,5 @@ -TextRun | docx

ClassTextRun

Hierarchy (view full)

Constructors

constructor +TextRun | docx

ClassTextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ThematicBreak.html b/api/classes/ThematicBreak.html index 0af66a4cfc..a14cfabaff 100644 --- a/api/classes/ThematicBreak.html +++ b/api/classes/ThematicBreak.html @@ -1,5 +1,5 @@ -ThematicBreak | docx

ClassThematicBreak

Hierarchy (view full)

Constructors

constructor +ThematicBreak | docx

ClassThematicBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Type.html b/api/classes/Type.html index c0d65203bb..f0647fa8e3 100644 --- a/api/classes/Type.html +++ b/api/classes/Type.html @@ -1,5 +1,5 @@ -Type | docx

ClassType

Hierarchy (view full)

Constructors

constructor +Type | docx

ClassType

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassUnderline

Hierarchy (view full)

Constructors

constructor +Underline | docx

ClassUnderline

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

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

  • Parameters

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

    Returns Underline

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

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

  • Parameters

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

    Returns Underline

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassVerticalAlignAttributes

Hierarchy (view full)

Constructors

constructor +VerticalAlignAttributes | docx

ClassVerticalAlignAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalAlignElement.html b/api/classes/VerticalAlignElement.html index 6561e4dfab..d12e5043e9 100644 --- a/api/classes/VerticalAlignElement.html +++ b/api/classes/VerticalAlignElement.html @@ -1,5 +1,5 @@ -VerticalAlignElement | docx

ClassVerticalAlignElement

Hierarchy (view full)

Constructors

constructor +VerticalAlignElement | docx

ClassVerticalAlignElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalMerge.html b/api/classes/VerticalMerge.html index 45a50dd819..56b895e6a2 100644 --- a/api/classes/VerticalMerge.html +++ b/api/classes/VerticalMerge.html @@ -1,6 +1,6 @@ VerticalMerge | docx

ClassVerticalMerge

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalPosition.html b/api/classes/VerticalPosition.html index f5ee345e25..83e90d39f4 100644 --- a/api/classes/VerticalPosition.html +++ b/api/classes/VerticalPosition.html @@ -1,5 +1,5 @@ -VerticalPosition | docx

ClassVerticalPosition

Hierarchy (view full)

Constructors

constructor +VerticalPosition | docx

ClassVerticalPosition

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapNone.html b/api/classes/WrapNone.html index 82a03c7200..e889fce7ba 100644 --- a/api/classes/WrapNone.html +++ b/api/classes/WrapNone.html @@ -1,5 +1,5 @@ -WrapNone | docx

ClassWrapNone

Hierarchy (view full)

Constructors

constructor +WrapNone | docx

ClassWrapNone

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassWrapSquare

Hierarchy (view full)

Constructors

constructor +WrapSquare | docx

ClassWrapSquare

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassWrapTight

Hierarchy (view full)

Constructors

constructor +WrapTight | docx

ClassWrapTight

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassWrapTopAndBottom

Hierarchy (view full)

Constructors

constructor +WrapTopAndBottom | docx

ClassWrapTopAndBottom

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/XmlAttributeComponent.html b/api/classes/XmlAttributeComponent.html index 3a56855af4..6d435fca1d 100644 --- a/api/classes/XmlAttributeComponent.html +++ b/api/classes/XmlAttributeComponent.html @@ -1,3 +1,3 @@ -XmlAttributeComponent | docx

ClassXmlAttributeComponent<T>Abstract

Type Parameters

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

Hierarchy (view full)

Constructors

constructor +XmlAttributeComponent | docx

ClassXmlAttributeComponent<T>Abstract

Type Parameters

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

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/XmlComponent.html b/api/classes/XmlComponent.html index aaaff31e0b..3e5a6742d4 100644 --- a/api/classes/XmlComponent.html +++ b/api/classes/XmlComponent.html @@ -1,5 +1,5 @@ -XmlComponent | docx

ClassXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor +XmlComponent | docx

ClassXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/YearLong.html b/api/classes/YearLong.html index 57b9840f9e..8f7abd5d6b 100644 --- a/api/classes/YearLong.html +++ b/api/classes/YearLong.html @@ -1,5 +1,5 @@ -YearLong | docx

ClassYearLong

Hierarchy (view full)

Constructors

constructor +YearLong | docx

ClassYearLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/YearShort.html b/api/classes/YearShort.html index c3f68123d0..30e4f79a00 100644 --- a/api/classes/YearShort.html +++ b/api/classes/YearShort.html @@ -1,5 +1,5 @@ -YearShort | docx

ClassYearShort

Hierarchy (view full)

Constructors

constructor +YearShort | docx

ClassYearShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/functions/abstractNumUniqueNumericIdGen.html b/api/functions/abstractNumUniqueNumericIdGen.html index 2dac2fd4f7..e29be63d1d 100644 --- a/api/functions/abstractNumUniqueNumericIdGen.html +++ b/api/functions/abstractNumUniqueNumericIdGen.html @@ -1 +1 @@ -abstractNumUniqueNumericIdGen | docx

FunctionabstractNumUniqueNumericIdGen

Settings

Member Visibility
+abstractNumUniqueNumericIdGen | docx

FunctionabstractNumUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/bookmarkUniqueNumericIdGen.html b/api/functions/bookmarkUniqueNumericIdGen.html index f6e196d55e..4db3cd5ac6 100644 --- a/api/functions/bookmarkUniqueNumericIdGen.html +++ b/api/functions/bookmarkUniqueNumericIdGen.html @@ -1 +1 @@ -bookmarkUniqueNumericIdGen | docx

FunctionbookmarkUniqueNumericIdGen

Settings

Member Visibility
+bookmarkUniqueNumericIdGen | docx

FunctionbookmarkUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/concreteNumUniqueNumericIdGen.html b/api/functions/concreteNumUniqueNumericIdGen.html index 20ca929e9d..1e4c1dd4e6 100644 --- a/api/functions/concreteNumUniqueNumericIdGen.html +++ b/api/functions/concreteNumUniqueNumericIdGen.html @@ -1 +1 @@ -concreteNumUniqueNumericIdGen | docx

FunctionconcreteNumUniqueNumericIdGen

Settings

Member Visibility
+concreteNumUniqueNumericIdGen | docx

FunctionconcreteNumUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/convertInchesToTwip.html b/api/functions/convertInchesToTwip.html index 70611dbca9..7ef2e8877c 100644 --- a/api/functions/convertInchesToTwip.html +++ b/api/functions/convertInchesToTwip.html @@ -1 +1 @@ -convertInchesToTwip | docx

FunctionconvertInchesToTwip

Settings

Member Visibility
+convertInchesToTwip | docx

FunctionconvertInchesToTwip

Settings

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

FunctionconvertMillimetersToTwip

Settings

Member Visibility
+convertMillimetersToTwip | docx

FunctionconvertMillimetersToTwip

Settings

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

FunctionconvertToXmlComponent

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

Settings

Member Visibility
+

Returns undefined | string | ImportedXmlComponent

Settings

Member Visibility
diff --git a/api/functions/createFrameProperties.html b/api/functions/createFrameProperties.html index 7525a5e9e4..97e1bc415e 100644 --- a/api/functions/createFrameProperties.html +++ b/api/functions/createFrameProperties.html @@ -1 +1 @@ -createFrameProperties | docx

FunctioncreateFrameProperties

Settings

Member Visibility
+createFrameProperties | docx

FunctioncreateFrameProperties

Settings

Member Visibility
diff --git a/api/functions/createLineNumberType.html b/api/functions/createLineNumberType.html index 5928c907f7..c0e8b90b04 100644 --- a/api/functions/createLineNumberType.html +++ b/api/functions/createLineNumberType.html @@ -1 +1 @@ -createLineNumberType | docx

FunctioncreateLineNumberType

Settings

Member Visibility
+createLineNumberType | docx

FunctioncreateLineNumberType

Settings

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

FunctioncreateStringElement

Settings

Member Visibility
+createStringElement | docx

FunctioncreateStringElement

Settings

Member Visibility
diff --git a/api/functions/dateTimeValue.html b/api/functions/dateTimeValue.html index 4797728d20..f9f5e20ffa 100644 --- a/api/functions/dateTimeValue.html +++ b/api/functions/dateTimeValue.html @@ -1 +1 @@ -dateTimeValue | docx

FunctiondateTimeValue

Settings

Member Visibility
+dateTimeValue | docx

FunctiondateTimeValue

Settings

Member Visibility
diff --git a/api/functions/decimalNumber.html b/api/functions/decimalNumber.html index 2b9bc5b1c1..a453b8c9c8 100644 --- a/api/functions/decimalNumber.html +++ b/api/functions/decimalNumber.html @@ -1 +1 @@ -decimalNumber | docx

FunctiondecimalNumber

  • decimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+decimalNumber | docx

FunctiondecimalNumber

  • decimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/docPropertiesUniqueNumericIdGen.html b/api/functions/docPropertiesUniqueNumericIdGen.html index 5b8773d992..02ab3c74d8 100644 --- a/api/functions/docPropertiesUniqueNumericIdGen.html +++ b/api/functions/docPropertiesUniqueNumericIdGen.html @@ -1 +1 @@ -docPropertiesUniqueNumericIdGen | docx

FunctiondocPropertiesUniqueNumericIdGen

Settings

Member Visibility
+docPropertiesUniqueNumericIdGen | docx

FunctiondocPropertiesUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/eighthPointMeasureValue.html b/api/functions/eighthPointMeasureValue.html index 5ae291b879..1fa829f891 100644 --- a/api/functions/eighthPointMeasureValue.html +++ b/api/functions/eighthPointMeasureValue.html @@ -1 +1 @@ -eighthPointMeasureValue | docx

FunctioneighthPointMeasureValue

  • eighthPointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+eighthPointMeasureValue | docx

FunctioneighthPointMeasureValue

  • eighthPointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/hashedId.html b/api/functions/hashedId.html index f3e011566f..d89eff6e2b 100644 --- a/api/functions/hashedId.html +++ b/api/functions/hashedId.html @@ -1 +1 @@ -hashedId | docx

FunctionhashedId

  • hashedId(data): string

  • Parameters

    • data:
          | string
          | Buffer
          | Uint8Array
          | ArrayBuffer

    Returns string

Settings

Member Visibility
+hashedId | docx

FunctionhashedId

  • hashedId(data): string

  • Parameters

    • data:
          | string
          | Buffer
          | Uint8Array
          | ArrayBuffer

    Returns string

Settings

Member Visibility
diff --git a/api/functions/hexColorValue.html b/api/functions/hexColorValue.html index 65f6030cf9..cb9f1778b4 100644 --- a/api/functions/hexColorValue.html +++ b/api/functions/hexColorValue.html @@ -1 +1 @@ -hexColorValue | docx

FunctionhexColorValue

  • hexColorValue(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+hexColorValue | docx

FunctionhexColorValue

  • hexColorValue(val): string

  • Parameters

    • val: string

    Returns string

Settings

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

FunctionhpsMeasureValue

  • hpsMeasureValue(val): string | number

  • Parameters

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

    Returns string | number

Settings

Member Visibility
+hpsMeasureValue | docx

FunctionhpsMeasureValue

  • hpsMeasureValue(val): string | number

  • Parameters

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

    Returns string | number

Settings

Member Visibility
diff --git a/api/functions/longHexNumber.html b/api/functions/longHexNumber.html index 0a46e0654f..1ace836558 100644 --- a/api/functions/longHexNumber.html +++ b/api/functions/longHexNumber.html @@ -1 +1 @@ -longHexNumber | docx

FunctionlongHexNumber

  • longHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+longHexNumber | docx

FunctionlongHexNumber

  • longHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/measurementOrPercentValue.html b/api/functions/measurementOrPercentValue.html index 862b81fd52..3316c66471 100644 --- a/api/functions/measurementOrPercentValue.html +++ b/api/functions/measurementOrPercentValue.html @@ -1 +1 @@ -measurementOrPercentValue | docx

FunctionmeasurementOrPercentValue

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

  • Parameters

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

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

Settings

Member Visibility
+measurementOrPercentValue | docx

FunctionmeasurementOrPercentValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/patchDetector.html b/api/functions/patchDetector.html index 911012fdd3..0484cf8ff8 100644 --- a/api/functions/patchDetector.html +++ b/api/functions/patchDetector.html @@ -1,2 +1,2 @@ patchDetector | docx

FunctionpatchDetector

Detects which patches are needed/present in a template

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

  • Parameters

    • __namedParameters: PatchDetectorOptions

    Returns Promise<readonly string[]>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/functions/patchDocument.html b/api/functions/patchDocument.html index 505606630e..5bc89884a7 100644 --- a/api/functions/patchDocument.html +++ b/api/functions/patchDocument.html @@ -1 +1 @@ -patchDocument | docx

FunctionpatchDocument

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

  • Type Parameters

    • T extends keyof OutputByType = keyof OutputByType

    Parameters

    Returns Promise<OutputByType[T]>

Settings

Member Visibility
+patchDocument | docx

FunctionpatchDocument

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

  • Type Parameters

    • T extends keyof OutputByType = keyof OutputByType

    Parameters

    Returns Promise<OutputByType[T]>

Settings

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

FunctionpercentageValue

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

  • Parameters

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

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

Settings

Member Visibility
+percentageValue | docx

FunctionpercentageValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/pointMeasureValue.html b/api/functions/pointMeasureValue.html index 83f98c0a90..2c9839e64a 100644 --- a/api/functions/pointMeasureValue.html +++ b/api/functions/pointMeasureValue.html @@ -1 +1 @@ -pointMeasureValue | docx

FunctionpointMeasureValue

  • pointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+pointMeasureValue | docx

FunctionpointMeasureValue

  • pointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/positiveUniversalMeasureValue.html b/api/functions/positiveUniversalMeasureValue.html index 1df197d074..6ceea7479a 100644 --- a/api/functions/positiveUniversalMeasureValue.html +++ b/api/functions/positiveUniversalMeasureValue.html @@ -1 +1 @@ -positiveUniversalMeasureValue | docx

FunctionpositiveUniversalMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
+positiveUniversalMeasureValue | docx

FunctionpositiveUniversalMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/shortHexNumber.html b/api/functions/shortHexNumber.html index 6842cd71ff..3dccb7cf72 100644 --- a/api/functions/shortHexNumber.html +++ b/api/functions/shortHexNumber.html @@ -1 +1 @@ -shortHexNumber | docx

FunctionshortHexNumber

  • shortHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+shortHexNumber | docx

FunctionshortHexNumber

  • shortHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

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

FunctionsignedHpsMeasureValue

  • signedHpsMeasureValue(val): string | number

  • Parameters

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

    Returns string | number

Settings

Member Visibility
+signedHpsMeasureValue | docx

FunctionsignedHpsMeasureValue

  • signedHpsMeasureValue(val): string | number

  • Parameters

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

    Returns string | number

Settings

Member Visibility
diff --git a/api/functions/signedTwipsMeasureValue.html b/api/functions/signedTwipsMeasureValue.html index 632c15c8bc..cc98578a0e 100644 --- a/api/functions/signedTwipsMeasureValue.html +++ b/api/functions/signedTwipsMeasureValue.html @@ -1 +1 @@ -signedTwipsMeasureValue | docx

FunctionsignedTwipsMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
+signedTwipsMeasureValue | docx

FunctionsignedTwipsMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/twipsMeasureValue.html b/api/functions/twipsMeasureValue.html index 54b3abfca5..a201aed184 100644 --- a/api/functions/twipsMeasureValue.html +++ b/api/functions/twipsMeasureValue.html @@ -1 +1 @@ -twipsMeasureValue | docx

FunctiontwipsMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
+twipsMeasureValue | docx

FunctiontwipsMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/uCharHexNumber.html b/api/functions/uCharHexNumber.html index 80fa66bcf1..14549e5f4f 100644 --- a/api/functions/uCharHexNumber.html +++ b/api/functions/uCharHexNumber.html @@ -1 +1 @@ -uCharHexNumber | docx

FunctionuCharHexNumber

  • uCharHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
+uCharHexNumber | docx

FunctionuCharHexNumber

  • uCharHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

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

FunctionuniqueId

Settings

Member Visibility
+uniqueId | docx

FunctionuniqueId

Settings

Member Visibility
diff --git a/api/functions/uniqueNumericIdCreator-1.html b/api/functions/uniqueNumericIdCreator-1.html index b06119ed4f..b3cb06fe61 100644 --- a/api/functions/uniqueNumericIdCreator-1.html +++ b/api/functions/uniqueNumericIdCreator-1.html @@ -1 +1 @@ -uniqueNumericIdCreator | docx

FunctionuniqueNumericIdCreator

Settings

Member Visibility
+uniqueNumericIdCreator | docx

FunctionuniqueNumericIdCreator

Settings

Member Visibility
diff --git a/api/functions/uniqueUuid.html b/api/functions/uniqueUuid.html index 6d1a77cb12..910207b060 100644 --- a/api/functions/uniqueUuid.html +++ b/api/functions/uniqueUuid.html @@ -1 +1 @@ -uniqueUuid | docx

FunctionuniqueUuid

Settings

Member Visibility
+uniqueUuid | docx

FunctionuniqueUuid

Settings

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

FunctionuniversalMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
+universalMeasureValue | docx

FunctionuniversalMeasureValue

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

  • Parameters

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

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

Settings

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

FunctionunsignedDecimalNumber

  • unsignedDecimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
+unsignedDecimalNumber | docx

FunctionunsignedDecimalNumber

  • unsignedDecimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/interfaces/IAlignmentFrameOptions.html b/api/interfaces/IAlignmentFrameOptions.html index fa3d7d0f12..02e7b5868b 100644 --- a/api/interfaces/IAlignmentFrameOptions.html +++ b/api/interfaces/IAlignmentFrameOptions.html @@ -1,4 +1,4 @@ -IAlignmentFrameOptions | docx

InterfaceIAlignmentFrameOptions

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

Hierarchy

  • IBaseFrameOptions
    • IAlignmentFrameOptions

Properties

alignment +IAlignmentFrameOptions | docx

InterfaceIAlignmentFrameOptions

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

Hierarchy

  • IBaseFrameOptions
    • IAlignmentFrameOptions

Properties

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

Properties

Readonlyalignment

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

Readonlyanchor

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

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

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

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Optional Readonlyrule

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

Optional Readonlyspace

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

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyalignment

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

Readonlyanchor

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

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

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

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Optional Readonlyrule

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

Optional Readonlyspace

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

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBaseCharacterStyleOptions.html b/api/interfaces/IBaseCharacterStyleOptions.html index 93527d9879..7cd4999af4 100644 --- a/api/interfaces/IBaseCharacterStyleOptions.html +++ b/api/interfaces/IBaseCharacterStyleOptions.html @@ -1,4 +1,4 @@ -IBaseCharacterStyleOptions | docx

InterfaceIBaseCharacterStyleOptions

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

Hierarchy (view full)

Properties

basedOn? +IBaseCharacterStyleOptions | docx

InterfaceIBaseCharacterStyleOptions

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

Hierarchy (view full)

Properties

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

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

-

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

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

InterfaceIBaseParagraphStyleOptions

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

Hierarchy (view full)

Properties

basedOn? +IBaseParagraphStyleOptions | docx

InterfaceIBaseParagraphStyleOptions

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

Hierarchy (view full)

Properties

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

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

-

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBorderOptions.html b/api/interfaces/IBorderOptions.html index 716c9e154f..0dd381f485 100644 --- a/api/interfaces/IBorderOptions.html +++ b/api/interfaces/IBorderOptions.html @@ -1,8 +1,8 @@ -IBorderOptions | docx

InterfaceIBorderOptions

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

Properties

color? +IBorderOptions | docx

InterfaceIBorderOptions

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

Properties

color? size? space? style

Properties

Optional Readonlycolor

color?: string

Border color, in hex (eg 'FF00AA')

-

Optional Readonlysize

size?: number

Size of the border in 1/8 pt

-

Optional Readonlyspace

space?: number

Spacing offset. Values are specified in pt

-

Readonlystyle

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

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlysize

size?: number

Size of the border in 1/8 pt

+

Optional Readonlyspace

space?: number

Spacing offset. Values are specified in pt

+

Readonlystyle

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBordersOptions.html b/api/interfaces/IBordersOptions.html index 6b9c401fad..98f8dbf06a 100644 --- a/api/interfaces/IBordersOptions.html +++ b/api/interfaces/IBordersOptions.html @@ -1,5 +1,5 @@ -IBordersOptions | docx

InterfaceIBordersOptions

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

Properties

bottom? +IBordersOptions | docx

InterfaceIBordersOptions

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

Properties

bottom? left? right? top? -

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

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

InterfaceICharacterStyleOptions

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

Hierarchy (view full)

Properties

basedOn? +ICharacterStyleOptions | docx

InterfaceICharacterStyleOptions

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

Hierarchy (view full)

Properties

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

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

-

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICheckboxSymbolOptions.html b/api/interfaces/ICheckboxSymbolOptions.html index 0dc74ced6d..18a082c9d0 100644 --- a/api/interfaces/ICheckboxSymbolOptions.html +++ b/api/interfaces/ICheckboxSymbolOptions.html @@ -1,5 +1,5 @@ -ICheckboxSymbolOptions | docx

InterfaceICheckboxSymbolOptions

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

Properties

alias? +ICheckboxSymbolOptions | docx

InterfaceICheckboxSymbolOptions

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

Properties

alias? checked? checkedState? uncheckedState? -

Properties

Optional Readonlyalias

alias?: string

Optional Readonlychecked

checked?: boolean

Optional ReadonlycheckedState

checkedState?: ICheckboxSymbolProperties

Optional ReadonlyuncheckedState

uncheckedState?: ICheckboxSymbolProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalias

alias?: string

Optional Readonlychecked

checked?: boolean

Optional ReadonlycheckedState

checkedState?: ICheckboxSymbolProperties

Optional ReadonlyuncheckedState

uncheckedState?: ICheckboxSymbolProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICheckboxSymbolProperties.html b/api/interfaces/ICheckboxSymbolProperties.html index c43040a1af..58d79abc30 100644 --- a/api/interfaces/ICheckboxSymbolProperties.html +++ b/api/interfaces/ICheckboxSymbolProperties.html @@ -1,3 +1,3 @@ -ICheckboxSymbolProperties | docx

InterfaceICheckboxSymbolProperties

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

Properties

font? +ICheckboxSymbolProperties | docx

InterfaceICheckboxSymbolProperties

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

Properties

font? value? -

Properties

Optional Readonlyfont

font?: string

Optional Readonlyvalue

value?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyfont

font?: string

Optional Readonlyvalue

value?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICommentOptions.html b/api/interfaces/ICommentOptions.html index 61061f1114..e7b3f09a28 100644 --- a/api/interfaces/ICommentOptions.html +++ b/api/interfaces/ICommentOptions.html @@ -1,6 +1,6 @@ -ICommentOptions | docx

InterfaceICommentOptions

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

Properties

author? +ICommentOptions | docx

InterfaceICommentOptions

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

Properties

author? children date? id initials? -

Properties

Optional Readonlyauthor

author?: string

Readonlychildren

children: readonly FileChild[]

Optional Readonlydate

date?: Date

Readonlyid

id: number

Optional Readonlyinitials

initials?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyauthor

author?: string

Readonlychildren

children: readonly FileChild[]

Optional Readonlydate

date?: Date

Readonlyid

id: number

Optional Readonlyinitials

initials?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICommentsOptions.html b/api/interfaces/ICommentsOptions.html index 3bc9e312be..bbdecb3050 100644 --- a/api/interfaces/ICommentsOptions.html +++ b/api/interfaces/ICommentsOptions.html @@ -1,2 +1,2 @@ -ICommentsOptions | docx

InterfaceICommentsOptions

interface ICommentsOptions {
    children: readonly ICommentOptions[];
}

Properties

children -

Properties

Readonlychildren

children: readonly ICommentOptions[]

Settings

Member Visibility

On This Page

Properties
+ICommentsOptions | docx

InterfaceICommentsOptions

interface ICommentsOptions {
    children: readonly ICommentOptions[];
}

Properties

children +

Properties

Readonlychildren

children: readonly ICommentOptions[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IConcreteNumberingOptions.html b/api/interfaces/IConcreteNumberingOptions.html index f0bd06dbab..30a176298e 100644 --- a/api/interfaces/IConcreteNumberingOptions.html +++ b/api/interfaces/IConcreteNumberingOptions.html @@ -1,6 +1,6 @@ -IConcreteNumberingOptions | docx

InterfaceIConcreteNumberingOptions

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

Properties

abstractNumId +IConcreteNumberingOptions | docx

InterfaceIConcreteNumberingOptions

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

Properties

abstractNumId instance numId overrideLevels? reference -

Properties

ReadonlyabstractNumId

abstractNumId: number

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Optional ReadonlyoverrideLevels

overrideLevels?: readonly IOverrideLevel[]

Readonlyreference

reference: string

Settings

Member Visibility

On This Page

Properties
+

Properties

ReadonlyabstractNumId

abstractNumId: number

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Optional ReadonlyoverrideLevels

overrideLevels?: readonly IOverrideLevel[]

Readonlyreference

reference: string

Settings

Member Visibility

On This Page

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

InterfaceIContext

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

Properties

file +IContext | docx

InterfaceIContext

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

Properties

file stack viewWrapper -

Properties

Readonlyfile

file: Document

Readonlystack

stack: IXmlableObject[]

ReadonlyviewWrapper

viewWrapper: IViewWrapper

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyfile

file: Document

Readonlystack

stack: IXmlableObject[]

ReadonlyviewWrapper

viewWrapper: IViewWrapper

Settings

Member Visibility

On This Page

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

InterfaceIDocGridAttributesProperties

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

Properties

charSpace? +IDocGridAttributesProperties | docx

InterfaceIDocGridAttributesProperties

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

Properties

charSpace? linePitch? type? -

Properties

Optional ReadonlycharSpace

charSpace?: number

Optional ReadonlylinePitch

linePitch?: number

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycharSpace

charSpace?: number

Optional ReadonlylinePitch

linePitch?: number

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentAttributesProperties.html b/api/interfaces/IDocumentAttributesProperties.html index 3b85738495..75219a6d5f 100644 --- a/api/interfaces/IDocumentAttributesProperties.html +++ b/api/interfaces/IDocumentAttributesProperties.html @@ -1,4 +1,4 @@ -IDocumentAttributesProperties | docx

InterfaceIDocumentAttributesProperties

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

Properties

aink? +IDocumentAttributesProperties | docx

InterfaceIDocumentAttributesProperties

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

Properties

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

Properties

Optional Readonlyaink

aink?: string

Optional Readonlyam3d

am3d?: string

Optional Readonlycp

cp?: string

Optional Readonlycx

cx?: string

Optional Readonlycx1

cx1?: string

Optional Readonlycx2

cx2?: string

Optional Readonlycx3

cx3?: string

Optional Readonlycx4

cx4?: string

Optional Readonlycx5

cx5?: string

Optional Readonlycx6

cx6?: string

Optional Readonlycx7

cx7?: string

Optional Readonlycx8

cx8?: string

Optional Readonlydc

dc?: string

Optional Readonlydcmitype

dcmitype?: string

Optional Readonlydcterms

dcterms?: string

Optional ReadonlyIgnorable

Ignorable?: string

Optional Readonlym

m?: string

Optional Readonlymc

mc?: string

Optional Readonlyo

o?: string

Optional Readonlyr

r?: string

Optional Readonlytype

type?: string

Optional Readonlyv

v?: string

Optional Readonlyw

w?: string

Optional Readonlyw10

w10?: string

Optional Readonlyw14

w14?: string

Optional Readonlyw15

w15?: string

Optional Readonlyw16

w16?: string

Optional Readonlyw16cex

w16cex?: string

Optional Readonlyw16cid

w16cid?: string

Optional Readonlyw16sdtdh

w16sdtdh?: string

Optional Readonlyw16se

w16se?: string

Optional Readonlywne

wne?: string

Optional Readonlywp

wp?: string

Optional Readonlywp14

wp14?: string

Optional Readonlywpc

wpc?: string

Optional Readonlywpg

wpg?: string

Optional Readonlywpi

wpi?: string

Optional Readonlywps

wps?: string

Optional Readonlyxsi

xsi?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyaink

aink?: string

Optional Readonlyam3d

am3d?: string

Optional Readonlycp

cp?: string

Optional Readonlycx

cx?: string

Optional Readonlycx1

cx1?: string

Optional Readonlycx2

cx2?: string

Optional Readonlycx3

cx3?: string

Optional Readonlycx4

cx4?: string

Optional Readonlycx5

cx5?: string

Optional Readonlycx6

cx6?: string

Optional Readonlycx7

cx7?: string

Optional Readonlycx8

cx8?: string

Optional Readonlydc

dc?: string

Optional Readonlydcmitype

dcmitype?: string

Optional Readonlydcterms

dcterms?: string

Optional ReadonlyIgnorable

Ignorable?: string

Optional Readonlym

m?: string

Optional Readonlymc

mc?: string

Optional Readonlyo

o?: string

Optional Readonlyr

r?: string

Optional Readonlytype

type?: string

Optional Readonlyv

v?: string

Optional Readonlyw

w?: string

Optional Readonlyw10

w10?: string

Optional Readonlyw14

w14?: string

Optional Readonlyw15

w15?: string

Optional Readonlyw16

w16?: string

Optional Readonlyw16cex

w16cex?: string

Optional Readonlyw16cid

w16cid?: string

Optional Readonlyw16sdtdh

w16sdtdh?: string

Optional Readonlyw16se

w16se?: string

Optional Readonlywne

wne?: string

Optional Readonlywp

wp?: string

Optional Readonlywp14

wp14?: string

Optional Readonlywpc

wpc?: string

Optional Readonlywpg

wpg?: string

Optional Readonlywpi

wpi?: string

Optional Readonlywps

wps?: string

Optional Readonlyxsi

xsi?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentBackgroundOptions.html b/api/interfaces/IDocumentBackgroundOptions.html index ae6b437ecb..05d5552c3c 100644 --- a/api/interfaces/IDocumentBackgroundOptions.html +++ b/api/interfaces/IDocumentBackgroundOptions.html @@ -1,5 +1,5 @@ -IDocumentBackgroundOptions | docx

InterfaceIDocumentBackgroundOptions

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

Properties

color? +IDocumentBackgroundOptions | docx

InterfaceIDocumentBackgroundOptions

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

Properties

color? themeColor? themeShade? themeTint? -

Properties

Optional Readonlycolor

color?: string

Optional ReadonlythemeColor

themeColor?: string

Optional ReadonlythemeShade

themeShade?: string

Optional ReadonlythemeTint

themeTint?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolor

color?: string

Optional ReadonlythemeColor

themeColor?: string

Optional ReadonlythemeShade

themeShade?: string

Optional ReadonlythemeTint

themeTint?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentDefaultsOptions.html b/api/interfaces/IDocumentDefaultsOptions.html index ac71c0b69e..f24a8897b9 100644 --- a/api/interfaces/IDocumentDefaultsOptions.html +++ b/api/interfaces/IDocumentDefaultsOptions.html @@ -1,3 +1,3 @@ -IDocumentDefaultsOptions | docx

InterfaceIDocumentDefaultsOptions

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

Properties

paragraph? +IDocumentDefaultsOptions | docx

InterfaceIDocumentDefaultsOptions

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

Properties

paragraph? run? -

Properties

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Settings

Member Visibility

On This Page

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

InterfaceIDocumentFooter

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

Properties

footer +IDocumentFooter | docx

InterfaceIDocumentFooter

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

Properties

footer type -

Properties

Readonlyfooter

footer: FooterWrapper

Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyfooter

footer: FooterWrapper

Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentHeader.html b/api/interfaces/IDocumentHeader.html index 74ba280c5d..f022574796 100644 --- a/api/interfaces/IDocumentHeader.html +++ b/api/interfaces/IDocumentHeader.html @@ -1,3 +1,3 @@ -IDocumentHeader | docx

InterfaceIDocumentHeader

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

Properties

header +IDocumentHeader | docx

InterfaceIDocumentHeader

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

Properties

header type -

Properties

Readonlyheader

header: HeaderWrapper

Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyheader

header: HeaderWrapper

Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentOptions.html b/api/interfaces/IDocumentOptions.html index 4b8bf5b772..8918631a00 100644 --- a/api/interfaces/IDocumentOptions.html +++ b/api/interfaces/IDocumentOptions.html @@ -1,2 +1,2 @@ -IDocumentOptions | docx

InterfaceIDocumentOptions

interface IDocumentOptions {
    background?: IDocumentBackgroundOptions;
}

Properties

background? -

Properties

Optional Readonlybackground

background?: IDocumentBackgroundOptions

Settings

Member Visibility

On This Page

Properties
+IDocumentOptions | docx

InterfaceIDocumentOptions

interface IDocumentOptions {
    background?: IDocumentBackgroundOptions;
}

Properties

background? +

Properties

Optional Readonlybackground

background?: IDocumentBackgroundOptions

Settings

Member Visibility

On This Page

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

InterfaceIDrawingOptions

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

Properties

docProperties? +IDrawingOptions | docx

InterfaceIDrawingOptions

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

Properties

docProperties? floating? outline? -

Properties

Optional ReadonlydocProperties

docProperties?: DocPropertiesOptions

Optional Readonlyfloating

floating?: IFloating

Optional Readonlyoutline

outline?: OutlineOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlydocProperties

docProperties?: DocPropertiesOptions

Optional Readonlyfloating

floating?: IFloating

Optional Readonlyoutline

outline?: OutlineOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IFloating.html b/api/interfaces/IFloating.html index 7f2bffee23..961c5de17d 100644 --- a/api/interfaces/IFloating.html +++ b/api/interfaces/IFloating.html @@ -1,4 +1,4 @@ -IFloating | docx

InterfaceIFloating

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

Properties

allowOverlap? +IFloating | docx

InterfaceIFloating

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

Properties

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

Properties

Optional ReadonlyallowOverlap

allowOverlap?: boolean

Optional ReadonlybehindDocument

behindDocument?: boolean

ReadonlyhorizontalPosition

horizontalPosition: IHorizontalPositionOptions

Optional ReadonlylayoutInCell

layoutInCell?: boolean

Optional ReadonlylockAnchor

lockAnchor?: boolean

Optional Readonlymargins

margins?: IMargins

ReadonlyverticalPosition

verticalPosition: IVerticalPositionOptions

Optional Readonlywrap

wrap?: ITextWrapping

Optional ReadonlyzIndex

zIndex?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallowOverlap

allowOverlap?: boolean

Optional ReadonlybehindDocument

behindDocument?: boolean

ReadonlyhorizontalPosition

horizontalPosition: IHorizontalPositionOptions

Optional ReadonlylayoutInCell

layoutInCell?: boolean

Optional ReadonlylockAnchor

lockAnchor?: boolean

Optional Readonlymargins

margins?: IMargins

ReadonlyverticalPosition

verticalPosition: IVerticalPositionOptions

Optional Readonlywrap

wrap?: ITextWrapping

Optional ReadonlyzIndex

zIndex?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IFontAttributesProperties.html b/api/interfaces/IFontAttributesProperties.html index 2e712ff4ca..e4f7d3c064 100644 --- a/api/interfaces/IFontAttributesProperties.html +++ b/api/interfaces/IFontAttributesProperties.html @@ -1,6 +1,6 @@ -IFontAttributesProperties | docx

InterfaceIFontAttributesProperties

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

Properties

ascii? +IFontAttributesProperties | docx

InterfaceIFontAttributesProperties

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

Properties

ascii? cs? eastAsia? hAnsi? hint? -

Properties

Optional Readonlyascii

ascii?: string

Optional Readonlycs

cs?: string

Optional ReadonlyeastAsia

eastAsia?: string

Optional ReadonlyhAnsi

hAnsi?: string

Optional Readonlyhint

hint?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyascii

ascii?: string

Optional Readonlycs

cs?: string

Optional ReadonlyeastAsia

eastAsia?: string

Optional ReadonlyhAnsi

hAnsi?: string

Optional Readonlyhint

hint?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderFooterGroup.html b/api/interfaces/IHeaderFooterGroup.html index a42467f080..644a996bd3 100644 --- a/api/interfaces/IHeaderFooterGroup.html +++ b/api/interfaces/IHeaderFooterGroup.html @@ -1,4 +1,4 @@ -IHeaderFooterGroup | docx

InterfaceIHeaderFooterGroup<T>

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

Type Parameters

  • T

Properties

default? +IHeaderFooterGroup | docx

InterfaceIHeaderFooterGroup<T>

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

Type Parameters

  • T

Properties

default? even? first? -

Properties

Optional Readonlydefault

default?: T

Optional Readonlyeven

even?: T

Optional Readonlyfirst

first?: T

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlydefault

default?: T

Optional Readonlyeven

even?: T

Optional Readonlyfirst

first?: T

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderFooterOptions.html b/api/interfaces/IHeaderFooterOptions.html index 442b320d42..309e3f979a 100644 --- a/api/interfaces/IHeaderFooterOptions.html +++ b/api/interfaces/IHeaderFooterOptions.html @@ -1,3 +1,3 @@ -IHeaderFooterOptions | docx

InterfaceIHeaderFooterOptions

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

Properties

id? +IHeaderFooterOptions | docx

InterfaceIHeaderFooterOptions

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

Properties

id? type? -

Properties

Optional Readonlyid

id?: number

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyid

id?: number

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderOptions.html b/api/interfaces/IHeaderOptions.html index 4579d05e69..92b76661fe 100644 --- a/api/interfaces/IHeaderOptions.html +++ b/api/interfaces/IHeaderOptions.html @@ -1,2 +1,2 @@ -IHeaderOptions | docx

InterfaceIHeaderOptions

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

Properties

children -

Properties

Readonlychildren

children: readonly (Paragraph | Table)[]

Settings

Member Visibility

On This Page

Properties
+IHeaderOptions | docx

InterfaceIHeaderOptions

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

Properties

children +

Properties

Readonlychildren

children: readonly (Paragraph | Table)[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHorizontalPositionOptions.html b/api/interfaces/IHorizontalPositionOptions.html index 656f540449..c6afeeb5e2 100644 --- a/api/interfaces/IHorizontalPositionOptions.html +++ b/api/interfaces/IHorizontalPositionOptions.html @@ -1,4 +1,4 @@ -IHorizontalPositionOptions | docx

InterfaceIHorizontalPositionOptions

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

Properties

align? +IHorizontalPositionOptions | docx

InterfaceIHorizontalPositionOptions

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

Properties

align? offset? relative? -

Properties

Optional Readonlyalign

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

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalign

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

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IIndentAttributesProperties.html b/api/interfaces/IIndentAttributesProperties.html index c2a9309100..0a374bffb5 100644 --- a/api/interfaces/IIndentAttributesProperties.html +++ b/api/interfaces/IIndentAttributesProperties.html @@ -1,7 +1,7 @@ -IIndentAttributesProperties | docx

InterfaceIIndentAttributesProperties

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

Properties

end? +IIndentAttributesProperties | docx

InterfaceIIndentAttributesProperties

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

Properties

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

Properties

Optional Readonlyend

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

Optional ReadonlyfirstLine

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

Optional Readonlyhanging

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

Optional Readonlyleft

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

Optional Readonlyright

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

Optional Readonlystart

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyend

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

Optional ReadonlyfirstLine

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

Optional Readonlyhanging

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

Optional Readonlyleft

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

Optional Readonlyright

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

Optional Readonlystart

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

Settings

Member Visibility

On This Page

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

InterfaceILevelParagraphStylePropertiesOptions

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

Hierarchy (view full)

Properties

alignment? +ILevelParagraphStylePropertiesOptions | docx

InterfaceILevelParagraphStylePropertiesOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

keepNext?: boolean

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

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

keepNext?: boolean

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

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ILevelsOptions.html b/api/interfaces/ILevelsOptions.html index c8d5f76410..20edc38e4b 100644 --- a/api/interfaces/ILevelsOptions.html +++ b/api/interfaces/ILevelsOptions.html @@ -1,4 +1,4 @@ -ILevelsOptions | docx

InterfaceILevelsOptions

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

Properties

alignment? +ILevelsOptions | docx

InterfaceILevelsOptions

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

Properties

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

Properties

Optional Readonlyalignment

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

Optional Readonlyformat

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

Optional ReadonlyisLegalNumberingStyle

isLegalNumberingStyle?: boolean

Readonlylevel

level: number

Optional Readonlystart

start?: number

Optional Readonlystyle

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

Optional Readonlysuffix

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

Optional Readonlytext

text?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyformat

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

Optional ReadonlyisLegalNumberingStyle

isLegalNumberingStyle?: boolean

Readonlylevel

level: number

Optional Readonlystart

start?: number

Optional Readonlystyle

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

Optional Readonlysuffix

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

Optional Readonlytext

text?: string

Settings

Member Visibility

On This Page

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

InterfaceIMargins

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

Properties

bottom? +IMargins | docx

InterfaceIMargins

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

Properties

bottom? left? right? top? -

Properties

Optional Readonlybottom

bottom?: number

Optional Readonlyleft

left?: number

Optional Readonlyright

right?: number

Optional Readonlytop

top?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: number

Optional Readonlyleft

left?: number

Optional Readonlyright

right?: number

Optional Readonlytop

top?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathFractionOptions.html b/api/interfaces/IMathFractionOptions.html index a0ead234e8..4099ab6a89 100644 --- a/api/interfaces/IMathFractionOptions.html +++ b/api/interfaces/IMathFractionOptions.html @@ -1,3 +1,3 @@ -IMathFractionOptions | docx

InterfaceIMathFractionOptions

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

Properties

denominator +IMathFractionOptions | docx

InterfaceIMathFractionOptions

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

Properties

denominator numerator -

Properties

Readonlydenominator

denominator: readonly MathComponent[]

Readonlynumerator

numerator: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlydenominator

denominator: readonly MathComponent[]

Readonlynumerator

numerator: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathFunctionOptions.html b/api/interfaces/IMathFunctionOptions.html index 737f288bc8..eca088185b 100644 --- a/api/interfaces/IMathFunctionOptions.html +++ b/api/interfaces/IMathFunctionOptions.html @@ -1,3 +1,3 @@ -IMathFunctionOptions | docx

InterfaceIMathFunctionOptions

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

Properties

children +IMathFunctionOptions | docx

InterfaceIMathFunctionOptions

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

Properties

children name -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlyname

name: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlyname

name: readonly MathComponent[]

Settings

Member Visibility

On This Page

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

InterfaceIMathIntegralOptions

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

Properties

children +IMathIntegralOptions | docx

InterfaceIMathIntegralOptions

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

Properties

children subScript? superScript? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathLimitLowerOptions.html b/api/interfaces/IMathLimitLowerOptions.html index 27d2618c9e..25451d63e7 100644 --- a/api/interfaces/IMathLimitLowerOptions.html +++ b/api/interfaces/IMathLimitLowerOptions.html @@ -1,3 +1,3 @@ -IMathLimitLowerOptions | docx

InterfaceIMathLimitLowerOptions

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

Properties

children +IMathLimitLowerOptions | docx

InterfaceIMathLimitLowerOptions

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

Properties

children limit -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathLimitUpperOptions.html b/api/interfaces/IMathLimitUpperOptions.html index ec1e12edea..11a19deabd 100644 --- a/api/interfaces/IMathLimitUpperOptions.html +++ b/api/interfaces/IMathLimitUpperOptions.html @@ -1,3 +1,3 @@ -IMathLimitUpperOptions | docx

InterfaceIMathLimitUpperOptions

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

Properties

children +IMathLimitUpperOptions | docx

InterfaceIMathLimitUpperOptions

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

Properties

children limit -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

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

InterfaceIMathOptions

interface IMathOptions {
    children: readonly MathComponent[];
}

Properties

children -

Properties

Readonlychildren

children: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+IMathOptions | docx

InterfaceIMathOptions

interface IMathOptions {
    children: readonly MathComponent[];
}

Properties

children +

Properties

Readonlychildren

children: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathPreSubSuperScriptOptions.html b/api/interfaces/IMathPreSubSuperScriptOptions.html index 7b36d4847a..1d58206913 100644 --- a/api/interfaces/IMathPreSubSuperScriptOptions.html +++ b/api/interfaces/IMathPreSubSuperScriptOptions.html @@ -1,4 +1,4 @@ -IMathPreSubSuperScriptOptions | docx

InterfaceIMathPreSubSuperScriptOptions

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

Properties

children +IMathPreSubSuperScriptOptions | docx

InterfaceIMathPreSubSuperScriptOptions

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

Properties

children subScript superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

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

InterfaceIMathRadicalOptions

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

Properties

children +IMathRadicalOptions | docx

InterfaceIMathRadicalOptions

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

Properties

children degree? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional Readonlydegree

degree?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional Readonlydegree

degree?: readonly MathComponent[]

Settings

Member Visibility

On This Page

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

InterfaceIMathSubScriptOptions

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

Properties

children +IMathSubScriptOptions | docx

InterfaceIMathSubScriptOptions

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

Properties

children subScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSubSuperScriptOptions.html b/api/interfaces/IMathSubSuperScriptOptions.html index d057baf9c9..2e968c1be7 100644 --- a/api/interfaces/IMathSubSuperScriptOptions.html +++ b/api/interfaces/IMathSubSuperScriptOptions.html @@ -1,4 +1,4 @@ -IMathSubSuperScriptOptions | docx

InterfaceIMathSubSuperScriptOptions

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

Properties

children +IMathSubSuperScriptOptions | docx

InterfaceIMathSubSuperScriptOptions

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

Properties

children subScript superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSumOptions.html b/api/interfaces/IMathSumOptions.html index 3d598ec2dc..d52326f05e 100644 --- a/api/interfaces/IMathSumOptions.html +++ b/api/interfaces/IMathSumOptions.html @@ -1,4 +1,4 @@ -IMathSumOptions | docx

InterfaceIMathSumOptions

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

Properties

children +IMathSumOptions | docx

InterfaceIMathSumOptions

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

Properties

children subScript? superScript? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

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

InterfaceIMathSuperScriptOptions

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

Properties

children +IMathSuperScriptOptions | docx

InterfaceIMathSuperScriptOptions

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

Properties

children superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMediaDataTransformation.html b/api/interfaces/IMediaDataTransformation.html index d7c382248c..5a64d2a37f 100644 --- a/api/interfaces/IMediaDataTransformation.html +++ b/api/interfaces/IMediaDataTransformation.html @@ -1,5 +1,5 @@ -IMediaDataTransformation | docx

InterfaceIMediaDataTransformation

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

Properties

emus +IMediaDataTransformation | docx

InterfaceIMediaDataTransformation

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

Properties

emus flip? pixels rotation? -

Properties

Readonlyemus

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

Optional Readonlyflip

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

Readonlypixels

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

Optional Readonlyrotation

rotation?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyemus

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

Optional Readonlyflip

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

Readonlypixels

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

Optional Readonlyrotation

rotation?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMediaTransformation.html b/api/interfaces/IMediaTransformation.html index 4aa44e2ec3..966bc9b3ed 100644 --- a/api/interfaces/IMediaTransformation.html +++ b/api/interfaces/IMediaTransformation.html @@ -1,5 +1,5 @@ -IMediaTransformation | docx

InterfaceIMediaTransformation

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

Properties

flip? +IMediaTransformation | docx

InterfaceIMediaTransformation

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

Properties

flip? height rotation? width -

Properties

Optional Readonlyflip

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

Readonlyheight

height: number

Optional Readonlyrotation

rotation?: number

Readonlywidth

width: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyflip

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

Readonlyheight

height: number

Optional Readonlyrotation

rotation?: number

Readonlywidth

width: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/INumberingOptions.html b/api/interfaces/INumberingOptions.html index 4f901571dd..d5de042b10 100644 --- a/api/interfaces/INumberingOptions.html +++ b/api/interfaces/INumberingOptions.html @@ -1,2 +1,2 @@ -INumberingOptions | docx

InterfaceINumberingOptions

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

Properties

config -

Properties

Readonlyconfig

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

Settings

Member Visibility

On This Page

Properties
+INumberingOptions | docx

InterfaceINumberingOptions

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

Properties

config +

Properties

Readonlyconfig

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageBorderAttributes.html b/api/interfaces/IPageBorderAttributes.html index c2632b7b34..2595e816c0 100644 --- a/api/interfaces/IPageBorderAttributes.html +++ b/api/interfaces/IPageBorderAttributes.html @@ -1,4 +1,4 @@ -IPageBorderAttributes | docx

InterfaceIPageBorderAttributes

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

Properties

display? +IPageBorderAttributes | docx

InterfaceIPageBorderAttributes

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

Properties

display? offsetFrom? zOrder? -

Properties

Optional Readonlydisplay

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

Optional ReadonlyoffsetFrom

offsetFrom?: "text" | "page"

Optional ReadonlyzOrder

zOrder?: "back" | "front"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlydisplay

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

Optional ReadonlyoffsetFrom

offsetFrom?: "text" | "page"

Optional ReadonlyzOrder

zOrder?: "back" | "front"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageBordersOptions.html b/api/interfaces/IPageBordersOptions.html index a79bb01df1..00fe0aebff 100644 --- a/api/interfaces/IPageBordersOptions.html +++ b/api/interfaces/IPageBordersOptions.html @@ -1,6 +1,6 @@ -IPageBordersOptions | docx

InterfaceIPageBordersOptions

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

Properties

pageBorderBottom? +IPageBordersOptions | docx

InterfaceIPageBordersOptions

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

Properties

pageBorderBottom? pageBorderLeft? pageBorderRight? pageBorders? pageBorderTop? -

Properties

Optional ReadonlypageBorderBottom

pageBorderBottom?: IBorderOptions

Optional ReadonlypageBorderLeft

pageBorderLeft?: IBorderOptions

Optional ReadonlypageBorderRight

pageBorderRight?: IBorderOptions

Optional ReadonlypageBorders

pageBorders?: IPageBorderAttributes

Optional ReadonlypageBorderTop

pageBorderTop?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlypageBorderBottom

pageBorderBottom?: IBorderOptions

Optional ReadonlypageBorderLeft

pageBorderLeft?: IBorderOptions

Optional ReadonlypageBorderRight

pageBorderRight?: IBorderOptions

Optional ReadonlypageBorders

pageBorders?: IPageBorderAttributes

Optional ReadonlypageBorderTop

pageBorderTop?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageNumberTypeAttributes.html b/api/interfaces/IPageNumberTypeAttributes.html index 4a888fff74..bab766ede6 100644 --- a/api/interfaces/IPageNumberTypeAttributes.html +++ b/api/interfaces/IPageNumberTypeAttributes.html @@ -1,4 +1,4 @@ -IPageNumberTypeAttributes | docx

InterfaceIPageNumberTypeAttributes

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

Properties

formatType? +IPageNumberTypeAttributes | docx

InterfaceIPageNumberTypeAttributes

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

Properties

formatType? separator? start? -

Properties

Optional ReadonlyformatType

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

Optional Readonlyseparator

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

Optional Readonlystart

start?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyformatType

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

Optional Readonlyseparator

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

Optional Readonlystart

start?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphOptions.html b/api/interfaces/IParagraphOptions.html index 3057121a16..9d00d3aee9 100644 --- a/api/interfaces/IParagraphOptions.html +++ b/api/interfaces/IParagraphOptions.html @@ -1,4 +1,4 @@ -IParagraphOptions | docx

InterfaceIParagraphOptions

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

Hierarchy (view full)

Properties

alignment? +IParagraphOptions | docx

InterfaceIParagraphOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

This element specifies whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. +

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

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

-

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional Readonlychildren

children?: readonly ParagraphChild[]

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

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

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

keepNext?: boolean

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

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

-

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonlytext

text?: string

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional Readonlychildren

children?: readonly ParagraphChild[]

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

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

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

keepNext?: boolean

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

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

+

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonlytext

text?: string

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphPropertiesOptions.html b/api/interfaces/IParagraphPropertiesOptions.html index fb63e76e08..72c3fbfa9d 100644 --- a/api/interfaces/IParagraphPropertiesOptions.html +++ b/api/interfaces/IParagraphPropertiesOptions.html @@ -1,4 +1,4 @@ -IParagraphPropertiesOptions | docx

InterfaceIParagraphPropertiesOptions

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

Hierarchy (view full)

Properties

alignment? +IParagraphPropertiesOptions | docx

InterfaceIParagraphPropertiesOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

This element specifies whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. +

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

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

-

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

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

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

keepNext?: boolean

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

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

-

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

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

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

keepNext?: boolean

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

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

+

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphStyleOptions.html b/api/interfaces/IParagraphStyleOptions.html index 85a9e5fb3d..bea51f9877 100644 --- a/api/interfaces/IParagraphStyleOptions.html +++ b/api/interfaces/IParagraphStyleOptions.html @@ -1,4 +1,4 @@ -IParagraphStyleOptions | docx

InterfaceIParagraphStyleOptions

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

Hierarchy (view full)

Properties

basedOn? +IParagraphStyleOptions | docx

InterfaceIParagraphStyleOptions

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

Hierarchy (view full)

Properties

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

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

-

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

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

InterfaceIParagraphStylePropertiesOptions

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

Hierarchy (view full)

Properties

alignment? +IParagraphStylePropertiesOptions | docx

InterfaceIParagraphStylePropertiesOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

keepNext?: boolean

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

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

keepNext?: boolean

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

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunOptions.html b/api/interfaces/IRunOptions.html index 2c6ff98345..dcfb257ef2 100644 --- a/api/interfaces/IRunOptions.html +++ b/api/interfaces/IRunOptions.html @@ -1,4 +1,4 @@ -IRunOptions | docx

InterfaceIRunOptions

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

Hierarchy (view full)

Properties

allCaps? +IRunOptions | docx

InterfaceIRunOptions

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

Hierarchy (view full)

Properties

allCaps? bold? boldComplexScript? border? @@ -37,4 +37,4 @@ text? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunPropertiesChangeOptions.html b/api/interfaces/IRunPropertiesChangeOptions.html index 2b30206a4c..1662d38346 100644 --- a/api/interfaces/IRunPropertiesChangeOptions.html +++ b/api/interfaces/IRunPropertiesChangeOptions.html @@ -1,4 +1,4 @@ -IRunPropertiesChangeOptions | docx

InterfaceIRunPropertiesChangeOptions

interface IRunPropertiesChangeOptions {
    allCaps?: boolean;
    author: string;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    date: string;
    doubleStrike?: boolean;
    effect?:
        | "none"
        | "blinkBackground"
        | "lights"
        | "antsBlack"
        | "antsRed"
        | "shimmer"
        | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?:
        | "none"
        | "black"
        | "blue"
        | "cyan"
        | "darkBlue"
        | "darkCyan"
        | "darkGray"
        | "darkGreen"
        | "darkMagenta"
        | "darkRed"
        | "darkYellow"
        | "green"
        | "lightGray"
        | "magenta"
        | "red"
        | "white"
        | "yellow";
    highlightComplexScript?: string | boolean;
    id: number;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?:
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    sizeComplexScript?:
        | number
        | boolean
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?:
            | "single"
            | "dotDash"
            | "dotDotDash"
            | "dotted"
            | "double"
            | "none"
            | "thick"
            | "wave"
            | "words"
            | "dottedHeavy"
            | "dash"
            | "dashedHeavy"
            | "dashLong"
            | "dashLongHeavy"
            | "dashDotHeavy"
            | "dashDotDotHeavy"
            | "wavyHeavy"
            | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy (view full)

Properties

allCaps? +IRunPropertiesChangeOptions | docx

InterfaceIRunPropertiesChangeOptions

interface IRunPropertiesChangeOptions {
    allCaps?: boolean;
    author: string;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    date: string;
    doubleStrike?: boolean;
    effect?:
        | "none"
        | "blinkBackground"
        | "lights"
        | "antsBlack"
        | "antsRed"
        | "shimmer"
        | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?:
        | "none"
        | "black"
        | "blue"
        | "cyan"
        | "darkBlue"
        | "darkCyan"
        | "darkGray"
        | "darkGreen"
        | "darkMagenta"
        | "darkRed"
        | "darkYellow"
        | "green"
        | "lightGray"
        | "magenta"
        | "red"
        | "white"
        | "yellow";
    highlightComplexScript?: string | boolean;
    id: number;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?:
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    sizeComplexScript?:
        | number
        | boolean
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?:
            | "single"
            | "dotDash"
            | "dotDotDash"
            | "dotted"
            | "double"
            | "none"
            | "thick"
            | "wave"
            | "words"
            | "dottedHeavy"
            | "dash"
            | "dashedHeavy"
            | "dashLong"
            | "dashLongHeavy"
            | "dashDotHeavy"
            | "dashDotDotHeavy"
            | "wavyHeavy"
            | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy (view full)

Properties

allCaps? author bold? boldComplexScript? @@ -37,4 +37,4 @@ superScript? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Readonlyauthor

author: string

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Readonlydate

date: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Readonlyid

id: number

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Readonlyauthor

author: string

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Readonlydate

date: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Readonlyid

id: number

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunPropertiesOptions.html b/api/interfaces/IRunPropertiesOptions.html index 4f4a1bcdf5..98627438ef 100644 --- a/api/interfaces/IRunPropertiesOptions.html +++ b/api/interfaces/IRunPropertiesOptions.html @@ -1,4 +1,4 @@ -IRunPropertiesOptions | docx

InterfaceIRunPropertiesOptions

interface IRunPropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    doubleStrike?: boolean;
    effect?:
        | "none"
        | "blinkBackground"
        | "lights"
        | "antsBlack"
        | "antsRed"
        | "shimmer"
        | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?:
        | "none"
        | "black"
        | "blue"
        | "cyan"
        | "darkBlue"
        | "darkCyan"
        | "darkGray"
        | "darkGreen"
        | "darkMagenta"
        | "darkRed"
        | "darkYellow"
        | "green"
        | "lightGray"
        | "magenta"
        | "red"
        | "white"
        | "yellow";
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?:
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    sizeComplexScript?:
        | number
        | boolean
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?:
            | "single"
            | "dotDash"
            | "dotDotDash"
            | "dotted"
            | "double"
            | "none"
            | "thick"
            | "wave"
            | "words"
            | "dottedHeavy"
            | "dash"
            | "dashedHeavy"
            | "dashLong"
            | "dashLongHeavy"
            | "dashDotHeavy"
            | "dashDotDotHeavy"
            | "wavyHeavy"
            | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy (view full)

Properties

allCaps? +IRunPropertiesOptions | docx

InterfaceIRunPropertiesOptions

interface IRunPropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    doubleStrike?: boolean;
    effect?:
        | "none"
        | "blinkBackground"
        | "lights"
        | "antsBlack"
        | "antsRed"
        | "shimmer"
        | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?:
        | "none"
        | "black"
        | "blue"
        | "cyan"
        | "darkBlue"
        | "darkCyan"
        | "darkGray"
        | "darkGreen"
        | "darkMagenta"
        | "darkRed"
        | "darkYellow"
        | "green"
        | "lightGray"
        | "magenta"
        | "red"
        | "white"
        | "yellow";
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?:
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    sizeComplexScript?:
        | number
        | boolean
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    style?: string;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?:
            | "single"
            | "dotDash"
            | "dotDotDash"
            | "dotted"
            | "double"
            | "none"
            | "thick"
            | "wave"
            | "words"
            | "dottedHeavy"
            | "dash"
            | "dashedHeavy"
            | "dashLong"
            | "dashLongHeavy"
            | "dashDotHeavy"
            | "dashDotDotHeavy"
            | "wavyHeavy"
            | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy (view full)

Properties

allCaps? bold? boldComplexScript? border? @@ -34,4 +34,4 @@ superScript? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

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

InterfaceIRunStylePropertiesOptions

interface IRunStylePropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    doubleStrike?: boolean;
    effect?:
        | "none"
        | "blinkBackground"
        | "lights"
        | "antsBlack"
        | "antsRed"
        | "shimmer"
        | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?:
        | "none"
        | "black"
        | "blue"
        | "cyan"
        | "darkBlue"
        | "darkCyan"
        | "darkGray"
        | "darkGreen"
        | "darkMagenta"
        | "darkRed"
        | "darkYellow"
        | "green"
        | "lightGray"
        | "magenta"
        | "red"
        | "white"
        | "yellow";
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?:
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    sizeComplexScript?:
        | number
        | boolean
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?:
            | "single"
            | "dotDash"
            | "dotDotDash"
            | "dotted"
            | "double"
            | "none"
            | "thick"
            | "wave"
            | "words"
            | "dottedHeavy"
            | "dash"
            | "dashedHeavy"
            | "dashLong"
            | "dashLongHeavy"
            | "dashDotHeavy"
            | "dashDotDotHeavy"
            | "wavyHeavy"
            | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy (view full)

Properties

allCaps? +IRunStylePropertiesOptions | docx

InterfaceIRunStylePropertiesOptions

interface IRunStylePropertiesOptions {
    allCaps?: boolean;
    bold?: boolean;
    boldComplexScript?: boolean;
    border?: IBorderOptions;
    characterSpacing?: number;
    color?: string;
    doubleStrike?: boolean;
    effect?:
        | "none"
        | "blinkBackground"
        | "lights"
        | "antsBlack"
        | "antsRed"
        | "shimmer"
        | "sparkle";
    emboss?: boolean;
    emphasisMark?: {
        type?: "dot";
    };
    font?: string | IFontAttributesProperties | IFontOptions;
    highlight?:
        | "none"
        | "black"
        | "blue"
        | "cyan"
        | "darkBlue"
        | "darkCyan"
        | "darkGray"
        | "darkGreen"
        | "darkMagenta"
        | "darkRed"
        | "darkYellow"
        | "green"
        | "lightGray"
        | "magenta"
        | "red"
        | "white"
        | "yellow";
    highlightComplexScript?: string | boolean;
    imprint?: boolean;
    italics?: boolean;
    italicsComplexScript?: boolean;
    kern?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    language?: ILanguageOptions;
    math?: boolean;
    noProof?: boolean;
    position?:
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`
        | `-${number}mm`
        | `-${number}cm`
        | `-${number}in`
        | `-${number}pt`
        | `-${number}pc`
        | `-${number}pi`;
    revision?: IRunPropertiesChangeOptions;
    rightToLeft?: boolean;
    scale?: number;
    shading?: IShadingAttributesProperties;
    size?:
        | number
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    sizeComplexScript?:
        | number
        | boolean
        | `${number}mm`
        | `${number}cm`
        | `${number}in`
        | `${number}pt`
        | `${number}pc`
        | `${number}pi`;
    smallCaps?: boolean;
    snapToGrid?: boolean;
    specVanish?: boolean;
    strike?: boolean;
    subScript?: boolean;
    superScript?: boolean;
    underline?: {
        color?: string;
        type?:
            | "single"
            | "dotDash"
            | "dotDotDash"
            | "dotted"
            | "double"
            | "none"
            | "thick"
            | "wave"
            | "words"
            | "dottedHeavy"
            | "dash"
            | "dashedHeavy"
            | "dashLong"
            | "dashLongHeavy"
            | "dashDotHeavy"
            | "dashDotDotHeavy"
            | "wavyHeavy"
            | "wavyDouble";
    };
    vanish?: boolean;
}

Hierarchy (view full)

Properties

allCaps? bold? boldComplexScript? border? @@ -33,4 +33,4 @@ superScript? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

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

InterfaceISectionOptions

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

Properties

children +ISectionOptions | docx

InterfaceISectionOptions

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

Properties

children footers? headers? properties? -

Properties

Readonlychildren

children: readonly FileChild[]

Optional Readonlyfooters

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

Optional Readonlyheaders

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

Optional Readonlyproperties

properties?: ISectionPropertiesOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly FileChild[]

Optional Readonlyfooters

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

Optional Readonlyheaders

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

Optional Readonlyproperties

properties?: ISectionPropertiesOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISectionPropertiesOptions.html b/api/interfaces/ISectionPropertiesOptions.html index 55c9daf3c4..7bf48aa33b 100644 --- a/api/interfaces/ISectionPropertiesOptions.html +++ b/api/interfaces/ISectionPropertiesOptions.html @@ -1,4 +1,4 @@ -ISectionPropertiesOptions | docx

InterfaceISectionPropertiesOptions

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

Properties

column? +ISectionPropertiesOptions | docx

InterfaceISectionPropertiesOptions

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

Properties

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

Properties

Optional Readonlycolumn

column?: IColumnsAttributes

Optional ReadonlyfooterWrapperGroup

footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>

Optional Readonlygrid

grid?: IDocGridAttributesProperties

Optional ReadonlyheaderWrapperGroup

headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>

Optional ReadonlylineNumbers

lineNumbers?: ILineNumberAttributes

Optional Readonlypage

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

Optional ReadonlytitlePage

titlePage?: boolean

Optional Readonlytype

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

Optional ReadonlyverticalAlign

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolumn

column?: IColumnsAttributes

Optional ReadonlyfooterWrapperGroup

footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>

Optional Readonlygrid

grid?: IDocGridAttributesProperties

Optional ReadonlyheaderWrapperGroup

headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>

Optional ReadonlylineNumbers

lineNumbers?: ILineNumberAttributes

Optional Readonlypage

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

Optional ReadonlytitlePage

titlePage?: boolean

Optional Readonlytype

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

Optional ReadonlyverticalAlign

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IShadingAttributesProperties.html b/api/interfaces/IShadingAttributesProperties.html index 410823e7f6..5acf935cd8 100644 --- a/api/interfaces/IShadingAttributesProperties.html +++ b/api/interfaces/IShadingAttributesProperties.html @@ -1,4 +1,4 @@ -IShadingAttributesProperties | docx

InterfaceIShadingAttributesProperties

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

Properties

color? +IShadingAttributesProperties | docx

InterfaceIShadingAttributesProperties

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

Properties

color? fill? type? -

Properties

Optional Readonlycolor

color?: string

Optional Readonlyfill

fill?: string

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolor

color?: string

Optional Readonlyfill

fill?: string

Optional Readonlytype

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

Settings

Member Visibility

On This Page

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

InterfaceISpacingProperties

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

Properties

after? +ISpacingProperties | docx

InterfaceISpacingProperties

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

Properties

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

Properties

Optional Readonlyafter

after?: number

Optional ReadonlyafterAutoSpacing

afterAutoSpacing?: boolean

Optional Readonlybefore

before?: number

Optional ReadonlybeforeAutoSpacing

beforeAutoSpacing?: boolean

Optional Readonlyline

line?: number

Optional ReadonlylineRule

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyafter

after?: number

Optional ReadonlyafterAutoSpacing

afterAutoSpacing?: boolean

Optional Readonlybefore

before?: number

Optional ReadonlybeforeAutoSpacing

beforeAutoSpacing?: boolean

Optional Readonlyline

line?: number

Optional ReadonlylineRule

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

Settings

Member Visibility

On This Page

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

InterfaceIStylesOptions

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

Properties

characterStyles? +IStylesOptions | docx

InterfaceIStylesOptions

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

Properties

characterStyles? default? importedStyles? initialStyles? paragraphStyles? -

Properties

Optional ReadonlycharacterStyles

characterStyles?: readonly ICharacterStyleOptions[]

Optional Readonlydefault

default?: IDefaultStylesOptions

Optional ReadonlyimportedStyles

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

Optional ReadonlyinitialStyles

initialStyles?: BaseXmlComponent

Optional ReadonlyparagraphStyles

paragraphStyles?: readonly IParagraphStyleOptions[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycharacterStyles

characterStyles?: readonly ICharacterStyleOptions[]

Optional Readonlydefault

default?: IDefaultStylesOptions

Optional ReadonlyimportedStyles

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

Optional ReadonlyinitialStyles

initialStyles?: BaseXmlComponent

Optional ReadonlyparagraphStyles

paragraphStyles?: readonly IParagraphStyleOptions[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISymbolRunOptions.html b/api/interfaces/ISymbolRunOptions.html index 2300ad0408..6823184a3a 100644 --- a/api/interfaces/ISymbolRunOptions.html +++ b/api/interfaces/ISymbolRunOptions.html @@ -1,4 +1,4 @@ -ISymbolRunOptions | docx

InterfaceISymbolRunOptions

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

Hierarchy (view full)

Properties

allCaps? +ISymbolRunOptions | docx

InterfaceISymbolRunOptions

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

Hierarchy (view full)

Properties

allCaps? bold? boldComplexScript? border? @@ -39,4 +39,4 @@ text? underline? vanish? -

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Readonlychar

char: string

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlysymbolfont

symbolfont?: string

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Readonlychar

char: string

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlysymbolfont

symbolfont?: string

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

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

InterfaceITableBordersOptions

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

Properties

bottom? +ITableBordersOptions | docx

InterfaceITableBordersOptions

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

Properties

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

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional ReadonlyinsideHorizontal

insideHorizontal?: IBorderOptions

Optional ReadonlyinsideVertical

insideVertical?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional ReadonlyinsideHorizontal

insideHorizontal?: IBorderOptions

Optional ReadonlyinsideVertical

insideVertical?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableCellBorders.html b/api/interfaces/ITableCellBorders.html index 1e4f27b441..df26e0d74c 100644 --- a/api/interfaces/ITableCellBorders.html +++ b/api/interfaces/ITableCellBorders.html @@ -1,7 +1,7 @@ -ITableCellBorders | docx

InterfaceITableCellBorders

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

Properties

bottom? +ITableCellBorders | docx

InterfaceITableCellBorders

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

Properties

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

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyend

end?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlystart

start?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyend

end?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlystart

start?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

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

InterfaceITableCellOptions

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

Hierarchy

  • ITableCellPropertiesOptions
    • ITableCellOptions

Properties

borders? +ITableCellOptions | docx

InterfaceITableCellOptions

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

Hierarchy

  • ITableCellPropertiesOptions
    • ITableCellOptions

Properties

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

Properties

Optional Readonlyborders

borders?: ITableCellBorders

Readonlychildren

children: readonly (Paragraph | Table)[]

Optional ReadonlycolumnSpan

columnSpan?: number

Optional Readonlymargins

margins?: ITableCellMarginOptions

Optional ReadonlyrowSpan

rowSpan?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional ReadonlytextDirection

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

Optional ReadonlyverticalAlign

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

Optional ReadonlyverticalMerge

verticalMerge?: "continue" | "restart"

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyborders

borders?: ITableCellBorders

Readonlychildren

children: readonly (Paragraph | Table)[]

Optional ReadonlycolumnSpan

columnSpan?: number

Optional Readonlymargins

margins?: ITableCellMarginOptions

Optional ReadonlyrowSpan

rowSpan?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional ReadonlytextDirection

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

Optional ReadonlyverticalAlign

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

Optional ReadonlyverticalMerge

verticalMerge?: "continue" | "restart"

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableOfContentsOptions.html b/api/interfaces/ITableOfContentsOptions.html index a2c90c097f..174d1a48d3 100644 --- a/api/interfaces/ITableOfContentsOptions.html +++ b/api/interfaces/ITableOfContentsOptions.html @@ -3,7 +3,7 @@ Part 1 - Page 1251

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

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

Properties

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

Properties

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

Properties

Optional ReadonlycaptionLabel

captionLabel?: string

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

-

Optional ReadonlycaptionLabelIncludingNumbers

captionLabelIncludingNumbers?: string

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

Optional ReadonlycaptionLabelIncludingNumbers

captionLabelIncludingNumbers?: string

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

-

Optional ReadonlyentriesFromBookmark

entriesFromBookmark?: string

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

Optional ReadonlyentriesFromBookmark

entriesFromBookmark?: string

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

-

Optional ReadonlyentryAndPageNumberSeparator

entryAndPageNumberSeparator?: string

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

Optional ReadonlyentryAndPageNumberSeparator

entryAndPageNumberSeparator?: string

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

-

Optional ReadonlyheadingStyleRange

headingStyleRange?: string

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

Optional ReadonlyheadingStyleRange

headingStyleRange?: string

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

-

Optional ReadonlyhideTabAndPageNumbersInWebView

hideTabAndPageNumbersInWebView?: boolean

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

-

Optional Readonlyhyperlink

hyperlink?: boolean

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

-

Optional ReadonlypageNumbersEntryLevelsRange

pageNumbersEntryLevelsRange?: string

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

Optional ReadonlyhideTabAndPageNumbersInWebView

hideTabAndPageNumbersInWebView?: boolean

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

+

Optional Readonlyhyperlink

hyperlink?: boolean

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

+

Optional ReadonlypageNumbersEntryLevelsRange

pageNumbersEntryLevelsRange?: string

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

-

Optional ReadonlypreserveNewLineInEntries

preserveNewLineInEntries?: boolean

\x Preserves newline characters within table entries.

-

Optional ReadonlypreserveTabInEntries

preserveTabInEntries?: boolean

\w Preserves tab entries within table entries.

-

Optional ReadonlyseqFieldIdentifierForPrefix

seqFieldIdentifierForPrefix?: string

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

Optional ReadonlypreserveNewLineInEntries

preserveNewLineInEntries?: boolean

\x Preserves newline characters within table entries.

+

Optional ReadonlypreserveTabInEntries

preserveTabInEntries?: boolean

\w Preserves tab entries within table entries.

+

Optional ReadonlyseqFieldIdentifierForPrefix

seqFieldIdentifierForPrefix?: string

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

-

Optional ReadonlysequenceAndPageNumbersSeparator

sequenceAndPageNumbersSeparator?: string

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

Optional ReadonlysequenceAndPageNumbersSeparator

sequenceAndPageNumbersSeparator?: string

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

-

Optional ReadonlystylesWithLevels

stylesWithLevels?: readonly StyleLevel[]

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

Optional ReadonlystylesWithLevels

stylesWithLevels?: readonly StyleLevel[]

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

-

Optional ReadonlytcFieldIdentifier

tcFieldIdentifier?: string

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

Optional ReadonlytcFieldIdentifier

tcFieldIdentifier?: string

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

-

Optional ReadonlytcFieldLevelRange

tcFieldLevelRange?: string

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

Optional ReadonlytcFieldLevelRange

tcFieldLevelRange?: string

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

-

Optional ReadonlyuseAppliedParagraphOutlineLevel

useAppliedParagraphOutlineLevel?: boolean

\u Uses the applied paragraph outline level.

-

Settings

Member Visibility

On This Page

Properties
+

Optional ReadonlyuseAppliedParagraphOutlineLevel

useAppliedParagraphOutlineLevel?: boolean

\u Uses the applied paragraph outline level.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableOptions.html b/api/interfaces/ITableOptions.html index 7a6e402cc9..af7de01064 100644 --- a/api/interfaces/ITableOptions.html +++ b/api/interfaces/ITableOptions.html @@ -1,4 +1,4 @@ -ITableOptions | docx

InterfaceITableOptions

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

Properties

alignment? +ITableOptions | docx

InterfaceITableOptions

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

Properties

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

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycolumnWidths

columnWidths?: readonly number[]

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlymargins

margins?: ITableCellMarginOptions

Readonlyrows

rows: readonly TableRow[]

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycolumnWidths

columnWidths?: readonly number[]

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlymargins

margins?: ITableCellMarginOptions

Readonlyrows

rows: readonly TableRow[]

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITablePropertiesOptions.html b/api/interfaces/ITablePropertiesOptions.html index 4f7408edf6..2566a6a809 100644 --- a/api/interfaces/ITablePropertiesOptions.html +++ b/api/interfaces/ITablePropertiesOptions.html @@ -1,4 +1,4 @@ -ITablePropertiesOptions | docx

InterfaceITablePropertiesOptions

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

Properties

alignment? +ITablePropertiesOptions | docx

InterfaceITablePropertiesOptions

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

Properties

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

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycellMargin

cellMargin?: ITableCellMarginOptions

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycellMargin

cellMargin?: ITableCellMarginOptions

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableRowOptions.html b/api/interfaces/ITableRowOptions.html index 136810f679..0bd4b62a50 100644 --- a/api/interfaces/ITableRowOptions.html +++ b/api/interfaces/ITableRowOptions.html @@ -1,5 +1,5 @@ -ITableRowOptions | docx

InterfaceITableRowOptions

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

Hierarchy (view full)

Properties

cantSplit? +ITableRowOptions | docx

InterfaceITableRowOptions

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

Hierarchy (view full)

Properties

cantSplit? children height? tableHeader? -

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Readonlychildren

children: readonly TableCell[]

Optional Readonlyheight

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

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Readonlychildren

children: readonly TableCell[]

Optional Readonlyheight

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

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

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

InterfaceITableRowPropertiesOptions

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

Hierarchy (view full)

Properties

cantSplit? +ITableRowPropertiesOptions | docx

InterfaceITableRowPropertiesOptions

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

Hierarchy (view full)

Properties

cantSplit? height? tableHeader? -

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Optional Readonlyheight

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

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Optional Readonlyheight

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

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITextWrapping.html b/api/interfaces/ITextWrapping.html index eca90fb6c2..67f83f7f86 100644 --- a/api/interfaces/ITextWrapping.html +++ b/api/interfaces/ITextWrapping.html @@ -1,4 +1,4 @@ -ITextWrapping | docx

InterfaceITextWrapping

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

Properties

margins? +ITextWrapping | docx

InterfaceITextWrapping

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

Properties

margins? side? type -

Properties

Optional Readonlymargins

margins?: IDistance

Optional Readonlyside

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

Readonlytype

type:
    | 0
    | 1
    | 2
    | 3

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlymargins

margins?: IDistance

Optional Readonlyside

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

Readonlytype

type:
    | 0
    | 1
    | 2
    | 3

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IVerticalPositionOptions.html b/api/interfaces/IVerticalPositionOptions.html index 623d2373d5..0267cf12a3 100644 --- a/api/interfaces/IVerticalPositionOptions.html +++ b/api/interfaces/IVerticalPositionOptions.html @@ -1,4 +1,4 @@ -IVerticalPositionOptions | docx

InterfaceIVerticalPositionOptions

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

Properties

align? +IVerticalPositionOptions | docx

InterfaceIVerticalPositionOptions

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

Properties

align? offset? relative? -

Properties

Optional Readonlyalign

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

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalign

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

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IXYFrameOptions.html b/api/interfaces/IXYFrameOptions.html index 266adf13b3..6c198207c8 100644 --- a/api/interfaces/IXYFrameOptions.html +++ b/api/interfaces/IXYFrameOptions.html @@ -1,4 +1,4 @@ -IXYFrameOptions | docx

InterfaceIXYFrameOptions

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

Hierarchy

  • IBaseFrameOptions
    • IXYFrameOptions

Properties

anchor +IXYFrameOptions | docx

InterfaceIXYFrameOptions

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

Hierarchy

  • IBaseFrameOptions
    • IXYFrameOptions

Properties

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

Properties

Readonlyanchor

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

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

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

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Readonlyposition

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

Optional Readonlyrule

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

Optional Readonlyspace

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

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyanchor

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

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

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

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Readonlyposition

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

Optional Readonlyrule

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

Optional Readonlyspace

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

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IXmlAttribute.html b/api/interfaces/IXmlAttribute.html index 30a25ddb25..2335a8dc07 100644 --- a/api/interfaces/IXmlAttribute.html +++ b/api/interfaces/IXmlAttribute.html @@ -1 +1 @@ -IXmlAttribute | docx

InterfaceIXmlAttribute

Indexable

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

Settings

Member Visibility
+IXmlAttribute | docx

InterfaceIXmlAttribute

Indexable

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

Settings

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

InterfaceIXmlableObject

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

  • [key: string]: any

Settings

Member Visibility
+IXmlableObject | docx

InterfaceIXmlableObject

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

  • [key: string]: any

Settings

Member Visibility
diff --git a/api/interfaces/PositionalTabOptions.html b/api/interfaces/PositionalTabOptions.html index 8be3deed41..75e079943d 100644 --- a/api/interfaces/PositionalTabOptions.html +++ b/api/interfaces/PositionalTabOptions.html @@ -1,4 +1,4 @@ -PositionalTabOptions | docx

InterfacePositionalTabOptions

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

Properties

alignment +PositionalTabOptions | docx

InterfacePositionalTabOptions

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

Properties

alignment leader relativeTo -

Properties

Readonlyalignment

alignment: "center" | "left" | "right"

Readonlyleader

leader:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

ReadonlyrelativeTo

relativeTo: "indent" | "margin"

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyalignment

alignment: "center" | "left" | "right"

Readonlyleader

leader:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

ReadonlyrelativeTo

relativeTo: "indent" | "margin"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/TabStopDefinition.html b/api/interfaces/TabStopDefinition.html index be60fb9542..25c04c8e51 100644 --- a/api/interfaces/TabStopDefinition.html +++ b/api/interfaces/TabStopDefinition.html @@ -1,4 +1,4 @@ -TabStopDefinition | docx

InterfaceTabStopDefinition

interface TabStopDefinition {
    leader?:
        | "none"
        | "dot"
        | "hyphen"
        | "underscore"
        | "middleDot";
    position: number;
    type:
        | "center"
        | "clear"
        | "left"
        | "right"
        | "start"
        | "end"
        | "decimal"
        | "bar"
        | "num";
}

Properties

leader? +TabStopDefinition | docx

InterfaceTabStopDefinition

interface TabStopDefinition {
    leader?:
        | "none"
        | "dot"
        | "hyphen"
        | "underscore"
        | "middleDot";
    position: number;
    type:
        | "center"
        | "clear"
        | "left"
        | "right"
        | "start"
        | "end"
        | "decimal"
        | "bar"
        | "num";
}

Properties

leader? position type -

Properties

Optional Readonlyleader

leader?:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

Readonlyposition

position: number

Readonlytype

type:
    | "center"
    | "clear"
    | "left"
    | "right"
    | "start"
    | "end"
    | "decimal"
    | "bar"
    | "num"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyleader

leader?:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

Readonlyposition

position: number

Readonlytype

type:
    | "center"
    | "clear"
    | "left"
    | "right"
    | "start"
    | "end"
    | "decimal"
    | "bar"
    | "num"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/types/AttributeData.html b/api/types/AttributeData.html index 12a4fc4c3b..976ea4a7a0 100644 --- a/api/types/AttributeData.html +++ b/api/types/AttributeData.html @@ -1 +1 @@ -AttributeData | docx

Type AliasAttributeData

AttributeData: {
    [key: string]: boolean | number | string;
}

Settings

Member Visibility
+AttributeData | docx

Type AliasAttributeData

AttributeData: {
    [key: string]: boolean | number | string;
}

Settings

Member Visibility
diff --git a/api/types/AttributePayload.html b/api/types/AttributePayload.html index 692ddfed35..13258ac76f 100644 --- a/api/types/AttributePayload.html +++ b/api/types/AttributePayload.html @@ -1 +1 @@ -AttributePayload | docx

Type AliasAttributePayload<T>

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

Type Parameters

  • T

Settings

Member Visibility
+AttributePayload | docx

Type AliasAttributePayload<T>

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

Type Parameters

  • T

Settings

Member Visibility
diff --git a/api/types/IColumnsAttributes.html b/api/types/IColumnsAttributes.html index cba8be6756..a6e3720c65 100644 --- a/api/types/IColumnsAttributes.html +++ b/api/types/IColumnsAttributes.html @@ -1 +1 @@ -IColumnsAttributes | docx

Type AliasIColumnsAttributes

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

Settings

Member Visibility
+IColumnsAttributes | docx

Type AliasIColumnsAttributes

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

Settings

Member Visibility
diff --git a/api/types/IDistance.html b/api/types/IDistance.html index bf99f37155..47a77fa590 100644 --- a/api/types/IDistance.html +++ b/api/types/IDistance.html @@ -1 +1 @@ -IDistance | docx

Type AliasIDistance

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

Settings

Member Visibility
+IDistance | docx

Type AliasIDistance

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

Settings

Member Visibility
diff --git a/api/types/IFrameOptions.html b/api/types/IFrameOptions.html index 09a8eccf80..04ad375bce 100644 --- a/api/types/IFrameOptions.html +++ b/api/types/IFrameOptions.html @@ -1 +1 @@ -IFrameOptions | docx

Type AliasIFrameOptions

IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions

Settings

Member Visibility
+IFrameOptions | docx

Type AliasIFrameOptions

IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions

Settings

Member Visibility
diff --git a/api/types/IImageOptions.html b/api/types/IImageOptions.html index 3f13f5fd03..32adf8cd69 100644 --- a/api/types/IImageOptions.html +++ b/api/types/IImageOptions.html @@ -1 +1 @@ -IImageOptions | docx

Type AliasIImageOptions

IImageOptions: (RegularImageOptions | SvgMediaOptions) & CoreImageOptions

Settings

Member Visibility
+IImageOptions | docx

Type AliasIImageOptions

IImageOptions: (RegularImageOptions | SvgMediaOptions) & CoreImageOptions

Settings

Member Visibility
diff --git a/api/types/ILineNumberAttributes.html b/api/types/ILineNumberAttributes.html index 53e6151ae1..84df0f7a7c 100644 --- a/api/types/ILineNumberAttributes.html +++ b/api/types/ILineNumberAttributes.html @@ -1 +1 @@ -ILineNumberAttributes | docx

Type AliasILineNumberAttributes

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

Settings

Member Visibility
+ILineNumberAttributes | docx

Type AliasILineNumberAttributes

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

Settings

Member Visibility
diff --git a/api/types/IMediaData.html b/api/types/IMediaData.html index 33e7c5f790..6cafa17a99 100644 --- a/api/types/IMediaData.html +++ b/api/types/IMediaData.html @@ -1 +1 @@ -IMediaData | docx

Type AliasIMediaData

IMediaData: (RegularMediaData | SvgMediaData) & CoreMediaData

Settings

Member Visibility
+IMediaData | docx

Type AliasIMediaData

IMediaData: (RegularMediaData | SvgMediaData) & CoreMediaData

Settings

Member Visibility
diff --git a/api/types/IPageMarginAttributes.html b/api/types/IPageMarginAttributes.html index c86e46f72c..c42ab9dcfc 100644 --- a/api/types/IPageMarginAttributes.html +++ b/api/types/IPageMarginAttributes.html @@ -1 +1 @@ -IPageMarginAttributes | docx

Type AliasIPageMarginAttributes

IPageMarginAttributes: {
    bottom?: number | UniversalMeasure;
    footer?: number | PositiveUniversalMeasure;
    gutter?: number | PositiveUniversalMeasure;
    header?: number | PositiveUniversalMeasure;
    left?: number | PositiveUniversalMeasure;
    right?: number | PositiveUniversalMeasure;
    top?: number | UniversalMeasure;
}

Settings

Member Visibility
+IPageMarginAttributes | docx

Type AliasIPageMarginAttributes

IPageMarginAttributes: {
    bottom?: number | UniversalMeasure;
    footer?: number | PositiveUniversalMeasure;
    gutter?: number | PositiveUniversalMeasure;
    header?: number | PositiveUniversalMeasure;
    left?: number | PositiveUniversalMeasure;
    right?: number | PositiveUniversalMeasure;
    top?: number | UniversalMeasure;
}

Settings

Member Visibility
diff --git a/api/types/IPageReferenceOptions.html b/api/types/IPageReferenceOptions.html index 2b5e3fd375..c3d75e2e86 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 628c24fef0..99b64cc322 100644 --- a/api/types/IPageSizeAttributes.html +++ b/api/types/IPageSizeAttributes.html @@ -1 +1 @@ -IPageSizeAttributes | docx

Type AliasIPageSizeAttributes

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

Settings

Member Visibility
+IPageSizeAttributes | docx

Type AliasIPageSizeAttributes

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

Settings

Member Visibility
diff --git a/api/types/IPatch.html b/api/types/IPatch.html index 77bc1a8b28..6cd65c7dae 100644 --- a/api/types/IPatch.html +++ b/api/types/IPatch.html @@ -1 +1 @@ -IPatch | docx

Type AliasIPatch

IPatch: ParagraphPatch | FilePatch

Settings

Member Visibility
+IPatch | docx

Type AliasIPatch

IPatch: ParagraphPatch | FilePatch

Settings

Member Visibility
diff --git a/api/types/ITableFloatOptions.html b/api/types/ITableFloatOptions.html index 79d428956e..defd74a486 100644 --- a/api/types/ITableFloatOptions.html +++ b/api/types/ITableFloatOptions.html @@ -44,4 +44,4 @@ margin - relative to the horizontal edge of the text margin before any text runs page - relative to the horizontal edge of the page before any text runs (top edge for top-to-bottom paragraphs) text - relative to the horizontal edge of the text margin for the column in which the anchor paragraph is located If omitted, the value is assumed to be page.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/types/ITableWidthProperties.html b/api/types/ITableWidthProperties.html index 6d7e640ab7..45c630b448 100644 --- a/api/types/ITableWidthProperties.html +++ b/api/types/ITableWidthProperties.html @@ -1 +1 @@ -ITableWidthProperties | docx

Type AliasITableWidthProperties

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

Settings

Member Visibility
+ITableWidthProperties | docx

Type AliasITableWidthProperties

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

Settings

Member Visibility
diff --git a/api/types/InputDataType.html b/api/types/InputDataType.html index c3d337c42b..c76b27b83f 100644 --- a/api/types/InputDataType.html +++ b/api/types/InputDataType.html @@ -1 +1 @@ -InputDataType | docx

Type AliasInputDataType

InputDataType:
    | Buffer
    | string
    | number[]
    | Uint8Array
    | ArrayBuffer
    | Blob
    | NodeJS.ReadableStream

Settings

Member Visibility
+InputDataType | docx

Type AliasInputDataType

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 03fb250f7f..7d09d229cc 100644 --- a/api/types/MathComponent.html +++ b/api/types/MathComponent.html @@ -1 +1 @@ -MathComponent | docx

Type AliasMathComponent

MathComponent:
    | MathRun
    | MathFraction
    | MathSum
    | MathIntegral
    | MathSuperScript
    | MathSubScript
    | MathSubSuperScript
    | MathRadical
    | MathFunction
    | MathRoundBrackets
    | MathCurlyBrackets
    | MathAngledBrackets
    | MathSquareBrackets

Settings

Member Visibility
+MathComponent | docx

Type AliasMathComponent

MathComponent:
    | MathRun
    | MathFraction
    | MathSum
    | MathIntegral
    | MathSuperScript
    | MathSubScript
    | MathSubSuperScript
    | MathRadical
    | MathFunction
    | MathRoundBrackets
    | MathCurlyBrackets
    | MathAngledBrackets
    | MathSquareBrackets

Settings

Member Visibility
diff --git a/api/types/ParagraphChild.html b/api/types/ParagraphChild.html index 0233028d34..6bbfd88c6b 100644 --- a/api/types/ParagraphChild.html +++ b/api/types/ParagraphChild.html @@ -1 +1 @@ -ParagraphChild | docx

Type AliasParagraphChild

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 AliasParagraphChild

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 56acd66d55..7761418549 100644 --- a/api/types/PatchDocumentOptions.html +++ b/api/types/PatchDocumentOptions.html @@ -1 +1 @@ -PatchDocumentOptions | docx

Type AliasPatchDocumentOptions<T>

PatchDocumentOptions<T>: {
    data: InputDataType;
    keepOriginalStyles?: boolean;
    outputType: T;
    patches: {
        [key: string]: IPatch;
    };
}

Type Parameters

Settings

Member Visibility
+PatchDocumentOptions | docx

Type AliasPatchDocumentOptions<T>

PatchDocumentOptions<T>: {
    data: InputDataType;
    keepOriginalStyles?: boolean;
    outputType: T;
    patches: {
        [key: string]: IPatch;
    };
}

Type Parameters

Settings

Member Visibility
diff --git a/api/types/PatchDocumentOutputType.html b/api/types/PatchDocumentOutputType.html index 22d58c629f..ea1af60afe 100644 --- a/api/types/PatchDocumentOutputType.html +++ b/api/types/PatchDocumentOutputType.html @@ -1 +1 @@ -PatchDocumentOutputType | docx

Type AliasPatchDocumentOutputType

PatchDocumentOutputType: keyof OutputByType

Settings

Member Visibility
+PatchDocumentOutputType | docx

Type AliasPatchDocumentOutputType

PatchDocumentOutputType: keyof OutputByType

Settings

Member Visibility
diff --git a/api/types/Percentage.html b/api/types/Percentage.html index 43dd8eace6..c58a12aba9 100644 --- a/api/types/Percentage.html +++ b/api/types/Percentage.html @@ -1 +1 @@ -Percentage | docx

Type AliasPercentage

Percentage: `${"-" | ""}${number}%`

Settings

Member Visibility
+Percentage | docx

Type AliasPercentage

Percentage: `${"-" | ""}${number}%`

Settings

Member Visibility
diff --git a/api/types/PositiveUniversalMeasure.html b/api/types/PositiveUniversalMeasure.html index 33759aad5a..c48b406e7c 100644 --- a/api/types/PositiveUniversalMeasure.html +++ b/api/types/PositiveUniversalMeasure.html @@ -1 +1 @@ -PositiveUniversalMeasure | docx

Type AliasPositiveUniversalMeasure

PositiveUniversalMeasure: `${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
+PositiveUniversalMeasure | docx

Type AliasPositiveUniversalMeasure

PositiveUniversalMeasure: `${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

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

Type AliasUniqueNumericIdCreator

UniqueNumericIdCreator: (() => number)

Settings

Member Visibility
+UniqueNumericIdCreator | docx

Type AliasUniqueNumericIdCreator

UniqueNumericIdCreator: (() => number)

Settings

Member Visibility
diff --git a/api/types/UniversalMeasure.html b/api/types/UniversalMeasure.html index ed6cbbd159..c151e241dc 100644 --- a/api/types/UniversalMeasure.html +++ b/api/types/UniversalMeasure.html @@ -1 +1 @@ -UniversalMeasure | docx

Type AliasUniversalMeasure

UniversalMeasure: `${"-" | ""}${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
+UniversalMeasure | docx

Type AliasUniversalMeasure

UniversalMeasure: `${"-" | ""}${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
diff --git a/api/variables/AlignmentType.html b/api/variables/AlignmentType.html index 7b1668ac9c..131de84ae1 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 07fd8410f8..e73657c8cb 100644 --- a/api/variables/BorderStyle.html +++ b/api/variables/BorderStyle.html @@ -1 +1 @@ -BorderStyle | docx

    VariableBorderStyleConst

    BorderStyle: {
        DASH_DOT_STROKED: "dashDotStroked";
        DASH_SMALL_GAP: "dashSmallGap";
        DASHED: "dashed";
        DOT_DASH: "dotDash";
        DOT_DOT_DASH: "dotDotDash";
        DOTTED: "dotted";
        DOUBLE: "double";
        DOUBLE_WAVE: "doubleWave";
        INSET: "inset";
        NIL: "nil";
        NONE: "none";
        OUTSET: "outset";
        SINGLE: "single";
        THICK: "thick";
        THICK_THIN_LARGE_GAP: "thickThinLargeGap";
        THICK_THIN_MEDIUM_GAP: "thickThinMediumGap";
        THICK_THIN_SMALL_GAP: "thickThinSmallGap";
        THIN_THICK_LARGE_GAP: "thinThickLargeGap";
        THIN_THICK_MEDIUM_GAP: "thinThickMediumGap";
        THIN_THICK_SMALL_GAP: "thinThickSmallGap";
        THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap";
        THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap";
        THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap";
        THREE_D_EMBOSS: "threeDEmboss";
        THREE_D_ENGRAVE: "threeDEngrave";
        TRIPLE: "triple";
        WAVE: "wave";
    } = ...

    Settings

    Member Visibility
    +BorderStyle | docx

    VariableBorderStyleConst

    BorderStyle: {
        DASH_DOT_STROKED: "dashDotStroked";
        DASH_SMALL_GAP: "dashSmallGap";
        DASHED: "dashed";
        DOT_DASH: "dotDash";
        DOT_DOT_DASH: "dotDotDash";
        DOTTED: "dotted";
        DOUBLE: "double";
        DOUBLE_WAVE: "doubleWave";
        INSET: "inset";
        NIL: "nil";
        NONE: "none";
        OUTSET: "outset";
        SINGLE: "single";
        THICK: "thick";
        THICK_THIN_LARGE_GAP: "thickThinLargeGap";
        THICK_THIN_MEDIUM_GAP: "thickThinMediumGap";
        THICK_THIN_SMALL_GAP: "thickThinSmallGap";
        THIN_THICK_LARGE_GAP: "thinThickLargeGap";
        THIN_THICK_MEDIUM_GAP: "thinThickMediumGap";
        THIN_THICK_SMALL_GAP: "thinThickSmallGap";
        THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap";
        THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap";
        THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap";
        THREE_D_EMBOSS: "threeDEmboss";
        THREE_D_ENGRAVE: "threeDEngrave";
        TRIPLE: "triple";
        WAVE: "wave";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/CharacterSet.html b/api/variables/CharacterSet.html index ebbfbfdd8a..5e2469f79a 100644 --- a/api/variables/CharacterSet.html +++ b/api/variables/CharacterSet.html @@ -1 +1 @@ -CharacterSet | docx

    VariableCharacterSetConst

    CharacterSet: {
        ANSI: "00";
        ARABIC: "B2";
        BALTIC: "BA";
        CHINESEBIG5: "88";
        DEFAULT: "01";
        EASTEUROPE: "EE";
        GB_2312: "86";
        GREEK: "A1";
        HANGUL: "81";
        HEBREW: "B1";
        JIS: "80";
        JOHAB: "82";
        MAC: "4D";
        OEM: "FF";
        RUSSIAN: "CC";
        SYMBOL: "02";
        THAI: "DE";
        TURKISH: "A2";
        VIETNAMESE: "A3";
    } = ...

    Settings

    Member Visibility
    +CharacterSet | docx

    VariableCharacterSetConst

    CharacterSet: {
        ANSI: "00";
        ARABIC: "B2";
        BALTIC: "BA";
        CHINESEBIG5: "88";
        DEFAULT: "01";
        EASTEUROPE: "EE";
        GB_2312: "86";
        GREEK: "A1";
        HANGUL: "81";
        HEBREW: "B1";
        JIS: "80";
        JOHAB: "82";
        MAC: "4D";
        OEM: "FF";
        RUSSIAN: "CC";
        SYMBOL: "02";
        THAI: "DE";
        TURKISH: "A2";
        VIETNAMESE: "A3";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/DocumentGridType.html b/api/variables/DocumentGridType.html index abac4c8b2e..8be6d4213f 100644 --- a/api/variables/DocumentGridType.html +++ b/api/variables/DocumentGridType.html @@ -1 +1 @@ -DocumentGridType | docx

    VariableDocumentGridTypeConst

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

    Settings

    Member Visibility
    +DocumentGridType | docx

    VariableDocumentGridTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/DropCapType.html b/api/variables/DropCapType.html index 51ce2c048c..385f4ceabb 100644 --- a/api/variables/DropCapType.html +++ b/api/variables/DropCapType.html @@ -1 +1 @@ -DropCapType | docx

    VariableDropCapTypeConst

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

    Settings

    Member Visibility
    +DropCapType | docx

    VariableDropCapTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/EMPTY_OBJECT.html b/api/variables/EMPTY_OBJECT.html index 6df56dc1a5..0dcf9e8905 100644 --- a/api/variables/EMPTY_OBJECT.html +++ b/api/variables/EMPTY_OBJECT.html @@ -1 +1 @@ -EMPTY_OBJECT | docx

    VariableEMPTY_OBJECTConst

    EMPTY_OBJECT: {} = ...

    Settings

    Member Visibility
    +EMPTY_OBJECT | docx

    VariableEMPTY_OBJECTConst

    EMPTY_OBJECT: {} = ...

    Settings

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

    VariableEmphasisMarkTypeConst

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

    Settings

    Member Visibility
    +EmphasisMarkType | docx

    VariableEmphasisMarkTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/FrameAnchorType.html b/api/variables/FrameAnchorType.html index 51e1384c98..9a5ae9578e 100644 --- a/api/variables/FrameAnchorType.html +++ b/api/variables/FrameAnchorType.html @@ -1 +1 @@ -FrameAnchorType | docx

    VariableFrameAnchorTypeConst

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

    Settings

    Member Visibility
    +FrameAnchorType | docx

    VariableFrameAnchorTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/FrameWrap.html b/api/variables/FrameWrap.html index 7a06370fb5..259ad0c5e8 100644 --- a/api/variables/FrameWrap.html +++ b/api/variables/FrameWrap.html @@ -1 +1 @@ -FrameWrap | docx

    VariableFrameWrapConst

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

    Settings

    Member Visibility
    +FrameWrap | docx

    VariableFrameWrapConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/HeaderFooterReferenceType.html b/api/variables/HeaderFooterReferenceType.html index 232fe02557..c96941ada3 100644 --- a/api/variables/HeaderFooterReferenceType.html +++ b/api/variables/HeaderFooterReferenceType.html @@ -1 +1 @@ -HeaderFooterReferenceType | docx

    VariableHeaderFooterReferenceTypeConst

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

    Settings

    Member Visibility
    +HeaderFooterReferenceType | docx

    VariableHeaderFooterReferenceTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/HeaderFooterType.html b/api/variables/HeaderFooterType.html index e37ac53946..712f11c9f0 100644 --- a/api/variables/HeaderFooterType.html +++ b/api/variables/HeaderFooterType.html @@ -1 +1 @@ -HeaderFooterType | docx

    VariableHeaderFooterTypeConst

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

    Settings

    Member Visibility
    +HeaderFooterType | docx

    VariableHeaderFooterTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/HeadingLevel.html b/api/variables/HeadingLevel.html index 1494d206ca..14c131bf51 100644 --- a/api/variables/HeadingLevel.html +++ b/api/variables/HeadingLevel.html @@ -1 +1 @@ -HeadingLevel | docx

    VariableHeadingLevelConst

    HeadingLevel: {
        HEADING_1: "Heading1";
        HEADING_2: "Heading2";
        HEADING_3: "Heading3";
        HEADING_4: "Heading4";
        HEADING_5: "Heading5";
        HEADING_6: "Heading6";
        TITLE: "Title";
    } = ...

    Settings

    Member Visibility
    +HeadingLevel | docx

    VariableHeadingLevelConst

    HeadingLevel: {
        HEADING_1: "Heading1";
        HEADING_2: "Heading2";
        HEADING_3: "Heading3";
        HEADING_4: "Heading4";
        HEADING_5: "Heading5";
        HEADING_6: "Heading6";
        TITLE: "Title";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HeightRule.html b/api/variables/HeightRule.html index a8cc31588c..082bcf2bcc 100644 --- a/api/variables/HeightRule.html +++ b/api/variables/HeightRule.html @@ -1,4 +1,4 @@ HeightRule | docx

    VariableHeightRuleConst

    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 280c5a8b61..899b47ee86 100644 --- a/api/variables/HighlightColor.html +++ b/api/variables/HighlightColor.html @@ -1 +1 @@ -HighlightColor | docx

    VariableHighlightColorConst

    HighlightColor: {
        BLACK: "black";
        BLUE: "blue";
        CYAN: "cyan";
        DARK_BLUE: "darkBlue";
        DARK_CYAN: "darkCyan";
        DARK_GRAY: "darkGray";
        DARK_GREEN: "darkGreen";
        DARK_MAGENTA: "darkMagenta";
        DARK_RED: "darkRed";
        DARK_YELLOW: "darkYellow";
        GREEN: "green";
        LIGHT_GRAY: "lightGray";
        MAGENTA: "magenta";
        NONE: "none";
        RED: "red";
        WHITE: "white";
        YELLOW: "yellow";
    } = ...

    Settings

    Member Visibility
    +HighlightColor | docx

    VariableHighlightColorConst

    HighlightColor: {
        BLACK: "black";
        BLUE: "blue";
        CYAN: "cyan";
        DARK_BLUE: "darkBlue";
        DARK_CYAN: "darkCyan";
        DARK_GRAY: "darkGray";
        DARK_GREEN: "darkGreen";
        DARK_MAGENTA: "darkMagenta";
        DARK_RED: "darkRed";
        DARK_YELLOW: "darkYellow";
        GREEN: "green";
        LIGHT_GRAY: "lightGray";
        MAGENTA: "magenta";
        NONE: "none";
        RED: "red";
        WHITE: "white";
        YELLOW: "yellow";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HorizontalPositionAlign.html b/api/variables/HorizontalPositionAlign.html index 6806bbef2a..5c08a2f5bd 100644 --- a/api/variables/HorizontalPositionAlign.html +++ b/api/variables/HorizontalPositionAlign.html @@ -1 +1 @@ -HorizontalPositionAlign | docx

    VariableHorizontalPositionAlignConst

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

    Settings

    Member Visibility
    +HorizontalPositionAlign | docx

    VariableHorizontalPositionAlignConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/HorizontalPositionRelativeFrom.html b/api/variables/HorizontalPositionRelativeFrom.html index 6dc5449fb6..47132e1a4a 100644 --- a/api/variables/HorizontalPositionRelativeFrom.html +++ b/api/variables/HorizontalPositionRelativeFrom.html @@ -1 +1 @@ -HorizontalPositionRelativeFrom | docx

    VariableHorizontalPositionRelativeFromConst

    HorizontalPositionRelativeFrom: {
        CHARACTER: "character";
        COLUMN: "column";
        INSIDE_MARGIN: "insideMargin";
        LEFT_MARGIN: "leftMargin";
        MARGIN: "margin";
        OUTSIDE_MARGIN: "outsideMargin";
        PAGE: "page";
        RIGHT_MARGIN: "rightMargin";
    } = ...

    Settings

    Member Visibility
    +HorizontalPositionRelativeFrom | docx

    VariableHorizontalPositionRelativeFromConst

    HorizontalPositionRelativeFrom: {
        CHARACTER: "character";
        COLUMN: "column";
        INSIDE_MARGIN: "insideMargin";
        LEFT_MARGIN: "leftMargin";
        MARGIN: "margin";
        OUTSIDE_MARGIN: "outsideMargin";
        PAGE: "page";
        RIGHT_MARGIN: "rightMargin";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/HyperlinkType.html b/api/variables/HyperlinkType.html index 61a2abb3a8..8de673d86a 100644 --- a/api/variables/HyperlinkType.html +++ b/api/variables/HyperlinkType.html @@ -1 +1 @@ -HyperlinkType | docx

    VariableHyperlinkTypeConst

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

    Settings

    Member Visibility
    +HyperlinkType | docx

    VariableHyperlinkTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/LeaderType.html b/api/variables/LeaderType.html index 1ef3589680..38d4bdc087 100644 --- a/api/variables/LeaderType.html +++ b/api/variables/LeaderType.html @@ -1 +1 @@ -LeaderType | docx

    VariableLeaderTypeConst

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

    Settings

    Member Visibility
    +LeaderType | docx

    VariableLeaderTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/LevelFormat.html b/api/variables/LevelFormat.html index 6dcc0ba997..28c3b60143 100644 --- a/api/variables/LevelFormat.html +++ b/api/variables/LevelFormat.html @@ -1 +1 @@ -LevelFormat | docx

    VariableLevelFormatConst

    LevelFormat: {
        AIUEO: "aiueo";
        AIUEO_FULL_WIDTH: "aiueoFullWidth";
        ARABIC_ABJAD: "arabicAbjad";
        ARABIC_ALPHA: "arabicAlpha";
        BAHT_TEXT: "bahtText";
        BULLET: "bullet";
        CARDINAL_TEXT: "cardinalText";
        CHICAGO: "chicago";
        CHINESE_COUNTING: "chineseCounting";
        CHINESE_COUNTING_THOUSAND: "chineseCountingThousand";
        CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
        CHOSUNG: "chosung";
        CUSTOM: "custom";
        DECIMAL: "decimal";
        DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
        DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
        DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop";
        DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen";
        DECIMAL_FULL_WIDTH: "decimalFullWidth";
        DECIMAL_FULL_WIDTH2: "decimalFullWidth2";
        DECIMAL_HALF_WIDTH: "decimalHalfWidth";
        DECIMAL_ZERO: "decimalZero";
        DOLLAR_TEXT: "dollarText";
        GANADA: "ganada";
        HEBREW1: "hebrew1";
        HEBREW2: "hebrew2";
        HEX: "hex";
        HINDI_CONSONANTS: "hindiConsonants";
        HINDI_COUNTING: "hindiCounting";
        HINDI_NUMBERS: "hindiNumbers";
        HINDI_VOWELS: "hindiVowels";
        IDEOGRAPH__DIGITAL: "ideographDigital";
        IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
        IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
        IDEOGRAPH_TRADITIONAL: "ideographTraditional";
        IDEOGRAPH_ZODIAC: "ideographZodiac";
        IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
        IROHA: "iroha";
        IROHA_FULL_WIDTH: "irohaFullWidth";
        JAPANESE_COUNTING: "japaneseCounting";
        JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
        JAPANESE_LEGAL: "japaneseLegal";
        KOREAN_COUNTING: "koreanCounting";
        KOREAN_DIGITAL: "koreanDigital";
        KOREAN_DIGITAL2: "koreanDigital2";
        KOREAN_LEGAL: "koreanLegal";
        LOWER_LETTER: "lowerLetter";
        LOWER_ROMAN: "lowerRoman";
        NONE: "none";
        NUMBER_IN_DASH: "numberInDash";
        ORDINAL: "ordinal";
        ORDINAL_TEXT: "ordinalText";
        RUSSIAN_LOWER: "russianLower";
        RUSSIAN_UPPER: "russianUpper";
        TAIWANESE_COUNTING: "taiwaneseCounting";
        TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
        TAIWANESE_DIGITAL: "taiwaneseDigital";
        THAI_COUNTING: "thaiCounting";
        THAI_LETTERS: "thaiLetters";
        THAI_NUMBERS: "thaiNumbers";
        UPPER_LETTER: "upperLetter";
        UPPER_ROMAN: "upperRoman";
        VIETNAMESE_COUNTING: "vietnameseCounting";
    } = ...

    Settings

    Member Visibility
    +LevelFormat | docx

    VariableLevelFormatConst

    LevelFormat: {
        AIUEO: "aiueo";
        AIUEO_FULL_WIDTH: "aiueoFullWidth";
        ARABIC_ABJAD: "arabicAbjad";
        ARABIC_ALPHA: "arabicAlpha";
        BAHT_TEXT: "bahtText";
        BULLET: "bullet";
        CARDINAL_TEXT: "cardinalText";
        CHICAGO: "chicago";
        CHINESE_COUNTING: "chineseCounting";
        CHINESE_COUNTING_THOUSAND: "chineseCountingThousand";
        CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
        CHOSUNG: "chosung";
        CUSTOM: "custom";
        DECIMAL: "decimal";
        DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
        DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
        DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop";
        DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen";
        DECIMAL_FULL_WIDTH: "decimalFullWidth";
        DECIMAL_FULL_WIDTH2: "decimalFullWidth2";
        DECIMAL_HALF_WIDTH: "decimalHalfWidth";
        DECIMAL_ZERO: "decimalZero";
        DOLLAR_TEXT: "dollarText";
        GANADA: "ganada";
        HEBREW1: "hebrew1";
        HEBREW2: "hebrew2";
        HEX: "hex";
        HINDI_CONSONANTS: "hindiConsonants";
        HINDI_COUNTING: "hindiCounting";
        HINDI_NUMBERS: "hindiNumbers";
        HINDI_VOWELS: "hindiVowels";
        IDEOGRAPH__DIGITAL: "ideographDigital";
        IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
        IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
        IDEOGRAPH_TRADITIONAL: "ideographTraditional";
        IDEOGRAPH_ZODIAC: "ideographZodiac";
        IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
        IROHA: "iroha";
        IROHA_FULL_WIDTH: "irohaFullWidth";
        JAPANESE_COUNTING: "japaneseCounting";
        JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
        JAPANESE_LEGAL: "japaneseLegal";
        KOREAN_COUNTING: "koreanCounting";
        KOREAN_DIGITAL: "koreanDigital";
        KOREAN_DIGITAL2: "koreanDigital2";
        KOREAN_LEGAL: "koreanLegal";
        LOWER_LETTER: "lowerLetter";
        LOWER_ROMAN: "lowerRoman";
        NONE: "none";
        NUMBER_IN_DASH: "numberInDash";
        ORDINAL: "ordinal";
        ORDINAL_TEXT: "ordinalText";
        RUSSIAN_LOWER: "russianLower";
        RUSSIAN_UPPER: "russianUpper";
        TAIWANESE_COUNTING: "taiwaneseCounting";
        TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
        TAIWANESE_DIGITAL: "taiwaneseDigital";
        THAI_COUNTING: "thaiCounting";
        THAI_LETTERS: "thaiLetters";
        THAI_NUMBERS: "thaiNumbers";
        UPPER_LETTER: "upperLetter";
        UPPER_ROMAN: "upperRoman";
        VIETNAMESE_COUNTING: "vietnameseCounting";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/LevelSuffix.html b/api/variables/LevelSuffix.html index 21ed642049..eaceebad99 100644 --- a/api/variables/LevelSuffix.html +++ b/api/variables/LevelSuffix.html @@ -1 +1 @@ -LevelSuffix | docx

    VariableLevelSuffixConst

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

    Settings

    Member Visibility
    +LevelSuffix | docx

    VariableLevelSuffixConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/LineNumberRestartFormat.html b/api/variables/LineNumberRestartFormat.html index e6b8d8d90d..fb0946855f 100644 --- a/api/variables/LineNumberRestartFormat.html +++ b/api/variables/LineNumberRestartFormat.html @@ -1 +1 @@ -LineNumberRestartFormat | docx

    VariableLineNumberRestartFormatConst

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

    Settings

    Member Visibility
    +LineNumberRestartFormat | docx

    VariableLineNumberRestartFormatConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/LineRuleType.html b/api/variables/LineRuleType.html index e7c6334aa5..9747b659dc 100644 --- a/api/variables/LineRuleType.html +++ b/api/variables/LineRuleType.html @@ -1 +1 @@ -LineRuleType | docx

    VariableLineRuleTypeConst

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

    Settings

    Member Visibility
    +LineRuleType | docx

    VariableLineRuleTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/NumberFormat.html b/api/variables/NumberFormat.html index bd14f12154..211aee0430 100644 --- a/api/variables/NumberFormat.html +++ b/api/variables/NumberFormat.html @@ -1 +1 @@ -NumberFormat | docx

    VariableNumberFormatConst

    NumberFormat: {
        AIUEO: "aiueo";
        AIUEO_FULL_WIDTH: "aiueoFullWidth";
        ARABIC_ABJAD: "arabicAbjad";
        ARABIC_ALPHA: "arabicAlpha";
        BAHT_TEXT: "bahtText";
        BULLET: "bullet";
        CARDINAL_TEXT: "cardinalText";
        CHICAGO: "chicago";
        CHINESE_COUNTING: "chineseCounting";
        CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand";
        CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
        CHOSUNG: "chosung";
        DECIMAL: "decimal";
        DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
        DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
        DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop";
        DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen";
        DECIMAL_FULL_WIDTH: "decimalFullWidth";
        DECIMAL_FULL_WIDTH_2: "decimalFullWidth2";
        DECIMAL_HALF_WIDTH: "decimalHalfWidth";
        DECIMAL_ZERO: "decimalZero";
        DOLLAR_TEXT: "dollarText";
        GANADA: "ganada";
        HEBREW_1: "hebrew1";
        HEBREW_2: "hebrew2";
        HEX: "hex";
        HINDI_CONSONANTS: "hindiConsonants";
        HINDI_COUNTING: "hindiCounting";
        HINDI_NUMBERS: "hindiNumbers";
        HINDI_VOWELS: "hindiVowels";
        IDEOGRAPH_DIGITAL: "ideographDigital";
        IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
        IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
        IDEOGRAPH_TRADITIONAL: "ideographTraditional";
        IDEOGRAPH_ZODIAC: "ideographZodiac";
        IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
        IROHA: "iroha";
        IROHA_FULL_WIDTH: "irohaFullWidth";
        JAPANESE_COUNTING: "japaneseCounting";
        JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
        JAPANESE_LEGAL: "japaneseLegal";
        KOREAN_COUNTING: "koreanCounting";
        KOREAN_DIGITAL: "koreanDigital";
        KOREAN_DIGITAL_2: "koreanDigital2";
        KOREAN_LEGAL: "koreanLegal";
        LOWER_LETTER: "lowerLetter";
        LOWER_ROMAN: "lowerRoman";
        NONE: "none";
        NUMBER_IN_DASH: "numberInDash";
        ORDINAL: "ordinal";
        ORDINAL_TEXT: "ordinalText";
        RUSSIAN_LOWER: "russianLower";
        RUSSIAN_UPPER: "russianUpper";
        TAIWANESE_COUNTING: "taiwaneseCounting";
        TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
        TAIWANESE_DIGITAL: "taiwaneseDigital";
        THAI_COUNTING: "thaiCounting";
        THAI_LETTERS: "thaiLetters";
        THAI_NUMBERS: "thaiNumbers";
        UPPER_LETTER: "upperLetter";
        UPPER_ROMAN: "upperRoman";
        VIETNAMESE_COUNTING: "vietnameseCounting";
    } = ...

    Settings

    Member Visibility
    +NumberFormat | docx

    VariableNumberFormatConst

    NumberFormat: {
        AIUEO: "aiueo";
        AIUEO_FULL_WIDTH: "aiueoFullWidth";
        ARABIC_ABJAD: "arabicAbjad";
        ARABIC_ALPHA: "arabicAlpha";
        BAHT_TEXT: "bahtText";
        BULLET: "bullet";
        CARDINAL_TEXT: "cardinalText";
        CHICAGO: "chicago";
        CHINESE_COUNTING: "chineseCounting";
        CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand";
        CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
        CHOSUNG: "chosung";
        DECIMAL: "decimal";
        DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
        DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
        DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop";
        DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen";
        DECIMAL_FULL_WIDTH: "decimalFullWidth";
        DECIMAL_FULL_WIDTH_2: "decimalFullWidth2";
        DECIMAL_HALF_WIDTH: "decimalHalfWidth";
        DECIMAL_ZERO: "decimalZero";
        DOLLAR_TEXT: "dollarText";
        GANADA: "ganada";
        HEBREW_1: "hebrew1";
        HEBREW_2: "hebrew2";
        HEX: "hex";
        HINDI_CONSONANTS: "hindiConsonants";
        HINDI_COUNTING: "hindiCounting";
        HINDI_NUMBERS: "hindiNumbers";
        HINDI_VOWELS: "hindiVowels";
        IDEOGRAPH_DIGITAL: "ideographDigital";
        IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
        IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
        IDEOGRAPH_TRADITIONAL: "ideographTraditional";
        IDEOGRAPH_ZODIAC: "ideographZodiac";
        IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
        IROHA: "iroha";
        IROHA_FULL_WIDTH: "irohaFullWidth";
        JAPANESE_COUNTING: "japaneseCounting";
        JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
        JAPANESE_LEGAL: "japaneseLegal";
        KOREAN_COUNTING: "koreanCounting";
        KOREAN_DIGITAL: "koreanDigital";
        KOREAN_DIGITAL_2: "koreanDigital2";
        KOREAN_LEGAL: "koreanLegal";
        LOWER_LETTER: "lowerLetter";
        LOWER_ROMAN: "lowerRoman";
        NONE: "none";
        NUMBER_IN_DASH: "numberInDash";
        ORDINAL: "ordinal";
        ORDINAL_TEXT: "ordinalText";
        RUSSIAN_LOWER: "russianLower";
        RUSSIAN_UPPER: "russianUpper";
        TAIWANESE_COUNTING: "taiwaneseCounting";
        TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
        TAIWANESE_DIGITAL: "taiwaneseDigital";
        THAI_COUNTING: "thaiCounting";
        THAI_LETTERS: "thaiLetters";
        THAI_NUMBERS: "thaiNumbers";
        UPPER_LETTER: "upperLetter";
        UPPER_ROMAN: "upperRoman";
        VIETNAMESE_COUNTING: "vietnameseCounting";
    } = ...

    Settings

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

    VariableOverlapTypeConst

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

    Settings

    Member Visibility
    +OverlapType | docx

    VariableOverlapTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PageBorderDisplay.html b/api/variables/PageBorderDisplay.html index 528a97df30..762953d550 100644 --- a/api/variables/PageBorderDisplay.html +++ b/api/variables/PageBorderDisplay.html @@ -1 +1 @@ -PageBorderDisplay | docx

    VariablePageBorderDisplayConst

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

    Settings

    Member Visibility
    +PageBorderDisplay | docx

    VariablePageBorderDisplayConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PageBorderOffsetFrom.html b/api/variables/PageBorderOffsetFrom.html index 3a69fad810..0264c4477b 100644 --- a/api/variables/PageBorderOffsetFrom.html +++ b/api/variables/PageBorderOffsetFrom.html @@ -1 +1 @@ -PageBorderOffsetFrom | docx

    VariablePageBorderOffsetFromConst

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

    Settings

    Member Visibility
    +PageBorderOffsetFrom | docx

    VariablePageBorderOffsetFromConst

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

    Settings

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

    VariablePageBorderZOrderConst

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

    Settings

    Member Visibility
    +PageBorderZOrder | docx

    VariablePageBorderZOrderConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PageNumber.html b/api/variables/PageNumber.html index 07c685c9d3..d131f9eb06 100644 --- a/api/variables/PageNumber.html +++ b/api/variables/PageNumber.html @@ -1 +1 @@ -PageNumber | docx

    VariablePageNumberConst

    PageNumber: {
        CURRENT: "CURRENT";
        CURRENT_SECTION: "SECTION";
        TOTAL_PAGES: "TOTAL_PAGES";
        TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION";
    } = ...

    Settings

    Member Visibility
    +PageNumber | docx

    VariablePageNumberConst

    PageNumber: {
        CURRENT: "CURRENT";
        CURRENT_SECTION: "SECTION";
        TOTAL_PAGES: "TOTAL_PAGES";
        TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/PageNumberSeparator.html b/api/variables/PageNumberSeparator.html index 0a157d75cf..f5f1362ce0 100644 --- a/api/variables/PageNumberSeparator.html +++ b/api/variables/PageNumberSeparator.html @@ -1 +1 @@ -PageNumberSeparator | docx

    VariablePageNumberSeparatorConst

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

    Settings

    Member Visibility
    +PageNumberSeparator | docx

    VariablePageNumberSeparatorConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PageOrientation.html b/api/variables/PageOrientation.html index 2f2a98c914..1dfbc1f6c4 100644 --- a/api/variables/PageOrientation.html +++ b/api/variables/PageOrientation.html @@ -1 +1 @@ -PageOrientation | docx

    VariablePageOrientationConst

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

    Settings

    Member Visibility
    +PageOrientation | docx

    VariablePageOrientationConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PageTextDirectionType.html b/api/variables/PageTextDirectionType.html index 68b0a8b9c3..cb5b6e41d2 100644 --- a/api/variables/PageTextDirectionType.html +++ b/api/variables/PageTextDirectionType.html @@ -1 +1 @@ -PageTextDirectionType | docx

    VariablePageTextDirectionTypeConst

    PageTextDirectionType: {
        LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
        TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
    } = ...

    Settings

    Member Visibility
    +PageTextDirectionType | docx

    VariablePageTextDirectionTypeConst

    PageTextDirectionType: {
        LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
        TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
    } = ...

    Settings

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

    VariablePatchTypeConst

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

    Settings

    Member Visibility
    +PatchType | docx

    VariablePatchTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PositionalTabAlignment.html b/api/variables/PositionalTabAlignment.html index 988c46807a..1b98150449 100644 --- a/api/variables/PositionalTabAlignment.html +++ b/api/variables/PositionalTabAlignment.html @@ -1 +1 @@ -PositionalTabAlignment | docx

    VariablePositionalTabAlignmentConst

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

    Settings

    Member Visibility
    +PositionalTabAlignment | docx

    VariablePositionalTabAlignmentConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PositionalTabLeader.html b/api/variables/PositionalTabLeader.html index c404b88206..cd9e452b04 100644 --- a/api/variables/PositionalTabLeader.html +++ b/api/variables/PositionalTabLeader.html @@ -1 +1 @@ -PositionalTabLeader | docx

    VariablePositionalTabLeaderConst

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

    Settings

    Member Visibility
    +PositionalTabLeader | docx

    VariablePositionalTabLeaderConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PositionalTabRelativeTo.html b/api/variables/PositionalTabRelativeTo.html index 778f4fee61..bbf64641fc 100644 --- a/api/variables/PositionalTabRelativeTo.html +++ b/api/variables/PositionalTabRelativeTo.html @@ -1 +1 @@ -PositionalTabRelativeTo | docx

    VariablePositionalTabRelativeToConst

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

    Settings

    Member Visibility
    +PositionalTabRelativeTo | docx

    VariablePositionalTabRelativeToConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/PrettifyType.html b/api/variables/PrettifyType.html index 660198d667..57e4f6eb36 100644 --- a/api/variables/PrettifyType.html +++ b/api/variables/PrettifyType.html @@ -1,2 +1,2 @@ PrettifyType | docx

    VariablePrettifyTypeConst

    PrettifyType: {
        NONE: "";
        WITH_2_BLANKS: " ";
        WITH_4_BLANKS: " ";
        WITH_TAB: "\t";
    } = ...

    Use blanks to prettify

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/api/variables/RelativeHorizontalPosition.html b/api/variables/RelativeHorizontalPosition.html index 465c4e1eca..566bc8cf9c 100644 --- a/api/variables/RelativeHorizontalPosition.html +++ b/api/variables/RelativeHorizontalPosition.html @@ -1 +1 @@ -RelativeHorizontalPosition | docx

    VariableRelativeHorizontalPositionConst

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

    Settings

    Member Visibility
    +RelativeHorizontalPosition | docx

    VariableRelativeHorizontalPositionConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/RelativeVerticalPosition.html b/api/variables/RelativeVerticalPosition.html index 7bc288eaea..fffef04ae3 100644 --- a/api/variables/RelativeVerticalPosition.html +++ b/api/variables/RelativeVerticalPosition.html @@ -1 +1 @@ -RelativeVerticalPosition | docx

    VariableRelativeVerticalPositionConst

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

    Settings

    Member Visibility
    +RelativeVerticalPosition | docx

    VariableRelativeVerticalPositionConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/SectionType.html b/api/variables/SectionType.html index 1867891021..173c4148ec 100644 --- a/api/variables/SectionType.html +++ b/api/variables/SectionType.html @@ -1 +1 @@ -SectionType | docx

    VariableSectionTypeConst

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

    Settings

    Member Visibility
    +SectionType | docx

    VariableSectionTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/ShadingType.html b/api/variables/ShadingType.html index 03f210633c..094741e473 100644 --- a/api/variables/ShadingType.html +++ b/api/variables/ShadingType.html @@ -1 +1 @@ -ShadingType | docx

    VariableShadingTypeConst

    ShadingType: {
        CLEAR: "clear";
        DIAGONAL_CROSS: "diagCross";
        DIAGONAL_STRIPE: "diagStripe";
        HORIZONTAL_CROSS: "horzCross";
        HORIZONTAL_STRIPE: "horzStripe";
        NIL: "nil";
        PERCENT_10: "pct10";
        PERCENT_12: "pct12";
        PERCENT_15: "pct15";
        PERCENT_20: "pct20";
        PERCENT_25: "pct25";
        PERCENT_30: "pct30";
        PERCENT_35: "pct35";
        PERCENT_37: "pct37";
        PERCENT_40: "pct40";
        PERCENT_45: "pct45";
        PERCENT_5: "pct5";
        PERCENT_50: "pct50";
        PERCENT_55: "pct55";
        PERCENT_60: "pct60";
        PERCENT_62: "pct62";
        PERCENT_65: "pct65";
        PERCENT_70: "pct70";
        PERCENT_75: "pct75";
        PERCENT_80: "pct80";
        PERCENT_85: "pct85";
        PERCENT_87: "pct87";
        PERCENT_90: "pct90";
        PERCENT_95: "pct95";
        REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe";
        SOLID: "solid";
        THIN_DIAGONAL_CROSS: "thinDiagCross";
        THIN_DIAGONAL_STRIPE: "thinDiagStripe";
        THIN_HORIZONTAL_CROSS: "thinHorzCross";
        THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe";
        THIN_VERTICAL_STRIPE: "thinVertStripe";
        VERTICAL_STRIPE: "vertStripe";
    } = ...

    Settings

    Member Visibility
    +ShadingType | docx

    VariableShadingTypeConst

    ShadingType: {
        CLEAR: "clear";
        DIAGONAL_CROSS: "diagCross";
        DIAGONAL_STRIPE: "diagStripe";
        HORIZONTAL_CROSS: "horzCross";
        HORIZONTAL_STRIPE: "horzStripe";
        NIL: "nil";
        PERCENT_10: "pct10";
        PERCENT_12: "pct12";
        PERCENT_15: "pct15";
        PERCENT_20: "pct20";
        PERCENT_25: "pct25";
        PERCENT_30: "pct30";
        PERCENT_35: "pct35";
        PERCENT_37: "pct37";
        PERCENT_40: "pct40";
        PERCENT_45: "pct45";
        PERCENT_5: "pct5";
        PERCENT_50: "pct50";
        PERCENT_55: "pct55";
        PERCENT_60: "pct60";
        PERCENT_62: "pct62";
        PERCENT_65: "pct65";
        PERCENT_70: "pct70";
        PERCENT_75: "pct75";
        PERCENT_80: "pct80";
        PERCENT_85: "pct85";
        PERCENT_87: "pct87";
        PERCENT_90: "pct90";
        PERCENT_95: "pct95";
        REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe";
        SOLID: "solid";
        THIN_DIAGONAL_CROSS: "thinDiagCross";
        THIN_DIAGONAL_STRIPE: "thinDiagStripe";
        THIN_HORIZONTAL_CROSS: "thinHorzCross";
        THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe";
        THIN_VERTICAL_STRIPE: "thinVertStripe";
        VERTICAL_STRIPE: "vertStripe";
    } = ...

    Settings

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

    VariableSpaceTypeConst

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

    Settings

    Member Visibility
    +SpaceType | docx

    VariableSpaceTypeConst

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

    Settings

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

    VariableTabStopPositionConst

    TabStopPosition: {
        MAX: 9026;
    } = ...

    Settings

    Member Visibility
    +TabStopPosition | docx

    VariableTabStopPositionConst

    TabStopPosition: {
        MAX: 9026;
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TabStopType.html b/api/variables/TabStopType.html index fcbb1a0eaa..53e8d754c7 100644 --- a/api/variables/TabStopType.html +++ b/api/variables/TabStopType.html @@ -1 +1 @@ -TabStopType | docx

    VariableTabStopTypeConst

    TabStopType: {
        BAR: "bar";
        CENTER: "center";
        CLEAR: "clear";
        DECIMAL: "decimal";
        END: "end";
        LEFT: "left";
        NUM: "num";
        RIGHT: "right";
        START: "start";
    } = ...

    Settings

    Member Visibility
    +TabStopType | docx

    VariableTabStopTypeConst

    TabStopType: {
        BAR: "bar";
        CENTER: "center";
        CLEAR: "clear";
        DECIMAL: "decimal";
        END: "end";
        LEFT: "left";
        NUM: "num";
        RIGHT: "right";
        START: "start";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TableAnchorType.html b/api/variables/TableAnchorType.html index 7552b4b4cb..203e2c288a 100644 --- a/api/variables/TableAnchorType.html +++ b/api/variables/TableAnchorType.html @@ -1 +1 @@ -TableAnchorType | docx

    VariableTableAnchorTypeConst

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

    Settings

    Member Visibility
    +TableAnchorType | docx

    VariableTableAnchorTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/TableLayoutType.html b/api/variables/TableLayoutType.html index 2eea8f5fae..86f4387327 100644 --- a/api/variables/TableLayoutType.html +++ b/api/variables/TableLayoutType.html @@ -1 +1 @@ -TableLayoutType | docx

    VariableTableLayoutTypeConst

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

    Settings

    Member Visibility
    +TableLayoutType | docx

    VariableTableLayoutTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/TextDirection.html b/api/variables/TextDirection.html index 16aa6799e2..eec573b2c8 100644 --- a/api/variables/TextDirection.html +++ b/api/variables/TextDirection.html @@ -1 +1 @@ -TextDirection | docx

    VariableTextDirectionConst

    TextDirection: {
        BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr";
        LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
        TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
    } = ...

    Settings

    Member Visibility
    +TextDirection | docx

    VariableTextDirectionConst

    TextDirection: {
        BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr";
        LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
        TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TextEffect.html b/api/variables/TextEffect.html index 48093c441c..24d1510af8 100644 --- a/api/variables/TextEffect.html +++ b/api/variables/TextEffect.html @@ -1 +1 @@ -TextEffect | docx

    VariableTextEffectConst

    TextEffect: {
        ANTS_BLACK: "antsBlack";
        ANTS_RED: "antsRed";
        BLINK_BACKGROUND: "blinkBackground";
        LIGHTS: "lights";
        NONE: "none";
        SHIMMER: "shimmer";
        SPARKLE: "sparkle";
    } = ...

    Settings

    Member Visibility
    +TextEffect | docx

    VariableTextEffectConst

    TextEffect: {
        ANTS_BLACK: "antsBlack";
        ANTS_RED: "antsRed";
        BLINK_BACKGROUND: "blinkBackground";
        LIGHTS: "lights";
        NONE: "none";
        SHIMMER: "shimmer";
        SPARKLE: "sparkle";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/TextWrappingSide.html b/api/variables/TextWrappingSide.html index a48e5b5111..79e1771c5e 100644 --- a/api/variables/TextWrappingSide.html +++ b/api/variables/TextWrappingSide.html @@ -1 +1 @@ -TextWrappingSide | docx

    VariableTextWrappingSideConst

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

    Settings

    Member Visibility
    +TextWrappingSide | docx

    VariableTextWrappingSideConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/TextWrappingType.html b/api/variables/TextWrappingType.html index 222c2146b6..9b48c4e754 100644 --- a/api/variables/TextWrappingType.html +++ b/api/variables/TextWrappingType.html @@ -1 +1 @@ -TextWrappingType | docx

    VariableTextWrappingTypeConst

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

    Settings

    Member Visibility
    +TextWrappingType | docx

    VariableTextWrappingTypeConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/UnderlineType.html b/api/variables/UnderlineType.html index 68e4c92202..0a3b970434 100644 --- a/api/variables/UnderlineType.html +++ b/api/variables/UnderlineType.html @@ -1 +1 @@ -UnderlineType | docx

    VariableUnderlineTypeConst

    UnderlineType: {
        DASH: "dash";
        DASHDOTDOTHEAVY: "dashDotDotHeavy";
        DASHDOTHEAVY: "dashDotHeavy";
        DASHEDHEAVY: "dashedHeavy";
        DASHLONG: "dashLong";
        DASHLONGHEAVY: "dashLongHeavy";
        DOTDASH: "dotDash";
        DOTDOTDASH: "dotDotDash";
        DOTTED: "dotted";
        DOTTEDHEAVY: "dottedHeavy";
        DOUBLE: "double";
        NONE: "none";
        SINGLE: "single";
        THICK: "thick";
        WAVE: "wave";
        WAVYDOUBLE: "wavyDouble";
        WAVYHEAVY: "wavyHeavy";
        WORDS: "words";
    } = ...

    Settings

    Member Visibility
    +UnderlineType | docx

    VariableUnderlineTypeConst

    UnderlineType: {
        DASH: "dash";
        DASHDOTDOTHEAVY: "dashDotDotHeavy";
        DASHDOTHEAVY: "dashDotHeavy";
        DASHEDHEAVY: "dashedHeavy";
        DASHLONG: "dashLong";
        DASHLONGHEAVY: "dashLongHeavy";
        DOTDASH: "dotDash";
        DOTDOTDASH: "dotDotDash";
        DOTTED: "dotted";
        DOTTEDHEAVY: "dottedHeavy";
        DOUBLE: "double";
        NONE: "none";
        SINGLE: "single";
        THICK: "thick";
        WAVE: "wave";
        WAVYDOUBLE: "wavyDouble";
        WAVYHEAVY: "wavyHeavy";
        WORDS: "words";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/VerticalAlign.html b/api/variables/VerticalAlign.html index 964b9244c3..416adafbe2 100644 --- a/api/variables/VerticalAlign.html +++ b/api/variables/VerticalAlign.html @@ -1 +1 @@ -VerticalAlign | docx

    VariableVerticalAlignConst

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

    Settings

    Member Visibility
    +VerticalAlign | docx

    VariableVerticalAlignConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/VerticalMergeType.html b/api/variables/VerticalMergeType.html index 1c3adcf6b5..12c30e1a80 100644 --- a/api/variables/VerticalMergeType.html +++ b/api/variables/VerticalMergeType.html @@ -1,4 +1,4 @@ VerticalMergeType | docx

    VariableVerticalMergeTypeConst

    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 90e8a52b01..a23c33fa59 100644 --- a/api/variables/VerticalPositionAlign.html +++ b/api/variables/VerticalPositionAlign.html @@ -1 +1 @@ -VerticalPositionAlign | docx

    VariableVerticalPositionAlignConst

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

    Settings

    Member Visibility
    +VerticalPositionAlign | docx

    VariableVerticalPositionAlignConst

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

    Settings

    Member Visibility
    diff --git a/api/variables/VerticalPositionRelativeFrom.html b/api/variables/VerticalPositionRelativeFrom.html index d38c62b1bb..72b4fc1e9e 100644 --- a/api/variables/VerticalPositionRelativeFrom.html +++ b/api/variables/VerticalPositionRelativeFrom.html @@ -1 +1 @@ -VerticalPositionRelativeFrom | docx

    VariableVerticalPositionRelativeFromConst

    VerticalPositionRelativeFrom: {
        BOTTOM_MARGIN: "bottomMargin";
        INSIDE_MARGIN: "insideMargin";
        LINE: "line";
        MARGIN: "margin";
        OUTSIDE_MARGIN: "outsideMargin";
        PAGE: "page";
        PARAGRAPH: "paragraph";
        TOP_MARGIN: "topMargin";
    } = ...

    Settings

    Member Visibility
    +VerticalPositionRelativeFrom | docx

    VariableVerticalPositionRelativeFromConst

    VerticalPositionRelativeFrom: {
        BOTTOM_MARGIN: "bottomMargin";
        INSIDE_MARGIN: "insideMargin";
        LINE: "line";
        MARGIN: "margin";
        OUTSIDE_MARGIN: "outsideMargin";
        PAGE: "page";
        PARAGRAPH: "paragraph";
        TOP_MARGIN: "topMargin";
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/WidthType.html b/api/variables/WidthType.html index 585fa1f832..32a8817599 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 fc13a65a51..9ea632d46d 100644 --- a/api/variables/sectionMarginDefaults.html +++ b/api/variables/sectionMarginDefaults.html @@ -1 +1 @@ -sectionMarginDefaults | docx

    VariablesectionMarginDefaultsConst

    sectionMarginDefaults: {
        BOTTOM: number;
        FOOTER: number;
        GUTTER: number;
        HEADER: number;
        LEFT: number;
        RIGHT: number;
        TOP: number;
    } = ...

    Settings

    Member Visibility
    +sectionMarginDefaults | docx

    VariablesectionMarginDefaultsConst

    sectionMarginDefaults: {
        BOTTOM: number;
        FOOTER: number;
        GUTTER: number;
        HEADER: number;
        LEFT: number;
        RIGHT: number;
        TOP: number;
    } = ...

    Settings

    Member Visibility
    diff --git a/api/variables/sectionPageSizeDefaults.html b/api/variables/sectionPageSizeDefaults.html index 5476d81276..0fd064f252 100644 --- a/api/variables/sectionPageSizeDefaults.html +++ b/api/variables/sectionPageSizeDefaults.html @@ -1 +1 @@ -sectionPageSizeDefaults | docx

    VariablesectionPageSizeDefaultsConst

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

    Settings

    Member Visibility
    +sectionPageSizeDefaults | docx

    VariablesectionPageSizeDefaultsConst

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

    Settings

    Member Visibility