Document

Document class

Représente un document Word.

Pour en savoir plus, visitez leTravailler avec un document article documentaire.

public class Document : DocumentBase

Constructeurs

NomLa description
Document()Crée un document Word vierge.
Document(Stream)Ouvre un document existant à partir d’un flux. Détecte automatiquement le format de fichier.
Document(string)Ouvre un document existant à partir d’un fichier. Détecte automatiquement le format de fichier.
Document(Stream, LoadOptions)Ouvre un document existant à partir d’un flux. Permet de spécifier des options supplémentaires telles qu’un mot de passe de cryptage.
Document(string, LoadOptions)Ouvre un document existant à partir d’un fichier. Permet de spécifier des options supplémentaires telles qu’un mot de passe de cryptage.

Propriétés

NomLa description
AttachedTemplate { get; set; }Obtient ou définit le chemin complet du modèle joint au document.
AutomaticallyUpdateStyles { get; set; }Obtient ou définit un indicateur indiquant si les styles du document sont mis à jour pour correspondre aux styles du modèle joint à chaque fois que le document est ouvert dans MS Word.
BackgroundShape { get; set; }Obtient ou définit la forme d’arrière-plan du document. Peut êtrenul .
BuiltInDocumentProperties { get; }Renvoie une collection qui représente toutes les propriétés de document intégrées du document.
CompatibilityOptions { get; }Donne accès aux options de compatibilité des documents (c’est-à-dire les préférences utilisateur saisies dans leCompatibilité Onglet duPossibilités boîte de dialogue dans Word).
Compliance { get; }Obtient la version de conformité OOXML déterminée à partir du contenu du document chargé. N’a de sens que pour les documents OOXML.
Count { get; }Obtient le nombre d’enfants immédiats de ce nœud.
CustomDocumentProperties { get; }Renvoie une collection qui représente toutes les propriétés de document personnalisées du document.
CustomNodeId { get; set; }Spécifie l’identifiant de nœud personnalisé.
CustomXmlParts { get; set; }Obtient ou définit la collection de parties de stockage de données XML personnalisées.
DefaultTabStop { get; set; }Obtient ou définit l’intervalle (en points) entre les taquets de tabulation par défaut.
DigitalSignatures { get; }Obtient la collection de signatures numériques pour ce document et leurs résultats de validation.
override Document { get; }Obtient cette instance.
EndnoteOptions { get; }Fournit des options qui contrôlent la numérotation et le positionnement des notes de fin dans ce document.
FieldOptions { get; }Obtient unFieldOptions objet qui représente les options permettant de contrôler la gestion des champs dans le document.
FirstChild { get; }Obtient le premier enfant du nœud.
FirstSection { get; }Obtient la première section du document.
FontInfos { get; }Fournit un accès aux propriétés des polices utilisées dans ce document.
FontSettings { get; set; }Obtient ou définit les paramètres de police du document.
FootnoteOptions { get; }Fournit des options qui contrôlent la numérotation et le positionnement des notes de bas de page dans ce document.
Frameset { get; }Renvoie unFramesetexemple si ce document représente une page de frames.
GlossaryDocument { get; set; }Obtient ou définit le document glossaire dans ce document ou modèle. Un document de glossaire est un stockage pour les entrées AutoText, AutoCorrect et Building Block définies dans un document.
GrammarChecked { get; set; }Retoursvrai si le document a été vérifié pour la grammaire.
HasChildNodes { get; }Retoursvrai si ce nœud a des nœuds enfants.
HasMacros { get; }Retoursvrai si le document a un projet VBA (macros).
HasRevisions { get; }Retoursvrai si le document comporte des modifications suivies.
HyphenationOptions { get; }Donne accès aux options de césure des documents.
IncludeTextboxesFootnotesEndnotesInStat { get; set; }Spécifie s’il faut inclure des zones de texte, des notes de bas de page et des notes de fin dans les statistiques du nombre de mots.
override IsComposite { get; }Retoursvrai car ce nœud peut avoir des nœuds enfants.
JustificationMode { get; set; }Obtient ou définit l’ajustement de l’espacement des caractères d’un document.
LastChild { get; }Obtient le dernier enfant du nœud.
LastSection { get; }Obtient la dernière section du document.
LayoutOptions { get; }Obtient unLayoutOptions objet qui représente les options permettant de contrôler le processus de mise en page de ce document.
Lists { get; }Donne accès au formatage de liste utilisé dans le document.
MailMerge { get; }Renvoie unMailMerge objet qui représente la fonctionnalité de publipostage pour le document.
MailMergeSettings { get; set; }Obtient ou définit l’objet qui contient toutes les informations de publipostage pour un document.
NextSibling { get; }Obtient le nœud suivant immédiatement ce nœud.
NodeChangingCallback { get; set; }Appelé lorsqu’un nœud est inséré ou supprimé dans le document.
override NodeType { get; }RetoursDocument .
OriginalFileName { get; }Obtient le nom de fichier d’origine du document.
OriginalLoadFormat { get; }Obtient le format du document original chargé dans cet objet.
PackageCustomParts { get; set; }Obtient ou définit la collection de parties personnalisées (contenu arbitraire) liées au package OOXML à l’aide de « relations inconnues ».
PageColor { get; set; }Obtient ou définit la couleur de la page du document. Cette propriété est une version plus simple deBackgroundShape .
PageCount { get; }Obtient le nombre de pages du document calculé par l’opération de mise en page la plus récente.
ParentNode { get; }Obtient le parent immédiat de ce nœud.
PreviousSibling { get; }Obtient le nœud précédant immédiatement ce nœud.
ProtectionType { get; }Obtient le type de protection de document actuellement actif.
Range { get; }Renvoie unRange objet qui représente la partie d’un document contenue dans ce nœud.
RemovePersonalInformation { get; set; }Obtient ou définit un indicateur indiquant que Microsoft Word supprimera toutes les informations utilisateur des commentaires, des révisions et des propriétés du document lors de l’enregistrement du document.
ResourceLoadingCallback { get; set; }Permet de contrôler la manière dont les ressources externes sont chargées.
Revisions { get; }Obtient une collection de révisions (modifications suivies) qui existent dans ce document.
RevisionsView { get; set; }Obtient ou définit une valeur indiquant s’il faut utiliser la version originale ou révisée d’un document.
Sections { get; }Renvoie une collection qui représente toutes les sections du document.
ShadeFormData { get; set; }Spécifie s’il faut activer l’ombrage gris sur les champs du formulaire.
ShowGrammaticalErrors { get; set; }Spécifie s’il faut afficher les erreurs de grammaire dans ce document.
ShowSpellingErrors { get; set; }Spécifie s’il faut afficher les fautes d’orthographe dans ce document.
SpellingChecked { get; set; }Retoursvrai si l’orthographe du document a été vérifiée.
Styles { get; }Renvoie une collection de styles définis dans le document.
Theme { get; }Obtient leTheme objet pour ce document.
TrackRevisions { get; set; }True si les modifications sont suivies lorsque ce document est modifié dans Microsoft Word.
Variables { get; }Renvoie la collection de variables ajoutées à un document ou un modèle.
VbaProject { get; set; }Obtient ou définit unVbaProject .
VersionsCount { get; }Obtient le nombre de versions de document stockées dans le document DOC.
ViewOptions { get; }Fournit des options pour contrôler la façon dont le document est affiché dans Microsoft Word.
WarningCallback { get; set; }Appelé lors de diverses procédures de traitement de documents lorsqu’un problème est détecté qui pourrait entraîner une perte de fidélité des données ou du formatage.
Watermark { get; }Donne accès au filigrane du document.
WebExtensionTaskPanes { get; }Renvoie une collection qui représente une liste de compléments du volet Office.
WriteProtection { get; }Donne accès aux options de protection en écriture du document.

