Formatkonfigurationen

Vollständige rendereinstellungen pro Format

Jedes Dokument wird mit einer BaseConfig‑Implementierung geöffnet. Übergeben Sie eine an OpenDocumentAsync oder lassen Sie den Formatkatalog seine Vorgabe erstellen. Alle untenstehenden Klassen befinden sich im Namespace Doconut.

Dieser einzelne Namespace ist neu. Die vorherige .NET‑Standard‑Bibliothek verteilte diese Typen auf Doconut.Configs, Doconut.Configs.View und Doconut.Models. Die Typnamen haben sich nicht geändert – in den meisten Dateien besteht die gesamte Änderung darin, zwei using‑Zeilen zu entfernen. Siehe den Migrationsleitfaden.

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

Vererbung und verschachtelte PDF‑Einstellungen

Jedes Format erbt die fünf BaseConfig‑Eigenschaften. Formate, die über PDF umgeleitet werden können, stellen ein verschachteltes PdfConfig bereit. In WordConfig, ExcelConfig und PptConfig sind AllowSearch und AllowCopy Komfort‑Eigenschaften, die das verschachtelte PdfConfig lesen bzw. schreiben.

DefaultRender = true wählt den nativen Format‑Renderer. Bei Formaten mit PDF‑Umleitung bewirkt false, dass zunächst ein In‑Memory‑PDF erzeugt wird und anschließend der PDF‑Viewer verwendet wird. Dieser Pfad ist häufig nützlich für textbasierte Koordinatensuche, verursacht jedoch eine zusätzliche Konvertierung.

Sofern nicht anders angegeben, zeigen die Tabellen die Standardwerte von Konstruktoren/Eigenschaften. Der automatische Formatkatalog überschreibt bewusst zwei davon: Er erzeugt ExcelConfig mit SplitWorksheets = true und MhtConfig mit DefaultRender = false.

BaseConfig

TypEigenschaftStandardVerhalten
intImageResolution00 verwendet den Format‑Standard. Gültiger expliziter Bereich ist 25‑300 DPI; ungültige Zuweisungen werden ignoriert.
stringDocumentCulture""Gebietsschema für Datums‑ und Zahlenformatierung. Nicht‑leere Werte werden getrimmt; leere Zuweisungen werden ignoriert.
stringPassword""Passwort für geschützte Dokumente. DocOptions.Password wird hier automatisch kopiert.
boolShowUItrueKompatibilitätseigenschaft; der aktuelle Renderer nutzt sie nicht zur Steuerung der Browser‑Toolbar.
boolCachePagestrueZwischenspeichern gerenderter Seitenbilder für die Dokument‑Sitzung.

PdfConfig

Formate: PDF. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueKompatibilitätsschalter. Die aktuelle Fabrik verwendet den nativen PDF‑Viewer.
boolAllowSearchfalsePDF‑Text‑Suchindex erstellen/verwenden. Erfordert die Lizenz‑Fähigkeit Search für Anfragen.
boolAllowCopyfalseText‑Auswahl‑/Kopier‑Operationen zulassen.
boolExtractHyperlinksfalseLink‑Rechtecke für Client‑Overlays extrahieren.
intHyperlinksPageCount0Maximale zu scannende Seiten für Links; 0 bedeutet alle Seiten.
boolCompressImagesfalseEingebettete Bilder vor dem Rendern komprimieren.
intCompressQuality100JPEG‑Qualität, wenn Kompression aktiviert ist.
boolResizeImagesfalseEingebettete Bilder vor dem Rendern skalieren.
intResizeResolution300Ziel‑DPI für skalierte Bilder.
boolCompressFastfalseSchnelleren, qualitativ geringeren Kompressionspfad bevorzugen.
boolFixInvalidImagesfalseVersuch, ungültige eingebettete Bilder zu reparieren.
boolSplitSegmentsfalseWörter, die über Zeilen‑Segmente hinweg getrennt sind, wieder zusammenführen, um Suche/Kopie zu verbessern.

showHyperlinks in ViewerConfig steuert das Client‑Overlay, während ExtractHyperlinks die Server‑Extraktion regelt. Beide aktivieren.

WordConfig

Formate: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNativer Word‑Render; false nutzt die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzEinstellungen für den PDF‑/Such‑Pfad.
DocPaperSizePaperSizeA4Ausgabepapiergröße. Verwenden Sie Custom mit Breite/Höhe.
intPaperWidth595Benutzerdefinierte Breite in Punkten.
intPaperHeight841Benutzerdefinierte Höhe in Punkten.
boolRemovePaperMarginfalseSeitenränder des Dokuments entfernen.
boolRenderPageColortrueWord‑konfigurierte Seitenfarbe beibehalten; false rendert weiße Seiten.
boolExportPdfAfalseArchiv‑PDF/A im PDF‑Pfad verwenden.
Encoding?FileEncodingnullQuell‑Encoding überschreiben.
stringFontInfo""Informationen zur Schriftart‑Substitution.
string[]?FontFoldersnullZusätzliche Schriftordner, besonders nützlich unter Linux/Containern.
boolAllowSearchfalseDelegiert an PdfConfig.AllowSearch.
boolAllowCopyfalseDelegiert an PdfConfig.AllowCopy.
TableAutoFitBehaviorAutoFitAllTablesNoneNone, AutoFitToContents oder AutoFitToWindow.

