ControlCollection.AddPictureContentControl, méthode (ContentControl, String)

Ajoute un nouveau PictureContentControl basé sur un contrôle de contenu natif dans le document.

Espace de noms :  Microsoft.Office.Tools.Word
Assembly :  Microsoft.Office.Tools.Word (dans Microsoft.Office.Tools.Word.dll)

Syntaxe

'Déclaration
Function AddPictureContentControl ( _
    contentControl As ContentControl, _
    name As String _
) As PictureContentControl

PictureContentControl AddPictureContentControl(
    ContentControl contentControl,
    string name
)

Paramètres

• contentControl
  Type : Microsoft.Office.Interop.Word.ContentControl
  Microsoft.Office.Interop.Word.ContentControl qui est la base du nouveau contrôle.

• name
  Type : System.String
  Nom du nouveau contrôle.

Valeur de retour

Type : Microsoft.Office.Tools.Word.PictureContentControl
PictureContentControl ajouté au document.

Exceptions

Exception	Condition
ArgumentNullException	contentControl est nullune référence null (Nothing en Visual Basic). ou name est nullune référence null (Nothing en Visual Basic) ou une longueur nulle.
ControlNameAlreadyExistsException	Un contrôle du même nom figure déjà dans ControlCollection.
ArgumentException	contentControl n'est pas une galerie de blocs de construction (à savoir la propriété Type de contentControl n'a pas la valeur Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlPicture).

Notes

Utilisez cette méthode pour ajouter un nouveau PictureContentControl 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 PictureContentControl 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 Ajout de contrôles à des documents Office au moment de l'exécution.

Exemples

L'exemple de code suivant crée un nouveau PictureContentControl pour chaque contrôle d'image natif figurant dans le document.

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

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

Private Sub CreatePictureControlsFromNativeControls()
    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.wdContentControlPicture Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.PictureContentControl = _
                Me.Controls.AddPictureContentControl(nativeControl, _
                "VSTOPictureContentControl" + count.ToString())
            pictureControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

private System.Collections.Generic.List
   <Microsoft.Office.Tools.Word.PictureContentControl> pictureControls;

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

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

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlPicture)
        {
            count++;
            Microsoft.Office.Tools.Word.PictureContentControl tempControl =
                this.Controls.AddPictureContentControl(nativeControl,
                "VSTOPictureContentControl" + count.ToString());
            pictureControls.Add(tempControl);
        }
    }
}

Cette version est pour un complément d'application qui cible le .NET Framework 4. Pour utiliser ce code, collez-le dans la classe ThisAddIn de votre projet, puis appelez la méthode CreatePictureControlFromNativeControl à partir de la méthode ThisAddIn_Startup.

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

Private Sub CreatePictureControlsFromNativeControls()
    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.wdContentControlPicture Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.PictureContentControl = _
                vstoDoc.Controls.AddPictureContentControl(nativeControl, _
                "VSTOPictureContentControl" + count.ToString())
            pictureControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

private System.Collections.Generic.List
   <Microsoft.Office.Tools.Word.PictureContentControl> pictureControls;

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

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

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

    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlPicture)
        {
            count++;
            Microsoft.Office.Tools.Word.PictureContentControl tempControl =
                vstoDoc.Controls.AddPictureContentControl(nativeControl,
                "VSTOPictureContentControl" + count.ToString());
            pictureControls.Add(tempControl);
        }
    }
}

L'exemple de code suivant crée un nouveau PictureContentControl pour chaque contrôle d'image 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 classe ThisDocument de votre projet. En C#, vous devez également attacher le gestionnaire d'événements ThisDocument_PictureContentControlAfterAdd à l'événement ContentControlAfterAdd de la classe ThisDocument.

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

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlPicture Then
        Me.Controls.AddPictureContentControl(NewContentControl, _
            "PictureControl" + NewContentControl.ID)
    End If
End Sub

void ThisDocument_PictureContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlPicture)
    {
        this.Controls.AddPictureContentControl(NewContentControl,
            "PictureControl" + NewContentControl.ID);
    }
}

Cette version est pour un complément d'application qui cible le .NET Framework 4. Pour utiliser ce code, collez-le dans la classe ThisAddIn de votre projet. Vous devez également attacher le gestionnaire d'événements ActiveDocument_PictureContentControlAfterAdd à l'événement ContentControlAfterAdd du document actif.

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

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

void ActiveDocument_PictureContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlPicture)
    {
        vstoDoc.Controls.AddPictureContentControl(NewContentControl,
            "PictureControl" + NewContentControl.ID);
    }
}

Sécurité .NET Framework

• Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

ControlCollection Interface

AddPictureContentControl, surcharge

Microsoft.Office.Tools.Word, espace de noms

Autres ressources

Ajout de contrôles à des documents Office au moment de l'exécution

Méthodes d'assistance pour les contrôles hôtes

Comment : ajouter des contrôles de contenu à des documents Word