Méthodes

NomLa description
override Accept(DocumentVisitor)Accepte un visiteur.
AcceptAllRevisions()Accepte toutes les modifications suivies dans le document.
AppendChild(Node)Ajoute le nœud spécifié à la fin de la liste des nœuds enfants pour ce nœud.
AppendDocument(Document, ImportFormatMode)Ajoute le document spécifié à la fin de ce document.
AppendDocument(Document, ImportFormatMode, ImportFormatOptions)Ajoute le document spécifié à la fin de ce document.
Cleanup()Nettoie les styles et les listes inutilisés du document.
Cleanup(CleanupOptions)Nettoie les styles et les listes inutilisés du document en fonction des donnéesCleanupOptions .
Clone()Effectue une copie complète duDocument .
Clone(bool)Crée un duplicata du nœud.
Compare(Document, string, DateTime)Compare ce document avec un autre document produisant des modifications en nombre de révisions d’édition et de formatRevision .
Compare(Document, string, DateTime, CompareOptions)Compare ce document avec un autre document produisant des changements sous forme d’un certain nombre de révisions d’édition et de formatRevision . Permet de spécifier des options de comparaison en utilisantCompareOptions .
CopyStylesFromTemplate(Document)Copie les styles du modèle spécifié vers un document.
CopyStylesFromTemplate(string)Copie les styles du modèle spécifié vers un document.
CreateNavigator()Crée un navigateur qui peut être utilisé pour parcourir et lire des nœuds.
EnsureMinimum()Si le document ne contient aucune section, crée une section avec un paragraphe.
ExpandTableStylesToDirectFormatting()Convertit le formatage spécifié dans les styles de tableau en formatage direct sur les tableaux du document.
ExtractPages(int, int)Renvoie leDocument objet représentant la plage spécifiée de pages.
GetAncestor(NodeType)Obtient le premier ancêtre du spécifiéNodeType .
GetAncestor(Type)Obtient le premier ancêtre du type d’objet spécifié.
GetChild(NodeType, int, bool)Renvoie un Nième nœud enfant qui correspond au type spécifié.
GetChildNodes(NodeType, bool)Renvoie une collection active de nœuds enfants qui correspondent au type spécifié.
GetEnumerator()Fournit la prise en charge de chaque itération de style sur les nœuds enfants de ce nœud.
GetPageInfo(int)Obtient la taille de la page, son orientation et d’autres informations sur une page qui pourraient être utiles pour l’impression ou le rendu.
override GetText()Récupère le texte de ce nœud et de tous ses enfants.
ImportNode(Node, bool)Importe un nœud d’un autre document vers le document actuel.
ImportNode(Node, bool, ImportFormatMode)Importe un nœud d’un autre document vers le document actuel avec une option pour contrôler le formatage.
IndexOf(Node)Renvoie l’index du nœud enfant spécifié dans le tableau de nœuds enfants.
InsertAfter(Node, Node)Insère le nœud spécifié immédiatement après le nœud de référence spécifié.
InsertBefore(Node, Node)Insère le nœud spécifié immédiatement avant le nœud de référence spécifié.
JoinRunsWithSameFormatting()Les jointures s’exécutent avec le même formatage dans tous les paragraphes du document.
NextPreOrder(Node)Obtient le nœud suivant selon l’algorithme de traversée de l’arbre de pré-commande.
NormalizeFieldTypes()Modifie les valeurs du type de champFieldType deFieldStart ,FieldSeparator ,FieldEnd dans tout le document afin qu’ils correspondent aux types de champs contenus dans les codes de champs.
PrependChild(Node)Ajoute le nœud spécifié au début de la liste des nœuds enfants pour ce nœud.
PreviousPreOrder(Node)Obtient le nœud précédent selon l’algorithme de traversée d’arbre de pré-commande.
Print()Imprime l’intégralité du document sur l’imprimante par défaut.
Print(PrinterSettings)Imprime le document selon les paramètres d’imprimante spécifiés, à l’aide du contrôleur d’impression standard (sans interface utilisateur).
Print(string)Imprimez l’intégralité du document sur l’imprimante spécifiée, à l’aide du contrôleur d’impression standard (sans interface utilisateur).
Print(PrinterSettings, string)Imprime le document selon les paramètres d’imprimante spécifiés, à l’aide du contrôleur d’impression standard (sans interface utilisateur) et d’un nom de document.
Protect(ProtectionType)Protège le document des modifications sans modifier le mot de passe existant ou attribue un mot de passe aléatoire.
Protect(ProtectionType, string)Protège le document des modifications et définit éventuellement un mot de passe de protection.
Remove()Se supprime du parent.
RemoveAllChildren()Supprime tous les nœuds enfants du nœud actuel.
RemoveChild(Node)Supprime le nœud enfant spécifié.
RemoveExternalSchemaReferences()Supprime les références de schéma XML externes de ce document.
RemoveMacros()Supprime toutes les macros (le projet VBA) ainsi que les barres d’outils et les personnalisations de commandes du document.
RemoveSmartTags()Supprime toutSmartTagnœuds descendants du nœud actuel.
RenderToScale(int, Graphics, float, float, float)Rend une page de document dans unGraphics objet à une échelle spécifiée.
RenderToSize(int, Graphics, float, float, float, float)Rend une page de document dans unGraphics objet à une taille spécifiée.
Save(string)Enregistre le document dans un fichier. Détermine automatiquement le format de sauvegarde à partir de l’extension.
Save(Stream, SaveFormat)Enregistre le document dans un flux en utilisant le format spécifié.
Save(Stream, SaveOptions)Enregistre le document dans un flux à l’aide des options d’enregistrement spécifiées.
Save(string, SaveFormat)Enregistre le document dans un fichier au format spécifié.
Save(string, SaveOptions)Enregistre le document dans un fichier en utilisant les options d’enregistrement spécifiées.
Save(HttpResponse, string, ContentDisposition, SaveOptions)Envoie le document au navigateur client.
SelectNodes(string)Sélectionne une liste de nœuds correspondant à l’expression XPath.
SelectSingleNode(string)Sélectionne le premierNode qui correspond à l’expression XPath.
StartTrackRevisions(string)Commence automatiquement à marquer toutes les autres modifications que vous apportez au document par programme en tant que modifications de révision.
StartTrackRevisions(string, DateTime)Commence automatiquement à marquer toutes les autres modifications que vous apportez au document par programme en tant que modifications de révision.
StopTrackRevisions()Arrête le marquage automatique des modifications du document en tant que révisions.
ToString(SaveFormat)Exporte le contenu du nœud dans une chaîne au format spécifié.
ToString(SaveOptions)Exporte le contenu du nœud dans une chaîne à l’aide des options de sauvegarde spécifiées.
UnlinkFields()Dissocie les champs dans tout le document.
Unprotect()Supprime la protection du document quel que soit le mot de passe.
Unprotect(string)Supprime la protection du document si un mot de passe correct est spécifié.
UpdateFields()Met à jour les valeurs des champs dans tout le document.
UpdateListLabels()Met à jour les étiquettes de liste pour tous les éléments de liste du document.
UpdatePageLayout()Reconstruit la mise en page du document.
UpdateThumbnail()Mises à jourThumbnail du document en utilisant les options par défaut.
UpdateThumbnail(ThumbnailGeneratingOptions)Mises à jourThumbnail du document selon les options spécifiées.
UpdateWordCount()Met à jour les propriétés du nombre de mots du document.
UpdateWordCount(bool)Met à jour les propriétés du nombre de mots du document, éventuellement mises à jourLines propriété.

