Método ControlCollection.AddGroupContentControl (ContentControl, String)

Adiciona um novo GroupContentControl que é baseado em um controle de conteúdo nativo no documento.

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

Sintaxe

'Declaração
Function AddGroupContentControl ( _
    contentControl As ContentControl, _
    name As String _
) As GroupContentControl

GroupContentControl AddGroupContentControl(
    ContentControl contentControl,
    string name
)

Parâmetros

• contentControl
  Tipo: Microsoft.Office.Interop.Word.ContentControl
  Microsoft.Office.Interop.Word.ContentControl que é a base para o novo controle.

• name
  Tipo: System.String
  O nome do novo controle.

Valor de retorno

Tipo: Microsoft.Office.Tools.Word.GroupContentControl
GroupContentControl que foi adicionado ao documento.

Exceções

Exceção	Condição
ArgumentNullException	contentControl é nulluma referência nula (Nothing no Visual Basic). - ou - name é nulluma referência nula (Nothing no Visual Basic) ou tem comprimento zero.
ControlNameAlreadyExistsException	Um controle com o mesmo nome já está em ControlCollection.
ArgumentException	contentControl não é uma galeria do bloco de construção (ou seja, a propriedade de Type de contentControl não tem o valor Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlGroup).

Comentários

Use este método para adicionar novo GroupContentControl que é baseado em um controle de conteúdo nativo no documento em tempo de execução. Isso é útil quando você cria GroupContentControl em tempo de execução, e você deseja recriar o mesmo controle na próxima vez que o documento está aberto. Para obter mais informações, consulte Adicionando controles a documentos do Office em tempo de execução.

Exemplos

O exemplo de código a seguir cria um novo GroupContentControl para cada controle grupo nativo que está no documento.

Esta é uma versão para personalização de um documento nível. Para usar este código, colagem na classe de ThisDocument em seu projeto, e chame o método de CreateGroupControlsFromNativeControls de método ThisDocument_Startup .

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

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

Esta versão é para um suplemento ao nível que direciona .NET Framework 4 ou .NET Framework 4.5. Para usar este código, colagem na classe de ThisAddIn em seu projeto, e chame o método de CreateGroupControlsFromNativeControls de método ThisAddIn_Startup .

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

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

O exemplo de código a seguir cria um novo GroupContentControl para cada controle grupo nativo que o usuário adiciona ao documento.

Esta é uma versão para personalização de um documento nível. Para usar este código, colagem na classe de ThisDocument em seu projeto. Para C#, você também deve anexar um manipulador de eventos de ThisDocument_GroupContentControlAfterAdd ao evento de ContentControlAfterAdd da classe de ThisDocument .

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

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

Esta versão é para um suplemento ao nível que direciona .NET Framework 4 ou .NET Framework 4.5. Para usar este código, colagem na classe de ThisAddIn em seu projeto. Além disso, você deve anexar um manipulador de eventos de ActiveDocument_GroupContentControlAfterAdd ao evento de ContentControlAfterAdd de documento ativo.

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

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

Segurança do .NET Framework

• Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.

Consulte também

Referência

ControlCollection Interface

Sobrecargas AddGroupContentControl

Namespace Microsoft.Office.Tools.Word

Outros recursos

Adicionando controles a documentos do Office em tempo de execução

Como adicionar controles Content a documentos do Word