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

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

abstract member MoveStartUntil : obj * obj -> int

Public Function MoveStartUntil (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 by which the start position of the Bookmark control moved. 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 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 moves the range of the bookmark until it finds a space.

This example is for a document-level customization.

private void BookmarkMoveStartUntil()
{
    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.";
 
    object Count = bookmark1.Characters.Count;
    object cSet = " ";

    bookmark1.MoveStartUntil(ref cSet, ref Count);
}

Private Sub BookmarkMoveStartUntil()

    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."

    Bookmark1.MoveStartUntil(" ", Bookmark1.Characters.Count)
End Sub

Remarks

If the movement is backward through the document, the Bookmark control is expanded.

If the start position is moved forward to a point beyond the end position, the Bookmark control is collapsed and both the start and end positions are moved together.

Optional Parameters

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

Applies to