Remarques

LeDocument est un objet central de la bibliothèque Aspose.Words.

Pour charger un document existant dans l’un desLoadFormat formats, transmettez un nom de fichier ou un flux dans l’un desDocumentconstructeurs. Pour créer un document vierge, appelez le constructeur sans paramètres.

Utilisez l’une des surcharges de la méthode Save pour enregistrer le document dans l’un des SaveFormat formats.

Pour dessiner des pages de document directement sur unGraphique objet use RenderToScale ouRenderToSize méthode.

Pour imprimer le document, utilisez l’un desPrint méthodes.

MailMerge est le moteur de reporting d’Aspose.Words qui permet de remplir rapidement et facilement des rapports conçus dans Microsoft Word avec des données provenant de diverses sources de données. Les données peuvent provenir d’un DataSet, DataTable, DataView, IDataReader ou d’un tableau de valeurs. Fusion et publipostage parcourra les enregistrements trouvés dans la source de données et les insérera dans les champs de publipostage du document en le développant si nécessaire.

Document stocke des informations à l’échelle du document telles queStyles , BuiltInDocumentProperties ,CustomDocumentProperties listes et macros. La plupart de ces objets sont accessibles via les propriétés correspondantes duDocument.

LeDocument est un nœud racine d’une arborescence qui contient tous les autres nœuds du document. L’arborescence est un modèle de conception composite et à bien des égards similaire à XmlDocument. Le contenu du document peut être manipulé librement par programme :

  • Les nœuds du document sont accessibles via des collections typées, par exempleSections , ParagraphCollection etc.
  • Les nœuds du document peuvent être sélectionnés par leur type de nœud en utilisant GetChildNodes ou en utilisant une requête XPath avecSelectNodes ouSelectSingleNode.
  • Les nœuds de contenu peuvent être ajoutés ou supprimés n’importe où dans le document en utilisant InsertBefore ,InsertAfter , RemoveChild et les méthodes other fournies par la classe de baseCompositeNode.
  • Les attributs de formatage de chaque nœud peuvent être modifiés via les propriétés de ce nœud.

