ControlCollection.AddRichTextContentControl Méthode

Référence

Définition

Espace de noms:: Microsoft.Office.Tools.Word

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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Surcharges

AddRichTextContentControl(String)	Ajoute un nouveau RichTextContentControl à la sélection actuelle dans le document.
AddRichTextContentControl(ContentControl, String)	Ajoute un nouveau RichTextContentControl basé sur un contrôle de contenu natif du document.
AddRichTextContentControl(Range, String)	Ajoute un nouveau RichTextContentControl à la plage spécifiée dans le document.

AddRichTextContentControl(String)

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

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (string name);

abstract member AddRichTextContentControl : string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (name As String) As RichTextContentControl

Paramètres

name: String

Nom du nouveau contrôle.

Retours

RichTextContentControl

RichTextContentControl qui a été ajouté au document.

Exceptions

ArgumentNullException

name a la valeur null ou est de longueur nulle.

ControlNameAlreadyExistsException

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

Exemples

L’exemple de code suivant ajoute un nouveau RichTextContentControl 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 et appelez la AddRichTextControlAtSelection méthode à partir de la ThisDocument_Startup méthode .

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

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

    richTextControl1 = this.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    richTextControl1 = Me.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

Cette version concerne 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 et appelez la AddRichTextControlAtSelection méthode à partir de la ThisAddIn_Startup méthode .

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

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

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

    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    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()
    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

Remarques

Utilisez cette méthode pour ajouter un nouveau RichTextContentControl à 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 à

AddRichTextContentControl(ContentControl, String)

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

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(Microsoft::Office::Interop::Word::ContentControl ^ contentControl, System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (Microsoft.Office.Interop.Word.ContentControl contentControl, string name);

abstract member AddRichTextContentControl : Microsoft.Office.Interop.Word.ContentControl * string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (contentControl As ContentControl, name As String) As RichTextContentControl

Paramètres

contentControl: ContentControl

ContentControl qui est la base du nouveau contrôle.

name: String

Nom du nouveau contrôle.

Retours

RichTextContentControl

RichTextContentControl qui a été ajouté au document.

Exceptions

ArgumentNullException

contentControl est null.-or- name est ou n’a null aucune longueur.

ControlNameAlreadyExistsException

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

ArgumentException

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

Exemples

L’exemple de code suivant crée un nouveau RichTextContentControl pour chaque contrôle de texte enrichi 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 et appelez la CreateRichTextControlsFromNativeControls méthode à partir de la ThisDocument_Startup méthode .

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.RichTextContentControl> richTextControls;

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

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

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type ==
            Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText)
        {
            count++;
            Microsoft.Office.Tools.Word.RichTextContentControl tempControl =
                this.Controls.AddRichTextContentControl(nativeControl,
                "VSTORichTextControl" + count.ToString());
            richTextControls.Add(tempControl);
        }
    }
}

Private richTextControls As New System.Collections.Generic.List _
        (Of Microsoft.Office.Tools.Word.RichTextContentControl)

Private Sub CreateRichTextControlsFromNativeControls()
    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.wdContentControlRichText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.RichTextContentControl = _
                Me.Controls.AddRichTextContentControl(nativeControl, _
                "VSTORichTextContentControl" + count.ToString())
            richTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

Cette version concerne 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 et appelez la CreateRichTextControlsFromNativeControls méthode à partir de la ThisAddIn_Startup méthode .

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.RichTextContentControl> richTextControls;

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

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

    richTextControls = new System.Collections.Generic.List
        <Microsoft.Office.Tools.Word.RichTextContentControl>();
    int count = 0;
    
    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type ==
            Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText)
        {
            count++;
            Microsoft.Office.Tools.Word.RichTextContentControl tempControl =
                vstoDoc.Controls.AddRichTextContentControl(nativeControl,
                "VSTORichTextControl" + count.ToString());
            richTextControls.Add(tempControl);
        }
    }
}

Private richTextControls As New System.Collections.Generic.List _
        (Of Microsoft.Office.Tools.Word.RichTextContentControl)

