MoveWhile Method

Applies To

Range object, Selection object.

Description

Moves the specified range or selection while any of the specified characters are found in the document.

Remarks

While any character in Cset is found, the specified range or selection is moved. The resulting Range or Selection object is positioned as an insertion point after whatever Cset characters were found. This method returns the number of characters by which the specified range or selection was moved, as a Long value. If no Cset characters are found, the range or selection isn't changed and the method returns 0 (zero).

Syntax

expression.MoveWhile(Cset, Count)

expression Required. An expression that returns a Range or Selection object.

Cset Required Variant. One or more characters. This argument is case sensitive.

Count Optional Variant. The maximum number of characters by which the specified range or selection is to be moved. Can be a number or either the wdForward or wdBackward constant. If Count is a positive number, the specified range or selection is moved forward in the document, beginning at the end position. If it's a negative number, the range or selection is moved backward, beginning at the start position. The default value is wdForward.

See Also

Move method, MoveEndWhile method, MoveStartWhile method, MoveUntil method.

Example

This example moves the selection after consecutive tabs.

Selection.MoveWhile Cset:=vbTab, Count:=wdForward

This example moves aRange while any of the following (uppercase or lowercase) letters are found: "a", "t", or "i".

Set aRange = ActiveDocument.Characters(1)
aRange.MoveWhile Cset:="atiATI", Count:=wdForward