Share via


collapse method

Collapses (or removes) a range by moving the insertion point to the beginning or end of the current range.

 

Syntax

HRESULT retVal = object.collapse(toStart);

Parameters

toStart [in]

Type: VARIANT_BOOL

Specifies one of the following values:

true

Default. Moves the insertion point to the beginning of the range.

false

Moves the insertion point to the end of the range.

Return value

Type: HRESULT

This method can return one of these values.

Return code Description
S_OK

The operation completed successfully.

InvalidStateError

IHTMLDOMRange::detach has been invoked on the object.

 

Standards information

See also

IHTMLDOMRange::collapsed