diff --git a/README.md b/README.md index fd5ad9ecd9..e8da69f267 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- clippy the assistant + clippy the assistant

@@ -18,33 +18,51 @@ npm install --save docx Then you can `require` or `import` as usual: -```js -let docx = require("docx"); +```ts +const docx = require("docx"); ``` -```js +```ts import * as docx from "docx"; +// or +import { ... } from "docx"; ``` ## Basic Usage -```js -var fs = require("fs"); -var docx = require("docx"); +```ts +import * as fs from "fs"; +import { Document, Packer, Paragraph, TextRun } from "docx"; // Create document -var doc = new docx.Document(); +const doc = new Document(); -// Add some content in the document -var paragraph = new docx.Paragraph("Some cool text here."); -// Add more text into the paragraph if you wish -paragraph.addRun(new docx.TextRun("Lorem Ipsum Foo Bar")); -doc.addParagraph(paragraph); +// Documents contain sections, you can have multiple sections per document, go here to learn more about sections +// This simple example will only contain one section +doc.addSection({ + properties: {}, + children: [ + new Paragraph({ + children: [ + new TextRun("Hello World"), + new TextRun({ + text: "Foo Bar", + bold: true, + }), + new TextRun({ + text: "Github is the best", + bold: true, + }).tab(), + ], + }), + ], +}); // Used to export the file into a .docx file -var packer = new docx.Packer(); +const packer = new Packer(); + packer.toBuffer(doc).then((buffer) => { - fs.writeFileSync("My First Document.docx", buffer); + fs.writeFileSync("My Document.docx", buffer); }); // Done! A file called 'My First Document.docx' will be in your file system. diff --git a/_sidebar.md b/_sidebar.md index 558029dbf6..9e329b6448 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -9,6 +9,7 @@ * Usage * [Document](usage/document.md) + * [Sections](usage/sections.md) * [Paragraph](usage/paragraph.md) * [Text](usage/text.md) * [Image](usage/images.md) diff --git a/api/classes/abstractnumbering.html b/api/classes/abstractnumbering.html index 0037035715..78499040f8 100644 --- a/api/classes/abstractnumbering.html +++ b/api/classes/abstractnumbering.html @@ -125,7 +125,7 @@

Parameters

@@ -147,7 +147,7 @@
id: number
@@ -165,7 +165,7 @@

Returns boolean

@@ -186,7 +186,7 @@

Parameters

