Partager via


ControlCollection.AddPlainTextContentControl Méthode

Définition

Surcharges

AddPlainTextContentControl(String)

Ajoute un nouveau PlainTextContentControl à la sélection actuelle dans le document.

AddPlainTextContentControl(ContentControl, String)

Ajoute un nouveau PlainTextContentControl basé sur un contrôle de contenu natif du document.

AddPlainTextContentControl(Range, String)

Ajoute un nouveau PlainTextContentControl à la plage spécifiée dans le document.

AddPlainTextContentControl(String)

Ajoute un nouveau PlainTextContentControl à la sélection actuelle dans le document.

public:
 Microsoft::Office::Tools::Word::PlainTextContentControl ^ AddPlainTextContentControl(System::String ^ name);
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (string name);
abstract member AddPlainTextContentControl : string -> Microsoft.Office.Tools.Word.PlainTextContentControl
Public Function AddPlainTextContentControl (name As String) As PlainTextContentControl

Paramètres

name
String

Nom du nouveau contrôle.

Retours

PlainTextContentControl qui a été ajouté au document.

Exceptions

name a la valeur null ou est de longueur nulle.

Un contrôle du même nom se trouve déjà dans la ControlCollection.

Exemples

L’exemple de code suivant ajoute un nouveau PlainTextContentControl au début du document.

Cette version est destinée à une personnalisation au niveau du document. Pour utiliser ce code, collez-le dans la ThisDocument classe de votre projet, puis appelez la AddTextControlAtSelection méthode à partir de la ThisDocument_Startup méthode .

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

private void AddTextControlAtSelection()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.Select();

    textControl1 = this.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}
Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    plainTextControl1 = Me.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

Cette version est destinée à un complément au niveau de l’application qui cible .NET Framework 4 ou .NET Framework 4.5. Pour utiliser ce code, collez-le dans la ThisAddIn classe de votre projet, puis appelez la AddTextControlAtSelection méthode à partir de la ThisAddIn_Startup méthode .

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

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

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
    vstoDoc.Paragraphs[1].Range.Select();

    textControl1 = vstoDoc.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}
Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    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.Select()
    plainTextControl1 = vstoDoc.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

Remarques

Utilisez cette méthode pour ajouter un nouveau PlainTextContentControl à la sélection actuelle dans le document au moment de l’exécution. Pour plus d'informations, consultez Adding Controls to Office Documents at Run Time.

S’applique à

AddPlainTextContentControl(ContentControl, String)

Ajoute un nouveau PlainTextContentControl basé sur un contrôle de contenu natif du document.

public:
 Microsoft::Office::Tools::Word::PlainTextContentControl ^ AddPlainTextContentControl(Microsoft::Office::Interop::Word::ContentControl ^ contentControl, System::String ^ name);
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (Microsoft.Office.Interop.Word.ContentControl contentControl, string name);
abstract member AddPlainTextContentControl : Microsoft.Office.Interop.Word.ContentControl * string -> Microsoft.Office.Tools.Word.PlainTextContentControl
Public Function AddPlainTextContentControl (contentControl As ContentControl, name As String) As PlainTextContentControl

Paramètres

contentControl
ContentControl

ContentControl qui est la base du nouveau contrôle.

name
String

Nom du nouveau contrôle.

Retours

PlainTextContentControl qui a été ajouté au document.

Exceptions

contentControl est null.-ou- name est null ou a une longueur nulle.

Un contrôle du même nom se trouve déjà dans la ControlCollection.

contentControln’est pas une galerie de blocs de construction (autrement dit, la Type propriété de contentControl n’a pas la valeur Microsoft.Office.Interop.Word. WdContentControlType.wdContentControlText).

Exemples

L’exemple de code suivant crée un nouveau PlainTextContentControl pour chaque contrôle de texte brut natif qui se trouve dans le document.

Cette version est destinée à une personnalisation au niveau du document. Pour utiliser ce code, collez-le dans la ThisDocument classe de votre projet, puis appelez la CreateTextControlsFromNativeControls méthode à partir de la ThisDocument_Startup méthode .

private System.Collections.Generic.List<Microsoft.Office.Tools.Word.PlainTextContentControl> plainTextControls;

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

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

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlText)
        {
            count++;
            Microsoft.Office.Tools.Word.PlainTextContentControl tempControl =
                this.Controls.AddPlainTextContentControl(nativeControl,
                "VSTOPlainTextContentControl" + count.ToString());
            plainTextControls.Add(tempControl);
        }
    }
}
Private plainTextControls As New System.Collections.Generic.List _
    (Of Microsoft.Office.Tools.Word.PlainTextContentControl)

Private Sub CreatePlainTextControlsFromNativeControls()
    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.wdContentControlText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.PlainTextContentControl = _
                Me.Controls.AddPlainTextContentControl(nativeControl, _
                "VSTOPlainTextContentControl" + count.ToString())
            plainTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

Cette version est destinée à un complément au niveau de l’application qui cible .NET Framework 4 ou .NET Framework 4.5. Pour utiliser ce code, collez-le dans la ThisAddIn classe de votre projet, puis appelez la CreateTextControlsFromNativeControls méthode à partir de la ThisAddIn_Startup méthode .

