Configurations de format

Options de rendu complètes par format

Chaque document s'ouvre avec une implémentation BaseConfig. Passez‑en une à OpenDocumentAsync ou laissez le catalogue de formats créer sa valeur par défaut. Toutes les classes ci‑dessous se trouvent dans l'espace de noms Doconut.

Cet espace de noms unique est nouveau. La bibliothèque .NET Standard précédente répartissait ces types entre Doconut.Configs, Doconut.Configs.View et Doconut.Models. Les noms de type n'ont pas changé — dans la plupart des fichiers, la modification consiste simplement à supprimer deux lignes using. Voir le guide de migration.

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true,
    ImageResolution = 150
});

Héritage et paramètres PDF imbriqués

Chaque format hérite des cinq propriétés BaseConfig. Les formats pouvant rediriger via PDF exposent un PdfConfig imbriqué. Dans WordConfig, ExcelConfig et PptConfig, AllowSearch et AllowCopy sont des propriétés pratiques qui lisent et écrivent le PdfConfig imbriqué.

DefaultRender = true sélectionne le moteur de rendu natif du format. Sur les formats avec une redirection PDF, false convertit d'abord en PDF en mémoire puis utilise le visualiseur PDF. Cette voie est souvent utile pour la recherche par coordonnées de texte, mais entraîne une conversion supplémentaire.

Sauf indication contraire, les tableaux affichent les valeurs par défaut des constructeurs/propriétés. Le catalogue de formats automatique remplace délibérément deux d'entre eux : il crée ExcelConfig avec SplitWorksheets = true, et MhtConfig avec DefaultRender = false.

BaseConfig

TypePropriétéValeur par défautComportement
intImageResolution00 utilise la valeur par défaut du format. La plage explicite valide est de 25 à 300 DPI ; les affectations invalides sont ignorées.
stringDocumentCulture""Paramètre régional pour les dates et les nombres. Les valeurs non vides sont tronquées ; les affectations vides sont ignorées.
stringPassword""Mot de passe du document protégé. DocOptions.Password est copié ici automatiquement.
boolShowUItruePropriété de compatibilité ; le moteur de rendu actuel ne l'utilise pas pour contrôler la barre d'outils du navigateur.
boolCachePagestrueMet en cache les images de pages rendues pour la session du document.

PdfConfig

Formats : PDF. DPI par défaut : 200.

TypePropriétéValeur par défautComportement
boolDefaultRendertrueCommutateur de compatibilité. La fabrique actuelle utilise le visualiseur PDF natif.
boolAllowSearchfalseConstruire/utiliser l'index de recherche de texte PDF. Nécessite la capacité de licence Search pour les requêtes.
boolAllowCopyfalseAutoriser les opérations de sélection/copie de texte.
boolExtractHyperlinksfalseExtraire les rectangles de liens pour les superpositions client.
intHyperlinksPageCount0Nombre maximal de pages analysées pour les liens ; 0 signifie toutes les pages.
boolCompressImagesfalseCompresser les images incorporées avant le rendu.
intCompressQuality100Qualité JPEG utilisée lorsque la compression est activée.
boolResizeImagesfalseRedimensionner les images incorporées avant le rendu.
intResizeResolution300DPI cible pour les images redimensionnées.
boolCompressFastfalsePrivilégier le chemin de compression plus rapide et de moindre qualité.
boolFixInvalidImagesfalseTenter de réparer les images incorporées invalides.
boolSplitSegmentsfalseRéunir les mots séparés sur plusieurs segments de ligne pour améliorer la recherche/la copie.

showHyperlinks dans ViewerConfig contrôle la superposition client, tandis que ExtractHyperlinks contrôle l'extraction serveur. Activez les deux.

WordConfig

Formats : DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. DPI par défaut : 200.

