Share via

ITextRangeProvider::MoveEndpointByUnit Method

  • Article

Moves one endpoint of the text range the specified number of TextUnits within the document range.

Syntax

HRESULT MoveEndpointByUnit(      
    TextPatternRangeEndpoint endpoint,
    TextUnit unit,
    int count,
    int *pRetVal
);

Parameters

  • endpoint
    [in] A value from the TextPatternRangeEndpointEnum enumerated type that specifies the endpoint to move.
  • unit
    [in] A member of the TextUnit enumerated type that specifies the unit boundary.
  • count
    [in]  The number of units to move. A positive value moves the endpoint forward. A negative value moves backward. A value of 0 has no effect.
  • pRetVal
    [out, retval] The address of a variable that receives the number of units actually moved, which can be less than the number requested if moving the endpoint runs into the beginning or end of the document.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

The endpoint is moved forward or backward, as specified, to the next available unit boundary. If the original endpoint was at the boundary of the specified text unit, the endpoint is moved to the next available text unit boundary.

Moving the endpoints of a text range

If the endpoint being moved crosses the other endpoint of the same text range, the other endpoint is also moved, resulting in a degenerate range and ensuring the correct ordering of the endpoint (that is, that the start is always less than or equal to the end).

ITextRangeProvider::MoveEndpointByUnit deprecates up to the next supported text unit if the given text unit is not supported by the control.

The order, from smallest unit to largest, is listed here.

  • Character
  • Format
  • Word
  • Line
  • Paragraph
  • Page
  • Document

See Also

UI Automation Providers Overview, ITextProvider