From 179cc3b30cd8a9606311e0063fe17309bb33dadd Mon Sep 17 00:00:00 2001 From: dolanmiu Date: Wed, 16 Oct 2024 21:01:20 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20dolanmiu?= =?UTF-8?q?/docx@9c8a07eadc3f902dbaa5fb83299196d1f3106c26=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api/classes/AbstractNumbering.html | 6 ++-- api/classes/Alignment.html | 6 ++-- api/classes/AlignmentAttributes.html | 4 +-- api/classes/AnnotationReference.html | 6 ++-- api/classes/Attributes.html | 4 +-- api/classes/BaseEmphasisMark.html | 4 +-- api/classes/BaseXmlComponent.html | 4 +-- api/classes/Body.html | 8 ++--- api/classes/Bookmark.html | 4 +-- api/classes/BookmarkEnd.html | 6 ++-- api/classes/BookmarkStart.html | 6 ++-- api/classes/Border.html | 6 ++-- api/classes/BorderElement.html | 6 ++-- api/classes/BuilderElement.html | 6 ++-- api/classes/CarriageReturn.html | 6 ++-- api/classes/CheckBox.html | 6 ++-- api/classes/CheckBoxSymbolElement.html | 6 ++-- api/classes/CheckBoxUtil.html | 6 ++-- api/classes/Column.html | 6 ++-- api/classes/ColumnBreak.html | 6 ++-- api/classes/Columns.html | 6 ++-- api/classes/Comment.html | 6 ++-- api/classes/CommentRangeEnd.html | 6 ++-- api/classes/CommentRangeStart.html | 6 ++-- api/classes/CommentReference.html | 6 ++-- api/classes/Comments.html | 6 ++-- api/classes/ConcreteHyperlink.html | 6 ++-- api/classes/ConcreteNumbering.html | 6 ++-- api/classes/ContinuationSeparator.html | 6 ++-- api/classes/DayLong.html | 6 ++-- api/classes/DayShort.html | 6 ++-- api/classes/DeletedTextRun.html | 6 ++-- api/classes/DocGridAttributes.html | 4 +-- api/classes/Document.html | 4 +-- api/classes/DocumentAttributes.html | 4 +-- api/classes/DocumentBackground.html | 6 ++-- api/classes/DocumentBackgroundAttributes.html | 4 +-- api/classes/DocumentDefaults.html | 6 ++-- api/classes/DocumentGrid.html | 6 ++-- api/classes/DotEmphasisMark.html | 6 ++-- api/classes/Drawing.html | 6 ++-- api/classes/EmphasisMark.html | 6 ++-- api/classes/EmptyElement.html | 6 ++-- api/classes/EndnoteReference.html | 6 ++-- api/classes/ExternalHyperlink.html | 6 ++-- api/classes/FileChild.html | 6 ++-- .../FootNoteReferenceRunAttributes.html | 4 +-- api/classes/FootNotes.html | 6 ++-- api/classes/Footer.html | 4 +-- api/classes/FooterWrapper.html | 4 +-- api/classes/FootnoteReference.html | 6 ++-- api/classes/FootnoteReferenceElement.html | 6 ++-- api/classes/FootnoteReferenceRun.html | 6 ++-- api/classes/GridSpan.html | 8 ++--- api/classes/Header.html | 4 +-- api/classes/HeaderFooterReference.html | 6 ++-- api/classes/HeaderWrapper.html | 4 +-- api/classes/HorizontalPosition.html | 6 ++-- api/classes/HpsMeasureElement.html | 6 ++-- api/classes/IgnoreIfEmptyXmlComponent.html | 6 ++-- api/classes/ImageRun.html | 6 ++-- .../ImportedRootElementAttributes.html | 8 ++--- api/classes/ImportedXmlComponent.html | 10 +++--- api/classes/Indent.html | 6 ++-- api/classes/InitializableXmlComponent.html | 6 ++-- api/classes/InsertedTextRun.html | 6 ++-- api/classes/InternalHyperlink.html | 6 ++-- api/classes/LastRenderedPageBreak.html | 6 ++-- api/classes/Level.html | 6 ++-- api/classes/LevelBase.html | 6 ++-- api/classes/LevelForOverride.html | 6 ++-- api/classes/LevelOverride.html | 6 ++-- api/classes/Math.html | 6 ++-- api/classes/MathAccentCharacter.html | 6 ++-- api/classes/MathAngledBrackets.html | 6 ++-- api/classes/MathBase.html | 6 ++-- api/classes/MathCurlyBrackets.html | 6 ++-- api/classes/MathDegree.html | 6 ++-- api/classes/MathDenominator.html | 6 ++-- api/classes/MathFraction.html | 6 ++-- api/classes/MathFunction.html | 6 ++-- api/classes/MathFunctionName.html | 6 ++-- api/classes/MathFunctionProperties.html | 6 ++-- api/classes/MathIntegral.html | 6 ++-- api/classes/MathLimit.html | 6 ++-- api/classes/MathLimitLocation.html | 6 ++-- api/classes/MathLimitLower.html | 6 ++-- api/classes/MathLimitUpper.html | 6 ++-- api/classes/MathNAryProperties.html | 6 ++-- api/classes/MathNumerator.html | 6 ++-- api/classes/MathPreSubSuperScript.html | 6 ++-- .../MathPreSubSuperScriptProperties.html | 6 ++-- api/classes/MathRadical.html | 6 ++-- api/classes/MathRadicalProperties.html | 6 ++-- api/classes/MathRoundBrackets.html | 6 ++-- api/classes/MathRun.html | 6 ++-- api/classes/MathSquareBrackets.html | 6 ++-- api/classes/MathSubScript.html | 6 ++-- api/classes/MathSubScriptElement.html | 6 ++-- api/classes/MathSubScriptProperties.html | 6 ++-- api/classes/MathSubSuperScript.html | 6 ++-- api/classes/MathSubSuperScriptProperties.html | 6 ++-- api/classes/MathSum.html | 6 ++-- api/classes/MathSuperScript.html | 6 ++-- api/classes/MathSuperScriptElement.html | 6 ++-- api/classes/MathSuperScriptProperties.html | 6 ++-- api/classes/Media.html | 4 +-- api/classes/MonthLong.html | 6 ++-- api/classes/MonthShort.html | 6 ++-- api/classes/NextAttributeComponent.html | 4 +-- api/classes/NoBreakHyphen.html | 6 ++-- api/classes/NumberProperties.html | 6 ++-- api/classes/NumberValueElement.html | 6 ++-- api/classes/Numbering.html | 6 ++-- api/classes/OnOffElement.html | 6 ++-- api/classes/OutlineLevel.html | 6 ++-- api/classes/Packer.html | 4 +-- api/classes/PageBorders.html | 6 ++-- api/classes/PageBreak.html | 6 ++-- api/classes/PageBreakBefore.html | 8 ++--- api/classes/PageMargin.html | 6 ++-- api/classes/PageNumberElement.html | 6 ++-- api/classes/PageNumberType.html | 6 ++-- api/classes/PageNumberTypeAttributes.html | 4 +-- api/classes/PageReference.html | 6 ++-- api/classes/PageSize.html | 6 ++-- api/classes/PageTextDirection.html | 6 ++-- api/classes/Paragraph.html | 6 ++-- api/classes/ParagraphProperties.html | 6 ++-- api/classes/ParagraphPropertiesDefaults.html | 6 ++-- api/classes/PositionalTab.html | 6 ++-- api/classes/Run.html | 6 ++-- api/classes/RunFonts.html | 6 ++-- api/classes/RunProperties.html | 6 ++-- api/classes/RunPropertiesChange.html | 6 ++-- api/classes/RunPropertiesDefaults.html | 6 ++-- api/classes/SectionProperties.html | 6 ++-- api/classes/SectionTypeAttributes.html | 4 +-- api/classes/Separator.html | 6 ++-- api/classes/SequentialIdentifier.html | 6 ++-- api/classes/Shading.html | 6 ++-- api/classes/SimpleField.html | 6 ++-- api/classes/SimpleMailMergeField.html | 6 ++-- api/classes/SimplePos.html | 6 ++-- api/classes/SoftHyphen.html | 6 ++-- api/classes/Spacing.html | 6 ++-- api/classes/StringContainer.html | 6 ++-- api/classes/StringEnumValueElement.html | 6 ++-- api/classes/StringValueElement.html | 6 ++-- api/classes/Style.html | 6 ++-- api/classes/StyleForCharacter.html | 6 ++-- api/classes/StyleForParagraph.html | 6 ++-- api/classes/StyleLevel.html | 4 +-- api/classes/Styles.html | 6 ++-- api/classes/SymbolRun.html | 6 ++-- api/classes/TDirection.html | 8 ++--- api/classes/Tab.html | 6 ++-- api/classes/TabAttributes.html | 4 +-- api/classes/TabStop.html | 6 ++-- api/classes/TabStopItem.html | 6 ++-- api/classes/Table.html | 6 ++-- api/classes/TableBorders.html | 6 ++-- api/classes/TableCell.html | 6 ++-- api/classes/TableCellBorders.html | 6 ++-- api/classes/TableFloatProperties.html | 6 ++-- api/classes/TableLayout.html | 6 ++-- api/classes/TableOfContents.html | 6 ++-- api/classes/TableProperties.html | 6 ++-- api/classes/TableRow.html | 6 ++-- api/classes/TableRowHeight.html | 6 ++-- api/classes/TableRowHeightAttributes.html | 4 +-- api/classes/TableRowProperties.html | 6 ++-- api/classes/TableWidthElement.html | 6 ++-- api/classes/TextRun.html | 6 ++-- api/classes/ThematicBreak.html | 6 ++-- api/classes/Type.html | 6 ++-- api/classes/Underline.html | 6 ++-- api/classes/VerticalAlignAttributes.html | 4 +-- api/classes/VerticalAlignElement.html | 6 ++-- api/classes/VerticalMerge.html | 8 ++--- api/classes/VerticalPosition.html | 6 ++-- api/classes/WrapNone.html | 6 ++-- api/classes/WrapSquare.html | 6 ++-- api/classes/WrapTight.html | 6 ++-- api/classes/WrapTopAndBottom.html | 6 ++-- api/classes/XmlAttributeComponent.html | 4 +-- api/classes/XmlComponent.html | 6 ++-- api/classes/YearLong.html | 6 ++-- api/classes/YearShort.html | 6 ++-- .../abstractNumUniqueNumericIdGen.html | 2 +- api/functions/bookmarkUniqueNumericIdGen.html | 2 +- .../concreteNumUniqueNumericIdGen.html | 2 +- api/functions/convertInchesToTwip.html | 2 +- api/functions/convertMillimetersToTwip.html | 2 +- api/functions/convertToXmlComponent.html | 4 +-- api/functions/createFrameProperties.html | 2 +- api/functions/createLineNumberType.html | 2 +- api/functions/createStringElement.html | 2 +- api/functions/dateTimeValue.html | 2 +- api/functions/decimalNumber.html | 2 +- .../docPropertiesUniqueNumericIdGen.html | 2 +- api/functions/eighthPointMeasureValue.html | 2 +- api/functions/hashedId.html | 2 +- api/functions/hexColorValue.html | 2 +- api/functions/hpsMeasureValue.html | 2 +- api/functions/longHexNumber.html | 2 +- api/functions/measurementOrPercentValue.html | 2 +- api/functions/patchDetector.html | 4 +-- api/functions/patchDocument.html | 2 +- api/functions/percentageValue.html | 2 +- api/functions/pointMeasureValue.html | 2 +- .../positiveUniversalMeasureValue.html | 2 +- api/functions/shortHexNumber.html | 2 +- api/functions/signedHpsMeasureValue.html | 2 +- api/functions/signedTwipsMeasureValue.html | 2 +- api/functions/twipsMeasureValue.html | 2 +- api/functions/uCharHexNumber.html | 2 +- api/functions/uniqueId.html | 2 +- api/functions/uniqueNumericIdCreator-1.html | 2 +- api/functions/uniqueUuid.html | 2 +- api/functions/universalMeasureValue.html | 2 +- api/functions/unsignedDecimalNumber.html | 2 +- api/interfaces/IAlignmentFrameOptions.html | 4 +-- .../IBaseCharacterStyleOptions.html | 4 +-- .../IBaseParagraphStyleOptions.html | 4 +-- api/interfaces/IBorderOptions.html | 8 ++--- api/interfaces/IBordersOptions.html | 4 +-- api/interfaces/ICharacterStyleOptions.html | 4 +-- api/interfaces/ICheckboxSymbolOptions.html | 4 +-- api/interfaces/ICheckboxSymbolProperties.html | 4 +-- api/interfaces/ICommentOptions.html | 4 +-- api/interfaces/ICommentsOptions.html | 4 +-- api/interfaces/IConcreteNumberingOptions.html | 4 +-- api/interfaces/IContext.html | 4 +-- .../IDocGridAttributesProperties.html | 4 +-- .../IDocumentAttributesProperties.html | 4 +-- .../IDocumentBackgroundOptions.html | 4 +-- api/interfaces/IDocumentDefaultsOptions.html | 4 +-- api/interfaces/IDocumentFooter.html | 4 +-- api/interfaces/IDocumentHeader.html | 4 +-- api/interfaces/IDocumentOptions.html | 4 +-- api/interfaces/IDrawingOptions.html | 4 +-- api/interfaces/IFloating.html | 4 +-- api/interfaces/IFontAttributesProperties.html | 4 +-- api/interfaces/IHeaderFooterGroup.html | 4 +-- api/interfaces/IHeaderFooterOptions.html | 4 +-- api/interfaces/IHeaderOptions.html | 4 +-- .../IHorizontalPositionOptions.html | 4 +-- .../IIndentAttributesProperties.html | 4 +-- ...ILevelParagraphStylePropertiesOptions.html | 8 ++--- api/interfaces/ILevelsOptions.html | 4 +-- api/interfaces/IMargins.html | 4 +-- api/interfaces/IMathFractionOptions.html | 4 +-- api/interfaces/IMathFunctionOptions.html | 4 +-- api/interfaces/IMathIntegralOptions.html | 4 +-- api/interfaces/IMathLimitLowerOptions.html | 4 +-- api/interfaces/IMathLimitUpperOptions.html | 4 +-- api/interfaces/IMathOptions.html | 4 +-- .../IMathPreSubSuperScriptOptions.html | 4 +-- api/interfaces/IMathRadicalOptions.html | 4 +-- api/interfaces/IMathSubScriptOptions.html | 4 +-- .../IMathSubSuperScriptOptions.html | 4 +-- api/interfaces/IMathSumOptions.html | 4 +-- api/interfaces/IMathSuperScriptOptions.html | 4 +-- api/interfaces/IMediaDataTransformation.html | 4 +-- api/interfaces/IMediaTransformation.html | 4 +-- api/interfaces/INumberingOptions.html | 4 +-- api/interfaces/IPageBorderAttributes.html | 4 +-- api/interfaces/IPageBordersOptions.html | 4 +-- api/interfaces/IPageNumberTypeAttributes.html | 4 +-- api/interfaces/IParagraphOptions.html | 12 +++---- .../IParagraphPropertiesOptions.html | 12 +++---- api/interfaces/IParagraphStyleOptions.html | 4 +-- .../IParagraphStylePropertiesOptions.html | 8 ++--- api/interfaces/IRunOptions.html | 4 +-- .../IRunPropertiesChangeOptions.html | 4 +-- api/interfaces/IRunPropertiesOptions.html | 4 +-- .../IRunStylePropertiesOptions.html | 4 +-- api/interfaces/ISectionOptions.html | 4 +-- api/interfaces/ISectionPropertiesOptions.html | 4 +-- .../IShadingAttributesProperties.html | 4 +-- api/interfaces/ISpacingProperties.html | 4 +-- api/interfaces/IStylesOptions.html | 4 +-- api/interfaces/ISymbolRunOptions.html | 4 +-- api/interfaces/ITableBordersOptions.html | 4 +-- api/interfaces/ITableCellBorders.html | 4 +-- api/interfaces/ITableCellOptions.html | 4 +-- api/interfaces/ITableOfContentsOptions.html | 36 +++++++++---------- api/interfaces/ITableOptions.html | 4 +-- api/interfaces/ITablePropertiesOptions.html | 4 +-- api/interfaces/ITableRowOptions.html | 4 +-- .../ITableRowPropertiesOptions.html | 4 +-- api/interfaces/ITextWrapping.html | 4 +-- api/interfaces/IVerticalPositionOptions.html | 4 +-- api/interfaces/IXYFrameOptions.html | 4 +-- api/interfaces/IXmlAttribute.html | 2 +- api/interfaces/IXmlableObject.html | 2 +- api/interfaces/PositionalTabOptions.html | 4 +-- api/interfaces/TabStopDefinition.html | 4 +-- api/types/AttributeData.html | 2 +- api/types/AttributePayload.html | 2 +- api/types/IColumnsAttributes.html | 2 +- api/types/IDistance.html | 2 +- api/types/IFrameOptions.html | 2 +- api/types/IImageOptions.html | 2 +- api/types/ILineNumberAttributes.html | 2 +- api/types/IMediaData.html | 2 +- api/types/IPageMarginAttributes.html | 2 +- api/types/IPageReferenceOptions.html | 4 +-- api/types/IPageSizeAttributes.html | 2 +- api/types/IPatch.html | 2 +- api/types/ITableFloatOptions.html | 4 +-- api/types/ITableWidthProperties.html | 2 +- api/types/InputDataType.html | 2 +- api/types/MathComponent.html | 2 +- api/types/ParagraphChild.html | 2 +- api/types/PatchDocumentOptions.html | 2 +- api/types/PatchDocumentOutputType.html | 2 +- api/types/Percentage.html | 2 +- api/types/PositiveUniversalMeasure.html | 2 +- api/types/UniqueNumericIdCreator.html | 2 +- api/types/UniversalMeasure.html | 2 +- api/variables/AlignmentType.html | 4 +-- api/variables/BorderStyle.html | 2 +- api/variables/CharacterSet.html | 2 +- api/variables/DocumentGridType.html | 2 +- api/variables/DropCapType.html | 2 +- api/variables/EMPTY_OBJECT.html | 2 +- api/variables/EmphasisMarkType.html | 2 +- api/variables/FrameAnchorType.html | 2 +- api/variables/FrameWrap.html | 2 +- api/variables/HeaderFooterReferenceType.html | 2 +- api/variables/HeaderFooterType.html | 2 +- api/variables/HeadingLevel.html | 2 +- api/variables/HeightRule.html | 4 +-- api/variables/HighlightColor.html | 2 +- api/variables/HorizontalPositionAlign.html | 2 +- .../HorizontalPositionRelativeFrom.html | 2 +- api/variables/HyperlinkType.html | 2 +- api/variables/LeaderType.html | 2 +- api/variables/LevelFormat.html | 2 +- api/variables/LevelSuffix.html | 2 +- api/variables/LineNumberRestartFormat.html | 2 +- api/variables/LineRuleType.html | 2 +- api/variables/NumberFormat.html | 2 +- api/variables/OverlapType.html | 2 +- api/variables/PageBorderDisplay.html | 2 +- api/variables/PageBorderOffsetFrom.html | 2 +- api/variables/PageBorderZOrder.html | 2 +- api/variables/PageNumber.html | 2 +- api/variables/PageNumberSeparator.html | 2 +- api/variables/PageOrientation.html | 2 +- api/variables/PageTextDirectionType.html | 2 +- api/variables/PatchType.html | 2 +- api/variables/PositionalTabAlignment.html | 2 +- api/variables/PositionalTabLeader.html | 2 +- api/variables/PositionalTabRelativeTo.html | 2 +- api/variables/PrettifyType.html | 4 +-- api/variables/RelativeHorizontalPosition.html | 2 +- api/variables/RelativeVerticalPosition.html | 2 +- api/variables/SectionType.html | 2 +- api/variables/ShadingType.html | 2 +- api/variables/SpaceType.html | 2 +- api/variables/TabStopPosition.html | 2 +- api/variables/TabStopType.html | 2 +- api/variables/TableAnchorType.html | 2 +- api/variables/TableLayoutType.html | 2 +- api/variables/TextDirection.html | 2 +- api/variables/TextEffect.html | 2 +- api/variables/TextWrappingSide.html | 2 +- api/variables/TextWrappingType.html | 2 +- api/variables/UnderlineType.html | 2 +- api/variables/VerticalAlign.html | 2 +- api/variables/VerticalMergeType.html | 4 +-- api/variables/VerticalPositionAlign.html | 2 +- .../VerticalPositionRelativeFrom.html | 2 +- api/variables/WidthType.html | 4 +-- api/variables/sectionMarginDefaults.html | 2 +- api/variables/sectionPageSizeDefaults.html | 2 +- 379 files changed, 855 insertions(+), 855 deletions(-) diff --git a/api/classes/AbstractNumbering.html b/api/classes/AbstractNumbering.html index 13c3a73773..f7b069f0a1 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