@@ -209,7 +209,7 @@
  • Parameters

    @@ -232,7 +232,7 @@
  • Parameters

    @@ -265,7 +265,7 @@

    Returns void

    @@ -284,7 +284,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/adjustmentvalues.html b/api/classes/adjustmentvalues.html index 5441173682..7ccfac29d5 100644 --- a/api/classes/adjustmentvalues.html +++ b/api/classes/adjustmentvalues.html @@ -117,7 +117,7 @@

    Returns AdjustmentValues

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/alias.html b/api/classes/alias.html index c19a81931b..7f4637e7ac 100644 --- a/api/classes/alias.html +++ b/api/classes/alias.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/align.html b/api/classes/align.html index 697b82a7c7..33e419bca6 100644 --- a/api/classes/align.html +++ b/api/classes/align.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/alignment.html b/api/classes/alignment.html index 6eb6b372de..e1fbfa2922 100644 --- a/api/classes/alignment.html +++ b/api/classes/alignment.html @@ -110,20 +110,20 @@

    constructor

    -
    +

    Accessors

    @@ -100,7 +99,6 @@
  • addChildElement
  • addSection
  • delete
  • -
  • getParagraphs
  • getTablesOfContents
  • prepForXml
  • push
  • @@ -115,46 +113,23 @@

    constructor

    -
    +

    Accessors

    -
    - -

    DefaultSection

    - - -

    IsDeleted

    @@ -166,7 +141,7 @@

    Returns boolean

    @@ -187,7 +162,7 @@

    Parameters

    @@ -204,13 +179,13 @@

    addSection

    -
    - -

    getParagraphs

    - - -

    getTablesOfContents

    @@ -282,7 +240,7 @@
  • Returns TableOfContents[]

    @@ -300,7 +258,7 @@

    Returns IXmlableObject @@ -320,7 +278,7 @@
  • Parameters

    @@ -353,9 +311,6 @@
  • constructor
  • -
  • - DefaultSection -
  • IsDeleted
  • @@ -368,9 +323,6 @@
  • delete
  • -
  • - getParagraphs -
  • getTablesOfContents
  • diff --git a/api/classes/bold.html b/api/classes/bold.html index 1f7123088e..4009785ab2 100644 --- a/api/classes/bold.html +++ b/api/classes/bold.html @@ -117,7 +117,7 @@

    Returns Bold

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/boldcomplexscript.html b/api/classes/boldcomplexscript.html index 0db4929855..744413762d 100644 --- a/api/classes/boldcomplexscript.html +++ b/api/classes/boldcomplexscript.html @@ -117,7 +117,7 @@

    Returns BoldComplexScript

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/bookmark.html b/api/classes/bookmark.html index 513e84f7f5..961ba1d026 100644 --- a/api/classes/bookmark.html +++ b/api/classes/bookmark.html @@ -106,7 +106,7 @@
  • Parameters

    @@ -134,7 +134,7 @@
  • @@ -144,7 +144,7 @@
    linkId: number
    @@ -154,7 +154,7 @@
    @@ -164,7 +164,7 @@
    text: TextRun
    diff --git a/api/classes/bookmarkend.html b/api/classes/bookmarkend.html index cd24549731..f9cf6d0b04 100644 --- a/api/classes/bookmarkend.html +++ b/api/classes/bookmarkend.html @@ -123,7 +123,7 @@

    Parameters

    @@ -145,7 +145,7 @@
    linkId: number
    @@ -163,7 +163,7 @@

    Returns boolean

    @@ -184,7 +184,7 @@

    Parameters

    @@ -208,7 +208,7 @@

    Returns void

    @@ -227,7 +227,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/bookmarkendattributes.html b/api/classes/bookmarkendattributes.html index e3ac6dfec2..d95a7df686 100644 --- a/api/classes/bookmarkendattributes.html +++ b/api/classes/bookmarkendattributes.html @@ -117,7 +117,7 @@

    Inherited from XmlAttributeComponent.constructor

    Overrides BaseXmlComponent.constructor

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -166,7 +166,7 @@

    Inherited from XmlAttributeComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject

    @@ -184,7 +184,7 @@

    Parameters

    diff --git a/api/classes/bookmarkstart.html b/api/classes/bookmarkstart.html index 8becc23d86..8c090bc525 100644 --- a/api/classes/bookmarkstart.html +++ b/api/classes/bookmarkstart.html @@ -123,7 +123,7 @@

    Parameters

    @@ -148,7 +148,7 @@
    linkId: number
    @@ -166,7 +166,7 @@

    Returns boolean

    @@ -187,7 +187,7 @@

    Parameters

    @@ -211,7 +211,7 @@

    Returns void

    @@ -230,7 +230,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/bookmarkstartattributes.html b/api/classes/bookmarkstartattributes.html index 6d1d63ade5..6dd72bf02f 100644 --- a/api/classes/bookmarkstartattributes.html +++ b/api/classes/bookmarkstartattributes.html @@ -117,7 +117,7 @@

    Inherited from XmlAttributeComponent.constructor

    Overrides BaseXmlComponent.constructor

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -166,7 +166,7 @@

    Inherited from XmlAttributeComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject

    @@ -184,7 +184,7 @@

    Parameters

    diff --git a/api/classes/border.html b/api/classes/border.html index 5754cfeb93..f334da7424 100644 --- a/api/classes/border.html +++ b/api/classes/border.html @@ -93,14 +93,10 @@
  • IsDeleted
  • -
    +

    Methods

    @@ -114,16 +110,22 @@

    constructor

    @@ -142,7 +144,7 @@

    Returns boolean

    @@ -150,40 +152,8 @@
    -
    +

    Methods

    -
    - -

    addBottomBorder

    -
      -
    • addBottomBorder(color?: string, space?: string, value?: string, size?: string): XmlComponent
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value color: string = "auto"
        -
      • -
      • -
        Default value space: string = "1"
        -
      • -
      • -
        Default value value: string = "single"
        -
      • -
      • -
        Default value size: string = "6"
        -
      • -
      -

      Returns XmlComponent

      -
    • -
    -

    addChildElement

    @@ -195,7 +165,7 @@

    Parameters

    @@ -208,102 +178,6 @@
    -
    - -

    addLeftBorder

    -
      -
    • addLeftBorder(color?: string, space?: string, value?: string, size?: string): XmlComponent
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value color: string = "auto"
        -
      • -
      • -
        Default value space: string = "1"
        -
      • -
      • -
        Default value value: string = "single"
        -
      • -
      • -
        Default value size: string = "6"
        -
      • -
      -

      Returns XmlComponent

      -
    • -
    -
    -
    - -

    addRightBorder

    -
      -
    • addRightBorder(color?: string, space?: string, value?: string, size?: string): XmlComponent
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value color: string = "auto"
        -
      • -
      • -
        Default value space: string = "1"
        -
      • -
      • -
        Default value value: string = "single"
        -
      • -
      • -
        Default value size: string = "6"
        -
      • -
      -

      Returns XmlComponent

      -
    • -
    -
    -
    - -

    addTopBorder

    -
      -
    • addTopBorder(color?: string, space?: string, value?: string, size?: string): XmlComponent
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value color: string = "auto"
        -
      • -
      • -
        Default value space: string = "1"
        -
      • -
      • -
        Default value value: string = "single"
        -
      • -
      • -
        Default value size: string = "6"
        -
      • -
      -

      Returns XmlComponent

      -
    • -
    -

    delete

    @@ -315,7 +189,7 @@

    Returns void

    @@ -334,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -367,21 +241,9 @@
  • IsDeleted
  • -
  • - addBottomBorder -
  • addChildElement
  • -
  • - addLeftBorder -
  • -
  • - addRightBorder -
  • -
  • - addTopBorder -
  • delete
  • diff --git a/api/classes/borderattributes.html b/api/classes/borderattributes.html new file mode 100644 index 0000000000..483226d6ec --- /dev/null +++ b/api/classes/borderattributes.html @@ -0,0 +1,304 @@ + + + + + + BorderAttributes | docx + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
    • +
    • Public/Protected
    • +
    • All
    • +
    +
    + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    Class BorderAttributes

    +
    +
    +
    +
    +
    +
    +
    +

    Hierarchy

    + +
    +
    +

    Index

    +
    +
    +
    +

    Constructors

    + +
    +
    +

    Accessors

    + +
    +
    +

    Methods

    + +
    +
    +
    +
    +
    +

    Constructors

    +
    + +

    constructor

    + + +
    +
    +
    +

    Accessors

    +
    + +

    IsDeleted

    +
      +
    • get IsDeleted(): boolean
    • +
    + +
    +
    +
    +

    Methods

    +
    + +

    prepForXml

    + + +
    +
    + +

    set

    + + +
    +
    +
    + +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
    • +
    • Object literal
    • +
    • Variable
    • +
    • Function
    • +
    • Function with type parameter
    • +
    • Index signature
    • +
    • Type alias
    • +
    +
      +
    • Enumeration
    • +
    • Enumeration member
    • +
    • Property
    • +
    • Method
    • +
    +
      +
    • Interface
    • +
    • Interface with type parameter
    • +
    • Constructor
    • +
    • Property
    • +
    • Method
    • +
    • Index signature
    • +
    +
      +
    • Class
    • +
    • Class with type parameter
    • +
    • Constructor
    • +
    • Property
    • +
    • Method
    • +
    • Accessor
    • +
    • Index signature
    • +
    +
      +
    • Inherited constructor
    • +
    • Inherited property
    • +
    • Inherited method
    • +
    • Inherited accessor
    • +
    +
      +
    • Protected property
    • +
    • Protected method
    • +
    • Protected accessor
    • +
    +
      +
    • Private property
    • +
    • Private method
    • +
    • Private accessor
    • +
    +
      +
    • Static property
    • +
    • Static method
    • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/api/classes/bottomcellmargin.html b/api/classes/bottomcellmargin.html index 5b59b39681..e77e435e65 100644 --- a/api/classes/bottomcellmargin.html +++ b/api/classes/bottomcellmargin.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/break.html b/api/classes/break.html index 5249191ab1..fd3a62151c 100644 --- a/api/classes/break.html +++ b/api/classes/break.html @@ -117,7 +117,7 @@

    Returns Break

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/cantsplit.html b/api/classes/cantsplit.html index 005bed60f4..fa3b0644f6 100644 --- a/api/classes/cantsplit.html +++ b/api/classes/cantsplit.html @@ -117,7 +117,7 @@

    Returns CantSplit

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/caps.html b/api/classes/caps.html index 42fc5bda1f..e335e38dca 100644 --- a/api/classes/caps.html +++ b/api/classes/caps.html @@ -120,7 +120,7 @@

    Returns Caps

    @@ -142,7 +142,7 @@

    Inherited from BaseXmlComponent.IsDeleted

    Overrides BaseXmlComponent.IsDeleted

    Returns boolean

    @@ -164,7 +164,7 @@

    Inherited from XmlComponent.addChildElement

    Overrides XmlComponent.addChildElement

    Parameters

    @@ -189,7 +189,7 @@

    Inherited from XmlComponent.delete

    Overrides XmlComponent.delete

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/centertabstop.html b/api/classes/centertabstop.html index fbbbfb05ad..3fedfac18d 100644 --- a/api/classes/centertabstop.html +++ b/api/classes/centertabstop.html @@ -117,7 +117,7 @@

    Parameters

    @@ -147,7 +147,7 @@

    Returns boolean

    @@ -168,7 +168,7 @@

    Parameters

    @@ -192,7 +192,7 @@

    Returns void

    @@ -211,7 +211,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/characterspacing.html b/api/classes/characterspacing.html index 5387a2224d..a3fa99a9ce 100644 --- a/api/classes/characterspacing.html +++ b/api/classes/characterspacing.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/characterstyle.html b/api/classes/characterstyle.html index 615208c80b..6b64cad2fe 100644 --- a/api/classes/characterstyle.html +++ b/api/classes/characterstyle.html @@ -68,7 +68,7 @@

    Hierarchy

    @@ -137,7 +121,7 @@

    Returns ContinuationSeperatorRun

    @@ -158,7 +142,7 @@

    Returns boolean

    @@ -179,7 +163,7 @@

    Parameters

    @@ -192,42 +176,6 @@
    -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -239,37 +187,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -281,100 +205,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -386,7 +223,7 @@

    Returns Run

    @@ -404,7 +241,7 @@

    Returns Run

    @@ -423,7 +260,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -433,174 +270,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -612,40 +281,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -117,7 +113,7 @@
  • Parameters

    @@ -149,7 +145,7 @@
  • Returns Footer

    @@ -166,7 +162,7 @@
  • Returns Media

    @@ -183,7 +179,7 @@
  • Returns Relationships

    @@ -193,6 +189,29 @@

    Methods

    +
    + +

    add

    + + +

    addChildElement

    @@ -203,7 +222,7 @@
  • Parameters

    @@ -226,7 +245,7 @@
  • Parameters

    @@ -239,130 +258,6 @@
  • -
    - -

    addParagraph

    -
      -
    • addParagraph(paragraph: Paragraph): void
    • -
    - -
    -
    - -

    addTable

    -
      -
    • addTable(table: Table): void
    • -
    - -
    -
    - -

    createImage

    -
      -
    • createImage(image: Buffer | string | Uint8Array | ArrayBuffer, width?: undefined | number, height?: undefined | number): void
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        image: Buffer | string | Uint8Array | ArrayBuffer
        -
      • -
      • -
        Optional width: undefined | number
        -
      • -
      • -
        Optional height: undefined | number
        -
      • -
      -

      Returns void

      -
    • -
    -
    -
    - -

    createParagraph

    -
      -
    • createParagraph(text?: undefined | string): Paragraph
    • -
    - -
    -
    - -

    createTable

    -
      -
    • createTable(rows: number, cols: number): Table
    • -
    - -
  • Relationships
  • +
  • + add +
  • addChildElement
  • addImage
  • -
  • - addParagraph -
  • -
  • - addTable -
  • -
  • - createImage -
  • -
  • - createParagraph -
  • -
  • - createTable -
  • diff --git a/api/classes/footnote.html b/api/classes/footnote.html index 1048be1844..0cbcafc0fe 100644 --- a/api/classes/footnote.html +++ b/api/classes/footnote.html @@ -96,8 +96,8 @@

    Methods

    @@ -118,7 +118,7 @@

    Parameters

    @@ -148,7 +148,7 @@

    Returns boolean

    @@ -158,6 +158,29 @@

    Methods

    +
    + +

    add

    + + +

    addChildElement

    @@ -169,7 +192,7 @@

    Parameters

    @@ -182,29 +205,6 @@
    -
    - -

    addParagraph

    - - -

    delete

    @@ -216,7 +216,7 @@

    Returns void

    @@ -235,7 +235,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -268,12 +268,12 @@
  • IsDeleted
  • +
  • + add +
  • addChildElement
  • -
  • - addParagraph -
  • delete
  • diff --git a/api/classes/footnoteattributes.html b/api/classes/footnoteattributes.html index c03a21ed68..132c7c4825 100644 --- a/api/classes/footnoteattributes.html +++ b/api/classes/footnoteattributes.html @@ -117,7 +117,7 @@

    Inherited from XmlAttributeComponent.constructor

    Overrides BaseXmlComponent.constructor

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -166,7 +166,7 @@

    Inherited from XmlAttributeComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject

    @@ -184,7 +184,7 @@

    Parameters

    diff --git a/api/classes/footnoteref.html b/api/classes/footnoteref.html index 2d3f20a3b8..56cc755de8 100644 --- a/api/classes/footnoteref.html +++ b/api/classes/footnoteref.html @@ -117,7 +117,7 @@

    Returns FootnoteRef

    @@ -138,7 +138,7 @@

    Returns boolean

    @@ -159,7 +159,7 @@

    Parameters

    @@ -183,7 +183,7 @@

    Returns void

    @@ -202,7 +202,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/footnotereference.html b/api/classes/footnotereference.html index 6ba60ac504..152b6a5676 100644 --- a/api/classes/footnotereference.html +++ b/api/classes/footnotereference.html @@ -117,7 +117,7 @@

    Parameters

    @@ -144,7 +144,7 @@

    Returns boolean

    @@ -165,7 +165,7 @@

    Parameters

    @@ -189,7 +189,7 @@

    Returns void

    @@ -208,7 +208,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject diff --git a/api/classes/footnotereferencerun.html b/api/classes/footnotereferencerun.html index 0b332bce2c..4ef82b37bd 100644 --- a/api/classes/footnotereferencerun.html +++ b/api/classes/footnotereferencerun.html @@ -97,28 +97,12 @@

    Methods

    @@ -137,7 +121,7 @@

    Parameters

    @@ -164,7 +148,7 @@

    Returns boolean

    @@ -185,7 +169,7 @@

    Parameters

    @@ -198,42 +182,6 @@
    -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -245,37 +193,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -287,100 +211,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -392,7 +229,7 @@

    Returns Run

    @@ -410,7 +247,7 @@

    Returns Run

    @@ -429,7 +266,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -439,174 +276,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -618,40 +287,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -137,7 +121,7 @@

    Returns FootnoteRefRun

    @@ -158,7 +142,7 @@

    Returns boolean

    @@ -179,7 +163,7 @@

    Parameters

    @@ -192,42 +176,6 @@ -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -239,37 +187,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -281,100 +205,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -386,7 +223,7 @@

    Returns Run

    @@ -404,7 +241,7 @@

    Returns Run

    @@ -423,7 +260,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -433,174 +270,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -612,40 +281,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -117,7 +113,7 @@
  • Parameters

    @@ -149,7 +145,7 @@
  • Returns Header

    @@ -166,7 +162,7 @@
  • Returns Media

    @@ -183,7 +179,7 @@
  • Returns Relationships

    @@ -193,6 +189,29 @@

    Methods

    +
    + +

    add

    + + +

    addChildElement

    @@ -203,7 +222,7 @@
  • Parameters

    @@ -226,7 +245,7 @@
  • Parameters

    @@ -239,130 +258,6 @@
  • -
    - -

    addParagraph

    -
      -
    • addParagraph(paragraph: Paragraph): void
    • -
    - -
    -
    - -

    addTable

    -
      -
    • addTable(table: Table): void
    • -
    - -
    -
    - -

    createImage

    -
      -
    • createImage(image: Buffer | string | Uint8Array | ArrayBuffer, width?: undefined | number, height?: undefined | number): void
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        image: Buffer | string | Uint8Array | ArrayBuffer
        -
      • -
      • -
        Optional width: undefined | number
        -
      • -
      • -
        Optional height: undefined | number
        -
      • -
      -

      Returns void

      -
    • -
    -
    -
    - -

    createParagraph

    -
      -
    • createParagraph(text?: undefined | string): Paragraph
    • -
    - -
    -
    - -

    createTable

    -
      -
    • createTable(rows: number, cols: number): Table
    • -
    - -
  • Relationships
  • +
  • + add +
  • addChildElement
  • addImage
  • -
  • - addParagraph -
  • -
  • - addTable -
  • -
  • - createImage -
  • -
  • - createParagraph -
  • -
  • - createTable -
  • diff --git a/api/classes/heading1style.html b/api/classes/heading1style.html index 8eadaa891d..cb5ebfd71b 100644 --- a/api/classes/heading1style.html +++ b/api/classes/heading1style.html @@ -154,7 +154,7 @@

    Returns Heading1Style

    @@ -175,7 +175,7 @@

    Returns boolean

    @@ -196,7 +196,7 @@

    Parameters

    @@ -220,7 +220,7 @@

    Parameters

    @@ -244,7 +244,7 @@

    Parameters

    @@ -268,7 +268,7 @@

    Returns ParagraphStyle

    @@ -286,7 +286,7 @@

    Parameters

    @@ -310,7 +310,7 @@

    Returns ParagraphStyle

    @@ -328,7 +328,7 @@

    Returns ParagraphStyle

    @@ -346,7 +346,7 @@

    Parameters

    @@ -370,7 +370,7 @@

    Parameters

    @@ -394,7 +394,7 @@

    Returns void

    @@ -412,7 +412,7 @@

    Returns ParagraphStyle

    @@ -430,7 +430,7 @@

    Parameters

    @@ -454,7 +454,7 @@

    Parameters

    @@ -478,7 +478,7 @@

    Parameters

    @@ -502,7 +502,7 @@

    Returns ParagraphStyle

    @@ -520,7 +520,7 @@

    Returns ParagraphStyle

    @@ -538,7 +538,7 @@

    Returns ParagraphStyle

    @@ -556,7 +556,7 @@

    Returns ParagraphStyle

    @@ -574,7 +574,7 @@

    Returns ParagraphStyle

    @@ -592,7 +592,7 @@

    Parameters

    @@ -616,7 +616,7 @@

    Parameters

    @@ -640,7 +640,7 @@

    Returns ParagraphStyle

    @@ -658,7 +658,7 @@

    Parameters

    @@ -675,20 +675,20 @@

    outlineLevel

    - -
    - -

    pageBreakBefore

    - -
    -
    - -

    right

    - - -
    -
    - -

    rightTabStop

    - - -
    -
    - -

    scale

    - - -
    -
    - -

    setCustomNumbering

    - - -
    -
    - -

    setNumbering

    - - -
    -
    - -

    spacing

    - - -
    -
    - -

    start

    - - -
    -
    - -

    style

    - - -
    -
    - -

    thematicBreak

    - - -
    -
    - -

    title

    - - -
    @@ -158,20 +123,20 @@

    constructor

    -
    +

    Accessors

    -
    - -

    Borders

    - - -

    IsDeleted

    @@ -209,30 +157,13 @@

    Returns boolean

    -
    - -

    paragraphProperties

    - - -

    Methods

    @@ -246,7 +177,7 @@
  • Parameters

    @@ -270,7 +201,7 @@

    Parameters

    @@ -293,7 +224,7 @@
  • Parameters

    @@ -316,7 +247,7 @@
  • Parameters

    @@ -339,7 +270,7 @@
  • Parameters

    @@ -362,7 +293,7 @@
  • Parameters

    @@ -385,7 +316,7 @@
  • Parameters

    @@ -398,152 +329,6 @@
  • -
    - -

    bidirectional

    - - -
    -
    - -

    bullet

    - - -
    -
    - -

    center

    - - -
    -
    - -

    centerTabStop

    - - -
    -
    - -

    contextualSpacing

    - - -
    -
    - -

    createBorder

    - - -
    -
    - -

    createTextRun

    - - -

    delete

    @@ -555,312 +340,13 @@

    Returns void

    -
    - -

    distribute

    - - -
    -
    - -

    end

    - - -
    -
    - -

    heading1

    - - -
    -
    - -

    heading2

    - - -
    -
    - -

    heading3

    - - -
    -
    - -

    heading4

    - - -
    -
    - -

    heading5

    - - -
    -
    - -

    heading6

    - - -
    -
    - -

    indent

    - - -
    -
    - -

    justified

    - - -
    -
    - -

    keepLines

    - - -
    -
    - -

    keepNext

    - - -
    -
    - -

    left

    - - -
    -
    - -

    leftTabStop

    - - -
    -
    - -

    maxRightTabStop

    - - -
    -
    - -

    outlineLevel

    - - -

    pageBreak

    @@ -871,24 +357,7 @@
  • -

    Returns Paragraph

    -
  • - -
    -
    - -

    pageBreakBefore

    - -
    -
    - -

    right

    - - -
    -
    - -

    rightTabStop

    - - -
    -
    - -

    setCustomNumbering

    - - -
    -
    - -

    setNumbering

    - - -
    -
    - -

    spacing

    - - -
    -
    - -

    start

    - - -
    -
    - -

    style

    - - -
    -
    - -

    thematicBreak

    - - -
    -
    - -

    title

    - - -
    @@ -138,7 +121,7 @@

    Parameters

    @@ -168,7 +151,7 @@

    Returns boolean

    @@ -176,7 +159,7 @@ -
    +

    Methods

    @@ -189,7 +172,7 @@

    Parameters

    @@ -202,42 +185,6 @@
    -
    - -

    allCaps

    -
      -
    • allCaps(): Run
    • -
    - -
    -
    - -

    bold

    -
      -
    • bold(): Run
    • -
    - -

    break

    @@ -249,37 +196,13 @@

    Returns Run

    -
    - -

    color

    -
      -
    • color(color: string): Run
    • -
    - -

    delete

    @@ -291,100 +214,13 @@

    Returns void

    -
    - -

    doubleStrike

    -
      -
    • doubleStrike(): Run
    • -
    - -
    -
    - -

    font

    -
      -
    • font(fontName: string, hint?: string | undefined): Run
    • -
    - -
    -
    - -

    highlight

    -
      -
    • highlight(color: string): Run
    • -
    - -
    -
    - -

    italics

    -
      -
    • italics(): Run
    • -
    - -

    numberOfTotalPages

    @@ -396,7 +232,7 @@

    Returns Run

    @@ -414,7 +250,7 @@

    Returns Run

    @@ -433,7 +269,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -443,200 +279,6 @@

    -
    - -

    rightToLeft

    -
      -
    • rightToLeft(): Run
    • -
    - -
    -
    - -

    scale

    -
      -
    • scale(factorX?: number, factorY?: number): void
    • -
    -
      -
    • - -

      Parameters

      -
        -
      • -
        Default value factorX: number = 1
        -
      • -
      • -
        Default value factorY: number = factorX
        -
      • -
      -

      Returns void

      -
    • -
    -
    -
    - -

    shadow

    -
      -
    • shadow(value: string, fill: string, color: string): Run
    • -
    - -
    -
    - -

    size

    -
      -
    • size(size: number): Run
    • -
    - -
    -
    - -

    smallCaps

    -
      -
    • smallCaps(): Run
    • -
    - -
    -
    - -

    strike

    -
      -
    • strike(): Run
    • -
    - -
    -
    - -

    style

    -
      -
    • style(styleId: string): Run
    • -
    - -
    -
    - -

    subScript

    -
      -
    • subScript(): Run
    • -
    - -
    -
    - -

    superScript

    -
      -
    • superScript(): Run
    • -
    - -

    tab

    @@ -648,40 +290,13 @@

    Returns Run

    -
    - -

    underline

    -
      -
    • underline(underlineType?: undefined | string, color?: undefined | string): Run
    • -
    - -
    @@ -156,16 +140,22 @@

    constructor

    @@ -184,7 +174,7 @@

    Returns boolean

    @@ -205,7 +195,7 @@

    Parameters

    @@ -218,40 +208,6 @@ -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -262,36 +218,13 @@
  • Returns Run

  • -
    - -

    color

    - - -

    delete

    @@ -303,96 +236,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -403,7 +253,7 @@
  • Returns Run

    @@ -420,7 +270,7 @@
  • Returns Run

    @@ -439,7 +289,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -449,166 +299,6 @@

  • -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -619,39 +309,13 @@
  • Returns Run

  • -
    - -

    underline

    - - -
    @@ -137,7 +121,7 @@

    Returns SeperatorRun

    @@ -158,7 +142,7 @@

    Returns boolean

    @@ -179,7 +163,7 @@

    Parameters

    @@ -192,42 +176,6 @@ -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -239,37 +187,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -281,100 +205,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -386,7 +223,7 @@

    Returns Run

    @@ -404,7 +241,7 @@

    Returns Run

    @@ -423,7 +260,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -433,174 +270,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -612,40 +281,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -137,7 +121,7 @@

    Parameters

    @@ -164,7 +148,7 @@

    Returns boolean

    @@ -185,7 +169,7 @@

    Parameters

    @@ -198,42 +182,6 @@ -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -245,37 +193,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -287,100 +211,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -392,7 +229,7 @@

    Returns Run

    @@ -410,7 +247,7 @@

    Returns Run

    @@ -429,7 +266,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -439,174 +276,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -618,40 +287,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -71,7 +71,7 @@ XmlComponent @@ -84,21 +84,21 @@

    Constructors

    Accessors

    Methods

    @@ -110,14 +110,14 @@

    constructor

    -

    Returns Shadow

    +

    Returns Shading

    @@ -150,7 +150,7 @@

    Returns boolean

    @@ -171,7 +171,7 @@

    Parameters

    @@ -195,7 +195,7 @@

    Returns void

    @@ -214,7 +214,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -239,22 +239,22 @@ -
    - -

    setFixedWidthLayout

    - - -
    @@ -130,20 +114,20 @@

    constructor

    -
    - -

    allCaps

    - - -
    -
    - -

    bold

    - - -

    break

    @@ -245,37 +193,13 @@

    Returns Run

    -
    - -

    color

    - - -

    delete

    @@ -287,100 +211,13 @@

    Returns void

    -
    - -

    doubleStrike

    - - -
    -
    - -

    font

    - - -
    -
    - -

    highlight

    - - -
    -
    - -

    italics

    - - -

    numberOfTotalPages

    @@ -392,7 +229,7 @@

    Returns Run

    @@ -410,7 +247,7 @@

    Returns Run

    @@ -429,7 +266,7 @@

    Inherited from XmlComponent.prepForXml

    Overrides BaseXmlComponent.prepForXml

    Returns IXmlableObject @@ -439,174 +276,6 @@

    -
    - -

    rightToLeft

    - - -
    -
    - -

    shadow

    - - -
    -
    - -

    size

    - - -
    -
    - -

    smallCaps

    - - -
    -
    - -

    strike

    - - -
    -
    - -

    style

    - - -
    -
    - -

    subScript

    - - -
    -
    - -

    superScript

    - - -

    tab

    @@ -618,40 +287,13 @@

    Returns Run

    -
    - -

    underline

    - - -
    @@ -71,13 +71,14 @@

    Enumeration members

    @@ -91,7 +92,7 @@
    BOTH: = "both"
    @@ -101,7 +102,7 @@
    CENTER: = "center"
    @@ -111,7 +112,7 @@
    DISTRIBUTE: = "distribute"
    @@ -121,7 +122,17 @@
    END: = "end"
    + +
    + +

    JUSTIFIED

    +
    JUSTIFIED: = "both"
    +
    @@ -131,7 +142,7 @@
    LEFT: = "left"
    @@ -141,7 +152,7 @@
    RIGHT: = "right"
    @@ -151,7 +162,7 @@
    START: = "start"
    @@ -170,28 +181,31 @@