Bookmark.MoveUntil(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 Bookmark control until one of the specified characters is found in the document.

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

abstract member MoveUntil : obj * obj -> int

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

Parameters

cset: Object

One or more characters. If any character in Cset is found before the Count value expires, the Bookmark control is positioned as an insertion point immediately before that character. 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, beginning at the end position. If it is a negative number, the Bookmark control is moved backward, beginning at the start position. The default value is wdForward.

Returns

Int32

The number of characters by which the Bookmark control was moved. If Count is greater than 0 (zero), this method returns the number of characters moved plus one. If Count is less than 0 (zero), this method returns the number of characters moved minus one. 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 a blank space.

This example is for a document-level customization.

private void BookmarkMoveUntil()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    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 = " ";

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

Private Sub BookmarkMoveUntil()

    Me.Paragraphs(1).Range.InsertParagraphBefore()
    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.MoveUntil(" ", Bookmark1.Characters.Count)
End Sub

Remarks

The Bookmark is collapsed to a zero-length bookmark.

Optional Parameters

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

Applies to