Bookmark.GoToEditableRange Method

  • Article

Gets a Range object that represents an area of a Bookmark control that can be modified by the user or group of users.

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

Syntax

'Declaration
Function GoToEditableRange ( _
    ByRef EditorID As Object _
) As Range

Range GoToEditableRange(
    ref Object EditorID
)

Parameters

  • EditorID
    Type: System.Object%
    Can be a string that represents the e-mail alias of the user (if in the same domain), an e-mail address, or a WdEditorType constant that represents a group of users. If omitted, selects all ranges for which all users have permissions to edit.

Return Value

Type: Microsoft.Office.Interop.Word.Range
A Range object that represents an area of a Bookmark control that can be modified by the user or group of users.

Remarks

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 in the document and adds all users as editors of the fourth word in the bookmark. The example then protects the document against revisions. Finally, the code displays the editable range of the bookmark in a message box.

This example is for a document-level customization.

Private Sub BookmarkEditors()

    Dim editor As Object = Word.WdEditorType.wdEditorEveryone
    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 cannot be edited."
    Bookmark1.Words(4).Editors.Add(editor)
    Me.Protect(Word.WdProtectionType.wdAllowOnlyReading)

    Dim range1 As Word.Range = Bookmark1.GoToEditableRange(editor)

    If Not (range1 Is Nothing) Then
        MessageBox.Show("The editable Range of Bookmark1 spans from " _
            & range1.Start.ToString & " to " & range1.End.ToString)
    End If

End Sub

private void BookmarkEditors()
{
    object editor = Word.WdEditorType.wdEditorEveryone;
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Bookmark bookmark1 =
        this.Controls.AddBookmark(this.Paragraphs[1].Range,
        "bookmark1");
    bookmark1.Text = "This text cannot be edited.";
    bookmark1.Words[4].Editors.Add(ref editor);
    this.Protect(Word.WdProtectionType.wdAllowOnlyReading,
        ref missing, ref missing, ref missing, ref missing);

    Word.Range range1 = bookmark1.GoToEditableRange(ref editor);

    if (range1 != null)
    {
        MessageBox.Show("The editable Range of bookmark1 spans from " +
            range1.Start.ToString() + " to " + range1.End.ToString());
    }
}

.NET Framework Security

See Also

Reference

Bookmark Interface

Microsoft.Office.Tools.Word Namespace