Bookmark.MoveStartWhile Method

  • Article

Moves the start position of the Bookmark control while any of the specified characters are found in the document.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
Function MoveStartWhile ( _
    ByRef cset As Object, _
    ByRef count As Object _
) As Integer

int MoveStartWhile(
    ref Object cset,
    ref Object count
)

Parameters

  • cset
    Type: System.Object%
    One or more characters. This argument is case sensitive.
  • count
    Type: System.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.

Return Value

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

Remarks

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

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.

Optional Parameters

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

Examples

The following code example adds a Bookmark control with text to the first paragraph and then moves the range of the bookmark while it can find the characters T, h, i, or s.

This example is for a document-level customization.

Private Sub BookmarkMoveStartWhile()

    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.MoveStartWhile("This", Bookmark1.Characters.Count)
End Sub

private void BookmarkMoveStartWhile()
{
    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 = "This";

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

.NET Framework Security

See Also

Reference

Bookmark Interface

Microsoft.Office.Tools.Word Namespace