ControlCollection.AddGroupContentControl Método

Referencia

Definición

Espacio de nombres:: Microsoft.Office.Tools.Word

Ensamblados:: Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Sobrecargas

AddGroupContentControl(String)	Agrega un nuevo objeto GroupContentControl en la selección actual del documento.
AddGroupContentControl(ContentControl, String)	Agrega un nuevo objeto GroupContentControl basado en un control de contenido nativo del documento.
AddGroupContentControl(Range, String)	Agrega un nuevo objeto GroupContentControl en el intervalo especificado en el documento.

AddGroupContentControl(String)

Agrega un nuevo objeto GroupContentControl en la selección actual del documento.

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

Parámetros

name: String

El nombre del nuevo control.

Devoluciones

GroupContentControl

El objeto GroupContentControl que se agregó al documento.

Excepciones

ArgumentNullException

name es null o tiene una longitud cero.

ControlNameAlreadyExistsException

Un control con el mismo nombre ya se encuentra en el objeto ControlCollection.

Ejemplos

En el ejemplo de código siguiente se agrega un nuevo párrafo al principio del documento y se crea un nuevo GroupContentControl que contiene este párrafo. GroupContentControl Impide que los usuarios editan el texto del párrafo. Para obtener más información sobre el uso de para GroupContentControl proteger una parte de un documento, vea Controles de contenido.

Esta versión es para una personalización de nivel de documento. Para usar este código, péguelo en la ThisDocument clase del proyecto y llame al AddGroupControlAtSelection método desde el ThisDocument_Startup método .

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

Esta versión es para un complemento de nivel de aplicación que tiene como destino .NET Framework 4 o .NET Framework 4.5. Para usar este código, péguelo en la ThisAddIn clase del proyecto y llame al AddGroupControlAtSelection método desde el ThisAddIn_Startup método .

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

Comentarios

Use este método para agregar un nuevo GroupContentControl en la selección actual del documento en tiempo de ejecución. Para obtener más información, consulta Adding Controls to Office Documents at Run Time.

Se aplica a

AddGroupContentControl(ContentControl, String)

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

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

Parámetros

contentControl: ContentControl

El objeto ContentControl que es la base del nuevo control.

name: String

El nombre del nuevo control.

Devoluciones

GroupContentControl

El objeto GroupContentControl que se agregó al documento.

Excepciones

ArgumentNullException

contentControles .-o- name es nullnullo tiene una longitud cero.

ControlNameAlreadyExistsException

Un control con el mismo nombre ya se encuentra en el objeto ControlCollection.

ArgumentException

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

Ejemplos

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

Esta versión es para una personalización de nivel de documento. Para usar este código, péguelo en la ThisDocument clase del proyecto y llame al CreateGroupControlsFromNativeControls método desde el ThisDocument_Startup método .

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

Esta versión es para un complemento de nivel de aplicación que tiene como destino .NET Framework 4 o .NET Framework 4.5. Para usar este código, péguelo en la ThisAddIn clase del proyecto y llame al CreateGroupControlsFromNativeControls método desde el ThisAddIn_Startup método .

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

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

Esta versión es para una personalización de nivel de documento. Para usar este código, péguelo en la ThisDocument clase del proyecto. Para C#, también debe adjuntar el ThisDocument_GroupContentControlAfterAdd controlador de eventos al ContentControlAfterAdd evento de la ThisDocument clase .

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

Esta versión es para un complemento de nivel de aplicación que tiene como destino .NET Framework 4 o .NET Framework 4.5. Para usar este código, péguelo en la ThisAddIn clase del proyecto. Además, debe adjuntar el ActiveDocument_GroupContentControlAfterAdd controlador de eventos al ContentControlAfterAdd evento del documento activo.

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

Comentarios

Use este método para agregar un nuevo GroupContentControl basado en un control de contenido nativo en el documento en tiempo de ejecución. Esto resulta útil cuando se crea en GroupContentControl 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, consulta Adding Controls to Office Documents at Run Time.

Se aplica a

AddGroupContentControl(Range, String)

Agrega un nuevo objeto GroupContentControl en el intervalo especificado en el documento.

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

Parámetros

range: Range

Un objeto Range que proporciona los límites del nuevo control.

name: String

El nombre del nuevo control.

Devoluciones

GroupContentControl

El objeto GroupContentControl que se agregó al documento.

Excepciones

ArgumentNullException

name es null o tiene una longitud cero.

ControlNameAlreadyExistsException

Un control con el mismo nombre ya se encuentra en el objeto ControlCollection.

Ejemplos

En el ejemplo de código siguiente se agrega un nuevo párrafo al principio del documento y se crea un GroupContentControl objeto que contiene este párrafo. GroupContentControl Impide que los usuarios editan el texto del párrafo. Para obtener más información sobre el uso de para GroupContentControl proteger una parte de un documento, vea Controles de contenido.

Esta versión es para una personalización de nivel de documento. Para usar este código, péguelo en la ThisDocument clase del proyecto y llame al AddGroupControlAtRange método desde el ThisDocument_Startup método .

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

Esta versión es para un complemento de nivel de aplicación que tiene como destino .NET Framework 4 o .NET Framework 4.5. Para usar este código, péguelo en la ThisAddIn clase del proyecto y llame al AddGroupControlAtRange método desde el ThisAddIn_Startup método .

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

Comentarios

Use este método para agregar un nuevo GroupContentControl en un intervalo especificado en el documento en tiempo de ejecución. Para obtener más información, consulta Adding Controls to Office Documents at Run Time.

Se aplica a

Compartir a través de

ControlCollection.AddGroupContentControl Método

Definición

Sobrecargas

AddGroupContentControl(String)

Parámetros

Devoluciones

Excepciones

Ejemplos

Comentarios

Se aplica a

AddGroupContentControl(ContentControl, String)

Parámetros

Devoluciones

Excepciones

Ejemplos

Comentarios

Se aplica a

AddGroupContentControl(Range, String)

Parámetros

Devoluciones

Excepciones

Ejemplos

Comentarios

Se aplica a

Recursos adicionales