ControlCollection.AddGroupContentControl (Método) (ContentControl, String)

Artículo
08/10/2011

Agrega un nuevo control GroupContentControl basado en un control de contenido nativo del documento.

Espacio de nombres: Microsoft.Office.Tools.Word
Ensamblado: Microsoft.Office.Tools.Word (en Microsoft.Office.Tools.Word.dll)

Sintaxis

'Declaración
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 es la base del nuevo control.

name
Tipo: System.String
Nombre del nuevo control.

Valor devuelto

Tipo: Microsoft.Office.Tools.Word.GroupContentControl
El control GroupContentControl que se agregó al documento.

Excepciones

Excepción	Condición
ArgumentNullException	El valor de contentControl es nullreferencia null (Nothing en Visual Basic). O bien name es nullreferencia null (Nothing en Visual Basic) o tiene longitud cero.
ControlNameAlreadyExistsException	Ya existe un control con el mismo nombre en ControlCollection.
ArgumentException	contentControl no es una galería de bloques de creación (es decir, la propiedad Type de contentControl no tiene el valor Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlGroup).

ArgumentNullException

El valor de contentControl es nullreferencia null (Nothing en Visual Basic).

O bien

name es nullreferencia null (Nothing en Visual Basic) o tiene longitud cero.

ControlNameAlreadyExistsException

Ya existe un control con el mismo nombre en ControlCollection.

ArgumentException

contentControl no es una galería de bloques de creación (es decir, la propiedad Type de contentControl no tiene el valor Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlGroup).

Comentarios

Utilice este método para agregar un nuevo control GroupContentControl basado en un control de contenido nativo del documento en tiempo de ejecución. Esto resulta útil si crea un control GroupContentControl en tiempo de ejecución y desea volver a crear el mismo control la próxima vez que se abra el documento. Para obtener más información, vea Agregar controles a documentos de Office en tiempo de ejecución.

Ejemplos

En el ejemplo de código siguiente se crea un nuevo GroupContentControl para cada control de grupo nativo que hay en el documento.

Se trata de una versión para una personalización en el nivel del documento. Para usar este código, péguelo en la clase ThisDocument del proyecto y llame al método CreateGroupControlsFromNativeControls desde el 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 versión es para un complemento de nivel de aplicación dirigido a .NET Framework 4. Para usar este código, péguelo en la clase ThisAddIn del proyecto y llame al método CreateGroupControlsFromNativeControls desde el 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);
        }
    }
}

En el ejemplo de código siguiente se crea un nuevo GroupContentControl para cada control de grupo nativo que el usuario agrega al documento.

Se trata de una versión para una personalización en el nivel del documento. Para usar este código, péguelo en la clase ThisDocument del proyecto. En C#, además debe asociar el controlador de eventos ThisDocument_GroupContentControlAfterAdd al evento ContentControlAfterAdd de la clase 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 versión es para un complemento de nivel de aplicación dirigido a .NET Framework 4. Para usar este código, péguelo en la clase ThisAddIn del proyecto. Además, debe asociar el controlador de eventos ActiveDocument_GroupContentControlAfterAdd al evento ContentControlAfterAdd del documento activo.

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

Seguridad de .NET Framework

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.