# Interface IParagraphOptions

#### Hierarchy

- IParagraphPropertiesOptions
  - IParagraphOptions

- Defined in file/paragraph/paragraph.ts:40

#####
Index

### Properties

alignment?
autoSpaceEastAsianText?
bidirectional?
border?
bullet?
children?
contextualSpacing?
frame?
heading?
indent?
keepLines?
keepNext?
leftTabStop?
numbering?
outlineLevel?
pageBreakBefore?
rightTabStop?
run?
scale?
shading?
spacing?
style?
suppressLineNumbers?
tabStops?
text?
thematicBreak?
widowControl?
wordWrap?

## Properties

### `Optional` `Readonly` alignment

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

Inherited from IParagraphPropertiesOptions.alignment

- Defined in file/paragraph/properties.ts:21

### `Optional` `Readonly` autoSpaceEastAsianText

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.

Inherited from IParagraphPropertiesOptions.autoSpaceEastAsianText

- Defined in file/paragraph/properties.ts:68

### `Optional` `Readonly` bidirectional

bidirectional?: boolean

Inherited from IParagraphPropertiesOptions.bidirectional

- Defined in file/paragraph/properties.ts:51

### `Optional` `Readonly` border

border?: IBordersOptions

Inherited from IParagraphPropertiesOptions.border

- Defined in file/paragraph/properties.ts:49

### `Optional` `Readonly` bullet

bullet?: {
level: number;
}

#### Type declaration

- ##### `Readonly` level: number

Inherited from IParagraphPropertiesOptions.bullet

- Defined in file/paragraph/properties.ts:55

### `Optional` `Readonly` children

children?: readonly ParagraphChild []

- Defined in file/paragraph/paragraph.ts:42

### `Optional` `Readonly` contextualSpacing

contextualSpacing?: boolean

Inherited from IParagraphPropertiesOptions.contextualSpacing

- Defined in file/paragraph/properties.ts:23

### `Optional` `Readonly` frame

frame?: IFrameOptions

Inherited from IParagraphPropertiesOptions.frame

- Defined in file/paragraph/properties.ts:60

### `Optional` `Readonly` heading

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

Inherited from IParagraphPropertiesOptions.heading

- Defined in file/paragraph/properties.ts:50

### `Optional` `Readonly` indent

indent?: IIndentAttributesProperties

Inherited from IParagraphPropertiesOptions.indent

- Defined in file/paragraph/properties.ts:26

### `Optional` `Readonly` keepLines

keepLines?: boolean

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

Inherited from IParagraphPropertiesOptions.keepLines

- Defined in file/paragraph/properties.ts:35

### `Optional` `Readonly` keepNext

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.

Inherited from IParagraphPropertiesOptions.keepNext

- Defined in file/paragraph/properties.ts:31

### `Optional` `Readonly` leftTabStop

leftTabStop?: number

Inherited from IParagraphPropertiesOptions.leftTabStop

- Defined in file/paragraph/properties.ts:25

### `Optional` `Readonly` numbering

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

#### Type declaration

- ##### `Optional` `Readonly` custom?: boolean

- ##### `Optional` `Readonly` instance?: number

- ##### `Readonly` level: number

- ##### `Readonly` reference: string

Inherited from IParagraphPropertiesOptions.numbering

- Defined in file/paragraph/properties.ts:40

### `Optional` `Readonly` outlineLevel

outlineLevel?: number

Inherited from IParagraphPropertiesOptions.outlineLevel

- Defined in file/paragraph/properties.ts:36

### `Optional` `Readonly` pageBreakBefore

pageBreakBefore?: boolean

Inherited from IParagraphPropertiesOptions.pageBreakBefore

- Defined in file/paragraph/properties.ts:52

### `Optional` `Readonly` rightTabStop

rightTabStop?: number

Inherited from IParagraphPropertiesOptions.rightTabStop

- Defined in file/paragraph/properties.ts:24

### `Optional` `Readonly` run

run?: IRunOptions

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

Inherited from IParagraphPropertiesOptions.run

- Defined in file/paragraph/properties.ts:72

### `Optional` `Readonly` scale

scale?: number

Inherited from IParagraphPropertiesOptions.scale

- Defined in file/paragraph/properties.ts:63

### `Optional` `Readonly` shading

shading?: IShadingAttributesProperties

Inherited from IParagraphPropertiesOptions.shading

- Defined in file/paragraph/properties.ts:58

### `Optional` `Readonly` spacing

spacing?: ISpacingProperties

Inherited from IParagraphPropertiesOptions.spacing

- Defined in file/paragraph/properties.ts:27

### `Optional` `Readonly` style

style?: string

Inherited from IParagraphPropertiesOptions.style

- Defined in file/paragraph/properties.ts:54

### `Optional` `Readonly` suppressLineNumbers

suppressLineNumbers?: boolean

Inherited from IParagraphPropertiesOptions.suppressLineNumbers

- Defined in file/paragraph/properties.ts:61

### `Optional` `Readonly` tabStops

tabStops?: readonly TabStopDefinition []

Inherited from IParagraphPropertiesOptions.tabStops

- Defined in file/paragraph/properties.ts:53

### `Optional` `Readonly` text

text?: string

- Defined in file/paragraph/paragraph.ts:41

### `Optional` `Readonly` thematicBreak

thematicBreak?: boolean

Inherited from IParagraphPropertiesOptions.thematicBreak

- Defined in file/paragraph/properties.ts:22

### `Optional` `Readonly` widowControl

widowControl?: boolean

Inherited from IParagraphPropertiesOptions.widowControl

- Defined in file/paragraph/properties.ts:59

### `Optional` `Readonly` wordWrap

wordWrap?: boolean

Inherited from IParagraphPropertiesOptions.wordWrap

- Defined in file/paragraph/properties.ts:62

Generated using TypeDoc