ControlCollection.AddGroupContentControl 方法

參考

定義

命名空間:: Microsoft.Office.Tools.Word

組件:: Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

多載

AddGroupContentControl(String)	在文件的目前選取範圍新增 GroupContentControl。
AddGroupContentControl(ContentControl, String)	新增以文件中的原生內容控制項為基礎的新 GroupContentControl。
AddGroupContentControl(Range, String)	將新的 GroupContentControl 新增在文件的指定範圍。

AddGroupContentControl(String)

在文件的目前選取範圍新增 GroupContentControl。

public:
 Microsoft::Office::Tools::Word::GroupContentControl ^ AddGroupContentControl(System::String ^ name);

public Microsoft.Office.Tools.Word.GroupContentControl AddGroupContentControl (string name);

abstract member AddGroupContentControl : string -> Microsoft.Office.Tools.Word.GroupContentControl

Public Function AddGroupContentControl (name As String) As GroupContentControl

參數

name: String

新控制項的名稱。

傳回

GroupContentControl

已新增至文件的 GroupContentControl。

例外狀況

ArgumentNullException

name 是 null 或長度為 0。

ControlNameAlreadyExistsException

ControlCollection 中已具有相同名稱的控制項。

範例

下列程式代碼範例會將新的段落新增至檔的開頭，並建立包含此段落的新 GroupContentControl 。可防止 GroupContentControl 使用者編輯段落中的文字。如需使用 GroupContentControl 來保護檔的一部分的詳細資訊，請參閱內容控件。

此版本適用於檔層級自定義。若要使用此程式碼，請將它貼到專案中的 ThisDocument 類別，然後從 ThisDocument_Startup 方法呼叫 AddGroupControlAtSelection 方法。

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");
}

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

此版本適用於以 .NET Framework 4 或 .NET Framework 4.5 為目標的應用程式層級載入宏。若要使用此程式碼，請將它貼到專案中的 ThisAddIn 類別，然後從 ThisAddIn_Startup 方法呼叫 AddGroupControlAtSelection 方法。

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

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

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    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");
}

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 = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    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

備註

使用這個方法，在執行時間在檔案中目前的選取範圍中加入新的 GroupContentControl 。如需詳細資訊，請參閱 Adding Controls to Office Documents at Run Time。

適用於

AddGroupContentControl(ContentControl, String)

新增以文件中的原生內容控制項為基礎的新 GroupContentControl。

public:
 Microsoft::Office::Tools::Word::GroupContentControl ^ AddGroupContentControl(Microsoft::Office::Interop::Word::ContentControl ^ contentControl, System::String ^ name);

public Microsoft.Office.Tools.Word.GroupContentControl AddGroupContentControl (Microsoft.Office.Interop.Word.ContentControl contentControl, string name);

abstract member AddGroupContentControl : Microsoft.Office.Interop.Word.ContentControl * string -> Microsoft.Office.Tools.Word.GroupContentControl

Public Function AddGroupContentControl (contentControl As ContentControl, name As String) As GroupContentControl

參數

contentControl: ContentControl

ContentControl，是新控制項的基礎。

name: String

新控制項的名稱。

傳回

GroupContentControl

已新增至文件的 GroupContentControl。

例外狀況

ArgumentNullException

contentControl 為 null.-或- name 為 null 或長度為零。

ControlNameAlreadyExistsException

ControlCollection 中已具有相同名稱的控制項。

ArgumentException

contentControl不是建置組塊庫 (也就是說， Type 的 contentControl 屬性沒有 Microsoft.Office.Interop.Word 值。WdContentControlType.wdContentControlGroup) 。

範例

下列程式代碼範例會針對檔案中的每個原生群元件建立新的 GroupContentControl 。

此版本適用於檔層級自定義。若要使用此程式碼，請將它貼到專案中的 ThisDocument 類別，然後從 ThisDocument_Startup 方法呼叫 CreateGroupControlsFromNativeControls 方法。

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.GroupContentControl> groupControls;