ExcelConfig

Formate: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNativer Blatt‑Render; false nutzt die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzEinstellungen für den PDF‑/Such‑Pfad.
ExcelPaperSizePaperSizePaperA4Ausgabepapiergröße.
doublePaperMargins0.25Seitenränder in Zoll.
boolPaperLandscapetrueQuerformat‑Blattrendering.
boolAutoFitContentsfalseZeilenhöhen und Spaltenbreiten automatisch anpassen.
boolRemoveEmptyContenttrueAusgabe straffen, indem leere Inhalte ausgeschlossen werden.
boolCalculateFormulatrueFormeln vor dem Rendern neu berechnen.
boolShowRowColumnHeaderstrueTabellen‑Header einbeziehen.
boolExportPdfAfalsePDF/A im PDF‑Pfad verwenden.
boolSplitWorksheetsfalseArbeitsblätter als separate Seitengruppen behalten.
boolShowEmptyWorkSheetsfalseLeere Arbeitsblätter einbeziehen.
boolExportLandscapefalseExport im Querformat erzwingen.
boolExportOnePagePerSheetfalseJedes Arbeitsblatt auf eine Ausgabeseite skalieren.
boolMemoryOptimizationPreferencetrueSpitzen‑Speicherverbrauch reduzieren, ggf. zulasten etwas Geschwindigkeit.
boolAutoTrimWorksheetRenderRangetrueNur den sichtbaren benutzten Bereich rendern, wenn kein expliziter Druckbereich existiert.
boolAutoTrimPreserveExistingPrintAreatrueBeim Auto‑Trim vorhandene, im Arbeitsbuch definierte Druckbereiche beibehalten.
string?PrintAreanullExpliziter Bereich, z. B. "A1:Z100".
boolPrintGridlinesfalseRasterlinien des Arbeitsblatts drucken.
boolPrintHeadingsfalseZeilen‑/Spalten‑Überschriften drucken.
List<string>SheetNamesleerRendering auf benannte Arbeitsblätter beschränken.
CustomStyleCell?CustomStylesnullOptionale Overrides für Datums‑/Dezimal‑/Ganzzahl‑Formatierung.
boolAllowSearchfalseDelegiert an PdfConfig.AllowSearch.
boolAllowCopyfalseDelegiert an PdfConfig.AllowCopy.

CustomStyleCell stellt CustomStyleDateTime, CustomStyleNumberDecimal und CustomStyleNumberInteger bereit, alles nullable‑Strings.

new ExcelConfig() setzt SplitWorksheets auf false; das Öffnen einer Excel‑Datei ohne explizite Konfiguration nutzt den Formatkatalog, der den Wert auf true setzt.

PptConfig

Formate: PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNativer Folien‑Render; false nutzt die PDF‑Umleitung.
boolFastLoadfalseBeim Öffnen die erste Folie nicht rendern; Metadaten verwenden und bei Bedarf rendern.
PdfConfigPdfConfigneue InstanzEinstellungen für PDF‑/Such‑Verhalten.
stringFontInfo""Informationen zur Schriftart‑Substitution.
string[]?FontFoldersnullZusätzliche Schriftordner.
boolAllowSearchfalseDelegiert an PdfConfig.AllowSearch.
boolAllowCopyfalseDelegiert an PdfConfig.AllowCopy.

Unter Linux und macOS erfordert die aktuelle Rendering‑Engine libgdiplus und System.Drawing.EnableUnixSupport=true. Installieren Sie die für die Präsentation genutzten Schriften oder stellen Sie FontFolders bereit.

CadConfig

Formate: DWG, DXF, DGN. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNativer CAD‑Render; false nutzt die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
boolExportPdfAfalseArchiv‑PDF/A‑Ausgabe.
boolShowColortrueFarbe statt Monochrom.
boolWhiteBackgroundtrueWeißer Hintergrund statt Schwarz.
shortLineWidth25Strichbreite für CAD.
boolShowLayoutsfalseLayout‑Tabs rendern.
boolShowModeltrueModell‑Raum rendern.
boolCheck3DSolidtrue3D‑Solids verarbeiten.
boolExportAllLayoutsfalseAlle Layouts exportieren, überschreibt Modell/Layout‑Auswahl.
boolLimitMinimumSizefalseMinimumSize anwenden.
intMinimumSize700Minimale Ausgabebreite in Pixeln.
boolLimitMaximumSizefalseMaximumSize anwenden.
intMaximumSize700Maximale Ausgabebreite in Pixeln.
boolShowAllLayoutsDgnfalseAlle DGN‑Layouts einbeziehen.
boolAutomaticLayoutScalingtrueLayouts automatisch skalieren.
floatPdfMargins0.5PDF‑Rand in Zoll.
RenderQualityQualityImageLowRaster‑Qualität: Low, Medium oder High.
RenderQualityQualityTextMediumText‑Qualität: Low, Medium oder High.

