Bookmark.MoveEndWhile(Object, Object) Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assembly:: Microsoft.Office.Tools.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 ending character position of a Bookmark control while any of the specified characters are found in the document.

public int MoveEndWhile (ref object cset, ref object count);

abstract member MoveEndWhile : obj * obj -> int

Public Function MoveEndWhile (ByRef cset As Object, Optional ByRef count As Object) As Integer

Parameters

cset: Object

One or more characters. This argument is case sensitive.

count: Object

The maximum number of characters by which the Bookmark control is to be moved. Can be a number or either the wdForward or wdBackward constant. If Count is a positive number, the Bookmark control is moved forward in the document. If it is a negative number, the Bookmark control is moved backward. The default value is wdForward.

Returns

Int32

The number of characters that the end position of the Bookmark control moved. If no Cset characters are found, the Bookmark control is not changed and the method returns 0 (zero).

Examples

The following code example adds a Bookmark control with text to the first paragraph and then adds another Bookmark control to the third word in the first bookmark. The code then moves the range of the second bookmark while it can find the characters b, o, o, k, m, a, r, or k.

This example is for a document-level customization.

private void BookmarkMoveEndWhile()
{
    Microsoft.Office.Tools.Word.Bookmark bookmark1 =
        this.Controls.AddBookmark(this.Paragraphs[1].Range,
        "bookmark1");
    bookmark1.Text = "This is sample bookmark text.";

    Microsoft.Office.Tools.Word.Bookmark bookmark2 =
        this.Controls.AddBookmark(bookmark1.Words[3],
        "bookmark2");

    object Count = bookmark1.Characters.Count;
    object cSet = "bookmark";

    bookmark2.MoveEndWhile(ref cSet, ref Count);
}

Private Sub BookmarkMoveEndWhile()
    Dim Bookmark1 As Microsoft.Office.Tools.Word.Bookmark = _
        Me.Controls.AddBookmark(Me.Paragraphs(1).Range, "Bookmark1")

    Bookmark1.Text = "This is sample bookmark text."

    Dim Bookmark2 As Microsoft.Office.Tools.Word.Bookmark = _
        Me.Controls.AddBookmark(Bookmark1.Words(3), "Bookmark2")

    Bookmark2.MoveEndWhile("bookmark", Bookmark1.Characters.Count)
End Sub

Remarks

While any character in Cset is found, the end position of the Bookmark control is moved.

If the end position is moved backward to a point that precedes the original start position, the start position is set to the new end position.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to