Class AbstractNumbering

Hierarchy (view full)

Constructors

constructor

Properties

id

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyid

id: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyid

id: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/Alignment.html b/api/classes/Alignment.html index bb52855b9c..17621b7e90 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

Class Alignment

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/AlignmentAttributes.html b/api/classes/AlignmentAttributes.html index 31fffe65c6..fd99d716b5 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

Class AlignmentAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new AlignmentAttributes(root): AlignmentAttributes

  • Parameters

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

    Returns AlignmentAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new AlignmentAttributes(root): AlignmentAttributes

  • Parameters

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

    Returns AlignmentAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/AnnotationReference.html b/api/classes/AnnotationReference.html index 33894ff3c1..14c4da1908 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

Class AnnotationReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Attributes.html b/api/classes/Attributes.html index 0eb3ce37e9..e72a6560f5 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

Class Attributes

Hierarchy (view full)

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

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new Attributes(root): Attributes

  • Parameters

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

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new Attributes(root): Attributes

  • Parameters

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

    Returns Attributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BaseEmphasisMark.html b/api/classes/BaseEmphasisMark.html index 03466bb502..c16d92d493 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

Class BaseEmphasisMarkAbstract

Hierarchy (view full)

Methods

addChildElement prepForXml

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Methods
+

prepForXml

Settings

Member Visibility

On This Page

Methods
diff --git a/api/classes/BaseXmlComponent.html b/api/classes/BaseXmlComponent.html index d1f327a60c..36f44a6f52 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

Class BaseXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

AbstractprepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

AbstractprepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Body.html b/api/classes/Body.html index 83e77a0fd8..070b8e662d 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

Class Body

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement addSection prepForXml push -

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options): void

  • Adds new section properties. +

Constructors

constructor

Methods

addChildElement

addSection

  • addSection(options): void

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

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

    • last section should be direct child of body

    Parameters

    Returns void

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Returns void

prepForXml

push

Settings

Member Visibility

On This Page

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

ClassBookmark

Constructors

constructor +Bookmark | docx

Class Bookmark

Constructors

constructor

Properties

children end start -

Constructors

constructor

Properties

Readonlychildren

children: readonly ParagraphChild[]

Readonlyend

end: BookmarkEnd

Readonlystart

start: BookmarkStart

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlychildren

children: readonly ParagraphChild[]

Readonlyend

end: BookmarkEnd

Readonlystart

start: BookmarkStart

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/BookmarkEnd.html b/api/classes/BookmarkEnd.html index e0b0f78723..4f0e7b34a3 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

Class BookmarkEnd

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BookmarkStart.html b/api/classes/BookmarkStart.html index 7f7afe0191..61dcad5dcd 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

Class BookmarkStart

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Border.html b/api/classes/Border.html index 43c61356f2..cef47c6d92 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

Class Border

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BorderElement.html b/api/classes/BorderElement.html index 38e09862ff..a8e4332c3a 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

Class BorderElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/BuilderElement.html b/api/classes/BuilderElement.html index 3deedbb584..880c919fe8 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

Class BuilderElement<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CarriageReturn.html b/api/classes/CarriageReturn.html index 3dfc7d121a..d1303854f6 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

Class CarriageReturn

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CheckBox.html b/api/classes/CheckBox.html index bf7fe0f896..16e84e4645 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

Class CheckBox

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CheckBoxSymbolElement.html b/api/classes/CheckBoxSymbolElement.html index dd0eee8dc3..7166fe5a87 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

Class CheckBoxSymbolElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CheckBoxUtil.html b/api/classes/CheckBoxUtil.html index dcfcfa8ef5..72525c83f3 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

Class CheckBoxUtil

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Column.html b/api/classes/Column.html index b01f321d4a..3f71063b57 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

Class Column

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ColumnBreak.html b/api/classes/ColumnBreak.html index abd3f1c05c..5db1b8ebb2 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

Class ColumnBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Columns.html b/api/classes/Columns.html index ecf1511aa5..f1db1f7e47 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

Class Columns

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Comment.html b/api/classes/Comment.html index 32cc3618e0..c846a7aa0c 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

Class Comment

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CommentRangeEnd.html b/api/classes/CommentRangeEnd.html index 306a2dbfdc..db6bfdb535 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

Class CommentRangeEnd

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CommentRangeStart.html b/api/classes/CommentRangeStart.html index 6a709e9566..8777bfa7fb 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

Class CommentRangeStart

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/CommentReference.html b/api/classes/CommentReference.html index 9995de33df..6c35fbb5c2 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

Class CommentReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Comments.html b/api/classes/Comments.html index abae6ef59d..d944b51d32 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

Class Comments

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ConcreteHyperlink.html b/api/classes/ConcreteHyperlink.html index 44da9779a7..0c1600079e 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

Class ConcreteHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

linkId

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ConcreteNumbering.html b/api/classes/ConcreteNumbering.html index 08b422600f..cea3adb3b0 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

Class ConcreteNumbering

Hierarchy (view full)

Constructors

constructor

Properties

instance numId reference

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Readonlyreference

reference: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Readonlyreference

reference: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ContinuationSeparator.html b/api/classes/ContinuationSeparator.html index a7415e8866..57d3005846 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

Class ContinuationSeparator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DayLong.html b/api/classes/DayLong.html index dc08e3d4a5..873af6a15c 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

Class DayLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DayShort.html b/api/classes/DayShort.html index de7989619a..d0b0d8b5b5 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

Class DayShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DeletedTextRun.html b/api/classes/DeletedTextRun.html index 01bdb11211..740f87e042 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

Class DeletedTextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocGridAttributes.html b/api/classes/DocGridAttributes.html index 0b7afd973d..f1cb9932a3 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

Class DocGridAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Document.html b/api/classes/Document.html index a2c8662a55..773e6c00e9 100644 --- a/api/classes/Document.html +++ b/api/classes/Document.html @@ -1,4 +1,4 @@ -Document | docx

ClassDocument

Constructors

constructor +Document | docx

Class Document

Constructors

constructor

Accessors

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

Constructors

constructor

Accessors

AppProperties

  • get AppProperties(): AppProperties

  • Returns AppProperties

Comments

ContentTypes

CoreProperties

  • get CoreProperties(): CoreProperties

  • Returns CoreProperties

CustomProperties

  • get CustomProperties(): CustomProperties

  • Returns CustomProperties

Document

  • get Document(): DocumentWrapper

  • Returns DocumentWrapper

FileRelationships

  • get FileRelationships(): Relationships

  • Returns Relationships

FontTable

Footers

FootNotes

  • get FootNotes(): FootnotesWrapper

  • Returns FootnotesWrapper

Headers

Media

Numbering

Settings

Styles

Settings

Member Visibility

On This Page

Constructors
Accessors
+

Constructors

constructor

Accessors

AppProperties

  • get AppProperties(): AppProperties

  • Returns AppProperties

Comments

ContentTypes

CoreProperties

  • get CoreProperties(): CoreProperties

  • Returns CoreProperties

CustomProperties

  • get CustomProperties(): CustomProperties

  • Returns CustomProperties

Document

  • get Document(): DocumentWrapper

  • Returns DocumentWrapper

FileRelationships

  • get FileRelationships(): Relationships

  • Returns Relationships

FontTable

Footers

FootNotes

  • get FootNotes(): FootnotesWrapper

  • Returns FootnotesWrapper

Headers

Media

Numbering

Settings

Styles

Settings

Member Visibility

On This Page

Constructors
Accessors
diff --git a/api/classes/DocumentAttributes.html b/api/classes/DocumentAttributes.html index 737d85b5c0..acd57a6f8c 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

Class DocumentAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentBackground.html b/api/classes/DocumentBackground.html index c3861bbf98..6c47783b47 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

Class DocumentBackground

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentBackgroundAttributes.html b/api/classes/DocumentBackgroundAttributes.html index 42c13224be..991c38859f 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

Class DocumentBackgroundAttributes

Hierarchy (view full)

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

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentDefaults.html b/api/classes/DocumentDefaults.html index 04fe2b3de7..115824658f 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

Class DocumentDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DocumentGrid.html b/api/classes/DocumentGrid.html index d167ec6574..0015cc9d11 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

Class DocumentGrid

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/DotEmphasisMark.html b/api/classes/DotEmphasisMark.html index f55eded10f..7cfb29885f 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

Class DotEmphasisMark

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Drawing.html b/api/classes/Drawing.html index b023726958..576c68b788 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

Class Drawing

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/EmphasisMark.html b/api/classes/EmphasisMark.html index 7fe7c8b2fb..895abc9b27 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

Class EmphasisMark

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/EmptyElement.html b/api/classes/EmptyElement.html index 2e7fa5a900..23e38c8c67 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

Class EmptyElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/EndnoteReference.html b/api/classes/EndnoteReference.html index c791842bfc..1acdeb84ba 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

Class EndnoteReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ExternalHyperlink.html b/api/classes/ExternalHyperlink.html index 0da5587905..c99e329949 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

Class ExternalHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

options

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyoptions

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

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyoptions

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

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/FileChild.html b/api/classes/FileChild.html index 21d1851db7..94106187f3 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

Class FileChild

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/FootNoteReferenceRunAttributes.html b/api/classes/FootNoteReferenceRunAttributes.html index f2a1200675..501ad8f9d4 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

Class FootNoteReferenceRunAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootNotes.html b/api/classes/FootNotes.html index e749b6a789..6409c7a04d 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

Class FootNotes

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement createFootNote prepForXml -

Constructors

constructor

Methods

addChildElement

createFootNote

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

createFootNote

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Footer.html b/api/classes/Footer.html index 9607df58b7..83664c7ffa 100644 --- a/api/classes/Footer.html +++ b/api/classes/Footer.html @@ -1,3 +1,3 @@ -Footer | docx

ClassFooter

Constructors

constructor +Footer | docx

Class Footer

Constructors

constructor

Properties

options -

Constructors

constructor

Properties

Readonlyoptions

options: IHeaderOptions

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlyoptions

options: IHeaderOptions

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/FooterWrapper.html b/api/classes/FooterWrapper.html index 338fcbe30b..90f50c1df4 100644 --- a/api/classes/FooterWrapper.html +++ b/api/classes/FooterWrapper.html @@ -1,7 +1,7 @@ -FooterWrapper | docx

ClassFooterWrapper

Implements

  • IViewWrapper

Constructors

constructor +FooterWrapper | docx

Class FooterWrapper

Implements

  • IViewWrapper

Constructors

constructor

Accessors

Media Relationships View

Methods

add addChildElement -

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/FootnoteReference.html b/api/classes/FootnoteReference.html index e3269fdd04..5cf1469f3a 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

Class FootnoteReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootnoteReferenceElement.html b/api/classes/FootnoteReferenceElement.html index 74de7e21b0..2ad806bc6c 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

Class FootnoteReferenceElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/FootnoteReferenceRun.html b/api/classes/FootnoteReferenceRun.html index 882aa4b77a..879643698d 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

Class FootnoteReferenceRun

Hierarchy (view full)

  • Run
    • FootnoteReferenceRun

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/GridSpan.html b/api/classes/GridSpan.html index 5aed56634c..21d3fe399b 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 +GridSpan | docx

Class GridSpan

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

+

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member 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 dba846f4d7..b39817a89c 100644 --- a/api/classes/Header.html +++ b/api/classes/Header.html @@ -1,3 +1,3 @@ -Header | docx

ClassHeader

Constructors

constructor +Header | docx

Class Header

Constructors

constructor

Properties

options -

Constructors

constructor

Properties

Readonlyoptions

options: IHeaderOptions

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlyoptions

options: IHeaderOptions

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/HeaderFooterReference.html b/api/classes/HeaderFooterReference.html index fed3276639..ba44d1a747 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

Class HeaderFooterReference

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassHeaderWrapper

Implements

  • IViewWrapper

Constructors

constructor +HeaderWrapper | docx

Class HeaderWrapper

Implements

  • IViewWrapper

Constructors

constructor

Accessors

Media Relationships View

Methods

add addChildElement -

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

Media

Relationships

  • get Relationships(): Relationships

  • Returns Relationships

View

Methods

add

addChildElement

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/HorizontalPosition.html b/api/classes/HorizontalPosition.html index 59464fc976..6081e9ec1b 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

Class HorizontalPosition

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/HpsMeasureElement.html b/api/classes/HpsMeasureElement.html index 7d7a78001f..41df8f3850 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

Class HpsMeasureElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/IgnoreIfEmptyXmlComponent.html b/api/classes/IgnoreIfEmptyXmlComponent.html index 4303f3519c..b2ecd877e2 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

Class IgnoreIfEmptyXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ImageRun.html b/api/classes/ImageRun.html index 5471ef0527..0beea39aa7 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

Class ImageRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ImportedRootElementAttributes.html b/api/classes/ImportedRootElementAttributes.html index f52332a3b1..704de4aebd 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 +ImportedRootElementAttributes | docx

Class ImportedRootElementAttributes

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

+

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member 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 475844e032..cba83e0080 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 +ImportedXmlComponent | docx

Class ImportedXmlComponent

Represents imported xml component from xml file.

+

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 97b8344b95..5643413915 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

Class Indent

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/InitializableXmlComponent.html b/api/classes/InitializableXmlComponent.html index 03f3a8ea46..dfe9ae3864 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

Class InitializableXmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/InsertedTextRun.html b/api/classes/InsertedTextRun.html index 0d9a6531d0..993a8b243d 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

Class InsertedTextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/InternalHyperlink.html b/api/classes/InternalHyperlink.html index 9ec9292be2..7cfc0507a8 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

Class InternalHyperlink

Hierarchy (view full)

Constructors

constructor

Properties

linkId

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlylinkId

linkId: string

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/LastRenderedPageBreak.html b/api/classes/LastRenderedPageBreak.html index 2bb1139abf..d6c78334c6 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

Class LastRenderedPageBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Level.html b/api/classes/Level.html index 080d87ea50..d3ed2213bf 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

Class Level

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelBase.html b/api/classes/LevelBase.html index 14be82171e..0709640fe5 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

Class LevelBase

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelForOverride.html b/api/classes/LevelForOverride.html index ee28b604a7..0dc8c77a3e 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

Class LevelForOverride

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/LevelOverride.html b/api/classes/LevelOverride.html index e9ce7943ff..abc1fba029 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

Class LevelOverride

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Math.html b/api/classes/Math.html index a4494af4a2..384e1342f0 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

Class Math

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathAccentCharacter.html b/api/classes/MathAccentCharacter.html index 3369ba61e6..15a62a2481 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

Class MathAccentCharacter

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathAngledBrackets.html b/api/classes/MathAngledBrackets.html index acd64b833e..5573a89af9 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

Class MathAngledBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathBase.html b/api/classes/MathBase.html index aa96de36a5..44c98d2649 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

Class MathBase

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathCurlyBrackets.html b/api/classes/MathCurlyBrackets.html index 6f6347bbc2..e08a2954ca 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

Class MathCurlyBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathDegree.html b/api/classes/MathDegree.html index f202d4b937..dbcf339fa8 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

Class MathDegree

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathDenominator.html b/api/classes/MathDenominator.html index 38d6560045..e02adc9319 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

Class MathDenominator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFraction.html b/api/classes/MathFraction.html index 6a0817ece1..a90d04e123 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

