Bookmark.GoToNext Method

  • Article

Gets a Range object that refers to the start position of the next item or location within the Bookmark control specified by the What argument.

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

Syntax

'Declaration
Function GoToNext ( _
    What As WdGoToItem _
) As Range

Range GoToNext(
    WdGoToItem What
)

Parameters

Return Value

Type: Microsoft.Office.Interop.Word.Range
A Range object that refers to the start position of the next item or location within the Bookmark control specified by the What argument.

Remarks

When you use this method with the wdGoToGrammaticalError, wdGoToProofreadingError, or wdGoToSpellingError constant, the Range object that is returned includes any grammar error text or spelling error text.

Examples

The following code example adds text and a Bookmark control with text to the document, and then adds comments to the text. Using GoToNext and GoToPrevious, it displays the positions of the comments in a message box.

This example is for a document-level customization.

Private Sub BookmarkGoToNext()

    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Text = "This is the first paragraph."

    Dim Bookmark1 As Microsoft.Office.Tools.Word.Bookmark = _
        Me.Controls.AddBookmark(Me.Paragraphs(2).Range, "Bookmark1")
    Bookmark1.Text = "This is original text of the bookmark."

    Dim commentText As Object = "This is some comment text."
    Me.Paragraphs(1).Range.Comments.Add(Me.Paragraphs(1).Range _
        .Words(4), commentText)
    Bookmark1.Words.First.Comments.Add(Bookmark1.Words.First, _
        commentText)
    Bookmark1.InsertBefore("Text inserted before bookmark. ")
    Bookmark1.InsertAfter(" Text inserted after bookmark.")

    Dim range1 As Word.Range = Bookmark1.GoToNext( _
        Word.WdGoToItem.wdGoToComment)
    Dim range2 As Word.Range = Bookmark1.GoToPrevious( _
        Word.WdGoToItem.wdGoToComment)

    MessageBox.Show("Using GoToNext, the comment is " & _
        "at position " & range1.Start.ToString & vbLf & _
        "Using GoToPrevious, the comment is at position " & _
        range2.Start.ToString)

End Sub

private void BookmarkGoToNext()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.Text = "This is the first paragraph.";
    Microsoft.Office.Tools.Word.Bookmark bookmark1 =
       this.Controls.AddBookmark(this.Paragraphs[2].Range,
       "bookmark1");
    bookmark1.Text = "This is original text of the bookmark.";

    object commentText = "This is some comment text.";
    this.Paragraphs[1].Range.Comments.Add(this.Paragraphs[1]
        .Range.Words[4], ref commentText);
    bookmark1.Words.First.Comments.Add(bookmark1.Words.First,
        ref commentText);

    bookmark1.InsertBefore("Text inserted before bookmark. ");
    bookmark1.InsertAfter(" Text inserted after bookmark.");

    Word.Range range1 = bookmark1.GoToNext(Word.WdGoToItem.wdGoToComment);
    Word.Range range2 = bookmark1.GoToPrevious(Word.WdGoToItem.wdGoToComment);

    MessageBox.Show("Using GoToNext, the comment is at position " 
        + range1.Start.ToString() + "\n" +
        "Using GoToPrevious, the comment is at position "
        + range2.Start.ToString());
}

.NET Framework Security

See Also

Reference

Bookmark Interface

Microsoft.Office.Tools.Word Namespace