TypePropriétéValeur par défautComportement
boolDefaultRendertrueRendu natif Word ; false utilise la redirection PDF.
PdfConfigPdfConfignew instanceParamètres utilisés par le chemin PDF/recherche.
DocPaperSizePaperSizeA4Taille du papier de sortie. Utilisez Custom avec largeur/hauteur.
intPaperWidth595Largeur personnalisée en points.
intPaperHeight841Hauteur personnalisée en points.
boolRemovePaperMarginfalseSupprimer les marges des pages du document.
boolRenderPageColortrueConserver la couleur de page configurée par Word ; false rend les pages blanches.
boolExportPdfAfalseUtiliser le PDF/A d'archivage sur le chemin PDF.
Encoding?FileEncodingnullRemplacer le codage source.
stringFontInfo""Informations de substitution de police.
string[]?FontFoldersnullRépertoires de polices supplémentaires, particulièrement utiles sous Linux/containers.
boolAllowSearchfalseDélègue à PdfConfig.AllowSearch.
boolAllowCopyfalseDélègue à PdfConfig.AllowCopy.
TableAutoFitBehaviorAutoFitAllTablesNoneNone, AutoFitToContents, ou AutoFitToWindow.

ExcelConfig

Formats : XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. DPI par défaut : 200.

TypePropriétéPar défautComportement
boolDefaultRendertrueRendu natif de la feuille ; false utilise la redirection PDF.
PdfConfigPdfConfignouvelle instanceParamètres pour le chemin PDF/recherche.
ExcelPaperSizePaperSizePaperA4Taille du papier de sortie.
doublePaperMargins0.25Marges de page en pouces.
boolPaperLandscapetrueRendu de feuille en mode paysage.
boolAutoFitContentsfalseAjustement automatique des hauteurs de lignes et des largeurs de colonnes.
boolRemoveEmptyContenttrueResserrez la sortie en excluant le contenu vide.
boolCalculateFormulatrueRecalculer les formules avant le rendu.
boolShowRowColumnHeaderstrueInclure les en-têtes de la feuille de calcul.
boolExportPdfAfalseUtiliser PDF/A sur le chemin PDF.
boolSplitWorksheetsfalseConserver les feuilles de calcul comme groupes de pages séparés.
boolShowEmptyWorkSheetsfalseInclure les feuilles de calcul vides.
boolExportLandscapefalseForcer l'exportation en mode paysage.
boolExportOnePagePerSheetfalseAjuster chaque feuille de calcul à une page de sortie.
boolMemoryOptimizationPreferencetrueRéduire la mémoire maximale, au prix d'une possible perte de vitesse.
boolAutoTrimWorksheetRenderRangetrueRendre uniquement la plage utilisée visible lorsqu'aucune zone d'impression explicite n'existe.
boolAutoTrimPreserveExistingPrintAreatrueConserver les zones d'impression définies par le classeur lors du rognage automatique.
string?PrintAreanullPlage explicite telle que "A1:Z100".
boolPrintGridlinesfalseImprimer les lignes de grille de la feuille.
boolPrintHeadingsfalseImprimer les en-têtes de lignes/colonnes.
List<string>SheetNamesvideRestreindre le rendu aux feuilles de calcul nommées.
CustomStyleCell?CustomStylesnullRemplacements optionnels de formatage date/décimal/entier.
boolAllowSearchfalseDélègue à PdfConfig.AllowSearch.
boolAllowCopyfalseDélègue à PdfConfig.AllowCopy.

CustomStyleCell expose CustomStyleDateTime, CustomStyleNumberDecimal, et CustomStyleNumberInteger, toutes des chaînes nullables.

new ExcelConfig() définit SplitWorksheets à false ; l'ouverture d'un fichier Excel sans configuration explicite utilise le catalogue de formats, qui le définit à true.

PptConfig

Formats : PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. DPI par défaut : 200.

TypePropriétéPar défautComportement
boolDefaultRendertrueRendu natif de la diapositive ; false utilise la redirection PDF.
boolFastLoadfalseÉviter le rendu de la première diapositive lors de l'ouverture ; utiliser les métadonnées et rendre à la demande.
PdfConfigPdfConfignouvelle instanceParamètres pour le comportement PDF/recherche.
stringFontInfo""Informations de substitution de police.
string[]?FontFoldersnullRépertoires de polices supplémentaires.
boolAllowSearchfalseDélègue à PdfConfig.AllowSearch.
boolAllowCopyfalseDélègue à PdfConfig.AllowCopy.

Sur Linux et macOS, le rendu des présentations avec le moteur actuel nécessite libgdiplus et System.Drawing.EnableUnixSupport=true. Installez les polices utilisées par la présentation ou fournissez FontFolders.

CadConfig

Formats : DWG, DXF, DGN. DPI par défaut : 200.

