ITextRange::SetRange method (tom.h)

Article
02/22/2024

Adjusts the range endpoints to the specified values.

Syntax

HRESULT SetRange(
  long cpAnchor,
  long cpActive
);

Parameters

cpAnchor

Type: long

The character position for the anchor end of the range.

cpActive

Type: long

The character position for the active end of the range.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method sets the range's start position to min(cpActive, cpAnchor), and the end position to max(cpActive, cpAnchor). If the range is a nondegenerate selection, cpAnchor is the active end, and cpAnchor is the anchor end. If the range is a degenerate selection, the selection is displayed at the start of the line, rather than at the end of the previous line.

This method removes any other subranges this range may have. To preserve the current subranges, use ITextRange2::SetActiveSubrange.

If the text range is a selection, you can set the attributes of the selection by using the ITextSelection::SetFlags method.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll