ApiRange

Represents the ApiRange class.

Methods

Method	Returns	Description
AddBookmark	boolean	Adds a bookmark to the specified range.
AddComment	ApiComment	Adds a comment to the current range.
AddField	boolean	Adds a field to the specified range by the field instruction code.
AddHyperlink	ApiHyperlink	Adds a hyperlink to the specified range.
AddText	boolean	Adds a text to the specified position.
Delete	boolean	Deletes all the contents from the current range.
ExpandTo	ApiRange | null	Returns a new range that goes beyond the specified range in any direction and spans a different range. The current range has not changed.
GetAllParagraphs	ApiParagraph[]	Returns a collection of paragraphs that represents all the paragraphs in the specified range.
GetClassType	"range"	Returns a type of the ApiRange class.
GetEndPage	Number	Returns the end page number of the current range.
GetEndPos	number	Returns the end position of the current range.
GetParagraph	ApiParagraph | null	Returns a paragraph from all the paragraphs that are in the range.
GetRange	ApiRange	Returns a Range object that represents the document part contained in the specified range.
GetStartPage	Number	Returns the start page number of the current range.
GetStartPos	number	Returns the start position of the current range.
GetText	string	Returns a text from the specified range.
GetTextPr	ApiTextPr	Returns the merged text properties of the entire range.
IntersectWith	ApiRange | null	Returns a new range as the intersection of the current range with another range. The current range has not changed.
MoveCursorToPos	boolean	Moves a cursor to a specified position of the current range object.
Select	boolean	Sets the selection to the specified range.
SetBold	ApiRange | null	Sets the bold property to the text character.
SetCaps	ApiRange | null	Specifies that any lowercase characters in the current text Range are formatted for display only as their capital letter character equivalents.
SetColor	ApiRange | null	Sets the text color to the current text Range.
SetDoubleStrikeout	ApiRange | null	Specifies that the contents of the current Range are displayed with two horizontal lines through each character displayed on the line.
SetEndPos	boolean	Sets the end position of the current range object.
SetFontFamily	ApiRange | null	Sets all 4 font slots with the specified font family.
SetFontSize	ApiRange | null	Sets the font size to the characters of the current text Range.
SetHighlight	ApiRange | null	Specifies a highlighting color which is applied as a background to the contents of the current Range.
SetItalic	ApiRange | null	Sets the italic property to the text character.
SetPosition	ApiRange | null	Specifies the amount by which text is raised or lowered for the current Range in relation to the default
SetShd	ApiRange | null	Specifies the shading applied to the contents of the current text Range.
SetSmallCaps	ApiRange | null	Specifies that all the lowercase letter characters in the current text Range are formatted for display only as their capital
SetSpacing	ApiRange | null	Sets the text spacing measured in twentieths of a point.
SetStartPos	boolean	Sets the start position of the current range object.
SetStrikeout	ApiRange | null	Specifies that the contents of the current Range are displayed with a single horizontal line through the range center.
SetStyle	ApiRange | null	Sets the style to the current Range.
SetTextPr	ApiRange | null	Sets the text properties to the current Range.
SetUnderline	ApiRange | null	Specifies that the contents of the current Range are displayed along with a line appearing directly below the character
SetVertAlign	ApiRange | null	Specifies the alignment which will be applied to the Range contents in relation to the default appearance of the Range text:
ToHtml	string	Converts the range to HTML.
ToJSON	JSON	Converts the ApiRange object into the JSON object.