Selection.MoveStartWhile(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 start position of the specified selection while any of the specified characters are found in the document.

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

abstract member MoveStartWhile : obj * obj -> int

Public Function MoveStartWhile (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 selection is to be moved. Can be a number or either the wdForward or wdBackward constant. If Count is a positive number, the selection is moved forward in the document. If it's a negative number, the selection is moved backward. The default value is wdForward.

Returns

Int32

Remarks

While any character in Cset is found, the start position of the selection is moved. This method returns the number of characters that the start position of the selection moved as an Integer value. If not Cset characters are found, the selection isn't changed and the method returns 0 (zero). If the start position is moved forward to a position beyond the original end position, the end position is set to the new start position.

Applies to