OpenXmlPackage Classe
Définition
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.
Représente une classe de base pour les classes de document Open XML fortement typées.
public abstract class OpenXmlPackage : DocumentFormat.OpenXml.Packaging.OpenXmlPartContainer, IDisposable
type OpenXmlPackage = class
inherit OpenXmlPartContainer
interface IDisposable
Public MustInherit Class OpenXmlPackage
Inherits OpenXmlPartContainer
Implements IDisposable
- Héritage
- Dérivé
- Implémente
Constructeurs
OpenXmlPackage() |
Obsolète.
Obsolète.
Initialise une nouvelle instance de la classe OpenXmlPackage. |
Propriétés
AutoSave |
Obtient une valeur indiquant si les parties doivent être enregistrées lorsqu’elles sont supprimées. |
CanSave |
Obtient une valeur indiquant si l’enregistrement du package est pris en charge en appelant Save(). Certaines plateformes (telles que .NET Core) ont une prise en charge limitée de l’enregistrement.
Si |
CompressionOption |
Obtient ou définit le niveau de compression du contenu du nouveau composant |
DataPartReferenceRelationships |
Obtient toutes les DataPartReferenceRelationship relations. (Hérité de OpenXmlPartContainer) |
DataParts |
Obtient tous les DataPart composants du package de document. |
ExternalRelationships |
Obtient toutes les relations externes. Les relations de lien hypertexte ne sont pas incluses. Utilisez la propriété HyperlinkRelationship pour énumérer les relations de lien hypertexte. (Hérité de OpenXmlPartContainer) |
Features |
Obtient les fonctionnalités associées à ce composant. |
Features |
Obtient les fonctionnalités associées à ce composant. (Hérité de OpenXmlPartContainer) |
FileOpenAccess |
Obtient le paramètre FileAccess pour le document. Les paramètres actuels d’accès aux E/S sont les suivants : Lecture, Écriture ou ReadWrite. |
HyperlinkRelationships |
Obtient toutes les relations de lien hypertexte. (Hérité de OpenXmlPartContainer) |
MarkupCompatibilityProcessSettings |
Obtient les paramètres de compatibilité de balisage appliqués au moment du chargement. |
MaxCharactersInPart |
Obtient une valeur qui indique le nombre maximal autorisé de caractères dans une partie Open XML. Une valeur zéro (0) indique qu’il n’existe aucune limite sur la taille de la pièce. Une valeur différente de zéro spécifie la taille maximale, en caractères. |
Package |
Obsolète.
Obtient le package du document. |
PackageProperties |
Obtient les propriétés du package. |
PartExtensionProvider |
Obtient un composant PartExtensionProvider qui fournit un mappage de ContentType à l’extension de composant. |
Parts |
Obtient toutes les parties qui sont des cibles de relation de cette partie. (Hérité de OpenXmlPartContainer) |
RootPart |
Obtient la partie racine du package. |
StrictRelationshipFound |
Obtient une valeur indiquant si ce package contient des relations transitionnelles converties à partir de Strict. |
Méthodes
AddAnnotation(Object) |
Ajoute un objet à la liste d’annotations de ce PartContainer. (Hérité de OpenXmlPartContainer) |
AddExtendedPart(String, String, String, String) |
Ajoute un composant étendu ( partie spécifique à l’application ). (Hérité de OpenXmlPartContainer) |
AddExtendedPart(String, String, String) |
Ajoute un composant étendu ( partie spécifique à l’application ). (Hérité de OpenXmlPartContainer) |
AddExternalRelationship(String, Uri, String) |
Ajoute une relation externe. N’ajoutez pas de relations de lien hypertexte via cette méthode. Utilisez AddHyperlinkRelationship() à la place. (Hérité de OpenXmlPartContainer) |
AddExternalRelationship(String, Uri) |
Ajoute une relation externe. N’ajoutez pas de relations de lien hypertexte via cette méthode. Utilisez AddHyperlinkRelationship() à la place. (Hérité de OpenXmlPartContainer) |
AddHyperlinkRelationship(Uri, Boolean, String) |
Ajoute une nouvelle relation de lien hypertexte. (Hérité de OpenXmlPartContainer) |
AddHyperlinkRelationship(Uri, Boolean) |
Ajoute une nouvelle relation de lien hypertexte. (Hérité de OpenXmlPartContainer) |
AddNewPart<T>() |
Ajoute une nouvelle partie de type T. (Hérité de OpenXmlPartContainer) |
AddNewPart<T>(String, String) |
Ajoute une nouvelle partie de type T. (Hérité de OpenXmlPartContainer) |
AddNewPart<T>(String) |
Ajoute une nouvelle partie de type T. (Hérité de OpenXmlPartContainer) |
AddPart<T>(T, String) |
Ajoute le composant au document avec un identificateur de relation (ID) donné. Doit utiliser la partie retournée pour fonctionner sur la partie ajoutée au document (Hérité de OpenXmlPartContainer) |
AddPart<T>(T) |
Ajoute le composant spécifié au document. Utilisez la partie retournée pour fonctionner sur le composant ajouté au document. |
Annotation(Type) |
Obtenez le premier objet d’annotation du type spécifié à partir de ce PartContainer. (Hérité de OpenXmlPartContainer) |
Annotation<T>() |
Obtenez le premier objet d’annotation du type spécifié à partir de ce PartContainer. (Hérité de OpenXmlPartContainer) |
Annotations(Type) |
Obtient une collection d’annotations du type spécifié pour ce PartContainer. (Hérité de OpenXmlPartContainer) |
Annotations<T>() |
Obtient une collection d’annotations du type spécifié pour ce PartContainer. (Hérité de OpenXmlPartContainer) |
ChangeIdOfPart(OpenXmlPart, String) |
Modifie l’ID de relation du composant. (Hérité de OpenXmlPartContainer) |
Clone() |
Crée un clone modifiable de ce package OpenXml, ouvert sur un MemoryStream avec une capacité extensible et à l’aide d’OpenSettings par défaut. |
Clone(Package, OpenSettings) |
Crée un clone de ce package OpenXml, ouvert sur le instance de Package spécifié. |
Clone(Package) |
Crée un clone de ce package OpenXml, ouvert sur le instance de Package spécifié. Le clone sera ouvert avec les mêmes OpenSettings que ce package OpenXml. |
Clone(Stream, Boolean, OpenSettings) |
Crée un clone de ce package OpenXml, ouvert sur le flux donné. |
Clone(Stream, Boolean) |
Crée un clone de ce package OpenXml, ouvert sur le flux donné. Le package OpenXml cloné est ouvert avec les mêmes OpenSettings que ce package OpenXml. |
Clone(Stream) |
Crée un clone de ce package OpenXml, ouvert sur le flux donné. Le package OpenXml cloné est ouvert avec les mêmes paramètres, c’est-à-dire FileOpenAccess et OpenSettings, que ce package OpenXml. |
Clone(String, Boolean, OpenSettings) |
Crée un clone de ce package OpenXml ouvert à partir du fichier donné (qui sera créé en clonant ce package OpenXml). |
Clone(String, Boolean) |
Crée un clone de ce package OpenXml ouvert à partir du fichier donné (qui sera créé en clonant ce package OpenXml). Le package OpenXml cloné est ouvert avec les mêmes OpenSettings que ce package OpenXml. |
Clone(String) |
Crée un clone de ce package OpenXml ouvert à partir du fichier donné (qui sera créé en clonant ce package OpenXml). Le package OpenXml cloné est ouvert avec les mêmes paramètres, c’est-à-dire FileOpenAccess et OpenSettings, que ce package OpenXml. |
Close() |
Obsolète.
Enregistre et ferme le package OpenXml et tous les flux de composants sous-jacents. |
CreateClone(Package) |
Crée un instance d’OpenXmlPackage sur le instance de Package spécifié. |
CreateClone(Stream) |
Crée un OpenXmlPackage sur le flux donné. |
CreateClone(String) |
Crée un package OpenXml sur le fichier donné. |
CreateMediaDataPart(MediaDataPartType) |
Crée un composant MediaDataPart dans le package de document. |
CreateMediaDataPart(String, String) |
Crée un composant MediaDataPart dans le package de document. |
CreateMediaDataPart(String) |
Crée un composant MediaDataPart dans le package de document. |
CreateRelationshipToPart(OpenXmlPart, String) |
Ajoute une relation pour le composant spécifié à ce composant. (Hérité de OpenXmlPartContainer) |
CreateRelationshipToPart(OpenXmlPart) |
Ajoute une relation pour le composant spécifié à ce composant. (Hérité de OpenXmlPartContainer) |
DeleteExternalRelationship(ExternalRelationship) |
Supprime la relation externe spécifiée. (Hérité de OpenXmlPartContainer) |
DeleteExternalRelationship(String) |
Supprime le ExternalRelationship spécifié. (Hérité de OpenXmlPartContainer) |
DeletePart(DataPart) |
Supprime le spécifié DataPart du package de documents. |
DeletePart(OpenXmlPart) |
Supprime un composant spécifié dans la couche racine du package. (Hérité de OpenXmlPartContainer) |
DeletePart(String) |
Supprime la partie enfant spécifiée de ce composant. (Hérité de OpenXmlPartContainer) |
DeleteParts<T>(IEnumerable<T>) |
Supprime du document toutes les parties qui se trouvent dans la collection passée. (Hérité de OpenXmlPartContainer) |
DeletePartsRecursivelyOfType<T>() |
Supprime tous les composants avec le type de composant spécifié du package de manière récursive. |
DeleteReferenceRelationship(ReferenceRelationship) |
Supprime la relation de référence spécifiée. (Hérité de OpenXmlPartContainer) |
DeleteReferenceRelationship(String) |
Supprime la relation de référence spécifiée. (Hérité de OpenXmlPartContainer) |
Dispose() |
Vide et enregistre le contenu, ferme le document et libère toutes les ressources. |
Dispose(Boolean) |
Vide et enregistre le contenu, ferme le document et libère toutes les ressources. |
FromFlatOpcDocumentCore(XDocument, Package) |
Convertit un XDocument au format OPC plat en package OpenXml stocké dans un Package. |
FromFlatOpcDocumentCore(XDocument, Stream) |
Convertit un XDocument au format OPC plat en package OpenXml stocké sur un Stream. |
FromFlatOpcDocumentCore(XDocument, String) |
Convertit un XDocument au format OPC plat en package OpenXml stocké dans un fichier. |
GetExternalRelationship(String) |
Obtient l’ExternalRelationship spécifié. (Hérité de OpenXmlPartContainer) |
GetIdOfPart(OpenXmlPart) |
Obtient l’ID de relation du composant. (Hérité de OpenXmlPartContainer) |
GetPartById(String) |
Obtient la partie enfant via l’ID de relation. (Hérité de OpenXmlPartContainer) |
GetPartsCountOfType<T>() |
Obsolète.
Obtient le nombre de toutes les parties du type T. (Hérité de OpenXmlPartContainer) |
GetPartsOfType<T>() |
Énumère toutes les parties enfants du type |
GetPartsOfType<T>(ICollection<T>) |
Obsolète.
Obtient toutes les parties enfants du type |
GetReferenceRelationship(String) |
Obtient le ReferenceRelationship spécifié. (Hérité de OpenXmlPartContainer) |
OpenClone(Stream, Boolean, OpenSettings) |
Ouvre le package OpenXml cloné sur le flux donné. |
OpenClone(String, Boolean, OpenSettings) |
Ouvre le package OpenXml cloné sur le fichier donné. |
RemoveAnnotations(Type) |
Supprime les annotations du type spécifié de ce ComposantContainer. (Hérité de OpenXmlPartContainer) |
RemoveAnnotations<T>() |
Supprime les annotations du type spécifié de ce ComposantContainer. (Hérité de OpenXmlPartContainer) |
Save() |
Enregistre le contenu de toutes les parties et relations contenues dans le package OpenXml, si FileOpenAccess est ReadWrite. Certaines plateformes ne prennent pas en charge l’enregistrement en raison de limitations dans Package, donc interrogez CanSave lors de l’exécution pour savoir si l’enregistrement complet sera pris en charge sans fermer et supprimer le OpenXmlPackage. |
SaveAs(String) |
Obsolète.
Enregistre le contenu de toutes les parties et relations contenues dans le package OpenXml dans le fichier spécifié. Ouvre le document enregistré à l’aide des mêmes paramètres que pour ouvrir ce package OpenXml. |
ThrowIfObjectDisposed() |
Levée si un objet est supprimé. |
ToFlatOpcDocument() |
Convertit un package OpenXml au format OPC en XDocument un au format OPC plat. |
ToFlatOpcDocument(XProcessingInstruction) |
Convertit un package OpenXml au format OPC en XDocument un au format OPC plat. |
ToFlatOpcString() |
Convertit un package OpenXml au format OPC en chaîne au format OPC plat. |
TryGetPartById(String, OpenXmlPart) |
Essayez d’obtenir la partie enfant par l’ID de relation. (Hérité de OpenXmlPartContainer) |
Validate(OpenXmlPackageValidationSettings) |
Obsolète.
Valide le package. Cette méthode ne valide pas le contenu XML dans chaque partie. |
Méthodes d’extension
GetPackage(OpenXmlPackage) |
Obtient le actuel IPackage pour . |
AddDisposableFeature(OpenXmlPackage) |
Représente une classe de base pour les classes de document Open XML fortement typées. |
AddPackageEventsFeature(OpenXmlPackage) |
Ajoute une fonctionnalité pour suivre les événements d’un cycle de vie de package. |
AddPartEventsFeature(OpenXmlPackage) |
Ajoute une fonctionnalité pour suivre les événements d’un package créant ou supprimant des parties. |
AddPartRootEventsFeature(OpenXmlPartContainer) |
Ajoute une fonctionnalité pour suivre les événements de cycle de vie des packages. |
AddRandomNumberGeneratorFeature(OpenXmlPackage) |
Ajoutez un générateur de nombres aléatoires au package. |
CreateUnknownElement(OpenXmlPartContainer, String) |
Crée une classe OpenXmlUnknownElement à l’aide du code XML externe. |
ToFlatOpcDocument(OpenXmlPackage) |
Convertit un package OpenXml au format OPC en XDocument un au format OPC plat. |
ToFlatOpcString(OpenXmlPackage) |
Convertit un package OpenXml au format OPC en chaîne au format OPC plat. |
GetAllParts(OpenXmlPackage) |
Parcourez d’abord les OpenXmlPackage parties du par largeur. |