ApiParagraph

Class representing a paragraph.

ApiParagraph is a subclass of ApiParaPr.

Methods

The following table lists the available methods.

Method	Returns	Description
AddBookmarkCrossRef	boolean	Adds a bookmark cross-reference to the current paragraph.
AddCaption	boolean	Adds a caption paragraph after (or before) the current paragraph.
AddCaptionCrossRef	boolean	Adds a caption cross-reference to the current paragraph.
AddColumnBreak	ApiRun	Adds a column break to the current position and starts the next element from a new column.
AddComment	ApiComment	Adds a comment to the current paragraph.
AddDrawing	ApiRun	Adds a drawing object (image, shape or chart) to the current paragraph.
AddElement	boolean	Adds an element to the current paragraph.
AddEndnoteCrossRef	boolean	Adds an endnote cross-reference to the current paragraph.
AddFootnoteCrossRef	boolean	Adds a footnote cross-reference to the current paragraph.
AddHeadingCrossRef	boolean	Adds a heading cross-reference to the current paragraph.
AddHyperlink	ApiHyperlink	Adds a hyperlink to a paragraph.
AddInlineLvlSdt	ApiInlineLvlSdt	Adds an inline container.
AddLineBreak	ApiRun	Adds a line break to the current position and starts the next element from a new line.
AddNumberedCrossRef	boolean	Adds a numbered cross-reference to the current paragraph.
AddPageBreak	ApiRun	Adds a page break and starts the next element from the next page.
AddPageBreakBefore	ApiParagraph	Forces a page break before the paragraph.
AddPageNumber	ApiRun	Inserts a number of the current document page into the paragraph.
AddPagesCount	ApiRun	Inserts a number of pages in the current document into the paragraph.
AddTabStop	ApiRun	Adds a tab stop to the current paragraph.
AddText	ApiRun	Adds some text to the current paragraph.
Copy	ApiParagraph	Creates a paragraph copy.
Delete	boolean	Deletes the current paragraph.
GetAllCharts	ApiChart[]	Returns a collection of chart objects in the paragraph.
GetAllContentControls	ApiInlineLvlSdt[]	Returns a collection of content control objects in the paragraph.
GetAllDrawingObjects	Drawing[]	Returns a collection of drawing objects in the paragraph.
GetAllImages	ApiImage[]	Returns a collection of image objects in the paragraph.
GetAllOleObjects	ApiOleObject[]	Returns a collection of OLE objects in the paragraph.
GetAllShapes	ApiShape[]	Returns a collection of shape objects in the paragraph.
GetBetweenBorder	Border | undefined	Returns the between border of the current paragraph.
GetBottomBorder	Border | undefined	Returns the bottom border of the current paragraph.
GetClassType	"paragraph"	Returns a type of the ApiParagraph class.
GetContextualSpacing	boolean | undefined	Returns the contextual spacing value of the current paragraph.
GetElement	ParagraphContent	Returns a paragraph element using the position specified.
GetElementsCount	number	Returns a number of elements in the current paragraph.
GetFontNames	string[]	Returns all font names from all elements inside the current paragraph.
GetIndFirstLine	twips | undefined	Returns the paragraph first line indentation.
GetIndLeft	twips | undefined	Returns the paragraph left side indentation.
GetIndRight	twips | undefined	Returns the paragraph right side indentation.
GetInternalId	string	Returns an internal ID of the current content paragraph.
GetJc	"left" | "right" | "both" | "center" | undefined	Returns the paragraph contents justification.
GetKeepLines	boolean | undefined	Returns the keep lines value of the current paragraph.
GetKeepNext	boolean | undefined	Returns the keep next value of the current paragraph.
GetLastRunWithText	ApiRun	Returns the last Run with text in the current paragraph.
GetLeftBorder	Border | undefined	Returns the left border of the current paragraph.
GetNext	ApiParagraph | null	Returns the next paragraph.
GetNumPr	ApiNumberingLevel | undefined	Returns the numbering level for the current paragraph referencing the numbering definition instance in the current document.
GetNumbering	ApiNumberingLevel	Returns the numbering definition and numbering level for the numbered list.
GetOutlineLvl	Number | undefined	Returns the outline level of the specified properties.
GetPageBreakBefore	boolean | undefined	Returns the page break before value of the current paragraph.
GetParaId	number	Returns a unique ID for the current paragraph.
GetParaPr	ApiParaPr	Returns the paragraph properties.
GetParagraphMarkTextPr	ApiTextPr	Returns the text properties of the paragraph mark which is used to mark the paragraph end.
GetParentContentControl	ApiBlockLvlSdt | null	Returns a content control that contains the current paragraph.
GetParentTable	ApiTable | null	Returns a table that contains the current paragraph.
GetParentTableCell	ApiTableCell | null	Returns a table cell that contains the current paragraph.
GetPosInParent	Number	Returns the paragraph position within its parent element.
GetPrevious	ApiParagraph	Returns the previous paragraph.
GetRange	ApiRange | null	Returns a Range object that represents the part of the document contained in the specified paragraph.
GetRightBorder	Border | undefined	Returns the right border of the current paragraph.
GetSection	ApiSection	Returns the paragraph section.
GetShd	Shd | undefined	Returns the shading applied to the contents of the paragraph.
GetSpacingAfter	twips	Returns the spacing after value of the current paragraph.
GetSpacingBefore	twips	Returns the spacing before value of the current paragraph.
GetSpacingLineRule	"auto" | "atLeast" | "exact" | undefined	Returns the paragraph line spacing rule.
GetSpacingLineValue	twips | line240 | undefined	Returns the paragraph line spacing value.
GetStyle	ApiStyle	Returns the paragraph style method.
GetTabs	TabStop[]	Returns the custom tab stops of the current paragraph.
GetText	string	Returns the paragraph text.
GetTextPr	ApiTextPr	Returns the text properties for a paragraph end mark.
GetTopBorder	Border | undefined	Returns the top border of the current paragraph.
GetWidowControl	boolean | undefined	Returns the widow control value of the current paragraph.
InsertInContentControl	ApiParagraph | ApiBlockLvlSdt	Wraps the paragraph object with a rich text content control.
InsertParagraph	ApiParagraph | null	Inserts a paragraph at the specified position.
Last	ParagraphContent	Returns the last element of the paragraph.
MoveCursorToEnd	boolean	Moves the cursor to the end of the paragraph.
MoveCursorToStart	boolean	Moves the cursor to the start of the paragraph.
Push	boolean	Adds an element to the current paragraph.
RemoveAllElements	boolean	Removes all the elements from the current paragraph.
RemoveElement	boolean	Removes an element using the position specified.
ReplaceByElement	boolean	Replaces the current paragraph with a new element.
Search	ApiRange[]	Searches for a scope of a paragraph object.
Select	boolean	Selects the current paragraph.
SetBetweenBorder	boolean	Specifies the border which will be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings.
SetBold	ApiParagraph	Sets the bold property to the text character.
SetBottomBorder	boolean	Specifies the border which will be displayed below a set of paragraphs which have the same paragraph border settings.
SetCaps	ApiParagraph	Specifies that any lowercase characters in this paragraph are formatted for display only as their capital letter character equivalents.
SetColor	ApiParagraph	Sets the text color to the current paragraph.
SetContextualSpacing	boolean	Specifies that any space before or after this paragraph set using the ApiParaPr#SetSpacingBefore or ApiParaPr#SetSpacingAfter spacing element, should not be applied when the preceding and following paragraphs are of the same paragraph style, affecting the top and bottom spacing respectively.
SetDoubleStrikeout	ApiParagraph	Specifies that the contents of this paragraph are displayed with two horizontal lines through each character displayed on the line.
SetFontFamily	ApiParagraph	Sets all 4 font slots with the specified font family.
SetFontSize	ApiParagraph	Sets the font size to the characters of the current paragraph.
SetHighlight	ApiParagraph	Specifies a highlighting color which is applied as a background to the contents of the current paragraph.
SetIndFirstLine	boolean	Sets the paragraph first line indentation.
SetIndLeft	boolean	Sets the paragraph left side indentation.
SetIndRight	boolean	Sets the paragraph right side indentation.
SetItalic	ApiParagraph	Sets the italic property to the text character.
SetJc	boolean	Sets the paragraph contents justification.
SetKeepLines	boolean	Specifies that when rendering the document using a page view, all lines of the current paragraph are maintained on a single page whenever possible.
SetKeepNext	boolean	Specifies that when rendering the document using a paginated view, the contents of the current paragraph are at least partly rendered on the same page as the following paragraph whenever possible.
SetLeftBorder	boolean	Specifies the border which will be displayed at the left side of the page around the specified paragraph.
SetNumPr	boolean	Specifies that the current paragraph references a numbering definition instance in the current document.
SetNumbering	boolean	Specifies that the current paragraph references the numbering definition instance in the current document.
SetOutlineLvl	boolean	Sets the outline level for the specified properties.
SetPageBreakBefore	boolean	Specifies that when rendering the document using a paginated view, the contents of the current paragraph are rendered at the beginning of a new page in the document.
SetParaId	boolean	Specifies a unique ID for the current paragraph.
SetPosition	ApiParagraph	Specifies an amount by which text is raised or lowered for this paragraph in relation to the default baseline of the surrounding non-positioned text.
SetReadingOrder	ApiParagraph	Specifies the reading order for the current paragraph.
SetRightBorder	boolean	Specifies the border which will be displayed at the right side of the page around the specified paragraph.
SetSection	boolean	Sets the specified section to the current paragraph.
SetShd	boolean	Specifies the shading applied to the contents of the paragraph.
SetSmallCaps	ApiParagraph	Specifies that all the small letter characters in this paragraph are formatted for display only as their capital letter character equivalents which are two points smaller than the actual font size specified for this text.
SetSpacing	ApiParagraph	Sets the text spacing measured in twentieths of a point.
SetSpacingAfter	boolean	Sets the spacing after the current paragraph.
SetSpacingBefore	boolean	Sets the spacing before the current paragraph.
SetSpacingLine	boolean	Sets the paragraph line spacing.
SetStrikeout	ApiParagraph	Specifies that the contents of this paragraph are displayed with a single horizontal line through the center of the line.
SetStyle	boolean	The paragraph style base method.
SetTabs	boolean	Specifies a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
SetText	ApiRun	Replaces the paragraph content with the specified text.
SetTextPr	boolean	Sets the paragraph text properties.
SetTopBorder	boolean	Specifies the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings.
SetUnderline	ApiParagraph	Specifies that the contents of this paragraph are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
SetVertAlign	ApiParagraph | null	Specifies the alignment which will be applied to the contents of this paragraph in relation to the default appearance of the paragraph text:
SetWidowControl	boolean	Specifies whether a single line of the current paragraph will be displayed on a separate page from the remaining content at display time by moving the line onto the following page.
ToHtml	string	Converts the paragraph to HTML.
ToJSON	JSON	Converts the ApiParagraph object into the JSON object.
WrapInMailMergeField	boolean	Wraps the paragraph content in a mail merge field.