private void CreateGroupControlsFromNativeControls()
{
    if (this.ContentControls.Count <= 0)
        return;

    groupControls = new System.Collections.Generic.List
        <Microsoft.Office.Tools.Word.GroupContentControl>();
    int count = 0;

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlGroup)
        {
            count++;
            Microsoft.Office.Tools.Word.GroupContentControl tempControl =
                this.Controls.AddGroupContentControl(nativeControl,
                "VSTOGroupControl" + count.ToString());
            groupControls.Add(tempControl);
        }
    }
}

Private groupControls As New System.Collections.Generic.List _
        (Of Microsoft.Office.Tools.Word.GroupContentControl)

Private Sub CreateGroupControlsFromNativeControls()
    If Me.ContentControls.Count <= 0 Then
        Return
    End If

    Dim count As Integer = 0
    For Each nativeControl As Word.ContentControl In Me.ContentControls
        If nativeControl.Type = Word.WdContentControlType.wdContentControlGroup Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.GroupContentControl = _
                Me.Controls.AddGroupContentControl(nativeControl, _
                "VSTOGroupContentControl" + count.ToString())
            groupControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

此版本適用於以 .NET Framework 4 或 .NET Framework 4.5 為目標的應用程式層級載入宏。若要使用此程式碼，請將它貼到專案中的 ThisAddIn 類別，然後從 ThisAddIn_Startup 方法呼叫 CreateGroupControlsFromNativeControls 方法。

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.GroupContentControl> groupControls;

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

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (vstoDoc.ContentControls.Count <= 0)
        return;

    groupControls = new System.Collections.Generic.List
        <Microsoft.Office.Tools.Word.GroupContentControl>();
    int count = 0;

    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlGroup)
        {
            count++;
            Microsoft.Office.Tools.Word.GroupContentControl tempControl =
                vstoDoc.Controls.AddGroupContentControl(nativeControl,
                "VSTOGroupControl" + count.ToString());
            groupControls.Add(tempControl);
        }
    }
}

Private groupControls As New System.Collections.Generic.List _
        (Of Microsoft.Office.Tools.Word.GroupContentControl)

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

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    If vstoDoc.ContentControls.Count <= 0 Then
        Return
    End If

    Dim count As Integer = 0
    For Each nativeControl As Word.ContentControl In vstoDoc.ContentControls
        If nativeControl.Type = Word.WdContentControlType.wdContentControlGroup Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.GroupContentControl = _
                vstoDoc.Controls.AddGroupContentControl(nativeControl, _
                "VSTOGroupContentControl" + count.ToString())
            groupControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

下列程式代碼範例會為使用者新增至檔案的每個原生群元件建立新的 GroupContentControl 。

此版本適用於檔層級自定義。若要使用此程式碼，請將它貼到專案中的 ThisDocument 類別。針對 C#，您也必須將 ThisDocument_GroupContentControlAfterAdd 事件處理程式附加至 ContentControlAfterAdd 類別的 ThisDocument 事件。

void ThisDocument_GroupContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlGroup)
    {
        this.Controls.AddGroupContentControl(NewContentControl,
            "GroupControl" + NewContentControl.ID);
    }
}

Private Sub ThisDocument_GroupContentControlAfterAdd(ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean) Handles Me.ContentControlAfterAdd

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlGroup Then
        Me.Controls.AddGroupContentControl(NewContentControl, _
            "GroupControl" + NewContentControl.ID)
    End If
End Sub

此版本適用於以 .NET Framework 4 或 .NET Framework 4.5 為目標的應用程式層級載入宏。若要使用此程式碼，請將它貼到專案中的 ThisAddIn 類別。此外，您必須將 ActiveDocument_GroupContentControlAfterAdd 事件處理程式附加至使用中 ContentControlAfterAdd 檔的事件。