Class MathFraction

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunction.html b/api/classes/MathFunction.html index 3a2ccc9972..5b07c84585 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

Class MathFunction

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunctionName.html b/api/classes/MathFunctionName.html index cca8cb8f9f..7986bcde1e 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

Class MathFunctionName

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathFunctionProperties.html b/api/classes/MathFunctionProperties.html index 8a64f2156b..ff04b167ca 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

Class MathFunctionProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathIntegral.html b/api/classes/MathIntegral.html index 187ef94bd3..f1e2d3bedc 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

Class MathIntegral

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimit.html b/api/classes/MathLimit.html index 9ce45c4056..8c22ae5569 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

Class MathLimit

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitLocation.html b/api/classes/MathLimitLocation.html index 7703624442..ab7f009980 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

Class MathLimitLocation

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitLower.html b/api/classes/MathLimitLower.html index 88593cb245..450724208b 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

Class MathLimitLower

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathLimitUpper.html b/api/classes/MathLimitUpper.html index 7cac6c4974..f91646bb39 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

Class MathLimitUpper

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathNAryProperties.html b/api/classes/MathNAryProperties.html index 6c7ebc2636..0236db6812 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

Class MathNAryProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathNumerator.html b/api/classes/MathNumerator.html index 2ebfb644a0..433ccbae4f 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

Class MathNumerator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathPreSubSuperScript.html b/api/classes/MathPreSubSuperScript.html index c8f33d9876..38cf0cbbb5 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

Class MathPreSubSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathPreSubSuperScriptProperties.html b/api/classes/MathPreSubSuperScriptProperties.html index 07b9d1bb62..f4f92bac99 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

Class MathPreSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRadical.html b/api/classes/MathRadical.html index c65e5e3a72..de82163507 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

Class MathRadical

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRadicalProperties.html b/api/classes/MathRadicalProperties.html index 9e780db98c..5d7c523e6c 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

Class MathRadicalProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRoundBrackets.html b/api/classes/MathRoundBrackets.html index 54ec894eb8..d510dd9fb3 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

Class MathRoundBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathRun.html b/api/classes/MathRun.html index 34ea0419f7..817d3b31e3 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

Class MathRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSquareBrackets.html b/api/classes/MathSquareBrackets.html index aeede87fad..d033498345 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

Class MathSquareBrackets

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubScript.html b/api/classes/MathSubScript.html index 2a7394d833..b1d11fdbb8 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

Class MathSubScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubScriptElement.html b/api/classes/MathSubScriptElement.html index f799c94e83..1205e0a929 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

Class MathSubScriptElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubScriptProperties.html b/api/classes/MathSubScriptProperties.html index 709c308d9a..6c27bb78e4 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

Class MathSubScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubSuperScript.html b/api/classes/MathSubSuperScript.html index e6d624b1c0..94bf364108 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

Class MathSubSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSubSuperScriptProperties.html b/api/classes/MathSubSuperScriptProperties.html index 352705ae72..5a43c8da50 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

Class MathSubSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSum.html b/api/classes/MathSum.html index 3d190c825a..f65c8deec4 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

Class MathSum

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSuperScript.html b/api/classes/MathSuperScript.html index 66c0b4bcd1..2661db4ea5 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

Class MathSuperScript

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSuperScriptElement.html b/api/classes/MathSuperScriptElement.html index f45689951a..4aff886bf4 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

Class MathSuperScriptElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MathSuperScriptProperties.html b/api/classes/MathSuperScriptProperties.html index 8779c13f2f..851819d9b0 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

Class MathSuperScriptProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Media.html b/api/classes/Media.html index 445fc60ff5..79d7c9fe2c 100644 --- a/api/classes/Media.html +++ b/api/classes/Media.html @@ -1,4 +1,4 @@ -Media | docx

ClassMedia

Constructors

constructor +Media | docx

Class Media

Constructors

constructor

Accessors

Array

Methods

addImage -

Constructors

constructor

Accessors

Array

Methods

addImage

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

Array

Methods

addImage

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/MonthLong.html b/api/classes/MonthLong.html index 315e6254e8..4f3a02abda 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

Class MonthLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/MonthShort.html b/api/classes/MonthShort.html index 11ff710116..54bfd67bed 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

Class MonthShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NextAttributeComponent.html b/api/classes/NextAttributeComponent.html index 0e02f78b7b..617a0f59aa 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

Class NextAttributeComponent<T>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NoBreakHyphen.html b/api/classes/NoBreakHyphen.html index ee66c3516c..a696e1c42d 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

Class NoBreakHyphen

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NumberProperties.html b/api/classes/NumberProperties.html index 1328ac7520..f1b1aefdac 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

Class NumberProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/NumberValueElement.html b/api/classes/NumberValueElement.html index 77f64bcb96..838bca6259 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

Class NumberValueElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Numbering.html b/api/classes/Numbering.html index adf166c6a0..a57d098cf9 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

Class Numbering

Hierarchy (view full)

Constructors

constructor

Accessors

ConcreteNumbering ReferenceConfig

Methods

addChildElement createConcreteNumberingInstance prepForXml -

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference, instance): void

  • Parameters

    • reference: string
    • instance: number

    Returns void

prepForXml

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

ConcreteNumbering

ReferenceConfig

Methods

addChildElement

createConcreteNumberingInstance

  • createConcreteNumberingInstance(reference, instance): void

  • Parameters

    • reference: string
    • instance: number

    Returns void

prepForXml

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/OnOffElement.html b/api/classes/OnOffElement.html index 6990fb58a0..9a1e465384 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

Class OnOffElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/OutlineLevel.html b/api/classes/OutlineLevel.html index be15aca3ff..3d4fa05b88 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

Class OutlineLevel

Hierarchy (view full)

Constructors

constructor

Properties

level

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlylevel

level: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlylevel

level: number

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

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

ClassPacker

Constructors

constructor +Packer | docx

Class Packer

Constructors

constructor

Methods

toBase64String toBlob toBuffer toStream toString -

Constructors

constructor

Methods

StatictoBase64String

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

  • Parameters

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

    Returns Promise<string>

StatictoBlob

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

  • Parameters

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

    Returns Promise<Blob>

StatictoBuffer

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

  • Parameters

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

    Returns Promise<Buffer>

StatictoStream

  • toStream(file, prettify?): Stream

  • Parameters

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

    Returns Stream

StatictoString

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

  • Parameters

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

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

StatictoBase64String

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

  • Parameters

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

    Returns Promise<string>

StatictoBlob

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

  • Parameters

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

    Returns Promise<Blob>

StatictoBuffer

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

  • Parameters

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

    Returns Promise<Buffer>

StatictoStream

  • toStream(file, prettify?): Stream

  • Parameters

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

    Returns Stream

StatictoString

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

  • Parameters

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

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBorders.html b/api/classes/PageBorders.html index 43a73a4bb8..a886cd459e 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

Class PageBorders

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBreak.html b/api/classes/PageBreak.html index a3921e1e85..88056ff861 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

Class PageBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageBreakBefore.html b/api/classes/PageBreakBefore.html index add434fee2..3ba38eddac 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 +PageBreakBefore | docx

Class PageBreakBefore

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

+

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member 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 a85d443faf..70bfa27f0b 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

Class PageMargin

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

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

  • Parameters

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

    Returns PageMargin

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

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

  • Parameters

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

    Returns PageMargin

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageNumberElement.html b/api/classes/PageNumberElement.html index 9ba735db35..f2bb9311fc 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

Class PageNumberElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageNumberType.html b/api/classes/PageNumberType.html index 6de65413cd..406a4da963 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

Class PageNumberType

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageNumberTypeAttributes.html b/api/classes/PageNumberTypeAttributes.html index df8716a8d6..90e0d79641 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

Class PageNumberTypeAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageReference.html b/api/classes/PageReference.html index e25b90d25c..0e111d966b 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

Class PageReference

Hierarchy (view full)

  • Run
    • PageReference

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageSize.html b/api/classes/PageSize.html index ca57b65c5f..deed3f40cf 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

Class PageSize

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

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

  • Parameters

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

    Returns PageSize

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

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

  • Parameters

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

    Returns PageSize

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PageTextDirection.html b/api/classes/PageTextDirection.html index 3fa2b8b8ff..842d0a19ea 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

Class PageTextDirection

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Paragraph.html b/api/classes/Paragraph.html index 5b2f7cb024..6be3145f57 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

Class Paragraph

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement addRunToFront prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

addRunToFront

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

addRunToFront

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/ParagraphProperties.html b/api/classes/ParagraphProperties.html index c201cef078..09f3bff6ca 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

Class ParagraphProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml push -

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ParagraphPropertiesDefaults.html b/api/classes/ParagraphPropertiesDefaults.html index d940b4f1d1..d3cdc2593e 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

Class ParagraphPropertiesDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/PositionalTab.html b/api/classes/PositionalTab.html index 0c1abf2ce0..ab4e1487c2 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

Class PositionalTab

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Run.html b/api/classes/Run.html index 6ef04b8eb4..f10c844712 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

Class Run

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunFonts.html b/api/classes/RunFonts.html index 4bb1a96f51..1021bafc58 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

Class RunFonts

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunProperties.html b/api/classes/RunProperties.html index 7661082dea..118e1c31b1 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

Class RunProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml push -

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

push

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunPropertiesChange.html b/api/classes/RunPropertiesChange.html index 6359eb845d..ca603fb899 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

Class RunPropertiesChange

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/RunPropertiesDefaults.html b/api/classes/RunPropertiesDefaults.html index 35180d1dbf..7db6da2b54 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

Class RunPropertiesDefaults

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SectionProperties.html b/api/classes/SectionProperties.html index 271c553bd8..31ffd29f9f 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

Class SectionProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SectionTypeAttributes.html b/api/classes/SectionTypeAttributes.html index 8fb2427afd..349fe1c3aa 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

Class SectionTypeAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Separator.html b/api/classes/Separator.html index d8f172ce5b..0d0548b8bf 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

Class Separator

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SequentialIdentifier.html b/api/classes/SequentialIdentifier.html index 033531c815..3c6d7eed3a 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

Class SequentialIdentifier

Hierarchy (view full)

  • Run
    • SequentialIdentifier

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Shading.html b/api/classes/Shading.html index 1f91708f4d..98733c9768 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

Class Shading

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimpleField.html b/api/classes/SimpleField.html index 527d767598..fa207f5782 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

Class SimpleField

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimpleMailMergeField.html b/api/classes/SimpleMailMergeField.html index 526647e98d..69be768bb4 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

Class SimpleMailMergeField

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SimplePos.html b/api/classes/SimplePos.html index 7243b20d7c..66e5007348 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

Class SimplePos

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SoftHyphen.html b/api/classes/SoftHyphen.html index 40d0c54ac2..bff5624c76 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

Class SoftHyphen

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Spacing.html b/api/classes/Spacing.html index 568e2d2449..bbd6d68609 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

Class Spacing

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringContainer.html b/api/classes/StringContainer.html index 4348afecf5..e17386082a 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

Class StringContainer

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringEnumValueElement.html b/api/classes/StringEnumValueElement.html index 3c8c486cd6..766cb2e6a2 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

Class StringEnumValueElement<T>

Type Parameters

  • T extends string

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StringValueElement.html b/api/classes/StringValueElement.html index 1da3cfd5c0..f502cf4265 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

Class StringValueElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Style.html b/api/classes/Style.html index 75755e3001..980221d8cc 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

Class Style

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StyleForCharacter.html b/api/classes/StyleForCharacter.html index 1b4b623df9..ea18f927bf 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

Class StyleForCharacter

Hierarchy

  • Style
    • StyleForCharacter

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StyleForParagraph.html b/api/classes/StyleForParagraph.html index 7793021270..8e47553e66 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

Class StyleForParagraph

Hierarchy

  • Style
    • StyleForParagraph

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/StyleLevel.html b/api/classes/StyleLevel.html index 0db25da79b..9e935e66c4 100644 --- a/api/classes/StyleLevel.html +++ b/api/classes/StyleLevel.html @@ -1,4 +1,4 @@ -StyleLevel | docx

ClassStyleLevel

Constructors

constructor +StyleLevel | docx

Class StyleLevel

Constructors

constructor

Properties

level styleName -

Constructors

constructor

Properties

Readonlylevel

level: number

ReadonlystyleName

styleName: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlylevel

level: number

ReadonlystyleName

styleName: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/api/classes/Styles.html b/api/classes/Styles.html index 73788858c8..50088b2578 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

Class Styles

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/SymbolRun.html b/api/classes/SymbolRun.html index d100ae50c0..4feaff3a26 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

Class SymbolRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TDirection.html b/api/classes/TDirection.html index 26e1a3c0ac..8e3372ea3d 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 +TDirection | docx

Class TDirection

Text Direction within a table cell

+

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member 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 f6bea1bc53..5508102fe0 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

Class Tab

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TabAttributes.html b/api/classes/TabAttributes.html index ef122ca9be..a40e023ba5 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

Class TabAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

  • new TabAttributes(root): TabAttributes

  • Parameters

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

    Returns TabAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

  • new TabAttributes(root): TabAttributes

  • Parameters

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

    Returns TabAttributes

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TabStop.html b/api/classes/TabStop.html index ce8e1b1921..08a1f52bdc 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

Class TabStop

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TabStopItem.html b/api/classes/TabStopItem.html index 564ad0ab36..a827d7a36c 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

Class TabStopItem

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Table.html b/api/classes/Table.html index d399d07ed4..7d3395681a 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

Class Table

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableBorders.html b/api/classes/TableBorders.html index c5ab43db98..0e8f0a2371 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

Class TableBorders

Hierarchy (view full)

Constructors

constructor

Properties

NONE

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Static ReadonlyNONE

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

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Static ReadonlyNONE

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

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableCell.html b/api/classes/TableCell.html index ac63115acb..882ccb05e5 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

Class TableCell

Hierarchy (view full)

Constructors

constructor

Properties

options

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

Readonlyoptions

options: ITableCellOptions

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyoptions

options: ITableCellOptions

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableCellBorders.html b/api/classes/TableCellBorders.html index 356e5fa086..e50a11c8de 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

Class TableCellBorders

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableFloatProperties.html b/api/classes/TableFloatProperties.html index aae071f71d..be892e3ff8 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

Class TableFloatProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableLayout.html b/api/classes/TableLayout.html index 87ebc68578..8a0471c760 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

Class TableLayout

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableOfContents.html b/api/classes/TableOfContents.html index c6faeea3c0..d16cb61ade 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

Class TableOfContents

Hierarchy (view full)

Constructors

constructor

Properties

fileChild

Methods

addChildElement prepForXml -

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

ReadonlyfileChild

fileChild: symbol = ...

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/classes/TableProperties.html b/api/classes/TableProperties.html index cedc3d3ae2..c76dbc7b21 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

Class TableProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRow.html b/api/classes/TableRow.html index 117ff46802..6827edf4b6 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

Class TableRow

Hierarchy (view full)

Constructors

constructor

Accessors

CellCount cells

Methods

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

Constructors

constructor

Accessors

CellCount

cells

Methods

addCellToColumnIndex

addCellToIndex

addChildElement

columnIndexToRootIndex

  • columnIndexToRootIndex(columnIndex, allowEndNewCell?): number

  • Parameters

    • columnIndex: number
    • allowEndNewCell: boolean = false

    Returns number

prepForXml

rootIndexToColumnIndex

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Constructors

constructor

Accessors

CellCount

cells

Methods

addCellToColumnIndex

addCellToIndex

addChildElement

columnIndexToRootIndex

  • columnIndexToRootIndex(columnIndex, allowEndNewCell?): number

  • Parameters

    • columnIndex: number
    • allowEndNewCell: boolean = false

    Returns number

prepForXml

rootIndexToColumnIndex

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/classes/TableRowHeight.html b/api/classes/TableRowHeight.html index 420c8c2660..71e2b815d2 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

Class TableRowHeight

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRowHeightAttributes.html b/api/classes/TableRowHeightAttributes.html index 38f073d2ca..61bf7eae4e 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

Class TableRowHeightAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableRowProperties.html b/api/classes/TableRowProperties.html index af54897dbc..2a1caccf6c 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

Class TableRowProperties

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TableWidthElement.html b/api/classes/TableWidthElement.html index 2ebe9a55b7..74f08275ea 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

Class TableWidthElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/TextRun.html b/api/classes/TextRun.html index 12694b2f97..56fa4b2172 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

Class TextRun

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/ThematicBreak.html b/api/classes/ThematicBreak.html index db67ba5739..fb9808afe4 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

Class ThematicBreak

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Type.html b/api/classes/Type.html index 874a3e2220..f411610f2b 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

Class Type

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/Underline.html b/api/classes/Underline.html index e0cc8085a2..d184362ae3 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

Class Underline

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

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

  • Parameters

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

    Returns Underline

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

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

  • Parameters

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

    Returns Underline

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalAlignAttributes.html b/api/classes/VerticalAlignAttributes.html index d225f18581..1df4f6d670 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

Class VerticalAlignAttributes

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalAlignElement.html b/api/classes/VerticalAlignElement.html index 00cf541a2f..13a11555e1 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

Class VerticalAlignElement

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/VerticalMerge.html b/api/classes/VerticalMerge.html index 47e9c82f00..dc0cc59206 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 +VerticalMerge | docx

Class VerticalMerge

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

+

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member 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 e27e0c987f..3fabc8889e 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

Class VerticalPosition

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapNone.html b/api/classes/WrapNone.html index 968422ec4d..1501e07256 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

Class WrapNone

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapSquare.html b/api/classes/WrapSquare.html index b2a30f06bd..9224752fe7 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

Class WrapSquare

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapTight.html b/api/classes/WrapTight.html index b5ca97a5b4..5c9041121d 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

Class WrapTight

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/WrapTopAndBottom.html b/api/classes/WrapTopAndBottom.html index aa40bedc40..e189290e5c 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

Class WrapTopAndBottom

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/XmlAttributeComponent.html b/api/classes/XmlAttributeComponent.html index 81b9b14114..fc163d956a 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