Pensez à utiliserDocumentBuildercela simplifie la tâche de création par programme de ou de remplissage de l’arborescence des documents.

LeDocument ne peut contenir queSection objets.

Dans Microsoft Word, un document valide doit comporter au moins une section.

Exemples

Montre comment exécuter un publipostage avec les données d’un DataTable.

public void ExecuteDataTable()
{
    DataTable table = new DataTable("Test");
    table.Columns.Add("CustomerName");
    table.Columns.Add("Address");
    table.Rows.Add(new object[] { "Thomas Hardy", "120 Hanover Sq., London" });
    table.Rows.Add(new object[] { "Paolo Accorti", "Via Monte Bianco 34, Torino" });

    // Vous trouverez ci-dessous deux manières d'utiliser un DataTable comme source de données pour un publipostage.
    // 1 - Utilisez le tableau entier pour le publipostage afin de créer un document de publipostage de sortie pour chaque ligne du tableau :
    Document doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.WholeTable.docx");

    // 2 - Utilisez une ligne du tableau pour créer un document de publipostage en sortie :
    doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table.Rows[1]);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.OneRow.docx");
}

/// <summary>
/// Crée un document source de publipostage.
/// </summary>
private static Document CreateSourceDocExecuteDataTable()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.InsertField(" MERGEFIELD CustomerName ");
    builder.InsertParagraph();
    builder.InsertField(" MERGEFIELD Address ");

    return doc;
}

Voir également

ConvertUtil Class DocumentBase Class