58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
# Document
|
|
|
|
> The `Document` object is the starting point of your `.docx` journey, this is the literal Word Document. You add all your content such as `Paragraphs` to this `Document`, and at the end export it however you like.
|
|
|
|
To create a new document, it is very easy:
|
|
|
|
```ts
|
|
const doc = new docx.Document();
|
|
```
|
|
|
|
## Document properties
|
|
|
|
You can add properties to the Word document by specifying options, for example:
|
|
|
|
```ts
|
|
const doc = new docx.Document({
|
|
creator: "Dolan Miu",
|
|
description: "My extremely interesting document",
|
|
title: "My Document",
|
|
});
|
|
```
|
|
|
|
### Full list of options:
|
|
|
|
|
|
* creator
|
|
* description
|
|
* title
|
|
* subject
|
|
* keywords
|
|
* lastModifiedBy
|
|
* revision
|
|
* externalStyles
|
|
* styles
|
|
* numbering
|
|
* footnotes
|
|
* hyperlinks
|
|
* background
|
|
|
|
### Change background color of Document
|
|
|
|
Set the hex value in the document like so:
|
|
|
|
```ts
|
|
const doc = new docx.Document({
|
|
background: {
|
|
color: "C45911",
|
|
},
|
|
});
|
|
```
|
|
|
|
You can mix and match whatever properties you want, or provide no properties.
|
|
|
|
### Units for positioning
|
|
|
|
Various parts of the API require positioning arguments. The units are "20ths of a point" from the [OOXML](http://officeopenxml.com/index.php) specification.
|
|
See [Lars Corneliussen's blog post](https://startbigthinksmall.wordpress.com/2010/01/04/points-inches-and-emus-measuring-units-in-office-open-xml/) for more information and how to convert units.
|