Bookmark.InsertBreak(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.

Inserts a page, column, or section break into the Bookmark control.

public void InsertBreak (ref object Type);

abstract member InsertBreak : obj -> unit

Public Sub InsertBreak (Optional ByRef Type As Object)

Parameters

Type: Object

The type of break to be inserted. WdBreakType.

Examples

The following code example adds a Bookmark control with text to the document and then inserts a Next page section break before the fourth word in the bookmark.

This example is for a document-level customization.

private void BookmarkInsertBreak()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Bookmark bookmark1 =
        this.Controls.AddBookmark(this.Paragraphs[1].Range,
        "bookmark1");
    bookmark1.Text = "This text will have a section break.";

    object Type = Word.WdBreakType.wdSectionBreakNextPage;
    bookmark1.Words[4].InsertBreak(ref Type);
    MessageBox.Show("bookmark1 contains " + bookmark1.Sections.Count +
        " sections.");
}

Private Sub BookmarkInsertBreak()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Bookmark1 As Microsoft.Office.Tools.Word.Bookmark = _
        Me.Controls.AddBookmark(Me.Paragraphs(1).Range, "Bookmark1")
    Bookmark1.Text = "This text will have a section break."
    Bookmark1.Words(4).InsertBreak(Word.WdBreakType _
        .wdSectionBreakNextPage)

    MessageBox.Show("bookmark1 contains " & _
        Bookmark1.Sections.Count.ToString & " sections.")

End Sub

Remarks

Calling this method might delete the Bookmark control.

Optional Parameters

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

Applies to