private System.Collections.Generic.List<Microsoft.Office.Tools.Word.PlainTextContentControl> plainTextControls;

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

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

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

    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlText)
        {
            count++;
            Microsoft.Office.Tools.Word.PlainTextContentControl tempControl =
                vstoDoc.Controls.AddPlainTextContentControl(nativeControl,
                "VSTOPlainTextContentControl" + count.ToString());
            plainTextControls.Add(tempControl);
        }
    }
}
Private plainTextControls As New System.Collections.Generic.List _
    (Of Microsoft.Office.Tools.Word.PlainTextContentControl)

Private Sub CreatePlainTextControlsFromNativeControls()
    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.wdContentControlText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.PlainTextContentControl = _
                vstoDoc.Controls.AddPlainTextContentControl(nativeControl, _
                "VSTOPlainTextContentControl" + count.ToString())
            plainTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

L’exemple de code suivant crée un nouveau PlainTextContentControl pour chaque contrôle de texte brut natif que l’utilisateur ajoute au document.

Cette version est destinée à une personnalisation au niveau du document. Pour utiliser ce code, collez-le dans la ThisDocument classe de votre projet. En C#, vous devez également attacher le ThisDocument_PlainTextContentControlAfterAdd gestionnaire d'événements ContentControlAfterAdd à l'événement ThisDocument .

void ThisDocument_PlainTextContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlText)
    {
        this.Controls.AddPlainTextContentControl(NewContentControl,
            "PlainTextControl" + NewContentControl.ID);
    }
}
Private Sub ThisDocument_PlainTextContentControlAfterAdd(ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean) Handles Me.ContentControlAfterAdd

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlText Then
        Me.Controls.AddPlainTextContentControl(NewContentControl, _
            "PlainTextControl" + NewContentControl.ID)
    End If
End Sub

Cette version est destinée à un complément au niveau de l’application qui cible .NET Framework 4 ou .NET Framework 4.5. Pour utiliser ce code, collez-le dans la ThisAddIn classe de votre projet. En outre, vous devez joindre le ActiveDocument_PlainTextContentControlAfterAdd gestionnaire d’événements à l’événement ContentControlAfterAdd du document actif.

void ActiveDocument_PlainTextContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlText)
    {
        vstoDoc.Controls.AddPlainTextContentControl(NewContentControl,
            "PlainTextControl" + NewContentControl.ID);
    }
}
Private Sub ActiveDocument_PlainTextContentControlAfterAdd( _
    ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean)

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

Remarques

Utilisez cette méthode pour ajouter un nouveau PlainTextContentControl qui est basé sur un contrôle de contenu natif dans le document au moment de l’exécution. Cela est utile lorsque vous créez un PlainTextContentControl au moment de l’exécution et que vous souhaitez recréer le même contrôle lors de la prochaine ouverture du document. Pour plus d'informations, consultez Adding Controls to Office Documents at Run Time.

S’applique à

AddPlainTextContentControl(Range, String)

Ajoute un nouveau PlainTextContentControl à la plage spécifiée dans le document.

public:
 Microsoft::Office::Tools::Word::PlainTextContentControl ^ AddPlainTextContentControl(Microsoft::Office::Interop::Word::Range ^ range, System::String ^ name);
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (Microsoft.Office.Interop.Word.Range range, string name);
abstract member AddPlainTextContentControl : Microsoft.Office.Interop.Word.Range * string -> Microsoft.Office.Tools.Word.PlainTextContentControl
Public Function AddPlainTextContentControl (range As Range, name As String) As PlainTextContentControl

Paramètres

range
Range

Range qui indique les limites du nouveau contrôle.

name
String

Nom du nouveau contrôle.

Retours

PlainTextContentControl qui a été ajouté au document.

Exceptions

name a la valeur null ou est de longueur nulle.

Un contrôle du même nom se trouve déjà dans la ControlCollection.

Exemples

L’exemple de code suivant ajoute un nouveau PlainTextContentControl au début du document.

Cette version est destinée à une personnalisation au niveau du document. Pour utiliser ce code, collez-le dans la ThisDocument classe de votre projet, puis appelez la AddTextControlAtRange méthode à partir de la ThisDocument_Startup méthode .

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl2;

private void AddTextControlAtRange()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();

    textControl2 = this.Controls.AddPlainTextContentControl(this.Paragraphs[1].Range,
        "textControl2");
    textControl2.PlaceholderText = "Enter your first name";
}
Dim plainTextControl2 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtRange()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    plainTextControl2 = Me.Controls.AddPlainTextContentControl(Me.Paragraphs(1).Range, "plainTextControl2")
    plainTextControl2.PlaceholderText = "Enter your first name"
End Sub

Cette version est destinée à un complément au niveau de l’application qui cible .NET Framework 4 ou .NET Framework 4.5. Pour utiliser ce code, collez-le dans la ThisAddIn classe de votre projet, puis appelez la AddTextControlAtRange méthode à partir de la ThisAddIn_Startup méthode .

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl2;

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

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();

    textControl2 = vstoDoc.Controls.AddPlainTextContentControl(
        vstoDoc.Paragraphs[1].Range,
        "textControl2");
    textControl2.PlaceholderText = "Enter your first name";
}
Dim plainTextControl2 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtRange()
    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()
    plainTextControl2 = vstoDoc.Controls.AddPlainTextContentControl( _
        vstoDoc.Paragraphs(1).Range, "plainTextControl2")
    plainTextControl2.PlaceholderText = "Enter your first name"
End Sub

Remarques

Utilisez cette méthode pour ajouter un nouveau PlainTextContentControl au niveau d’une plage spécifiée dans le document au moment de l’exécution. Pour plus d'informations, consultez Adding Controls to Office Documents at Run Time.

S’applique à