Comment : ajouter des parties XML personnalisées à des documents à l'aide de compléments d'application

Article
08/10/2011

Vous pouvez stocker des données XML dans les types suivants de documents en créant une partie XML personnalisée dans un complément d'application :

Un classeur Microsoft Office Excel
Un document Microsoft Office Word
Une présentation Microsoft Office PowerPoint

Pour plus d'informations, consultez Vue d'ensemble des parties XML personnalisées.

S'applique à : Les informations contenues dans cette rubrique s'appliquent aux projets de niveau application pour les applications suivantes : Excel 2007, Excel 2010, PowerPoint 2007, PowerPoint 2010, Word 2007 et Word 2010. Pour en savoir plus, consultez Fonctionnalités disponibles par type d'application et de projet Office.

Pour ajouter une partie XML personnalisée à un classeur Excel

Ajoutez un nouvel objet CustomXMLPart à la collection CustomXMLParts du classeur. CustomXMLPart contient la chaîne XML à stocker dans le classeur.

L'exemple de code suivant ajoute une partie XML personnalisée à un classeur donné.

Private Sub AddCustomXmlPartToWorkbook(ByVal workbook As Excel.Workbook)
    Dim xmlString As String = _
        "<?xml version=""1.0"" encoding=""utf-8"" ?>" & _
            "<employees https://schemas.microsoft.com/vsto/samples"">" & _
                "<employee>" & _
                    "<name>Karina Leal</name>" & _
                    "<hireDate>1999-04-01</hireDate>" & _
                    "<title>Manager</title>" & _
                "</employee>" & _
            "</employees>"

    Dim employeeXMLPart As Office.CustomXMLPart = _
        workbook.CustomXMLParts.Add(xmlString)
End Sub

private void AddCustomXmlPartToWorkbook(Excel.Workbook workbook)
{
    string xmlString =
        "<?xml version=\"1.0\" encoding=\"utf-8\" ?>" +
        "<employees xmlns=\"https://schemas.microsoft.com/vsto/samples\">" +
            "<employee>" +
                "<name>Karina Leal</name>" +
                "<hireDate>1999-04-01</hireDate>" +
                "<title>Manager</title>" +
            "</employee>" +
        "</employees>";

    Office.CustomXMLPart employeeXMLPart = workbook.CustomXMLParts.Add(xmlString, missing);
}

Ajoutez la méthode AddCustomXmlPartToWorkbook à la classe ThisAddIn dans un projet au niveau de l'application pour Excel.
Appelez la méthode à partir d'un autre code dans votre projet. Par exemple, pour créer la partie XML personnalisée lorsque l'utilisateur ouvre un classeur, appelez la méthode à partir d'un gestionnaire d'événements pour l'événement WorkbookOpen.

Pour ajouter une partie XML personnalisée à un document Word

Ajoutez un nouvel objet CustomXMLPart à la collection CustomXMLParts du document. CustomXMLPart contient la chaîne XML à stocker dans le document.

L'exemple de code suivant ajoute une partie XML personnalisée à un document donné.

Private Sub AddCustomXmlPartToActiveDocument(ByVal document As Word.Document)
    Dim xmlString As String = _
        "<?xml version=""1.0"" encoding=""utf-8"" ?>" & _
            "<employees https://schemas.microsoft.com/vsto/samples"">" & _
                "<employee>" & _
                    "<name>Karina Leal</name>" & _
                    "<hireDate>1999-04-01</hireDate>" & _
                    "<title>Manager</title>" & _
                "</employee>" & _
            "</employees>"

    Dim employeeXMLPart As Office.CustomXMLPart = _
        document.CustomXMLParts.Add(xmlString)
End Sub

private void AddCustomXmlPartToActiveDocument(Word.Document document)
{
    string xmlString =
        "<?xml version=\"1.0\" encoding=\"utf-8\" ?>" +
        "<employees xmlns=\"https://schemas.microsoft.com/vsto/samples\">" +
            "<employee>" +
                "<name>Karina Leal</name>" +
                "<hireDate>1999-04-01</hireDate>" +
                "<title>Manager</title>" +
            "</employee>" +
        "</employees>";

    Office.CustomXMLPart employeeXMLPart = document.CustomXMLParts.Add(xmlString, missing);
}

Ajoutez la méthode AddCustomXmlPartToDocument à la classe ThisAddIn dans un projet au niveau de l'application pour Word.
Appelez la méthode à partir d'un autre code dans votre projet. Par exemple, pour créer la partie XML personnalisée lorsque l'utilisateur ouvre un document, appelez la méthode à partir d'un gestionnaire d'événements pour l'événement DocumentOpen.

Pour ajouter une partie XML personnalisée à une présentation PowerPoint

Ajoutez un nouvel objet CustomXMLPart à la collection CustomXMLParts de présentation. CustomXMLPart contient la chaîne XML à stocker dans la présentation.

L'exemple de code suivant ajoute une partie XML personnalisée à une présentation donnée.

Private Sub AddCustomXmlPartToPresentation(ByVal presentation As PowerPoint.Presentation)
    Dim xmlString As String = _
        "<?xml version=""1.0"" encoding=""utf-8"" ?>" & _
            "<employees https://schemas.microsoft.com/vsto/samples"">" & _
                "<employee>" & _
                    "<name>Karina Leal</name>" & _
                    "<hireDate>1999-04-01</hireDate>" & _
                    "<title>Manager</title>" & _
                "</employee>" & _
            "</employees>"
    Dim employeeXMLPart As Office.CustomXMLPart = _
        presentation.CustomXMLParts.Add(xmlString)
End Sub

private void AddCustomXmlPartToPresentation(PowerPoint.Presentation presentation)
{
    string xmlString =
        "<?xml version=\"1.0\" encoding=\"utf-8\" ?>" +
        "<employees xmlns=\"https://schemas.microsoft.com/vsto/samples\">" +
            "<employee>" +
                "<name>Karina Leal</name>" +
                "<hireDate>1999-04-01</hireDate>" +
                "<title>Manager</title>" +
            "</employee>" +
        "</employees>";

    Office.CustomXMLPart employeeXMLPart = 
        presentation.CustomXMLParts.Add(xmlString, missing);
}

Ajoutez la méthode AddCustomXmlPartToPresentation à la classe ThisAddIn dans un projet au niveau de l'application pour PowerPoint.
Appelez la méthode à partir d'un autre code dans votre projet. Par exemple, pour créer la partie XML personnalisée lorsque l'utilisateur ouvre une présentation, appelez la méthode à partir d'un gestionnaire d'événements pour l'événement AfterPresentationOpen.

Programmation fiable

Pour simplifier, cet exemple utilise une chaîne XML définie comme variable locale dans la méthode. En général, vous devez obtenir le code XML auprès d'une source externe, comme un fichier ou une base de données.

Voir aussi

Tâches

Comment : ajouter des parties XML personnalisées aux personnalisations au niveau du document

Comment : ajouter des parties XML personnalisées à des documents sans démarrer Microsoft Office

Concepts

Vue d'ensemble des parties XML personnalisées

Partager via