MoveUntil Method

Applies To

Range object, Selection object.

Description

Moves the specified range or selection until one of the specified characters is found in the document.

Remarks

This method returns the number of characters by which the specified range or selection was moved, as a Long value. If Count is greater than 0 (zero), this method returns the number of characters moved plus 1. If Count is less than 0 (zero), this method returns the number of characters moved minus 1. If no Cset characters are found, the range or selection isn't not changed and the method returns 0 (zero).

Syntax

expression.MoveUntil(Cset, Count)

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

Cset Required Variant. One or more characters. If any character in Cset is found before the Count value expires, the specified range or selection is positioned as an insertion point immediately before that character. 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 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, MoveEndUntil method, MoveStartUntil method, MoveWhile method.

Example

This example moves myRange forward through the next 100 characters in the document until the character "t" is found.

Set myRange = ActiveDocument.Words(1)
myRange.MoveUntil Cset:="t", Count:=100

This example moves the selection forward to the end of the active paragraph and then displays the number of characters by which the selection was moved.

x = Selection.MoveUntil(Cset:=Chr$(13), Count:=wdForward)
MsgBox x-1 & " character positions were moved"