ControlCollection.AddGroupContentControl メソッド (String) (2007 System)

[アーティクル]
08/22/2008

更新 : 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) であるか、または長さが 0 である場合。
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");
}