void ActiveDocument_GroupContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlGroup)
    {
        vstoDoc.Controls.AddGroupContentControl(NewContentControl,
            "GroupControl" + NewContentControl.ID);
    }
}

Private Sub ActiveDocument_GroupContentControlAfterAdd( _
    ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean)

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    If NewContentControl.Type = Word.WdContentControlType. _
        wdContentControlGroup Then
        vstoDoc.Controls.AddGroupContentControl(NewContentControl, _
            "GroupControl" + NewContentControl.ID)
    End If
End Sub

備註

使用這個方法，在執行時間新增以檔案中原生內容控制項為基礎的新 GroupContentControl 。當您在運行時間建立 GroupContentControl 時，這非常有用，而且您想要在下次開啟檔時重新建立相同的控件。如需詳細資訊，請參閱 Adding Controls to Office Documents at Run Time。

適用於

AddGroupContentControl(Range, String)

將新的 GroupContentControl 新增在文件的指定範圍。

public:
 Microsoft::Office::Tools::Word::GroupContentControl ^ AddGroupContentControl(Microsoft::Office::Interop::Word::Range ^ range, System::String ^ name);

public Microsoft.Office.Tools.Word.GroupContentControl AddGroupContentControl (Microsoft.Office.Interop.Word.Range range, string name);

abstract member AddGroupContentControl : Microsoft.Office.Interop.Word.Range * string -> Microsoft.Office.Tools.Word.GroupContentControl

Public Function AddGroupContentControl (range As Range, name As String) As GroupContentControl

參數

range: Range

Range，提供新控制項的界限。

name: String

新控制項的名稱。

傳回

GroupContentControl

已新增至文件的 GroupContentControl。

例外狀況

ArgumentNullException

name 是 null 或長度為 0。

ControlNameAlreadyExistsException

ControlCollection 中已具有相同名稱的控制項。

範例

下列程式代碼範例會將新的段落新增至檔的開頭，並建立 GroupContentControl 包含此段落的。可防止 GroupContentControl 使用者編輯段落中的文字。如需使用 GroupContentControl 來保護檔的一部分的詳細資訊，請參閱內容控件。

此版本適用於檔層級自定義。若要使用此程式碼，請將它貼到專案中的 ThisDocument 類別，然後從 ThisDocument_Startup 方法呼叫 AddGroupControlAtRange 方法。

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

private void AddGroupControlAtRange()
{
    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();

    groupControl2 = this.Controls.AddGroupContentControl(range1, "groupControl2");
}

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

Private Sub AddGroupControlAtRange()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim range1 As Word.Range = Me.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()
    groupControl2 = Me.Controls.AddGroupContentControl(range1, "groupControl2")
End Sub

此版本適用於以 .NET Framework 4 或 .NET Framework 4.5 為目標的應用程式層級載入宏。若要使用此程式碼，請將它貼到專案中的 ThisAddIn 類別，然後從 ThisAddIn_Startup 方法呼叫 AddGroupControlAtRange 方法。

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

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

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    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();

    groupControl2 = vstoDoc.Controls.AddGroupContentControl(range1, "groupControl2");
}

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

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

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
    Dim range1 As Word.Range = 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()
    groupControl2 = vstoDoc.Controls.AddGroupContentControl(range1, "groupControl2")
End Sub

備註

使用這個方法，在執行時間於檔案中的指定範圍新增新的 GroupContentControl 。如需詳細資訊，請參閱 Adding Controls to Office Documents at Run Time。

適用於

ControlCollection.AddGroupContentControl 方法

定義

多載

AddGroupContentControl(String)

參數

傳回

例外狀況

範例

備註

適用於

AddGroupContentControl(ContentControl, String)

參數

傳回

例外狀況

範例

備註

適用於

AddGroupContentControl(Range, String)

參數

傳回

例外狀況

範例

備註

適用於

其他資源