Private Sub CreateRichTextControlsFromNativeControls()
    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.wdContentControlRichText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.RichTextContentControl = _
                vstoDoc.Controls.AddRichTextContentControl(nativeControl, _
                "VSTORichTextContentControl" + count.ToString())
            richTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

L’exemple de code suivant crée un nouveau RichTextContentControl pour chaque contrôle de texte enrichi 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_RichTextContentControlAfterAdd gestionnaire d'événements ContentControlAfterAdd à l'événement ThisDocument .

void ThisDocument_RichTextContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlRichText)
    {
        this.Controls.AddRichTextContentControl(NewContentControl,
            "RichTextControl" + NewContentControl.ID);
    }
}

Private Sub ThisDocument_RichTextContentControlAfterAdd(ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean) Handles Me.ContentControlAfterAdd

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlRichText Then
        Me.Controls.AddRichTextContentControl(NewContentControl, _
            "RichTextControl" + NewContentControl.ID)
    End If
End Sub

Cette version concerne 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 attacher le ActiveDocument_RichTextContentControlAfterAdd gestionnaire d’événements à l’événement ContentControlAfterAdd du document actif.

void ActiveDocument_RichTextContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlRichText)
    {
        vstoDoc.Controls.AddRichTextContentControl(NewContentControl,
            "RichTextControl" + NewContentControl.ID);
    }
}

Private Sub ActiveDocument_RichTextContentControlAfterAdd( _
    ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean)

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

Remarques

Utilisez cette méthode pour ajouter un nouveau RichTextContentControl 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 au moment de RichTextContentControl l’exécution et que vous souhaitez recréer le même contrôle la prochaine fois que le document est ouvert. Pour plus d'informations, consultez Adding Controls to Office Documents at Run Time.

S’applique à

AddRichTextContentControl(Range, String)

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

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(Microsoft::Office::Interop::Word::Range ^ range, System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (Microsoft.Office.Interop.Word.Range range, string name);

abstract member AddRichTextContentControl : Microsoft.Office.Interop.Word.Range * string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (range As Range, name As String) As RichTextContentControl

Paramètres

range: Range

Range qui indique les limites du nouveau contrôle.

name: String

Nom du nouveau contrôle.

Retours

RichTextContentControl

RichTextContentControl qui a été ajouté au document.

Exceptions

ArgumentNullException

name a la valeur null ou est de longueur nulle.

ControlNameAlreadyExistsException

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

Exemples

L’exemple de code suivant ajoute un nouveau RichTextContentControl 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 et appelez la AddRichTextControlAtRange méthode à partir de la ThisDocument_Startup méthode .

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl2;

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

    richTextControl2 = this.Controls.AddRichTextContentControl(this.Paragraphs[1].Range,
        "richTextControl2");
    richTextControl2.PlaceholderText = "Enter your first name";
}

Dim richTextControl2 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtRange()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    richTextControl2 = Me.Controls.AddRichTextContentControl(Me.Paragraphs(1).Range, _
        "richTextControl2")
    richTextControl2.PlaceholderText = "Enter your first name"
End Sub

Cette version concerne 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 et appelez la AddRichTextControlAtRange méthode à partir de la ThisAddIn_Startup méthode .

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl2;

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

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

    richTextControl2 = vstoDoc.Controls.AddRichTextContentControl(vstoDoc.Paragraphs[1].Range,
        "richTextControl2");
    richTextControl2.PlaceholderText = "Enter your first name";
}

Dim richTextControl2 As Microsoft.Office.Tools.Word.RichTextContentControl

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

Remarques

Utilisez cette méthode pour ajouter un nouveau RichTextContentControl à 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 à

Partager via

ControlCollection.AddRichTextContentControl Méthode

Définition

Surcharges

AddRichTextContentControl(String)

Paramètres

Retours

Exceptions

Exemples

Remarques

S’applique à

AddRichTextContentControl(ContentControl, String)

Paramètres

Retours

Exceptions

Exemples

Remarques

S’applique à

AddRichTextContentControl(Range, String)

Paramètres

Retours

Exceptions

Exemples

Remarques

S’applique à

Ressources supplémentaires