Class XmlAttributeComponent<T>Abstract

Type Parameters

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

Hierarchy (view full)

Constructors

constructor

Methods

prepForXml -

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/XmlComponent.html b/api/classes/XmlComponent.html index b85e58be61..9b974edf9c 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

Class XmlComponentAbstract

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/YearLong.html b/api/classes/YearLong.html index eceabf21ef..062f6b0968 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

Class YearLong

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/classes/YearShort.html b/api/classes/YearShort.html index ebb3d789f5..784b765f05 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

Class YearShort

Hierarchy (view full)

Constructors

constructor

Methods

addChildElement prepForXml -

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

addChildElement

prepForXml

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/functions/abstractNumUniqueNumericIdGen.html b/api/functions/abstractNumUniqueNumericIdGen.html index b39b21102e..3a18b450d2 100644 --- a/api/functions/abstractNumUniqueNumericIdGen.html +++ b/api/functions/abstractNumUniqueNumericIdGen.html @@ -1 +1 @@ -abstractNumUniqueNumericIdGen | docx

FunctionabstractNumUniqueNumericIdGen

Settings

Member Visibility
+abstractNumUniqueNumericIdGen | docx

Function abstractNumUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/bookmarkUniqueNumericIdGen.html b/api/functions/bookmarkUniqueNumericIdGen.html index 74fdea5cfa..d9790085dd 100644 --- a/api/functions/bookmarkUniqueNumericIdGen.html +++ b/api/functions/bookmarkUniqueNumericIdGen.html @@ -1 +1 @@ -bookmarkUniqueNumericIdGen | docx

FunctionbookmarkUniqueNumericIdGen

Settings

Member Visibility
+bookmarkUniqueNumericIdGen | docx

Function bookmarkUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/concreteNumUniqueNumericIdGen.html b/api/functions/concreteNumUniqueNumericIdGen.html index 3f7fd36d22..17b54199b7 100644 --- a/api/functions/concreteNumUniqueNumericIdGen.html +++ b/api/functions/concreteNumUniqueNumericIdGen.html @@ -1 +1 @@ -concreteNumUniqueNumericIdGen | docx

FunctionconcreteNumUniqueNumericIdGen

Settings

Member Visibility
+concreteNumUniqueNumericIdGen | docx

Function concreteNumUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/convertInchesToTwip.html b/api/functions/convertInchesToTwip.html index 702cc12dd3..97f56b212a 100644 --- a/api/functions/convertInchesToTwip.html +++ b/api/functions/convertInchesToTwip.html @@ -1 +1 @@ -convertInchesToTwip | docx

FunctionconvertInchesToTwip

Settings

Member Visibility
+convertInchesToTwip | docx

Function convertInchesToTwip

Settings

Member Visibility
diff --git a/api/functions/convertMillimetersToTwip.html b/api/functions/convertMillimetersToTwip.html index 47633ef089..464f6c9b8b 100644 --- a/api/functions/convertMillimetersToTwip.html +++ b/api/functions/convertMillimetersToTwip.html @@ -1 +1 @@ -convertMillimetersToTwip | docx

FunctionconvertMillimetersToTwip

Settings

Member Visibility
+convertMillimetersToTwip | docx

Function convertMillimetersToTwip

Settings

Member Visibility
diff --git a/api/functions/convertToXmlComponent.html b/api/functions/convertToXmlComponent.html index 8369b102a0..23acc4f024 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.

+convertToXmlComponent | docx

Function convertToXmlComponent

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

Settings

Member Visibility
+

Returns undefined | string | ImportedXmlComponent

Settings

Member Visibility
diff --git a/api/functions/createFrameProperties.html b/api/functions/createFrameProperties.html index beed762bb3..36753ecd56 100644 --- a/api/functions/createFrameProperties.html +++ b/api/functions/createFrameProperties.html @@ -1 +1 @@ -createFrameProperties | docx

FunctioncreateFrameProperties

Settings

Member Visibility
+createFrameProperties | docx

Function createFrameProperties

Settings

Member Visibility
diff --git a/api/functions/createLineNumberType.html b/api/functions/createLineNumberType.html index 38c0fe790e..a901487118 100644 --- a/api/functions/createLineNumberType.html +++ b/api/functions/createLineNumberType.html @@ -1 +1 @@ -createLineNumberType | docx

FunctioncreateLineNumberType

Settings

Member Visibility
+createLineNumberType | docx

Function createLineNumberType

Settings

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

FunctioncreateStringElement

Settings

Member Visibility
+createStringElement | docx

Function createStringElement

Settings

Member Visibility
diff --git a/api/functions/dateTimeValue.html b/api/functions/dateTimeValue.html index 731624954c..13f0189de9 100644 --- a/api/functions/dateTimeValue.html +++ b/api/functions/dateTimeValue.html @@ -1 +1 @@ -dateTimeValue | docx

FunctiondateTimeValue

Settings

Member Visibility
+dateTimeValue | docx

Function dateTimeValue

Settings

Member Visibility
diff --git a/api/functions/decimalNumber.html b/api/functions/decimalNumber.html index 2ce8336d6c..1b02a7da3d 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

Function decimalNumber

  • decimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/docPropertiesUniqueNumericIdGen.html b/api/functions/docPropertiesUniqueNumericIdGen.html index 8e668241cb..e9df386fb1 100644 --- a/api/functions/docPropertiesUniqueNumericIdGen.html +++ b/api/functions/docPropertiesUniqueNumericIdGen.html @@ -1 +1 @@ -docPropertiesUniqueNumericIdGen | docx

FunctiondocPropertiesUniqueNumericIdGen

Settings

Member Visibility
+docPropertiesUniqueNumericIdGen | docx

Function docPropertiesUniqueNumericIdGen

Settings

Member Visibility
diff --git a/api/functions/eighthPointMeasureValue.html b/api/functions/eighthPointMeasureValue.html index 4580d49e91..710cf29e07 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

Function eighthPointMeasureValue

  • eighthPointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/hashedId.html b/api/functions/hashedId.html index 7183122785..9f208eab51 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

Function hashedId

  • hashedId(data): string

  • Parameters

    • data:
          | string
          | Buffer
          | Uint8Array
          | ArrayBuffer

    Returns string

Settings

Member Visibility
diff --git a/api/functions/hexColorValue.html b/api/functions/hexColorValue.html index 0c8f9dc475..5e65f38af1 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

