Paragraph Class
Defines a paragraph in the document.
#Declaration
export class Paragraph
#Properties
#index Property
Gets the paragraph’s index in the paragraphs collection.
#Declaration
get index(): number
#Property Value
Type | Description |
---|---|
number | The paragraph’s index. |
#interval Property
Gets the text buffer interval occupied by the current paragraph element.
#Declaration
get interval(): Interval
#Property Value
Type | Description |
---|---|
Interval | An object that specifies the interval settings. |
#list Property
Returns a list to which the paragraph belongs.
#Declaration
get list(): List | null
#Property Value
Type | Description |
---|---|
List | The list object. |
#listLevel Property
Returns a list level to which the paragraph belongs.
#Declaration
get listLevel(): number
#Property Value
Type | Description |
---|---|
number | The level (maximum 9), or |
#properties Property
Provide access to the paragraph’s properties.
#Declaration
get properties(): IParagraphProperties
set properties(properties: IParagraphProperties)
#Property Value
Type | Description |
---|---|
IParagraph |
A Paragraph |
#Methods
#addToList(list) Method
Adds the paragraph to a list at the specified level.
#Declaration
addToList(
list: List,
targetListLevel?: number
): void
#Parameters
Name | Type | Description |
---|---|---|
list | List | The list where the paragraph should be added. |
target |
number | The list level. |