ITextRange.MoveStart(TextRangeUnit, Int32) Method

Reference

Definition

Namespace:: Windows.UI.Text

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Moves the start position of a text range.

public:
 int MoveStart(TextRangeUnit unit, int count);

int MoveStart(TextRangeUnit const& unit, int const& count);

public int MoveStart(TextRangeUnit unit, int count);

function moveStart(unit, count)

Public Function MoveStart (unit As TextRangeUnit, count As Integer) As Integer

Parameters

unit: TextRangeUnit

The unit by which to move the start position of the text range. The default value is Character.

count: Int32
int

The number of units to move the start position of the text range. The default value is 1. If count is greater than zero, the start position of the text range moves forward, toward the end of the story. If count is less than zero, the start position of the text range moves backward, toward the beginning of the story. If count is zero, the start position doesn't move.

Returns

Int32

int

The actual number of units that the start position moved. The pointer can be NULL.

Remarks

If you move the start position of the text range so that it follows the original end position, this method sets the end position to be equal to the new start position; that is, the text range becomes a degenerate range (insertion point).

This method moves the start position in a logical direction rather than a physical direction. That is, movement is toward the end or start of a story. Depending on the language, moving the start position toward the end of the story could result in the start position moving either left or right.

For more information, see the discussion in ITextRange and the Remarks section of ITextRange.Move.

Applies to