Share via


ControlCollection.AddGroupContentControl Methode

Definition

Überlädt

AddGroupContentControl(String)

Fügt bei der aktuellen Auswahl im Dokument ein neues GroupContentControl hinzu.

AddGroupContentControl(ContentControl, String)

Fügt ein neues GroupContentControl hinzu, das auf einem nativen Inhaltssteuerelement im Dokument basiert.

AddGroupContentControl(Range, String)

Fügt ein neues GroupContentControl im angegebenen Bereich im Dokument hinzu.

AddGroupContentControl(String)

Fügt bei der aktuellen Auswahl im Dokument ein neues GroupContentControl hinzu.

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

Parameter

name
String

Der Name des neuen Steuerelements.

Gibt zurück

Das GroupContentControl, das dem Dokument hinzugefügt wurde.

Ausnahmen

name ist null oder hat die Länge 0 (null).

Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.

Beispiele

Im folgenden Codebeispiel wird am Anfang des Dokuments ein neuer Absatz hinzugefügt, und es wird ein neues GroupContentControl erstellt, das diesen Absatz enthält. Verhindert GroupContentControl , dass Benutzer den Text im Absatz bearbeiten können. Weitere Informationen zur Verwendung von zum GroupContentControl Schützen eines Teils eines Dokuments finden Sie unter Inhaltssteuerelemente.

Diese Version ist für eine Anpassung auf Dokumentebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und rufen Sie die AddGroupControlAtSelection -Methode aus der ThisDocument_Startup -Methode auf.

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

Diese Version ist für ein Add-In auf Anwendungsebene vorgesehen, das auf die .NET Framework 4 oder die .NET Framework 4.5 ausgerichtet ist. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und rufen Sie die AddGroupControlAtSelection -Methode aus der ThisAddIn_Startup -Methode auf.

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

Hinweise

Verwenden Sie diese Methode, um zur Laufzeit ein neues GroupContentControl bei der aktuellen Auswahl im Dokument hinzuzufügen. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.

Gilt für:

AddGroupContentControl(ContentControl, String)

Fügt ein neues GroupContentControl hinzu, das auf einem nativen Inhaltssteuerelement im Dokument basiert.

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

Parameter

contentControl
ContentControl

Das ContentControl, das die Grundlage für das neue Steuerelement ist.

name
String

Der Name des neuen Steuerelements.

Gibt zurück

Das GroupContentControl, das dem Dokument hinzugefügt wurde.

Ausnahmen

contentControl ist null.-or- name ist null oder hat die Länge null.

Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.

contentControlist kein Bausteinkatalog (d. h. die Type -Eigenschaft von contentControl hat nicht den Wert Microsoft.Office.Interop.Word. WdContentControlType.wdContentControlGroup).

Beispiele

Im folgenden Codebeispiel wird ein neues GroupContentControl für jedes systemeigene Gruppensteuerelement erstellt, das sich im Dokument befindet.

Diese Version ist für eine Anpassung auf Dokumentebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und rufen Sie die CreateGroupControlsFromNativeControls -Methode aus der ThisDocument_Startup -Methode auf.

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

Diese Version ist für ein Add-In auf Anwendungsebene vorgesehen, das auf die .NET Framework 4 oder die .NET Framework 4.5 ausgerichtet ist. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und rufen Sie die CreateGroupControlsFromNativeControls -Methode aus der ThisAddIn_Startup -Methode auf.

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

Im folgenden Codebeispiel wird ein neues GroupContentControl für jedes native Gruppensteuerelement erstellt, das der Benutzer dem Dokument hinzufügt.

Diese Version ist für eine Anpassung auf Dokumentebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein. Für C# müssen Sie den ThisDocument_GroupContentControlAfterAdd Ereignishandler auch an das ContentControlAfterAdd Ereignis der ThisDocument -Klasse anfügen.

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

Diese Version ist für ein Add-In auf Anwendungsebene vorgesehen, das auf die .NET Framework 4 oder die .NET Framework 4.5 ausgerichtet ist. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein. Außerdem müssen Sie den ActiveDocument_GroupContentControlAfterAdd Ereignishandler an das ContentControlAfterAdd Ereignis des aktiven Dokuments anfügen.

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

Hinweise

Verwenden Sie diese Methode, um ein neues GroupContentControl hinzuzufügen, das auf einem nativen Inhaltssteuerelement im Dokument zur Laufzeit basiert. Dies ist nützlich, wenn Sie ein GroupContentControl zur Laufzeit erstellen und dasselbe Steuerelement beim nächsten Öffnen des Dokuments neu erstellen möchten. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.

Gilt für:

AddGroupContentControl(Range, String)

Fügt ein neues GroupContentControl im angegebenen Bereich im Dokument hinzu.

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

Parameter

range
Range

Ein Range, der die Grenzen für das neue Steuerelement bereitstellt.

name
String

Der Name des neuen Steuerelements.

Gibt zurück

Das GroupContentControl, das dem Dokument hinzugefügt wurde.

Ausnahmen

name ist null oder hat die Länge 0 (null).

Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.

Beispiele

Im folgenden Codebeispiel wird am Anfang des Dokuments ein neuer Absatz hinzugefügt, und es wird ein GroupContentControl erstellt, der diesen Absatz enthält. Verhindert GroupContentControl , dass Benutzer den Text im Absatz bearbeiten können. Weitere Informationen zur Verwendung von zum GroupContentControl Schützen eines Teils eines Dokuments finden Sie unter Inhaltssteuerelemente.

Diese Version ist für eine Anpassung auf Dokumentebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und rufen Sie die AddGroupControlAtRange -Methode aus der ThisDocument_Startup -Methode auf.

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

Diese Version ist für ein Add-In auf Anwendungsebene vorgesehen, das auf die .NET Framework 4 oder die .NET Framework 4.5 ausgerichtet ist. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und rufen Sie die AddGroupControlAtRange -Methode aus der ThisAddIn_Startup -Methode auf.

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

Hinweise

Verwenden Sie diese Methode, um zur Laufzeit ein neues GroupContentControl in einem angegebenen Bereich im Dokument hinzuzufügen. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.

Gilt für: