ControlCollection.AddGroupContentControl 方法 (String) (2007 system)

2008-09-04

更新： 2008 年 7 月

在文档中当前选定的位置添加一个新的 GroupContentControl。

命名空间： Microsoft.Office.Tools.Word
程序集： Microsoft.Office.Tools.Word.v9.0（在 Microsoft.Office.Tools.Word.v9.0.dll 中）

语法

声明
Public Function AddGroupContentControl ( _
    name As String _
) As GroupContentControl
用法
Dim instance As ControlCollection
Dim name As String
Dim returnValue As GroupContentControl

returnValue = instance.AddGroupContentControl(name)

public GroupContentControl AddGroupContentControl(
    string name
)

参数

name
类型：System.String

新控件的名称。

返回值

类型：Microsoft.Office.Tools.Word.GroupContentControl

添加到文档的 GroupContentControl。

异常

异常	条件
ArgumentNullException	name 为 nullnull 引用（在 Visual Basic 中为 Nothing）或长度为零。
ControlNameAlreadyExistsException	ControlCollection 中已存在一个同名控件。

备注

使用此方法，可以在运行时在文档中的当前选定位置添加一个新的 GroupContentControl。有关更多信息，请参见在运行时向 Office 文档添加控件。

示例

下面的代码示例会在文档开头添加一个新段落，然后创建一个包含此段落的新 GroupContentControl。GroupContentControl 可以防止用户编辑段落中的文本。有关如何使用 GroupContentControl 保护文档某个部分的更多信息，请参见内容控件。

此版本针对的是文档级自定义项。若要使用此代码，请将其粘贴到项目内的 ThisDocument 类中，然后从 ThisDocument_Startup 方法中调用 AddGroupControlAtSelection 方法。

Dim groupControl1 As Microsoft.Office.Tools.Word.GroupContentControl

Private Sub AddGroupControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Text = "You cannot edit or change the formatting of text " & _
            "in this paragraph, because this paragraph is in a GroupContentControl."
    Me.Paragraphs(1).Range.Select()
    groupControl1 = Me.Controls.AddGroupContentControl("groupControl1")
End Sub

private Microsoft.Office.Tools.Word.GroupContentControl groupControl1;

private void AddGroupControlAtSelection()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Word.Range range1 = this.Paragraphs[1].Range;
    range1.Text = "You cannot edit or change the formatting of text " +
        "in this paragraph, because this paragraph is in a GroupContentControl.";
    range1.Select();

    groupControl1 = this.Controls.AddGroupContentControl("groupControl1");
}

此版本针对的是应用程序级外接程序。若要使用此代码，请将其粘贴到项目内的 ThisAddIn 类中，然后从 ThisAddIn_Startup 方法中调用 AddGroupControlAtSelection 方法。

Dim groupControl1 As Microsoft.Office.Tools.Word.GroupContentControl

Private Sub AddGroupControlAtSelection()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Me.Application.ActiveDocument.GetVstoObject()
    vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
    vstoDoc.Paragraphs(1).Range.Text = "You cannot edit or change the formatting of text " & _
            "in this paragraph, because this paragraph is in a GroupContentControl."
    vstoDoc.Paragraphs(1).Range.Select()
    groupControl1 = vstoDoc.Controls.AddGroupContentControl("groupControl1")
End Sub

private Microsoft.Office.Tools.Word.GroupContentControl groupControl1;

private void AddGroupControlAtSelection()
{
    if (this.Application.ActiveDocument == null)
        return;

    Document vstoDoc = this.Application.ActiveDocument.GetVstoObject();
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
    Word.Range range1 = vstoDoc.Paragraphs[1].Range;
    range1.Text = "You cannot edit or change the formatting of text " +
        "in this paragraph, because this paragraph is in a GroupContentControl.";
    range1.Select();

    groupControl1 = vstoDoc.Controls.AddGroupContentControl("groupControl1");
}