Range.MoveWhile(Object, Object) Method

Reference

Definition

Namespace:: Microsoft.Office.Interop.Word

Assembly:: Microsoft.Office.Interop.Word.dll

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.

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

public int MoveWhile (ref object Cset, ref object Count);

abstract member MoveWhile : obj * obj -> int

Public Function MoveWhile (ByRef Cset As Object, Optional ByRef Count As Object) As Integer

Parameters

Cset: Object

Required Object. One or more characters. This argument is case sensitive.

Count: Object

Optional Object. 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.

Returns

Int32

Remarks

While any character in Cset is found, the specified range is moved. The resulting Range 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 an Integer value. If no Cset characters are found, the range isn't changed and the method returns 0 (zero).

Applies to