# Interface IParagraphOptions

#### Hierarchy

- IParagraphPropertiesOptions
  - IParagraphOptions

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

#####
Index

### Properties

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

## Properties

### `Optional` `Readonly` alignment

alignment?: AlignmentType

Inherited from IParagraphPropertiesOptions.alignment

- Defined in src/file/paragraph/properties.ts:19

### `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 src/file/paragraph/properties.ts:66

### `Optional` `Readonly` bidirectional

bidirectional?: boolean

Inherited from IParagraphPropertiesOptions.bidirectional

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

### `Optional` `Readonly` border

border?: IBordersOptions

Inherited from IParagraphPropertiesOptions.border

- Defined in src/file/paragraph/properties.ts:47

### `Optional` `Readonly` bullet

bullet?: {
level: number;
}

#### Type declaration

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

Inherited from IParagraphPropertiesOptions.bullet

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

### `Optional` `Readonly` children

children?: readonly ParagraphChild[]

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

### `Optional` `Readonly` contextualSpacing

contextualSpacing?: boolean

Inherited from IParagraphPropertiesOptions.contextualSpacing

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

### `Optional` `Readonly` frame

frame?: IFrameOptions

Inherited from IParagraphPropertiesOptions.frame

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

### `Optional` `Readonly` heading

heading?: HeadingLevel

Inherited from IParagraphPropertiesOptions.heading

- Defined in src/file/paragraph/properties.ts:48

### `Optional` `Readonly` indent

indent?: IIndentAttributesProperties

Inherited from IParagraphPropertiesOptions.indent

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

### `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 src/file/paragraph/properties.ts:33

### `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 src/file/paragraph/properties.ts:29

### `Optional` `Readonly` leftTabStop

leftTabStop?: number

Inherited from IParagraphPropertiesOptions.leftTabStop

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

### `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 src/file/paragraph/properties.ts:38

### `Optional` `Readonly` outlineLevel

outlineLevel?: number

Inherited from IParagraphPropertiesOptions.outlineLevel

- Defined in src/file/paragraph/properties.ts:34

### `Optional` `Readonly` pageBreakBefore

pageBreakBefore?: boolean

Inherited from IParagraphPropertiesOptions.pageBreakBefore

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

### `Optional` `Readonly` rightTabStop

rightTabStop?: number

Inherited from IParagraphPropertiesOptions.rightTabStop

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

### `Optional` `Readonly` scale

scale?: number

Inherited from IParagraphPropertiesOptions.scale

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

### `Optional` `Readonly` shading

shading?: IShadingAttributesProperties

Inherited from IParagraphPropertiesOptions.shading

- Defined in src/file/paragraph/properties.ts:56

### `Optional` `Readonly` spacing

spacing?: ISpacingProperties

Inherited from IParagraphPropertiesOptions.spacing

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

### `Optional` `Readonly` style

style?: string

Inherited from IParagraphPropertiesOptions.style

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

### `Optional` `Readonly` suppressLineNumbers

suppressLineNumbers?: boolean

Inherited from IParagraphPropertiesOptions.suppressLineNumbers

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

### `Optional` `Readonly` tabStops

tabStops?: readonly TabStopDefinition[]

Inherited from IParagraphPropertiesOptions.tabStops

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

### `Optional` `Readonly` text

text?: string

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

### `Optional` `Readonly` thematicBreak

thematicBreak?: boolean

Inherited from IParagraphPropertiesOptions.thematicBreak

- Defined in src/file/paragraph/properties.ts:20

### `Optional` `Readonly` widowControl

widowControl?: boolean

Inherited from IParagraphPropertiesOptions.widowControl

- Defined in src/file/paragraph/properties.ts:57

### `Optional` `Readonly` wordWrap

wordWrap?: boolean

Inherited from IParagraphPropertiesOptions.wordWrap

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

Generated using TypeDoc