TypePropriétéPar défautComportement
boolDefaultRendertrueRendu natif CAD ; false utilise la redirection PDF.
PdfConfigPdfConfignouvelle instanceParamètres du chemin PDF.
boolExportPdfAfalseSortie PDF/A d'archivage.
boolShowColortrueCouleur plutôt que monochrome.
boolWhiteBackgroundtrueFond blanc au lieu de noir.
shortLineWidth25Largeur du trait CAD.
boolShowLayoutsfalseRendre les onglets de mise en page.
boolShowModeltrueRendre l'espace modèle.
boolCheck3DSolidtrueTraiter les solides 3D.
boolExportAllLayoutsfalseExporter toutes les mises en page, en écrasant la sélection modèle/mise en page.
boolLimitMinimumSizefalseAppliquer MinimumSize.
intMinimumSize700Taille minimale de sortie en pixels.
boolLimitMaximumSizefalseAppliquer MaximumSize.
intMaximumSize700Taille maximale de sortie en pixels.
boolShowAllLayoutsDgnfalseInclure toutes les mises en page DGN.
boolAutomaticLayoutScalingtrueRedimensionner automatiquement les mises en page.
floatPdfMargins0.5Marge PDF en pouces.
RenderQualityQualityImageLowQualité du raster : Low, Medium ou High.
RenderQualityQualityTextMediumQualité du texte : Low, Medium ou High.

EmailConfig

Formats : EML, EMLX, MSG. DPI par défaut : 200.

TypePropriétéValeur par défautComportement
boolDefaultRendertrueRendu d'email natif ; false utilise la redirection PDF.
PdfConfigPdfConfignouvelle instanceParamètres du chemin PDF.
Encoding?EmailEncodingnullRemplace l'encodage du message.
Encoding?SubjectEncodingnullRemplace l'encodage du sujet.
Encoding?BodyEncodingnullRemplace l'encodage du corps.
boolSkipExternalImagesfalseNe charge pas les images référencées à distance. Recommandé pour les e‑mails non fiables.
boolRemoveLastWhitePagefalseSupprime une page blanche finale.
boolUseAntiAliasingfalseActive l'anticrénelage.
boolUseHighQualityRenderingfalsePrivilégie un rendu plus propre mais plus lent.
TimeSpan?TimeZoneOffsetnullRemplace le fuseau horaire utilisé pour les dates.
boolForcePageSizefalseForce des dimensions de page fixes.

ImageConfig, TiffConfig et PsdConfig

ImageConfig couvre JPG, JPEG, JPE, PNG, BMP, GIF, ICO, EPS, TGA, WEBP, CDR, CMX, DNG, EMF, WMF, AVIF et SVG. Son DPI par défaut est 100.

ConfigurationPropriétéValeur par défautComportement
ImageConfigMaxImagePixelSize3000Largeur/hauteur maximale. 0 signifie illimité ; les valeurs non nulles inférieures à 50 sont ignorées.
ImageConfigTransparentPngtruePréserve la transparence PNG ; false utilise un fond blanc.
TiffConfigaucune propriété supplémentaireDPI 200Utilise uniquement BaseConfig ; prend en charge les TIFF multi‑pages.
PsdConfigMaxImagePixelSize3000Même validation 0/minimum-50 que ImageConfig ; le DPI par défaut est 100.

DicomConfig

Formats : DCM, IMA. DPI effectif par défaut : 100. Nécessite le plugin DICOM.

TypePropriétéValeur par défautComportement
intHorizontalResolution100 effectifDPI horizontal explicite ; sinon ImageResolution, puis 100.
intVerticalResolution100 effectifDPI vertical explicite ; sinon ImageResolution, puis 100.
intAnimationFrameDelayMs100Délai d'animation multiframe ; le timing GIF utilise des unités de 10 ms.
ushortLoopCount00 boucle indéfiniment ; les valeurs positives s'arrêtent après ce nombre.
DicomDisplayModeDisplayModeAnimationAndFramesAnimationOnly, FramesOnly, ou aperçu combiné plus images statiques.

TxtConfig

Format : TXT. DPI par défaut : 200.

TypePropriétéValeur par défautComportement
DocPaperSizePaperSizeA4Taille du papier de sortie.
Encoding?FileEncodingnullnull utilise UTF-8.
stringFontInformation""Informations sur la police pour le rendu du texte.

Utilisez WordConfig lorsque le texte brut nécessite un comportement de mise en page plus riche.

ProjectConfig

