expand Method

Expands the range so that partial units are completely contained.

Syntax

bSuccess = TextRange.expand(sUnit)

Parameters

sUnit Required. String that specifies the units to move in the range, using one one of the following values:

character Expands a character.

word Expands a word. A word is a collection of characters terminated by a space or another white-space character, such as a tab.

sentence Expands a sentence. A sentence is a collection of words terminated by an ending punctuation character, such as a period.

textedit Expands to enclose the entire range.

Return Value

Boolean. Returns true if it successfully expands the range, or false otherwise.

Remarks

This feature might not be available on non-Win32® platforms. For the latest information about Internet Explorer cross-platform compatibility, see article Q172976 in the Microsoft Knowledge Base.

Example

This example creates a range from the current selection and uses the expand method to ensure that any word partially enclosed in the range becomes entirely enclosed in the range.
var rng = document.selection.createRange();
rng.expand("word");

Applies To

[ Object Name ]

Platform Version

Win16:

Win32:

Mac:

Unix:

WinCE:

Version data is listed when the mouse hovers over a link, or the link has focus.

TextRange