EmailConfig

Formate: EML, EMLX, MSG. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNativer E‑Mail‑Render; false nutzt die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
Encoding?EmailEncodingnullNachrichten‑Encoding überschreiben.
Encoding?SubjectEncodingnullBetreff‑Encoding überschreiben.
Encoding?BodyEncodingnullBody‑Encoding überschreiben.
boolSkipExternalImagesfalseExtern referenzierte Bilder nicht laden. Empfohlen für nicht vertrauenswürdige E‑Mails.
boolRemoveLastWhitePagefalseLetzte leere Seite entfernen.
boolUseAntiAliasingfalseAnti‑Aliasing aktivieren.
boolUseHighQualityRenderingfalseSaubereres, langsameres Rendering bevorzugen.
TimeSpan?TimeZoneOffsetnullZeitzonen‑Offset für Datumsangaben überschreiben.
boolForcePageSizefalseFeste Seitenabmessungen erzwingen.

ImageConfig, TiffConfig und PsdConfig

ImageConfig deckt JPG, JPEG, JPE, PNG, BMP, GIF, ICO, EPS, TGA, WEBP, CDR, CMX, DNG, EMF, WMF, AVIF und SVG ab. Seine Standard‑DPI ist 100.

KonfigurationEigenschaftStandardVerhalten
ImageConfigMaxImagePixelSize3000Maximale Breite/Höhe. 0 bedeutet unbegrenzt; Werte unter 50 werden ignoriert.
ImageConfigTransparentPngtruePNG‑Transparenz beibehalten; false verwendet einen weißen Hintergrund.
TiffConfigkeine zusätzlichen EigenschaftenDPI 200Verwendet nur BaseConfig; unterstützt mehrseitige TIFFs.
PsdConfigMaxImagePixelSize3000Gleiche 0/Mindest‑50‑Validierung wie bei ImageConfig; Standard‑DPI ist 100.

DicomConfig

Formate: DCM, IMA. Effektive Standard‑DPI: 100. Benötigt das DICOM‑Plugin.

TypEigenschaftStandardVerhalten
intHorizontalResolution100 effektivExplizite horizontale DPI; sonst ImageResolution, dann 100.
intVerticalResolution100 effektivExplizite vertikale DPI; sonst ImageResolution, dann 100.
intAnimationFrameDelayMs100Verzögerung für Mehrfach‑Frame‑Animation; GIF‑Timing nutzt 10 ms‑Einheiten.
ushortLoopCount00 schleift unendlich; positive Werte stoppen nach dieser Anzahl.
DicomDisplayModeDisplayModeAnimationAndFramesAnimationOnly, FramesOnly oder kombinierte Übersicht plus statische Frames.

TxtConfig

Format: TXT. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
DocPaperSizePaperSizeA4Ausgabepapiergröße.
Encoding?FileEncodingnullnull verwendet UTF‑8.
stringFontInformation""Schriftinformationen für die Textdarstellung.

Verwenden Sie WordConfig, wenn reiner Text ein umfangreicheres Seitenlayout‑Verhalten benötigt.

ProjectConfig

Formate: MPP, MPPX, MPX. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Gantt‑Bild; false nutzt einen textbasierten PDF‑Pfad.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
boolExportPdfAtrueArchiv‑PDF/A‑Ausgabe.
MppPaperSizePaperSizeLedgerProjekt‑Ausgabepapiergröße.
MppTimeScaleTimeScaleMonthsDays oder Months.
MppFormatPresentationFormatGanttChartGanttChart, TaskUsage, ResourceUsage, ResourceSheet oder TaskSheet.

Für exakte textbasierte Koordinatensuche verwenden Sie DefaultRender = false.

VisioConfig

Formate: VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNativer Diagramm‑Render; false nutzt die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
boolExportPdfAtrueArchiv‑PDF/A‑Ausgabe.

HtmlConfig, EpubConfig, MhtConfig und XpsConfig

Alle vier haben standardmäßig 200 DPI und stellen ein verschachteltes PdfConfig bereit.

KonfigurationFormateDefaultRenderZusätzliche Eigenschaften/Verhalten
HtmlConfigHTML, HTMtrueNativer Render; false für einen textbasierten PDF‑Such‑Pfad.
EpubConfigEPUBtrueNativer Render; false nutzt PDF.
MhtConfigMHT, MHTMLtrue in der Klasse; false im automatischen KatalogDer normale Öffnungsvorgang ohne Konfiguration nutzt die durchsuchbare PDF‑Umleitung. Eine explizit konstruierte Standardinstanz rendert nativ.
XpsConfigXPSfalseVerwendet standardmäßig den PDF‑Pfad; true für nativen Bild‑Render.

Konfigurationsbeispiele nach Familie

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
    }
};

Auswahl pro Dateierweiterung

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‑Umleitung → pixelgenaue native Textsuche
    ".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
    ".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
    _ => null // Rückfall zur Standardkonfiguration des Formats
};

War diese Seite hilfreich?