Formats : MPP, MPPX, MPX. DPI par défaut : 200.

TypePropriétéValeur par défautComportement
boolDefaultRendertrueImage Gantt native ; false utilise un chemin PDF basé sur du texte.
PdfConfigPdfConfignouvelle instanceParamètres du chemin PDF.
boolExportPdfAtrueSortie PDF/A d'archivage.
MppPaperSizePaperSizeLedgerTaille du papier de sortie du projet.
MppTimeScaleTimeScaleMonthsDays ou Months.
MppFormatPresentationFormatGanttChartGanttChart, TaskUsage, ResourceUsage, ResourceSheet, ou TaskSheet.

Pour une recherche exacte par coordonnées de texte, utilisez DefaultRender = false.

VisioConfig

Formats : VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. DPI par défaut : 200.

TypePropriétéValeur par défautComportement
boolDefaultRendertrueRendu de diagramme natif ; false utilise la redirection PDF.
PdfConfigPdfConfignouvelle instanceParamètres du chemin PDF.
boolExportPdfAtrueSortie PDF/A d'archivage.

HtmlConfig, EpubConfig, MhtConfig et XpsConfig

Les quatre utilisent par défaut 200 DPI et exposent un PdfConfig imbriqué.

ConfigurationFormatsDefaultRenderPropriétés/comportement supplémentaires
HtmlConfigHTML, HTMtrueRendu natif ; utilisez false pour un chemin de recherche PDF basé sur du texte.
EpubConfigEPUBtrueRendu natif ; false utilise le PDF.
MhtConfigMHT, MHTMLtrue sur la classe ; false dans le catalogue automatiqueL'ouverture normale sans configuration utilise la redirection PDF consultable. Une instance par défaut explicitement construite rend nativement.
XpsConfigXPSfalseUtilise le chemin PDF par défaut ; définissez true pour le rendu d'image natif.

Exemples de configuration par famille

csharp
BaseConfig[] configs =
{
    new PdfConfig
    {
        AllowSearch = true,
        ExtractHyperlinks = true,
        HyperlinksPageCount = 0
    },
    new WordConfig
    {
        PaperSize = DocPaperSize.A4,
        RemovePaperMargin = false,
        FontFolders = new[] { "/usr/share/fonts/truetype" },
        AllowSearch = true
    },
    new ExcelConfig
    {
        PaperLandscape = true,
        AutoFitContents = true,
        CalculateFormula = true,
        SplitWorksheets = false,
        PrintGridlines = false
    },
    new PptConfig
    {
        FastLoad = true,
        FontFolders = new[] { "/usr/share/fonts/truetype" },
        AllowSearch = true
    },
    new CadConfig
    {
        ShowColor = true,
        WhiteBackground = true,
        ShowModel = true,
        ShowLayouts = false,
        QualityText = CadConfig.RenderQuality.High
    },
    new EmailConfig
    {
        SkipExternalImages = true,
        RemoveLastWhitePage = true,
        TimeZoneOffset = TimeSpan.Zero
    },
    new ImageConfig
    {
        MaxImagePixelSize = 3000,
        TransparentPng = true
    },
    new DicomConfig
    {
        DisplayMode = DicomDisplayMode.AnimationAndFrames,
        AnimationFrameDelayMs = 100,
        LoopCount = 0
    }
};

Sélection par extension

csharp
static BaseConfig? ConfigForExtension(string extUpper) => extUpper switch
{
    ".DOC" or ".DOCX" or ".DOT" or ".DOTX" or ".ODT" => new WordConfig
    {
        AutoFitAllTables = WordConfig.TableAutoFitBehavior.AutoFitToWindow,
        PaperSize = DocPaperSize.Tabloid,
        PdfConfig = new PdfConfig { ExtractHyperlinks = true, HyperlinksPageCount = 5, AllowCopy = true }
    },
    ".PDF" => new PdfConfig { AllowSearch = true, AllowCopy = true },
    ".XLS" or ".XLSX" or ".ODS" or ".CSV" => new ExcelConfig { AllowSearch = true, AllowCopy = true },
    ".DCM" or ".IMA" => new DicomConfig { DisplayMode = DicomDisplayMode.AnimationAndFrames },
    // DefaultRender = false → PDF redirection → recherche de texte native précise au pixel
    ".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
    ".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
    _ => null // revenir à la configuration par défaut du format
};

Cette page était-elle utile ?