Function hexColorValue

  • hexColorValue(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/hpsMeasureValue.html b/api/functions/hpsMeasureValue.html index 1341276ca5..b4a05e4b0a 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

Function hpsMeasureValue

  • hpsMeasureValue(val): string | number

  • Parameters

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

    Returns string | number

Settings

Member Visibility
diff --git a/api/functions/longHexNumber.html b/api/functions/longHexNumber.html index 0814378eb5..c326e8328e 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

Function longHexNumber

  • longHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/measurementOrPercentValue.html b/api/functions/measurementOrPercentValue.html index 81c210c85b..c42b5fd8b8 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

Function measurementOrPercentValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/patchDetector.html b/api/functions/patchDetector.html index b3ce075f7c..a21e7d81cb 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
+patchDetector | docx

Function patchDetector

Detects which patches are needed/present in a template

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

  • Parameters

    • __namedParameters: PatchDetectorOptions

    Returns Promise<readonly string[]>

Settings

Member Visibility
diff --git a/api/functions/patchDocument.html b/api/functions/patchDocument.html index eaaf118a14..6ff2076e0a 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

Function patchDocument

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

  • Type Parameters

    • T extends keyof OutputByType = keyof OutputByType

    Parameters

    Returns Promise<OutputByType[T]>

Settings

Member Visibility
diff --git a/api/functions/percentageValue.html b/api/functions/percentageValue.html index 71e3786579..e1ae21da9f 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

Function percentageValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/pointMeasureValue.html b/api/functions/pointMeasureValue.html index 7ea84f2409..f5bafbd433 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

Function pointMeasureValue

  • pointMeasureValue(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/functions/positiveUniversalMeasureValue.html b/api/functions/positiveUniversalMeasureValue.html index 72dbd08052..16245d37da 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

Function positiveUniversalMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/shortHexNumber.html b/api/functions/shortHexNumber.html index 96e86cf808..e76596d994 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

Function shortHexNumber

  • shortHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/signedHpsMeasureValue.html b/api/functions/signedHpsMeasureValue.html index edacb969bf..9fd40fc3c4 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

Function signedHpsMeasureValue

  • signedHpsMeasureValue(val): string | number

  • Parameters

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

    Returns string | number

Settings

Member Visibility
diff --git a/api/functions/signedTwipsMeasureValue.html b/api/functions/signedTwipsMeasureValue.html index e4b2c499c0..873d3cc09a 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

Function signedTwipsMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/twipsMeasureValue.html b/api/functions/twipsMeasureValue.html index 875c1f855d..76480d0f13 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

Function twipsMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/uCharHexNumber.html b/api/functions/uCharHexNumber.html index aa2f39173e..efab1cb5df 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

Function uCharHexNumber

  • uCharHexNumber(val): string

  • Parameters

    • val: string

    Returns string

Settings

Member Visibility
diff --git a/api/functions/uniqueId.html b/api/functions/uniqueId.html index 5a428f3197..01689860fb 100644 --- a/api/functions/uniqueId.html +++ b/api/functions/uniqueId.html @@ -1 +1 @@ -uniqueId | docx

FunctionuniqueId

Settings

Member Visibility
+uniqueId | docx

Function uniqueId

Settings

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

FunctionuniqueNumericIdCreator

Settings

Member Visibility
+uniqueNumericIdCreator | docx

Function uniqueNumericIdCreator

Settings

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

FunctionuniqueUuid

Settings

Member Visibility
+uniqueUuid | docx

Function uniqueUuid

Settings

Member Visibility
diff --git a/api/functions/universalMeasureValue.html b/api/functions/universalMeasureValue.html index f9319a4dfd..8c7a0e55dc 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

Function universalMeasureValue

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

  • Parameters

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

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

Settings

Member Visibility
diff --git a/api/functions/unsignedDecimalNumber.html b/api/functions/unsignedDecimalNumber.html index 13eab0d3b7..ecfead7f8a 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

Function unsignedDecimalNumber

  • unsignedDecimalNumber(val): number

  • Parameters

    • val: number

    Returns number

Settings

Member Visibility
diff --git a/api/interfaces/IAlignmentFrameOptions.html b/api/interfaces/IAlignmentFrameOptions.html index 918f0e8327..4ed649095a 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

Interface IAlignmentFrameOptions

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

Hierarchy

  • IBaseFrameOptions
    • IAlignmentFrameOptions

Properties

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

Properties

Readonlyalignment

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

Readonlyanchor

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

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

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

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Optional Readonlyrule

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

Optional Readonlyspace

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

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyalignment

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

Readonlyanchor

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

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

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

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Optional Readonlyrule

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

Optional Readonlyspace

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

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBaseCharacterStyleOptions.html b/api/interfaces/IBaseCharacterStyleOptions.html index 8c3ae65f1f..24a647d4d5 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

Interface IBaseCharacterStyleOptions

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

Hierarchy (view full)

Properties

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

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

-

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBaseParagraphStyleOptions.html b/api/interfaces/IBaseParagraphStyleOptions.html index 766be5be1f..30022c0ca1 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

Interface IBaseParagraphStyleOptions

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

Hierarchy (view full)

Properties

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

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

-

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBorderOptions.html b/api/interfaces/IBorderOptions.html index f766359526..9b819cc828 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

Interface IBorderOptions

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

Properties

color? size? space? style

Properties

Optional Readonlycolor

color?: string

Border color, in hex (eg 'FF00AA')

-

Optional Readonlysize

size?: number

Size of the border in 1/8 pt

-

Optional Readonlyspace

space?: number

Spacing offset. Values are specified in pt

-

Readonlystyle

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

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlysize

size?: number

Size of the border in 1/8 pt

+

Optional Readonlyspace

space?: number

Spacing offset. Values are specified in pt

+

Readonlystyle

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IBordersOptions.html b/api/interfaces/IBordersOptions.html index aa3cefa803..ef7b010d4b 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

Interface IBordersOptions

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

Properties

bottom? left? right? top? -

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICharacterStyleOptions.html b/api/interfaces/ICharacterStyleOptions.html index 768d4beba0..ae0916c3f2 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

Interface ICharacterStyleOptions

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

Hierarchy (view full)

Properties

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

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

-

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICheckboxSymbolOptions.html b/api/interfaces/ICheckboxSymbolOptions.html index c0342bcbe3..44d00c8196 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

Interface ICheckboxSymbolOptions

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

Properties

alias? checked? checkedState? uncheckedState? -

Properties

Optional Readonlyalias

alias?: string

Optional Readonlychecked

checked?: boolean

Optional ReadonlycheckedState

checkedState?: ICheckboxSymbolProperties

Optional ReadonlyuncheckedState

uncheckedState?: ICheckboxSymbolProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalias

alias?: string

Optional Readonlychecked

checked?: boolean

Optional ReadonlycheckedState

checkedState?: ICheckboxSymbolProperties

Optional ReadonlyuncheckedState

uncheckedState?: ICheckboxSymbolProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICheckboxSymbolProperties.html b/api/interfaces/ICheckboxSymbolProperties.html index 51bfdaf448..e59a5b5b67 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

Interface ICheckboxSymbolProperties

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

Properties

font? value? -

Properties

Optional Readonlyfont

font?: string

Optional Readonlyvalue

value?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyfont

font?: string

Optional Readonlyvalue

value?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICommentOptions.html b/api/interfaces/ICommentOptions.html index dc548bb194..40d307f771 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

Interface ICommentOptions

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

Properties

author? children date? id initials? -

Properties

Optional Readonlyauthor

author?: string

Readonlychildren

children: readonly FileChild[]

Optional Readonlydate

date?: Date

Readonlyid

id: number

Optional Readonlyinitials

initials?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyauthor

author?: string

Readonlychildren

children: readonly FileChild[]

Optional Readonlydate

date?: Date

Readonlyid

id: number

Optional Readonlyinitials

initials?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ICommentsOptions.html b/api/interfaces/ICommentsOptions.html index de8142e20d..4b2a110739 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

Interface ICommentsOptions

interface ICommentsOptions {
    children: readonly ICommentOptions[];
}

Properties

children +

Properties

Readonlychildren

children: readonly ICommentOptions[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IConcreteNumberingOptions.html b/api/interfaces/IConcreteNumberingOptions.html index c23d156ea4..be56abbccb 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

Interface IConcreteNumberingOptions

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

Properties

abstractNumId instance numId overrideLevels? reference -

Properties

ReadonlyabstractNumId

abstractNumId: number

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Optional ReadonlyoverrideLevels

overrideLevels?: readonly IOverrideLevel[]

Readonlyreference

reference: string

Settings

Member Visibility

On This Page

Properties
+

Properties

ReadonlyabstractNumId

abstractNumId: number

Readonlyinstance

instance: number

ReadonlynumId

numId: number

Optional ReadonlyoverrideLevels

overrideLevels?: readonly IOverrideLevel[]

Readonlyreference

reference: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IContext.html b/api/interfaces/IContext.html index dd62fe1729..b812c7afb0 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

Interface IContext

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

Properties

file stack viewWrapper -

Properties

Readonlyfile

file: Document

Readonlystack

stack: IXmlableObject[]

ReadonlyviewWrapper

viewWrapper: IViewWrapper

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyfile

file: Document

Readonlystack

stack: IXmlableObject[]

ReadonlyviewWrapper

viewWrapper: IViewWrapper

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocGridAttributesProperties.html b/api/interfaces/IDocGridAttributesProperties.html index 2fecc2c9f3..88aa83258f 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

Interface IDocGridAttributesProperties

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

Properties

charSpace? linePitch? type? -

Properties

Optional ReadonlycharSpace

charSpace?: number

Optional ReadonlylinePitch

linePitch?: number

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycharSpace

charSpace?: number

Optional ReadonlylinePitch

linePitch?: number

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentAttributesProperties.html b/api/interfaces/IDocumentAttributesProperties.html index 1bc82e6b5f..73461eb650 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

Interface IDocumentAttributesProperties

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

Properties

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

Properties

Optional Readonlyaink

aink?: string

Optional Readonlyam3d

am3d?: string

Optional Readonlycp

cp?: string

Optional Readonlycx

cx?: string

Optional Readonlycx1

cx1?: string

Optional Readonlycx2

cx2?: string

Optional Readonlycx3

cx3?: string

Optional Readonlycx4

cx4?: string

Optional Readonlycx5

cx5?: string

Optional Readonlycx6

cx6?: string

Optional Readonlycx7

cx7?: string

Optional Readonlycx8

cx8?: string

Optional Readonlydc

dc?: string

Optional Readonlydcmitype

dcmitype?: string

Optional Readonlydcterms

dcterms?: string

Optional ReadonlyIgnorable

Ignorable?: string

Optional Readonlym

m?: string

Optional Readonlymc

mc?: string

Optional Readonlyo

o?: string

Optional Readonlyr

r?: string

Optional Readonlytype

type?: string

Optional Readonlyv

v?: string

Optional Readonlyw

w?: string

Optional Readonlyw10

w10?: string

Optional Readonlyw14

w14?: string

Optional Readonlyw15

w15?: string

Optional Readonlyw16

w16?: string

Optional Readonlyw16cex

w16cex?: string

Optional Readonlyw16cid

w16cid?: string

Optional Readonlyw16sdtdh

w16sdtdh?: string

Optional Readonlyw16se

w16se?: string

Optional Readonlywne

wne?: string

Optional Readonlywp

wp?: string

Optional Readonlywp14

wp14?: string

Optional Readonlywpc

wpc?: string

Optional Readonlywpg

wpg?: string

Optional Readonlywpi

wpi?: string

Optional Readonlywps

wps?: string

Optional Readonlyxsi

xsi?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyaink

aink?: string

Optional Readonlyam3d

am3d?: string

Optional Readonlycp

cp?: string

Optional Readonlycx

cx?: string

Optional Readonlycx1

cx1?: string

Optional Readonlycx2

cx2?: string

Optional Readonlycx3

cx3?: string

Optional Readonlycx4

cx4?: string

Optional Readonlycx5

cx5?: string

Optional Readonlycx6

cx6?: string

Optional Readonlycx7

cx7?: string

Optional Readonlycx8

cx8?: string

Optional Readonlydc

dc?: string

Optional Readonlydcmitype

dcmitype?: string

Optional Readonlydcterms

dcterms?: string

Optional ReadonlyIgnorable

Ignorable?: string

Optional Readonlym

m?: string

Optional Readonlymc

mc?: string

Optional Readonlyo

o?: string

Optional Readonlyr

r?: string

Optional Readonlytype

type?: string

Optional Readonlyv

v?: string

Optional Readonlyw

w?: string

Optional Readonlyw10

w10?: string

Optional Readonlyw14

w14?: string

Optional Readonlyw15

w15?: string

Optional Readonlyw16

w16?: string

Optional Readonlyw16cex

w16cex?: string

Optional Readonlyw16cid

w16cid?: string

Optional Readonlyw16sdtdh

w16sdtdh?: string

Optional Readonlyw16se

w16se?: string

Optional Readonlywne

wne?: string

Optional Readonlywp

wp?: string

Optional Readonlywp14

wp14?: string

Optional Readonlywpc

wpc?: string

Optional Readonlywpg

wpg?: string

Optional Readonlywpi

wpi?: string

Optional Readonlywps

wps?: string

Optional Readonlyxsi

xsi?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentBackgroundOptions.html b/api/interfaces/IDocumentBackgroundOptions.html index c4385ddf08..7ac6e81b28 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

Interface IDocumentBackgroundOptions

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

Properties

color? themeColor? themeShade? themeTint? -

Properties

Optional Readonlycolor

color?: string

Optional ReadonlythemeColor

themeColor?: string

Optional ReadonlythemeShade

themeShade?: string

Optional ReadonlythemeTint

themeTint?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolor

color?: string

Optional ReadonlythemeColor

themeColor?: string

Optional ReadonlythemeShade

themeShade?: string

Optional ReadonlythemeTint

themeTint?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentDefaultsOptions.html b/api/interfaces/IDocumentDefaultsOptions.html index f5e1bfb842..e4fd9f68aa 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

Interface IDocumentDefaultsOptions

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

Properties

paragraph? run? -

Properties

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentFooter.html b/api/interfaces/IDocumentFooter.html index ca165fe59e..e07883fcf4 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

Interface IDocumentFooter

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

Properties

footer type -

Properties

Readonlyfooter

footer: FooterWrapper

Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyfooter

footer: FooterWrapper

Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentHeader.html b/api/interfaces/IDocumentHeader.html index 54d7137d33..661033ac74 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

Interface IDocumentHeader

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

Properties

header type -

Properties

Readonlyheader

header: HeaderWrapper

Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyheader

header: HeaderWrapper

Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDocumentOptions.html b/api/interfaces/IDocumentOptions.html index 3abae2a00b..69be1619ad 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

Interface IDocumentOptions

interface IDocumentOptions {
    background?: IDocumentBackgroundOptions;
}

Properties

background? +

Properties

Optional Readonlybackground

background?: IDocumentBackgroundOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IDrawingOptions.html b/api/interfaces/IDrawingOptions.html index cacbdb6448..733fb34295 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

Interface IDrawingOptions

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

Properties

docProperties? floating? outline? -

Properties

Optional ReadonlydocProperties

docProperties?: DocPropertiesOptions

Optional Readonlyfloating

floating?: IFloating

Optional Readonlyoutline

outline?: OutlineOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlydocProperties

docProperties?: DocPropertiesOptions

Optional Readonlyfloating

floating?: IFloating

Optional Readonlyoutline

outline?: OutlineOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IFloating.html b/api/interfaces/IFloating.html index 9c9347d0e7..e9c3dd3c48 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

Interface IFloating

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

Properties

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

Properties

Optional ReadonlyallowOverlap

allowOverlap?: boolean

Optional ReadonlybehindDocument

behindDocument?: boolean

ReadonlyhorizontalPosition

horizontalPosition: IHorizontalPositionOptions

Optional ReadonlylayoutInCell

layoutInCell?: boolean

Optional ReadonlylockAnchor

lockAnchor?: boolean

Optional Readonlymargins

margins?: IMargins

ReadonlyverticalPosition

verticalPosition: IVerticalPositionOptions

Optional Readonlywrap

wrap?: ITextWrapping

Optional ReadonlyzIndex

zIndex?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallowOverlap

allowOverlap?: boolean

Optional ReadonlybehindDocument

behindDocument?: boolean

ReadonlyhorizontalPosition

horizontalPosition: IHorizontalPositionOptions

Optional ReadonlylayoutInCell

layoutInCell?: boolean

Optional ReadonlylockAnchor

lockAnchor?: boolean

Optional Readonlymargins

margins?: IMargins

ReadonlyverticalPosition

verticalPosition: IVerticalPositionOptions

Optional Readonlywrap

wrap?: ITextWrapping

Optional ReadonlyzIndex

zIndex?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IFontAttributesProperties.html b/api/interfaces/IFontAttributesProperties.html index f4243ecda5..c5bbef5d10 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

Interface IFontAttributesProperties

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

Properties

ascii? cs? eastAsia? hAnsi? hint? -

Properties

Optional Readonlyascii

ascii?: string

Optional Readonlycs

cs?: string

Optional ReadonlyeastAsia

eastAsia?: string

Optional ReadonlyhAnsi

hAnsi?: string

Optional Readonlyhint

hint?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyascii

ascii?: string

Optional Readonlycs

cs?: string

Optional ReadonlyeastAsia

eastAsia?: string

Optional ReadonlyhAnsi

hAnsi?: string

Optional Readonlyhint

hint?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderFooterGroup.html b/api/interfaces/IHeaderFooterGroup.html index 57e5d42cd1..95ed5d93df 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

Interface IHeaderFooterGroup<T>

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

Type Parameters

  • T

Properties

default? even? first? -

Properties

Optional Readonlydefault

default?: T

Optional Readonlyeven

even?: T

Optional Readonlyfirst

first?: T

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlydefault

default?: T

Optional Readonlyeven

even?: T

Optional Readonlyfirst

first?: T

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderFooterOptions.html b/api/interfaces/IHeaderFooterOptions.html index 009914555f..ae358999dc 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

Interface IHeaderFooterOptions

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

Properties

id? type? -

Properties

Optional Readonlyid

id?: number

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyid

id?: number

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHeaderOptions.html b/api/interfaces/IHeaderOptions.html index 47a1776977..dd201b5c46 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

Interface IHeaderOptions

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

Properties

children +

Properties

Readonlychildren

children: readonly (Paragraph | Table)[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IHorizontalPositionOptions.html b/api/interfaces/IHorizontalPositionOptions.html index bda7bc6fc5..d4b613f7d2 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

Interface IHorizontalPositionOptions

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

Properties

align? offset? relative? -

Properties

Optional Readonlyalign

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

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalign

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

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IIndentAttributesProperties.html b/api/interfaces/IIndentAttributesProperties.html index 2661ae38b7..fb31eb03b8 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

Interface IIndentAttributesProperties

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

Properties

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

Properties

Optional Readonlyend

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

Optional ReadonlyfirstLine

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

Optional Readonlyhanging

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

Optional Readonlyleft

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

Optional Readonlyright

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

Optional Readonlystart

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyend

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

Optional ReadonlyfirstLine

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

Optional Readonlyhanging

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

Optional Readonlyleft

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

Optional Readonlyright

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

Optional Readonlystart

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ILevelParagraphStylePropertiesOptions.html b/api/interfaces/ILevelParagraphStylePropertiesOptions.html index 5264262ec2..217b1102a2 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

Interface ILevelParagraphStylePropertiesOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

keepNext?: boolean

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

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

keepNext?: boolean

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

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ILevelsOptions.html b/api/interfaces/ILevelsOptions.html index c6a18e266a..fc11867280 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

Interface ILevelsOptions

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

Properties

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

Properties

Optional Readonlyalignment

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

Optional Readonlyformat

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

Optional ReadonlyisLegalNumberingStyle

isLegalNumberingStyle?: boolean

Readonlylevel

level: number

Optional Readonlystart

start?: number

Optional Readonlystyle

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

Optional Readonlysuffix

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

Optional Readonlytext

text?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyformat

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

Optional ReadonlyisLegalNumberingStyle

isLegalNumberingStyle?: boolean

Readonlylevel

level: number

Optional Readonlystart

start?: number

Optional Readonlystyle

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

Optional Readonlysuffix

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

Optional Readonlytext

text?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMargins.html b/api/interfaces/IMargins.html index 5514d64d73..b2b61fe89e 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

Interface IMargins

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

Properties

bottom? left? right? top? -

Properties

Optional Readonlybottom

bottom?: number

Optional Readonlyleft

left?: number

Optional Readonlyright

right?: number

Optional Readonlytop

top?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: number

Optional Readonlyleft

left?: number

Optional Readonlyright

right?: number

Optional Readonlytop

top?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathFractionOptions.html b/api/interfaces/IMathFractionOptions.html index b10a16cac9..63abd3a33d 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

Interface IMathFractionOptions

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

Properties

denominator numerator -

Properties

Readonlydenominator

denominator: readonly MathComponent[]

Readonlynumerator

numerator: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlydenominator

denominator: readonly MathComponent[]

Readonlynumerator

numerator: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathFunctionOptions.html b/api/interfaces/IMathFunctionOptions.html index 8113b2a8bb..6216607e24 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

Interface IMathFunctionOptions

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

Properties

children name -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlyname

name: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlyname

name: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathIntegralOptions.html b/api/interfaces/IMathIntegralOptions.html index 38db5d34d2..9f8d75bd4b 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

Interface IMathIntegralOptions

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

Properties

children subScript? superScript? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathLimitLowerOptions.html b/api/interfaces/IMathLimitLowerOptions.html index a67c3a5376..96ec7ceb2f 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

Interface IMathLimitLowerOptions

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

Properties

children limit -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathLimitUpperOptions.html b/api/interfaces/IMathLimitUpperOptions.html index a6d77e7b97..5e81b9b276 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

Interface IMathLimitUpperOptions

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

Properties

children limit -

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Readonlylimit

limit: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathOptions.html b/api/interfaces/IMathOptions.html index 2636c181e9..2fc160b189 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

Interface IMathOptions

interface IMathOptions {
    children: readonly MathComponent[];
}

Properties

children +

Properties

Readonlychildren

children: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathPreSubSuperScriptOptions.html b/api/interfaces/IMathPreSubSuperScriptOptions.html index 1d6f2a0693..db620ae007 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

Interface IMathPreSubSuperScriptOptions

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

Properties

children subScript superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathRadicalOptions.html b/api/interfaces/IMathRadicalOptions.html index e95bed9698..6dff941db5 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

Interface IMathRadicalOptions

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

Properties

children degree? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional Readonlydegree

degree?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional Readonlydegree

degree?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSubScriptOptions.html b/api/interfaces/IMathSubScriptOptions.html index ffee479242..02f56b021f 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

Interface IMathSubScriptOptions

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

Properties

children subScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSubSuperScriptOptions.html b/api/interfaces/IMathSubSuperScriptOptions.html index bd63ae9fc0..260383c477 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

Interface IMathSubSuperScriptOptions

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

Properties

children subScript superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysubScript

subScript: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSumOptions.html b/api/interfaces/IMathSumOptions.html index 7ebfc4248f..72627ff4ea 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

Interface IMathSumOptions

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

Properties

children subScript? superScript? -

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

Optional ReadonlysubScript

subScript?: readonly MathComponent[]

Optional ReadonlysuperScript

superScript?: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMathSuperScriptOptions.html b/api/interfaces/IMathSuperScriptOptions.html index d23ddb5228..1a2f923272 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

Interface IMathSuperScriptOptions

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

Properties

children superScript -

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly MathComponent[]

ReadonlysuperScript

superScript: readonly MathComponent[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMediaDataTransformation.html b/api/interfaces/IMediaDataTransformation.html index 27bbecfa79..e3b495b39b 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

Interface IMediaDataTransformation

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

Properties

emus flip? pixels rotation? -

Properties

Readonlyemus

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

Optional Readonlyflip

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

Readonlypixels

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

Optional Readonlyrotation

rotation?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyemus

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

Optional Readonlyflip

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

Readonlypixels

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

Optional Readonlyrotation

rotation?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IMediaTransformation.html b/api/interfaces/IMediaTransformation.html index 3ac1e61548..9e449a4fcf 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

Interface IMediaTransformation

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

Properties

flip? height rotation? width -

Properties

Optional Readonlyflip

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

Readonlyheight

height: number

Optional Readonlyrotation

rotation?: number

Readonlywidth

width: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyflip

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

Readonlyheight

height: number

Optional Readonlyrotation

rotation?: number

Readonlywidth

width: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/INumberingOptions.html b/api/interfaces/INumberingOptions.html index 2c328ad619..4d648a9cf5 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

Interface INumberingOptions

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

Properties

config +

Properties

Readonlyconfig

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageBorderAttributes.html b/api/interfaces/IPageBorderAttributes.html index 383502c723..7a73777221 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

Interface IPageBorderAttributes

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

Properties

display? offsetFrom? zOrder? -

Properties

Optional Readonlydisplay

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

Optional ReadonlyoffsetFrom

offsetFrom?: "text" | "page"

Optional ReadonlyzOrder

zOrder?: "back" | "front"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlydisplay

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

Optional ReadonlyoffsetFrom

offsetFrom?: "text" | "page"

Optional ReadonlyzOrder

zOrder?: "back" | "front"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageBordersOptions.html b/api/interfaces/IPageBordersOptions.html index c07658717c..8ffd17e6f1 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

Interface IPageBordersOptions

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

Properties

pageBorderBottom? pageBorderLeft? pageBorderRight? pageBorders? pageBorderTop? -

Properties

Optional ReadonlypageBorderBottom

pageBorderBottom?: IBorderOptions

Optional ReadonlypageBorderLeft

pageBorderLeft?: IBorderOptions

Optional ReadonlypageBorderRight

pageBorderRight?: IBorderOptions

Optional ReadonlypageBorders

pageBorders?: IPageBorderAttributes

Optional ReadonlypageBorderTop

pageBorderTop?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlypageBorderBottom

pageBorderBottom?: IBorderOptions

Optional ReadonlypageBorderLeft

pageBorderLeft?: IBorderOptions

Optional ReadonlypageBorderRight

pageBorderRight?: IBorderOptions

Optional ReadonlypageBorders

pageBorders?: IPageBorderAttributes

Optional ReadonlypageBorderTop

pageBorderTop?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IPageNumberTypeAttributes.html b/api/interfaces/IPageNumberTypeAttributes.html index 0489c4c464..83c5e99579 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

Interface IPageNumberTypeAttributes

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

Properties

formatType? separator? start? -

Properties

Optional ReadonlyformatType

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

Optional Readonlyseparator

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

Optional Readonlystart

start?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyformatType

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

Optional Readonlyseparator

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

Optional Readonlystart

start?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphOptions.html b/api/interfaces/IParagraphOptions.html index 98ddf9801c..21b05959e9 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

Interface IParagraphOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

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

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

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

-

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional Readonlychildren

children?: readonly ParagraphChild[]

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

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

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

keepNext?: boolean

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

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

-

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonlytext

text?: string

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional Readonlychildren

children?: readonly ParagraphChild[]

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

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

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

keepNext?: boolean

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

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

+

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional Readonlytext

text?: string

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphPropertiesOptions.html b/api/interfaces/IParagraphPropertiesOptions.html index 182d41ae9a..c5beb2f3ae 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

Interface IParagraphPropertiesOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

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

Properties

Optional Readonlyalignment

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

Optional ReadonlyautoSpaceEastAsianText

autoSpaceEastAsianText?: boolean

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

-

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

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

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

keepNext?: boolean

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

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

-

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
+

Optional Readonlybidirectional

bidirectional?: boolean

Optional Readonlyborder

border?: IBordersOptions

Optional Readonlybullet

bullet?: {
    level: number;
}

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyframe

frame?: IFrameOptions

Optional Readonlyheading

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

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

keepNext?: boolean

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

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyoverflowPunctuation

overflowPunctuation?: boolean

Optional ReadonlypageBreakBefore

pageBreakBefore?: boolean

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyrun

run?: IRunOptions

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

+

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional Readonlystyle

style?: string

Optional ReadonlysuppressLineNumbers

suppressLineNumbers?: boolean

Optional ReadonlytabStops

tabStops?: readonly TabStopDefinition[]

Optional ReadonlythematicBreak

thematicBreak?: boolean

Optional ReadonlywidowControl

widowControl?: boolean

Optional ReadonlywordWrap

wordWrap?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphStyleOptions.html b/api/interfaces/IParagraphStyleOptions.html index b084d5e7bc..b695ad37ef 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

Interface IParagraphStyleOptions

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

Hierarchy (view full)

Properties

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

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

-

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
+

Readonlyid

id: string

Optional Readonlylink

link?: string

Optional Readonlyname

name?: string

Optional Readonlynext

next?: string

Optional Readonlyparagraph

paragraph?: IParagraphStylePropertiesOptions

Optional ReadonlyquickFormat

quickFormat?: boolean

Optional Readonlyrun

run?: IRunStylePropertiesOptions

Optional ReadonlysemiHidden

semiHidden?: boolean

Optional ReadonlyuiPriority

uiPriority?: number

Optional ReadonlyunhideWhenUsed

unhideWhenUsed?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IParagraphStylePropertiesOptions.html b/api/interfaces/IParagraphStylePropertiesOptions.html index dff35353b1..ac99114b7c 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

Interface IParagraphStylePropertiesOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

-

Optional ReadonlykeepNext

keepNext?: boolean

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

-

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional ReadonlycontextualSpacing

contextualSpacing?: boolean

Optional Readonlyindent

indent?: IIndentAttributesProperties

Optional ReadonlykeepLines

keepLines?: boolean

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

+

Optional ReadonlykeepNext

keepNext?: boolean

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

+

Optional ReadonlyleftTabStop

leftTabStop?: number

Optional Readonlynumbering

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

Optional ReadonlyoutlineLevel

outlineLevel?: number

Optional ReadonlyrightTabStop

rightTabStop?: number

Optional Readonlyspacing

spacing?: ISpacingProperties

Optional ReadonlythematicBreak

thematicBreak?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunOptions.html b/api/interfaces/IRunOptions.html index 87490a29b6..abd8ec3c9c 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

Interface IRunOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunPropertiesChangeOptions.html b/api/interfaces/IRunPropertiesChangeOptions.html index b3fd284b7c..11dfd38eb0 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

Interface IRunPropertiesChangeOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Readonlyauthor

author: string

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Readonlydate

date: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Readonlyid

id: number

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Readonlyauthor

author: string

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Readonlydate

date: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Readonlyid

id: number

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunPropertiesOptions.html b/api/interfaces/IRunPropertiesOptions.html index 0a4b5a4d5d..df2fb3c46d 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

Interface IRunPropertiesOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IRunStylePropertiesOptions.html b/api/interfaces/IRunStylePropertiesOptions.html index 633ee29abe..0a3cf238e6 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

Interface IRunStylePropertiesOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISectionOptions.html b/api/interfaces/ISectionOptions.html index 7cf93473b4..c2835cb50e 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

Interface ISectionOptions

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

Properties

children footers? headers? properties? -

Properties

Readonlychildren

children: readonly FileChild[]

Optional Readonlyfooters

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

Optional Readonlyheaders

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

Optional Readonlyproperties

properties?: ISectionPropertiesOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlychildren

children: readonly FileChild[]

Optional Readonlyfooters

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

Optional Readonlyheaders

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

Optional Readonlyproperties

properties?: ISectionPropertiesOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISectionPropertiesOptions.html b/api/interfaces/ISectionPropertiesOptions.html index 72882cc159..ef340c314a 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

Interface ISectionPropertiesOptions

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

Properties

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

Properties

Optional Readonlycolumn

column?: IColumnsAttributes

Optional ReadonlyfooterWrapperGroup

footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>

Optional Readonlygrid

grid?: IDocGridAttributesProperties

Optional ReadonlyheaderWrapperGroup

headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>

Optional ReadonlylineNumbers

lineNumbers?: ILineNumberAttributes

Optional Readonlypage

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

Optional ReadonlytitlePage

titlePage?: boolean

Optional Readonlytype

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

Optional ReadonlyverticalAlign

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolumn

column?: IColumnsAttributes

Optional ReadonlyfooterWrapperGroup

footerWrapperGroup?: IHeaderFooterGroup<FooterWrapper>

Optional Readonlygrid

grid?: IDocGridAttributesProperties

Optional ReadonlyheaderWrapperGroup

headerWrapperGroup?: IHeaderFooterGroup<HeaderWrapper>

Optional ReadonlylineNumbers

lineNumbers?: ILineNumberAttributes

Optional Readonlypage

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

Optional ReadonlytitlePage

titlePage?: boolean

Optional Readonlytype

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

Optional ReadonlyverticalAlign

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IShadingAttributesProperties.html b/api/interfaces/IShadingAttributesProperties.html index 8394cb8bd7..6aa9c24728 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

Interface IShadingAttributesProperties

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

Properties

color? fill? type? -

Properties

Optional Readonlycolor

color?: string

Optional Readonlyfill

fill?: string

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlycolor

color?: string

Optional Readonlyfill

fill?: string

Optional Readonlytype

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISpacingProperties.html b/api/interfaces/ISpacingProperties.html index 397a97d435..455f3b5ce3 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

Interface ISpacingProperties

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

Properties

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

Properties

Optional Readonlyafter

after?: number

Optional ReadonlyafterAutoSpacing

afterAutoSpacing?: boolean

Optional Readonlybefore

before?: number

Optional ReadonlybeforeAutoSpacing

beforeAutoSpacing?: boolean

Optional Readonlyline

line?: number

Optional ReadonlylineRule

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyafter

after?: number

Optional ReadonlyafterAutoSpacing

afterAutoSpacing?: boolean

Optional Readonlybefore

before?: number

Optional ReadonlybeforeAutoSpacing

beforeAutoSpacing?: boolean

Optional Readonlyline

line?: number

Optional ReadonlylineRule

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IStylesOptions.html b/api/interfaces/IStylesOptions.html index 5abb80d3cd..47fbc9445b 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

Interface IStylesOptions

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

Properties

characterStyles? default? importedStyles? initialStyles? paragraphStyles? -

Properties

Optional ReadonlycharacterStyles

characterStyles?: readonly ICharacterStyleOptions[]

Optional Readonlydefault

default?: IDefaultStylesOptions

Optional ReadonlyimportedStyles

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

Optional ReadonlyinitialStyles

initialStyles?: BaseXmlComponent

Optional ReadonlyparagraphStyles

paragraphStyles?: readonly IParagraphStyleOptions[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycharacterStyles

characterStyles?: readonly ICharacterStyleOptions[]

Optional Readonlydefault

default?: IDefaultStylesOptions

Optional ReadonlyimportedStyles

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

Optional ReadonlyinitialStyles

initialStyles?: BaseXmlComponent

Optional ReadonlyparagraphStyles

paragraphStyles?: readonly IParagraphStyleOptions[]

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ISymbolRunOptions.html b/api/interfaces/ISymbolRunOptions.html index 44a2a96606..c28c54ad32 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

Interface ISymbolRunOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Readonlychar

char: string

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlysymbolfont

symbolfont?: string

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlyallCaps

allCaps?: boolean

Optional Readonlybold

bold?: boolean

Optional ReadonlyboldComplexScript

boldComplexScript?: boolean

Optional Readonlyborder

border?: IBorderOptions

Optional Readonlybreak

break?: number

Readonlychar

char: string

Optional ReadonlycharacterSpacing

characterSpacing?: number

Optional Readonlychildren

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

Optional Readonlycolor

color?: string

Optional ReadonlydoubleStrike

doubleStrike?: boolean

Optional Readonlyeffect

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

Optional Readonlyemboss

emboss?: boolean

Optional ReadonlyemphasisMark

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

Optional Readonlyfont

font?: string | IFontAttributesProperties | IFontOptions

Optional Readonlyhighlight

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

Optional ReadonlyhighlightComplexScript

highlightComplexScript?: string | boolean

Optional Readonlyimprint

imprint?: boolean

Optional Readonlyitalics

italics?: boolean

Optional ReadonlyitalicsComplexScript

italicsComplexScript?: boolean

Optional Readonlykern

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

Optional Readonlylanguage

language?: ILanguageOptions

Optional Readonlymath

math?: boolean

Optional ReadonlynoProof

noProof?: boolean

Optional Readonlyposition

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

Optional Readonlyrevision

revision?: IRunPropertiesChangeOptions

Optional ReadonlyrightToLeft

rightToLeft?: boolean

Optional Readonlyscale

scale?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlysize

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

Optional ReadonlysizeComplexScript

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

Optional ReadonlysmallCaps

smallCaps?: boolean

Optional ReadonlysnapToGrid

snapToGrid?: boolean

Optional ReadonlyspecVanish

specVanish?: boolean

Optional Readonlystrike

strike?: boolean

Optional Readonlystyle

style?: string

Optional ReadonlysubScript

subScript?: boolean

Optional ReadonlysuperScript

superScript?: boolean

Optional Readonlysymbolfont

symbolfont?: string

Optional Readonlytext

text?: string

Optional Readonlyunderline

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

Optional Readonlyvanish

vanish?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableBordersOptions.html b/api/interfaces/ITableBordersOptions.html index c1624241e0..f7631892db 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

Interface ITableBordersOptions

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

Properties

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

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional ReadonlyinsideHorizontal

insideHorizontal?: IBorderOptions

Optional ReadonlyinsideVertical

insideVertical?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional ReadonlyinsideHorizontal

insideHorizontal?: IBorderOptions

Optional ReadonlyinsideVertical

insideVertical?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableCellBorders.html b/api/interfaces/ITableCellBorders.html index c5b7c34c99..49aac7f8eb 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

Interface ITableCellBorders

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

Properties

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

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyend

end?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlystart

start?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlybottom

bottom?: IBorderOptions

Optional Readonlyend

end?: IBorderOptions

Optional Readonlyleft

left?: IBorderOptions

Optional Readonlyright

right?: IBorderOptions

Optional Readonlystart

start?: IBorderOptions

Optional Readonlytop

top?: IBorderOptions

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableCellOptions.html b/api/interfaces/ITableCellOptions.html index 9e30cfb1d3..e9ae9a4035 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

Interface ITableCellOptions

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

Hierarchy

  • ITableCellPropertiesOptions
    • ITableCellOptions

Properties

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

Properties

Optional Readonlyborders

borders?: ITableCellBorders

Readonlychildren

children: readonly (Paragraph | Table)[]

Optional ReadonlycolumnSpan

columnSpan?: number

Optional Readonlymargins

margins?: ITableCellMarginOptions

Optional ReadonlyrowSpan

rowSpan?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional ReadonlytextDirection

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

Optional ReadonlyverticalAlign

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

Optional ReadonlyverticalMerge

verticalMerge?: "continue" | "restart"

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyborders

borders?: ITableCellBorders

Readonlychildren

children: readonly (Paragraph | Table)[]

Optional ReadonlycolumnSpan

columnSpan?: number

Optional Readonlymargins

margins?: ITableCellMarginOptions

Optional ReadonlyrowSpan

rowSpan?: number

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional ReadonlytextDirection

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

Optional ReadonlyverticalAlign

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

Optional ReadonlyverticalMerge

verticalMerge?: "continue" | "restart"

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableOfContentsOptions.html b/api/interfaces/ITableOfContentsOptions.html index 349ca8f84f..4e0ad7d438 100644 --- a/api/interfaces/ITableOfContentsOptions.html +++ b/api/interfaces/ITableOfContentsOptions.html @@ -1,9 +1,9 @@ -ITableOfContentsOptions | docx

InterfaceITableOfContentsOptions

Options according to this docs: +ITableOfContentsOptions | docx

Interface ITableOfContentsOptions

Options according to this docs: https://www.ecma-international.org/publications/standards/Ecma-376.htm 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 2355f6c2fd..07c9cf9754 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

Interface ITableOptions

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

Properties

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

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycolumnWidths

columnWidths?: readonly number[]

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlymargins

margins?: ITableCellMarginOptions

Readonlyrows

rows: readonly TableRow[]

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycolumnWidths

columnWidths?: readonly number[]

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlymargins

margins?: ITableCellMarginOptions

Readonlyrows

rows: readonly TableRow[]

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITablePropertiesOptions.html b/api/interfaces/ITablePropertiesOptions.html index 1369f31a73..ce92736012 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

Interface ITablePropertiesOptions

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

Properties

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

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycellMargin

cellMargin?: ITableCellMarginOptions

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalignment

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

Optional Readonlyborders

borders?: ITableBordersOptions

Optional ReadonlycellMargin

cellMargin?: ITableCellMarginOptions

Optional Readonlyfloat

float?: ITableFloatOptions

Optional Readonlyindent

indent?: ITableWidthProperties

Optional Readonlylayout

layout?: "fixed" | "autofit"

Optional Readonlyshading

shading?: IShadingAttributesProperties

Optional Readonlystyle

style?: string

Optional ReadonlyvisuallyRightToLeft

visuallyRightToLeft?: boolean

Optional Readonlywidth

width?: ITableWidthProperties

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableRowOptions.html b/api/interfaces/ITableRowOptions.html index f76b67fb57..7984fb674f 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

Interface ITableRowOptions

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

Hierarchy (view full)

Properties

cantSplit? children height? tableHeader? -

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Readonlychildren

children: readonly TableCell[]

Optional Readonlyheight

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

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Readonlychildren

children: readonly TableCell[]

Optional Readonlyheight

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

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITableRowPropertiesOptions.html b/api/interfaces/ITableRowPropertiesOptions.html index 42ed6b7b7e..4dd144ccd4 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

Interface ITableRowPropertiesOptions

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

Hierarchy (view full)

Properties

cantSplit? height? tableHeader? -

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Optional Readonlyheight

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

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional ReadonlycantSplit

cantSplit?: boolean

Optional Readonlyheight

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

Optional ReadonlytableHeader

tableHeader?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/ITextWrapping.html b/api/interfaces/ITextWrapping.html index 9e66aa75ad..c1c5d48a38 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

Interface ITextWrapping

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

Properties

margins? side? type -

Properties

Optional Readonlymargins

margins?: IDistance

Optional Readonlyside

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

Readonlytype

type:
    | 0
    | 1
    | 2
    | 3

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlymargins

margins?: IDistance

Optional Readonlyside

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

Readonlytype

type:
    | 0
    | 1
    | 2
    | 3

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IVerticalPositionOptions.html b/api/interfaces/IVerticalPositionOptions.html index 540d8a74b6..99c1f71121 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

Interface IVerticalPositionOptions

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

Properties

align? offset? relative? -

Properties

Optional Readonlyalign

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

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyalign

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

Optional Readonlyoffset

offset?: number

Optional Readonlyrelative

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IXYFrameOptions.html b/api/interfaces/IXYFrameOptions.html index 80bc4eefa6..6549f264a2 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

Interface IXYFrameOptions

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

Hierarchy

  • IBaseFrameOptions
    • IXYFrameOptions

Properties

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

Properties

Readonlyanchor

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

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

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

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Readonlyposition

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

Optional Readonlyrule

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

Optional Readonlyspace

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

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

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

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyanchor

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

Optional ReadonlyanchorLock

anchorLock?: boolean

Optional ReadonlydropCap

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

Readonlyheight

height: number

Optional Readonlylines

lines?: number

Readonlyposition

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

Optional Readonlyrule

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

Optional Readonlyspace

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

Readonlytype

type

Readonlywidth

width: number

Optional Readonlywrap

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

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/IXmlAttribute.html b/api/interfaces/IXmlAttribute.html index ddbe040ec9..3ae70efe94 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

Interface IXmlAttribute

Indexable

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

Settings

Member Visibility
diff --git a/api/interfaces/IXmlableObject.html b/api/interfaces/IXmlableObject.html index 044423837b..5e130ce518 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

Interface IXmlableObject

Hierarchy

  • Record<string, unknown>
    • IXmlableObject

Indexable

  • [key: string]: any

Settings

Member Visibility
diff --git a/api/interfaces/PositionalTabOptions.html b/api/interfaces/PositionalTabOptions.html index ad9fb3778d..81a85d0b22 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

Interface PositionalTabOptions

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

Properties

alignment leader relativeTo -

Properties

Readonlyalignment

alignment: "center" | "left" | "right"

Readonlyleader

leader:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

ReadonlyrelativeTo

relativeTo: "indent" | "margin"

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonlyalignment

alignment: "center" | "left" | "right"

Readonlyleader

leader:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

ReadonlyrelativeTo

relativeTo: "indent" | "margin"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/interfaces/TabStopDefinition.html b/api/interfaces/TabStopDefinition.html index cdaa287b9e..792b579a11 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

Interface TabStopDefinition

interface TabStopDefinition {
    leader?:
        | "none"
        | "dot"
        | "hyphen"
        | "underscore"
        | "middleDot";
    position: number;
    type:
        | "center"
        | "clear"
        | "left"
        | "right"
        | "start"
        | "end"
        | "decimal"
        | "bar"
        | "num";
}

Properties

leader? position type -

Properties

Optional Readonlyleader

leader?:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

Readonlyposition

position: number

Readonlytype

type:
    | "center"
    | "clear"
    | "left"
    | "right"
    | "start"
    | "end"
    | "decimal"
    | "bar"
    | "num"

Settings

Member Visibility

On This Page

Properties
+

Properties

Optional Readonlyleader

leader?:
    | "none"
    | "dot"
    | "hyphen"
    | "underscore"
    | "middleDot"

Readonlyposition

position: number

Readonlytype

type:
    | "center"
    | "clear"
    | "left"
    | "right"
    | "start"
    | "end"
    | "decimal"
    | "bar"
    | "num"

Settings

Member Visibility

On This Page

Properties
diff --git a/api/types/AttributeData.html b/api/types/AttributeData.html index 62fc9711a3..2ba987ff20 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 Alias AttributeData

AttributeData: {
    [key: string]: boolean | number | string;
}

Settings

Member Visibility
diff --git a/api/types/AttributePayload.html b/api/types/AttributePayload.html index 5710febec9..892f1a8b1d 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 Alias AttributePayload<T>

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

Type Parameters

  • T

Settings

Member Visibility
diff --git a/api/types/IColumnsAttributes.html b/api/types/IColumnsAttributes.html index f5ace9d7e6..9b7a5c4776 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 Alias IColumnsAttributes

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

Settings

Member Visibility
diff --git a/api/types/IDistance.html b/api/types/IDistance.html index 08f39d7dfe..9235cad4a4 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 Alias IDistance

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

Settings

Member Visibility
diff --git a/api/types/IFrameOptions.html b/api/types/IFrameOptions.html index 37f4269647..8658d28cf6 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 Alias IFrameOptions

IFrameOptions: IXYFrameOptions | IAlignmentFrameOptions

Settings

Member Visibility
diff --git a/api/types/IImageOptions.html b/api/types/IImageOptions.html index 4bbc88e51a..afa9d22ad5 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 Alias IImageOptions

IImageOptions: (RegularImageOptions | SvgMediaOptions) & CoreImageOptions

Settings

Member Visibility
diff --git a/api/types/ILineNumberAttributes.html b/api/types/ILineNumberAttributes.html index b6285f8e59..2928c934cb 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 Alias ILineNumberAttributes

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

Settings

Member Visibility
diff --git a/api/types/IMediaData.html b/api/types/IMediaData.html index 6c44459e27..6c70d164cd 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 Alias IMediaData

IMediaData: (RegularMediaData | SvgMediaData) & CoreMediaData

Settings

Member Visibility
diff --git a/api/types/IPageMarginAttributes.html b/api/types/IPageMarginAttributes.html index 96cf1c01f9..241ab6f832 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 Alias IPageMarginAttributes

IPageMarginAttributes: {
    bottom?: number | UniversalMeasure;
    footer?: number | PositiveUniversalMeasure;
    gutter?: number | PositiveUniversalMeasure;
    header?: number | PositiveUniversalMeasure;
    left?: number | PositiveUniversalMeasure;
    right?: number | PositiveUniversalMeasure;
    top?: number | UniversalMeasure;
}

Settings

Member Visibility
diff --git a/api/types/IPageReferenceOptions.html b/api/types/IPageReferenceOptions.html index 1f4ce5770c..e5c4286c96 100644 --- a/api/types/IPageReferenceOptions.html +++ b/api/types/IPageReferenceOptions.html @@ -1,7 +1,7 @@ -IPageReferenceOptions | docx

Type AliasIPageReferenceOptions

IPageReferenceOptions: {
    hyperlink?: boolean;
    useRelativePosition?: boolean;
}

Type declaration

  • Optional Readonlyhyperlink?: boolean

    \h option - Creates a hyperlink to the bookmarked paragraph.

    +IPageReferenceOptions | docx

    Type Alias IPageReferenceOptions

    IPageReferenceOptions: {
        hyperlink?: boolean;
        useRelativePosition?: boolean;
    }

    Type declaration

    • Optional Readonlyhyperlink?: boolean

      \h option - Creates a hyperlink to the bookmarked paragraph.

    • Optional ReadonlyuseRelativePosition?: boolean

      \p option - Causes the field to display its position relative to the source 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 ad97911c3b..231b544a7b 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 Alias IPageSizeAttributes

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

Settings

Member Visibility
diff --git a/api/types/IPatch.html b/api/types/IPatch.html index 6eb0fa5900..fc6bd768c0 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 Alias IPatch

IPatch: ParagraphPatch | FilePatch

Settings

Member Visibility
diff --git a/api/types/ITableFloatOptions.html b/api/types/ITableFloatOptions.html index 6bed24dc81..be80d88c98 100644 --- a/api/types/ITableFloatOptions.html +++ b/api/types/ITableFloatOptions.html @@ -1,4 +1,4 @@ -ITableFloatOptions | docx

Type AliasITableFloatOptions

ITableFloatOptions: {
    absoluteHorizontalPosition?: number | UniversalMeasure;
    absoluteVerticalPosition?: number | UniversalMeasure;
    bottomFromText?: number | PositiveUniversalMeasure;
    horizontalAnchor?: typeof TableAnchorType[keyof typeof TableAnchorType];
    leftFromText?: number | PositiveUniversalMeasure;
    overlap?: typeof OverlapType[keyof typeof OverlapType];
    relativeHorizontalPosition?: typeof RelativeHorizontalPosition[keyof typeof RelativeHorizontalPosition];
    relativeVerticalPosition?: typeof RelativeVerticalPosition[keyof typeof RelativeVerticalPosition];
    rightFromText?: number | PositiveUniversalMeasure;
    topFromText?: number | PositiveUniversalMeasure;
    verticalAnchor?: typeof TableAnchorType[keyof typeof TableAnchorType];
}

Type declaration

  • Optional ReadonlyabsoluteHorizontalPosition?: number | UniversalMeasure

    Specifies an absolute horizontal position for the table, relative to the horizontalAnchor. +ITableFloatOptions | docx

    Type Alias ITableFloatOptions

    ITableFloatOptions: {
        absoluteHorizontalPosition?: number | UniversalMeasure;
        absoluteVerticalPosition?: number | UniversalMeasure;
        bottomFromText?: number | PositiveUniversalMeasure;
        horizontalAnchor?: typeof TableAnchorType[keyof typeof TableAnchorType];
        leftFromText?: number | PositiveUniversalMeasure;
        overlap?: typeof OverlapType[keyof typeof OverlapType];
        relativeHorizontalPosition?: typeof RelativeHorizontalPosition[keyof typeof RelativeHorizontalPosition];
        relativeVerticalPosition?: typeof RelativeVerticalPosition[keyof typeof RelativeVerticalPosition];
        rightFromText?: number | PositiveUniversalMeasure;
        topFromText?: number | PositiveUniversalMeasure;
        verticalAnchor?: typeof TableAnchorType[keyof typeof TableAnchorType];
    }

    Type declaration

    • Optional ReadonlyabsoluteHorizontalPosition?: number | UniversalMeasure

      Specifies an absolute horizontal position for the table, relative to the horizontalAnchor. The value is in twentieths of a point. Note that the value can be negative, in which case the table is positioned before the anchor object in the direction of horizontal text flow. If relativeHorizontalPosition is also specified, then the absoluteHorizontalPosition attribute is ignored. @@ -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 a284257c1a..dd8ff4f33b 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 Alias ITableWidthProperties

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

Settings

Member Visibility
diff --git a/api/types/InputDataType.html b/api/types/InputDataType.html index f654f6a7aa..cb790cd1fe 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 Alias InputDataType

InputDataType:
    | Buffer
    | string
    | number[]
    | Uint8Array
    | ArrayBuffer
    | Blob
    | NodeJS.ReadableStream

Settings

Member Visibility
diff --git a/api/types/MathComponent.html b/api/types/MathComponent.html index caa9e7255b..e44819bc4d 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 Alias MathComponent

MathComponent:
    | MathRun
    | MathFraction
    | MathSum
    | MathIntegral
    | MathSuperScript
    | MathSubScript
    | MathSubSuperScript
    | MathRadical
    | MathFunction
    | MathRoundBrackets
    | MathCurlyBrackets
    | MathAngledBrackets
    | MathSquareBrackets

Settings

Member Visibility
diff --git a/api/types/ParagraphChild.html b/api/types/ParagraphChild.html index b4394e0b00..64361d3d37 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 Alias ParagraphChild

ParagraphChild:
    | TextRun
    | ImageRun
    | SymbolRun
    | Bookmark
    | PageBreak
    | ColumnBreak
    | SequentialIdentifier
    | FootnoteReferenceRun
    | InternalHyperlink
    | ExternalHyperlink
    | InsertedTextRun
    | DeletedTextRun
    | Math
    | SimpleField
    | SimpleMailMergeField
    | Comments
    | Comment
    | CommentRangeStart
    | CommentRangeEnd
    | CommentReference
    | CheckBox

Settings

Member Visibility
diff --git a/api/types/PatchDocumentOptions.html b/api/types/PatchDocumentOptions.html index 497ba206e9..14360b2d09 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 Alias PatchDocumentOptions<T>

PatchDocumentOptions<T>: {
    data: InputDataType;
    keepOriginalStyles?: boolean;
    outputType: T;
    patches: {
        [key: string]: IPatch;
    };
}

Type Parameters

Settings

Member Visibility
diff --git a/api/types/PatchDocumentOutputType.html b/api/types/PatchDocumentOutputType.html index 3835103f2c..cab472404e 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 Alias PatchDocumentOutputType

PatchDocumentOutputType: keyof OutputByType

Settings

Member Visibility
diff --git a/api/types/Percentage.html b/api/types/Percentage.html index 40e1f93844..672b131074 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 Alias Percentage

Percentage: `${"-" | ""}${number}%`

Settings

Member Visibility
diff --git a/api/types/PositiveUniversalMeasure.html b/api/types/PositiveUniversalMeasure.html index e6fcdcf6fe..5ece6f6bba 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 Alias PositiveUniversalMeasure

PositiveUniversalMeasure: `${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
diff --git a/api/types/UniqueNumericIdCreator.html b/api/types/UniqueNumericIdCreator.html index 98e682fc89..43d4c1e8ed 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 Alias UniqueNumericIdCreator

UniqueNumericIdCreator: (() => number)

Settings

Member Visibility
diff --git a/api/types/UniversalMeasure.html b/api/types/UniversalMeasure.html index 830b75961d..b485dd19e2 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 Alias UniversalMeasure

UniversalMeasure: `${"-" | ""}${number}${
    | "mm"
    | "cm"
    | "in"
    | "pt"
    | "pc"
    | "pi"}`

Settings

Member Visibility
diff --git a/api/variables/AlignmentType.html b/api/variables/AlignmentType.html index ae54a76a30..99168b3c47 100644 --- a/api/variables/AlignmentType.html +++ b/api/variables/AlignmentType.html @@ -1,4 +1,4 @@ -AlignmentType | docx

VariableAlignmentTypeConst

AlignmentType: {
    BOTH: "both";
    CENTER: "center";
    DISTRIBUTE: "distribute";
    END: "end";
    HIGH_KASHIDA: "highKashida";
    JUSTIFIED: "both";
    LEFT: "left";
    LOW_KASHIDA: "lowKashida";
    MEDIUM_KASHIDA: "mediumKashida";
    NUM_TAB: "numTab";
    RIGHT: "right";
    START: "start";
    THAI_DISTRIBUTE: "thaiDistribute";
} = ...

Type declaration

  • ReadonlyBOTH: "both"

    Justified

    +AlignmentType | docx

    Variable AlignmentTypeConst

    AlignmentType: {
        BOTH: "both";
        CENTER: "center";
        DISTRIBUTE: "distribute";
        END: "end";
        HIGH_KASHIDA: "highKashida";
        JUSTIFIED: "both";
        LEFT: "left";
        LOW_KASHIDA: "lowKashida";
        MEDIUM_KASHIDA: "mediumKashida";
        NUM_TAB: "numTab";
        RIGHT: "right";
        START: "start";
        THAI_DISTRIBUTE: "thaiDistribute";
    } = ...

    Type declaration

    • ReadonlyBOTH: "both"

      Justified

    • ReadonlyCENTER: "center"

      Align Center

    • ReadonlyDISTRIBUTE: "distribute"

      Distribute All Characters Equally

    • ReadonlyEND: "end"

      End

      @@ -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 b23089dcd6..26bb2908f5 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

Variable BorderStyleConst

BorderStyle: {
    DASH_DOT_STROKED: "dashDotStroked";
    DASH_SMALL_GAP: "dashSmallGap";
    DASHED: "dashed";
    DOT_DASH: "dotDash";
    DOT_DOT_DASH: "dotDotDash";
    DOTTED: "dotted";
    DOUBLE: "double";
    DOUBLE_WAVE: "doubleWave";
    INSET: "inset";
    NIL: "nil";
    NONE: "none";
    OUTSET: "outset";
    SINGLE: "single";
    THICK: "thick";
    THICK_THIN_LARGE_GAP: "thickThinLargeGap";
    THICK_THIN_MEDIUM_GAP: "thickThinMediumGap";
    THICK_THIN_SMALL_GAP: "thickThinSmallGap";
    THIN_THICK_LARGE_GAP: "thinThickLargeGap";
    THIN_THICK_MEDIUM_GAP: "thinThickMediumGap";
    THIN_THICK_SMALL_GAP: "thinThickSmallGap";
    THIN_THICK_THIN_LARGE_GAP: "thinThickThinLargeGap";
    THIN_THICK_THIN_MEDIUM_GAP: "thinThickThinMediumGap";
    THIN_THICK_THIN_SMALL_GAP: "thinThickThinSmallGap";
    THREE_D_EMBOSS: "threeDEmboss";
    THREE_D_ENGRAVE: "threeDEngrave";
    TRIPLE: "triple";
    WAVE: "wave";
} = ...

Settings

Member Visibility
diff --git a/api/variables/CharacterSet.html b/api/variables/CharacterSet.html index 13fffe8c00..57f9f62ca3 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

Variable CharacterSetConst

CharacterSet: {
    ANSI: "00";
    ARABIC: "B2";
    BALTIC: "BA";
    CHINESEBIG5: "88";
    DEFAULT: "01";
    EASTEUROPE: "EE";
    GB_2312: "86";
    GREEK: "A1";
    HANGUL: "81";
    HEBREW: "B1";
    JIS: "80";
    JOHAB: "82";
    MAC: "4D";
    OEM: "FF";
    RUSSIAN: "CC";
    SYMBOL: "02";
    THAI: "DE";
    TURKISH: "A2";
    VIETNAMESE: "A3";
} = ...

Settings

Member Visibility
diff --git a/api/variables/DocumentGridType.html b/api/variables/DocumentGridType.html index 1a3503d40a..b18d54db90 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

Variable DocumentGridTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/DropCapType.html b/api/variables/DropCapType.html index 0c08991158..d6c63bab61 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

Variable DropCapTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/EMPTY_OBJECT.html b/api/variables/EMPTY_OBJECT.html index 7798933c61..3a105febd7 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

Variable EMPTY_OBJECTConst

EMPTY_OBJECT: {} = ...

Settings

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

VariableEmphasisMarkTypeConst

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

Settings

Member Visibility
+EmphasisMarkType | docx

Variable EmphasisMarkTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/FrameAnchorType.html b/api/variables/FrameAnchorType.html index f985ee2635..9eeeda0dba 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

Variable FrameAnchorTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/FrameWrap.html b/api/variables/FrameWrap.html index 5e1d4da1ac..b64d52bc03 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

Variable FrameWrapConst

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

Settings

Member Visibility
diff --git a/api/variables/HeaderFooterReferenceType.html b/api/variables/HeaderFooterReferenceType.html index 9b647845ab..6b4ebeda8f 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

Variable HeaderFooterReferenceTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/HeaderFooterType.html b/api/variables/HeaderFooterType.html index 6a4e4f3ddd..31965dfab0 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

Variable HeaderFooterTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/HeadingLevel.html b/api/variables/HeadingLevel.html index 506e072d5a..548b3494ea 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

Variable HeadingLevelConst

HeadingLevel: {
    HEADING_1: "Heading1";
    HEADING_2: "Heading2";
    HEADING_3: "Heading3";
    HEADING_4: "Heading4";
    HEADING_5: "Heading5";
    HEADING_6: "Heading6";
    TITLE: "Title";
} = ...

Settings

Member Visibility
diff --git a/api/variables/HeightRule.html b/api/variables/HeightRule.html index d5095564f7..098f0756b1 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

    +HeightRule | docx

    Variable HeightRuleConst

    HeightRule: {
        ATLEAST: "atLeast";
        AUTO: "auto";
        EXACT: "exact";
    } = ...

    Type declaration

    • ReadonlyATLEAST: "atLeast"

      At least the value specified

    • ReadonlyAUTO: "auto"

      Height is determined based on the content, so value is ignored.

    • ReadonlyEXACT: "exact"

      Exactly the value specified

      -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/api/variables/HighlightColor.html b/api/variables/HighlightColor.html index 57d34ef3af..aff738dfab 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

Variable HighlightColorConst

HighlightColor: {
    BLACK: "black";
    BLUE: "blue";
    CYAN: "cyan";
    DARK_BLUE: "darkBlue";
    DARK_CYAN: "darkCyan";
    DARK_GRAY: "darkGray";
    DARK_GREEN: "darkGreen";
    DARK_MAGENTA: "darkMagenta";
    DARK_RED: "darkRed";
    DARK_YELLOW: "darkYellow";
    GREEN: "green";
    LIGHT_GRAY: "lightGray";
    MAGENTA: "magenta";
    NONE: "none";
    RED: "red";
    WHITE: "white";
    YELLOW: "yellow";
} = ...

Settings

Member Visibility
diff --git a/api/variables/HorizontalPositionAlign.html b/api/variables/HorizontalPositionAlign.html index 124157493e..bc5350c1e7 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

Variable HorizontalPositionAlignConst

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

Settings

Member Visibility
diff --git a/api/variables/HorizontalPositionRelativeFrom.html b/api/variables/HorizontalPositionRelativeFrom.html index f24ec4b15a..4a91b6bc40 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

Variable HorizontalPositionRelativeFromConst

HorizontalPositionRelativeFrom: {
    CHARACTER: "character";
    COLUMN: "column";
    INSIDE_MARGIN: "insideMargin";
    LEFT_MARGIN: "leftMargin";
    MARGIN: "margin";
    OUTSIDE_MARGIN: "outsideMargin";
    PAGE: "page";
    RIGHT_MARGIN: "rightMargin";
} = ...

Settings

Member Visibility
diff --git a/api/variables/HyperlinkType.html b/api/variables/HyperlinkType.html index f6ce2941b4..96b6cf31b2 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

Variable HyperlinkTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/LeaderType.html b/api/variables/LeaderType.html index 7b95dfaebd..b1f565eccc 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

Variable LeaderTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/LevelFormat.html b/api/variables/LevelFormat.html index 6fcf1c74db..2473256a5a 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

Variable LevelFormatConst

LevelFormat: {
    AIUEO: "aiueo";
    AIUEO_FULL_WIDTH: "aiueoFullWidth";
    ARABIC_ABJAD: "arabicAbjad";
    ARABIC_ALPHA: "arabicAlpha";
    BAHT_TEXT: "bahtText";
    BULLET: "bullet";
    CARDINAL_TEXT: "cardinalText";
    CHICAGO: "chicago";
    CHINESE_COUNTING: "chineseCounting";
    CHINESE_COUNTING_THOUSAND: "chineseCountingThousand";
    CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
    CHOSUNG: "chosung";
    CUSTOM: "custom";
    DECIMAL: "decimal";
    DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
    DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
    DECIMAL_ENCLOSED_FULLSTOP: "decimalEnclosedFullstop";
    DECIMAL_ENCLOSED_PARENTHESES: "decimalEnclosedParen";
    DECIMAL_FULL_WIDTH: "decimalFullWidth";
    DECIMAL_FULL_WIDTH2: "decimalFullWidth2";
    DECIMAL_HALF_WIDTH: "decimalHalfWidth";
    DECIMAL_ZERO: "decimalZero";
    DOLLAR_TEXT: "dollarText";
    GANADA: "ganada";
    HEBREW1: "hebrew1";
    HEBREW2: "hebrew2";
    HEX: "hex";
    HINDI_CONSONANTS: "hindiConsonants";
    HINDI_COUNTING: "hindiCounting";
    HINDI_NUMBERS: "hindiNumbers";
    HINDI_VOWELS: "hindiVowels";
    IDEOGRAPH__DIGITAL: "ideographDigital";
    IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
    IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
    IDEOGRAPH_TRADITIONAL: "ideographTraditional";
    IDEOGRAPH_ZODIAC: "ideographZodiac";
    IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
    IROHA: "iroha";
    IROHA_FULL_WIDTH: "irohaFullWidth";
    JAPANESE_COUNTING: "japaneseCounting";
    JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
    JAPANESE_LEGAL: "japaneseLegal";
    KOREAN_COUNTING: "koreanCounting";
    KOREAN_DIGITAL: "koreanDigital";
    KOREAN_DIGITAL2: "koreanDigital2";
    KOREAN_LEGAL: "koreanLegal";
    LOWER_LETTER: "lowerLetter";
    LOWER_ROMAN: "lowerRoman";
    NONE: "none";
    NUMBER_IN_DASH: "numberInDash";
    ORDINAL: "ordinal";
    ORDINAL_TEXT: "ordinalText";
    RUSSIAN_LOWER: "russianLower";
    RUSSIAN_UPPER: "russianUpper";
    TAIWANESE_COUNTING: "taiwaneseCounting";
    TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
    TAIWANESE_DIGITAL: "taiwaneseDigital";
    THAI_COUNTING: "thaiCounting";
    THAI_LETTERS: "thaiLetters";
    THAI_NUMBERS: "thaiNumbers";
    UPPER_LETTER: "upperLetter";
    UPPER_ROMAN: "upperRoman";
    VIETNAMESE_COUNTING: "vietnameseCounting";
} = ...

Settings

Member Visibility
diff --git a/api/variables/LevelSuffix.html b/api/variables/LevelSuffix.html index 68e5c9e771..fb4e839b99 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

Variable LevelSuffixConst

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

Settings

Member Visibility
diff --git a/api/variables/LineNumberRestartFormat.html b/api/variables/LineNumberRestartFormat.html index e9516949d2..c2f5c074e0 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

Variable LineNumberRestartFormatConst

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

Settings

Member Visibility
diff --git a/api/variables/LineRuleType.html b/api/variables/LineRuleType.html index b6cb80af21..6bcd588c51 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

Variable LineRuleTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/NumberFormat.html b/api/variables/NumberFormat.html index 0c36a77b3e..516891ca78 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

Variable NumberFormatConst

NumberFormat: {
    AIUEO: "aiueo";
    AIUEO_FULL_WIDTH: "aiueoFullWidth";
    ARABIC_ABJAD: "arabicAbjad";
    ARABIC_ALPHA: "arabicAlpha";
    BAHT_TEXT: "bahtText";
    BULLET: "bullet";
    CARDINAL_TEXT: "cardinalText";
    CHICAGO: "chicago";
    CHINESE_COUNTING: "chineseCounting";
    CHINESE_COUNTING_TEN_THOUSAND: "chineseCountingThousand";
    CHINESE_LEGAL_SIMPLIFIED: "chineseLegalSimplified";
    CHOSUNG: "chosung";
    DECIMAL: "decimal";
    DECIMAL_ENCLOSED_CIRCLE: "decimalEnclosedCircle";
    DECIMAL_ENCLOSED_CIRCLE_CHINESE: "decimalEnclosedCircleChinese";
    DECIMAL_ENCLOSED_FULL_STOP: "decimalEnclosedFullstop";
    DECIMAL_ENCLOSED_PAREN: "decimalEnclosedParen";
    DECIMAL_FULL_WIDTH: "decimalFullWidth";
    DECIMAL_FULL_WIDTH_2: "decimalFullWidth2";
    DECIMAL_HALF_WIDTH: "decimalHalfWidth";
    DECIMAL_ZERO: "decimalZero";
    DOLLAR_TEXT: "dollarText";
    GANADA: "ganada";
    HEBREW_1: "hebrew1";
    HEBREW_2: "hebrew2";
    HEX: "hex";
    HINDI_CONSONANTS: "hindiConsonants";
    HINDI_COUNTING: "hindiCounting";
    HINDI_NUMBERS: "hindiNumbers";
    HINDI_VOWELS: "hindiVowels";
    IDEOGRAPH_DIGITAL: "ideographDigital";
    IDEOGRAPH_ENCLOSED_CIRCLE: "ideographEnclosedCircle";
    IDEOGRAPH_LEGAL_TRADITIONAL: "ideographLegalTraditional";
    IDEOGRAPH_TRADITIONAL: "ideographTraditional";
    IDEOGRAPH_ZODIAC: "ideographZodiac";
    IDEOGRAPH_ZODIAC_TRADITIONAL: "ideographZodiacTraditional";
    IROHA: "iroha";
    IROHA_FULL_WIDTH: "irohaFullWidth";
    JAPANESE_COUNTING: "japaneseCounting";
    JAPANESE_DIGITAL_TEN_THOUSAND: "japaneseDigitalTenThousand";
    JAPANESE_LEGAL: "japaneseLegal";
    KOREAN_COUNTING: "koreanCounting";
    KOREAN_DIGITAL: "koreanDigital";
    KOREAN_DIGITAL_2: "koreanDigital2";
    KOREAN_LEGAL: "koreanLegal";
    LOWER_LETTER: "lowerLetter";
    LOWER_ROMAN: "lowerRoman";
    NONE: "none";
    NUMBER_IN_DASH: "numberInDash";
    ORDINAL: "ordinal";
    ORDINAL_TEXT: "ordinalText";
    RUSSIAN_LOWER: "russianLower";
    RUSSIAN_UPPER: "russianUpper";
    TAIWANESE_COUNTING: "taiwaneseCounting";
    TAIWANESE_COUNTING_THOUSAND: "taiwaneseCountingThousand";
    TAIWANESE_DIGITAL: "taiwaneseDigital";
    THAI_COUNTING: "thaiCounting";
    THAI_LETTERS: "thaiLetters";
    THAI_NUMBERS: "thaiNumbers";
    UPPER_LETTER: "upperLetter";
    UPPER_ROMAN: "upperRoman";
    VIETNAMESE_COUNTING: "vietnameseCounting";
} = ...

Settings

Member Visibility
diff --git a/api/variables/OverlapType.html b/api/variables/OverlapType.html index 7c515dd438..6c3a96a022 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

Variable OverlapTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/PageBorderDisplay.html b/api/variables/PageBorderDisplay.html index 845fb093dd..6d58d3cb54 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

Variable PageBorderDisplayConst

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

Settings

Member Visibility
diff --git a/api/variables/PageBorderOffsetFrom.html b/api/variables/PageBorderOffsetFrom.html index 7b837c8b99..69de3b0a8c 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

Variable PageBorderOffsetFromConst

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

Settings

Member Visibility
diff --git a/api/variables/PageBorderZOrder.html b/api/variables/PageBorderZOrder.html index 5a1347daa9..cd674f5587 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

Variable PageBorderZOrderConst

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

Settings

Member Visibility
diff --git a/api/variables/PageNumber.html b/api/variables/PageNumber.html index d89d4d1e79..70d7d28442 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

Variable PageNumberConst

PageNumber: {
    CURRENT: "CURRENT";
    CURRENT_SECTION: "SECTION";
    TOTAL_PAGES: "TOTAL_PAGES";
    TOTAL_PAGES_IN_SECTION: "TOTAL_PAGES_IN_SECTION";
} = ...

Settings

Member Visibility
diff --git a/api/variables/PageNumberSeparator.html b/api/variables/PageNumberSeparator.html index 191f1b1b7d..534a096fb5 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

Variable PageNumberSeparatorConst

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

Settings

Member Visibility
diff --git a/api/variables/PageOrientation.html b/api/variables/PageOrientation.html index 25fba26023..f5e4af107e 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

Variable PageOrientationConst

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

Settings

Member Visibility
diff --git a/api/variables/PageTextDirectionType.html b/api/variables/PageTextDirectionType.html index 8b5d5e08f5..fde643131b 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

Variable PageTextDirectionTypeConst

PageTextDirectionType: {
    LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
    TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
} = ...

Settings

Member Visibility
diff --git a/api/variables/PatchType.html b/api/variables/PatchType.html index 233321a44c..026b761206 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

Variable PatchTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/PositionalTabAlignment.html b/api/variables/PositionalTabAlignment.html index 925a3e41bb..91a7a107ce 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

Variable PositionalTabAlignmentConst

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

Settings

Member Visibility
diff --git a/api/variables/PositionalTabLeader.html b/api/variables/PositionalTabLeader.html index da7c7c0606..b5a63f8d42 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

Variable PositionalTabLeaderConst

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

Settings

Member Visibility
diff --git a/api/variables/PositionalTabRelativeTo.html b/api/variables/PositionalTabRelativeTo.html index c4715ab19f..3c42e2781b 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

Variable PositionalTabRelativeToConst

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

Settings

Member Visibility
diff --git a/api/variables/PrettifyType.html b/api/variables/PrettifyType.html index bf69e8ccc7..8230565e1a 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
+PrettifyType | docx

Variable PrettifyTypeConst

PrettifyType: {
    NONE: "";
    WITH_2_BLANKS: " ";
    WITH_4_BLANKS: " ";
    WITH_TAB: "\t";
} = ...

Use blanks to prettify

+

Settings

Member Visibility
diff --git a/api/variables/RelativeHorizontalPosition.html b/api/variables/RelativeHorizontalPosition.html index 9aa50a821a..8f3eb513bf 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

Variable RelativeHorizontalPositionConst

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

Settings

Member Visibility
diff --git a/api/variables/RelativeVerticalPosition.html b/api/variables/RelativeVerticalPosition.html index 5b32d6e654..34d1b3cdc5 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

Variable RelativeVerticalPositionConst

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

Settings

Member Visibility
diff --git a/api/variables/SectionType.html b/api/variables/SectionType.html index f2c2d5c3ee..f918e6e446 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

Variable SectionTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/ShadingType.html b/api/variables/ShadingType.html index 87d1aaa8fa..5301c757de 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

Variable ShadingTypeConst

ShadingType: {
    CLEAR: "clear";
    DIAGONAL_CROSS: "diagCross";
    DIAGONAL_STRIPE: "diagStripe";
    HORIZONTAL_CROSS: "horzCross";
    HORIZONTAL_STRIPE: "horzStripe";
    NIL: "nil";
    PERCENT_10: "pct10";
    PERCENT_12: "pct12";
    PERCENT_15: "pct15";
    PERCENT_20: "pct20";
    PERCENT_25: "pct25";
    PERCENT_30: "pct30";
    PERCENT_35: "pct35";
    PERCENT_37: "pct37";
    PERCENT_40: "pct40";
    PERCENT_45: "pct45";
    PERCENT_5: "pct5";
    PERCENT_50: "pct50";
    PERCENT_55: "pct55";
    PERCENT_60: "pct60";
    PERCENT_62: "pct62";
    PERCENT_65: "pct65";
    PERCENT_70: "pct70";
    PERCENT_75: "pct75";
    PERCENT_80: "pct80";
    PERCENT_85: "pct85";
    PERCENT_87: "pct87";
    PERCENT_90: "pct90";
    PERCENT_95: "pct95";
    REVERSE_DIAGONAL_STRIPE: "reverseDiagStripe";
    SOLID: "solid";
    THIN_DIAGONAL_CROSS: "thinDiagCross";
    THIN_DIAGONAL_STRIPE: "thinDiagStripe";
    THIN_HORIZONTAL_CROSS: "thinHorzCross";
    THIN_REVERSE_DIAGONAL_STRIPE: "thinReverseDiagStripe";
    THIN_VERTICAL_STRIPE: "thinVertStripe";
    VERTICAL_STRIPE: "vertStripe";
} = ...

Settings

Member Visibility
diff --git a/api/variables/SpaceType.html b/api/variables/SpaceType.html index fd93b6c00e..9d069689a4 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

Variable SpaceTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/TabStopPosition.html b/api/variables/TabStopPosition.html index 666d8c331c..a5698cb91a 100644 --- a/api/variables/TabStopPosition.html +++ b/api/variables/TabStopPosition.html @@ -1 +1 @@ -TabStopPosition | docx

VariableTabStopPositionConst

TabStopPosition: {
    MAX: 9026;
} = ...

Settings

Member Visibility
+TabStopPosition | docx

Variable TabStopPositionConst

TabStopPosition: {
    MAX: 9026;
} = ...

Settings

Member Visibility
diff --git a/api/variables/TabStopType.html b/api/variables/TabStopType.html index 01ca1b4eaa..50fe1282a9 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

Variable TabStopTypeConst

TabStopType: {
    BAR: "bar";
    CENTER: "center";
    CLEAR: "clear";
    DECIMAL: "decimal";
    END: "end";
    LEFT: "left";
    NUM: "num";
    RIGHT: "right";
    START: "start";
} = ...

Settings

Member Visibility
diff --git a/api/variables/TableAnchorType.html b/api/variables/TableAnchorType.html index e71b02c637..fe1951ddd4 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

Variable TableAnchorTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/TableLayoutType.html b/api/variables/TableLayoutType.html index 95a1501271..52ee44fe4d 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

Variable TableLayoutTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/TextDirection.html b/api/variables/TextDirection.html index b0ec4f6fb8..560cecf4b6 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

Variable TextDirectionConst

TextDirection: {
    BOTTOM_TO_TOP_LEFT_TO_RIGHT: "btLr";
    LEFT_TO_RIGHT_TOP_TO_BOTTOM: "lrTb";
    TOP_TO_BOTTOM_RIGHT_TO_LEFT: "tbRl";
} = ...

Settings

Member Visibility
diff --git a/api/variables/TextEffect.html b/api/variables/TextEffect.html index b35d312bcf..9ceecc626b 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

Variable TextEffectConst

TextEffect: {
    ANTS_BLACK: "antsBlack";
    ANTS_RED: "antsRed";
    BLINK_BACKGROUND: "blinkBackground";
    LIGHTS: "lights";
    NONE: "none";
    SHIMMER: "shimmer";
    SPARKLE: "sparkle";
} = ...

Settings

Member Visibility
diff --git a/api/variables/TextWrappingSide.html b/api/variables/TextWrappingSide.html index 15bf3b59b2..21a660499f 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

Variable TextWrappingSideConst

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

Settings

Member Visibility
diff --git a/api/variables/TextWrappingType.html b/api/variables/TextWrappingType.html index 23206e55b4..4b050d7093 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

Variable TextWrappingTypeConst

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

Settings

Member Visibility
diff --git a/api/variables/UnderlineType.html b/api/variables/UnderlineType.html index 8ff7d9ee85..9c9163bf9f 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

Variable UnderlineTypeConst

UnderlineType: {
    DASH: "dash";
    DASHDOTDOTHEAVY: "dashDotDotHeavy";
    DASHDOTHEAVY: "dashDotHeavy";
    DASHEDHEAVY: "dashedHeavy";
    DASHLONG: "dashLong";
    DASHLONGHEAVY: "dashLongHeavy";
    DOTDASH: "dotDash";
    DOTDOTDASH: "dotDotDash";
    DOTTED: "dotted";
    DOTTEDHEAVY: "dottedHeavy";
    DOUBLE: "double";
    NONE: "none";
    SINGLE: "single";
    THICK: "thick";
    WAVE: "wave";
    WAVYDOUBLE: "wavyDouble";
    WAVYHEAVY: "wavyHeavy";
    WORDS: "words";
} = ...

Settings

Member Visibility
diff --git a/api/variables/VerticalAlign.html b/api/variables/VerticalAlign.html index c1513cf017..7a104e9ec8 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

Variable VerticalAlignConst

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

Settings

Member Visibility
diff --git a/api/variables/VerticalMergeType.html b/api/variables/VerticalMergeType.html index 357cf8bc0c..7ae3354186 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.

+VerticalMergeType | docx

Variable VerticalMergeTypeConst

VerticalMergeType: {
    CONTINUE: "continue";
    RESTART: "restart";
} = ...

Vertical merge types.

Type declaration

  • ReadonlyCONTINUE: "continue"

    Cell that is merged with upper one.

  • ReadonlyRESTART: "restart"

    Cell that is starting the vertical merge.

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/api/variables/VerticalPositionAlign.html b/api/variables/VerticalPositionAlign.html index 37b5e13d96..669cadb7d4 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

Variable VerticalPositionAlignConst

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

Settings

Member Visibility
diff --git a/api/variables/VerticalPositionRelativeFrom.html b/api/variables/VerticalPositionRelativeFrom.html index a287a84d8e..f531bec7a4 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

Variable VerticalPositionRelativeFromConst

VerticalPositionRelativeFrom: {
    BOTTOM_MARGIN: "bottomMargin";
    INSIDE_MARGIN: "insideMargin";
    LINE: "line";
    MARGIN: "margin";
    OUTSIDE_MARGIN: "outsideMargin";
    PAGE: "page";
    PARAGRAPH: "paragraph";
    TOP_MARGIN: "topMargin";
} = ...

Settings

Member Visibility
diff --git a/api/variables/WidthType.html b/api/variables/WidthType.html index e4fc7bd543..c5163bbddb 100644 --- a/api/variables/WidthType.html +++ b/api/variables/WidthType.html @@ -1,5 +1,5 @@ -WidthType | docx

VariableWidthTypeConst

WidthType: {
    AUTO: "auto";
    DXA: "dxa";
    NIL: "nil";
    PERCENTAGE: "pct";
} = ...

Type declaration

  • ReadonlyAUTO: "auto"

    Auto.

    +WidthType | docx

    Variable WidthTypeConst

    WidthType: {
        AUTO: "auto";
        DXA: "dxa";
        NIL: "nil";
        PERCENTAGE: "pct";
    } = ...

    Type declaration

    • ReadonlyAUTO: "auto"

      Auto.

    • 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 2485753447..f8cef22db2 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

Variable sectionMarginDefaultsConst

sectionMarginDefaults: {
    BOTTOM: number;
    FOOTER: number;
    GUTTER: number;
    HEADER: number;
    LEFT: number;
    RIGHT: number;
    TOP: number;
} = ...

Settings

Member Visibility
diff --git a/api/variables/sectionPageSizeDefaults.html b/api/variables/sectionPageSizeDefaults.html index d9afc20e73..44de716b3a 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

Variable sectionPageSizeDefaultsConst

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

Settings

Member Visibility