Formatkonfigurationen

Vollständige Rendering-Optionen pro Format

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

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 und schreiben.

DefaultRender = true wählt den nativen Format‑Renderer. Bei Formaten mit einer PDF‑Umleitung bewirkt false, dass zunächst ein PDF im Speicher erzeugt wird und anschließend der PDF‑Viewer verwendet wird. Dieser Weg ist häufig nützlich für die Suche nach Textkoordinaten, 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 erstellt ExcelConfig mit SplitWorksheets = true und MhtConfig mit DefaultRender = false.

BaseConfig

TypEigenschaftStandardVerhalten
intImageResolution00 verwendet den Formatstandard. Gültiger expliziter Bereich ist 25‑300 DPI; ungültige Zuweisungen werden ignoriert.
stringDocumentCulture""Gebietsschema für Datums‑ und Zahlenangaben. 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‑Symbolleiste.
boolCachePagestrueZwischenspeichern gerenderter Seitenbilder für die Dokumentsitzung.

PdfConfig

Formate: PDF. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueKompatibilitätsschalter. Die aktuelle Fabrik verwendet den nativen PDF‑Viewer.
boolAllowSearchfalseErstellen/Verwenden des PDF‑Textsuch‑Index. Erfordert die Lizenzfunktion Search für Anfragen.
boolAllowCopyfalseErlaubt Textauswahl‑/Kopier‑Operationen.
boolExtractHyperlinksfalseExtrahiert Link‑Rechtecke für Client‑Overlays.
intHyperlinksPageCount0Maximale Anzahl von Seiten, die nach Links durchsucht werden; 0 bedeutet jede Seite.
boolCompressImagesfalseKomprimiert eingebettete Bilder vor dem Rendern.
intCompressQuality100JPEG‑Qualität, die bei aktivierter Kompression verwendet wird.
boolResizeImagesfalseSkaliert eingebettete Bilder vor dem Rendern.
intResizeResolution300Ziel‑DPI für skalierte Bilder.
boolCompressFastfalseBevorzugt den schnelleren, qualitativ geringeren Komprimierungspfad.
boolFixInvalidImagesfalseVersucht, ungültige eingebettete Bilder zu reparieren.
boolSplitSegmentsfalseFügt Wörter, die über Zeilenabschnitte hinweg getrennt wurden, wieder zusammen, um Suche/Kopieren zu verbessern.

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

WordConfig

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Word‑Render; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzEinstellungen, die vom PDF‑/Suchpfad verwendet werden.
DocPaperSizePaperSizeA4Ausgabepapiergröße. Verwenden Sie Custom mit Breite/Höhe.
intPaperWidth595Benutzerdefinierte Breite in Punkten.
intPaperHeight841Benutzerdefinierte Höhe in Punkten.
boolRemovePaperMarginfalseEntfernt Seitenränder des Dokuments.
boolRenderPageColortrueErhält die in Word konfigurierte Seitenfarbe; false rendert weiße Seiten.
boolExportPdfAfalseVerwendet das archivierte PDF/A im PDF‑Pfad.
Encoding?FileEncodingnullÜberschreibt die Quellkodierung.
stringFontInfo""Informationen zur Schriftart‑Substitution.
string[]?FontFoldersnullZusätzliche Schriftartverzeichnisse, besonders nützlich unter Linux/Containern.
boolAllowSearchfalseLeitet an PdfConfig.AllowSearch weiter.
boolAllowCopyfalseLeitet an PdfConfig.AllowCopy weiter.
TableAutoFitBehaviorAutoFitAllTablesNoneNone, AutoFitToContents oder AutoFitToWindow.

ExcelConfig

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Tabellen‑Render; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzEinstellungen für den PDF‑/Suchpfad.
ExcelPaperSizePaperSizePaperA4Ausgabepapiergröße.
doublePaperMargins0.25Seitenränder in Zoll.
boolPaperLandscapetrueQuerformat‑Tabellenrendering.
boolAutoFitContentsfalseAutomatisches Anpassen von Zeilenhöhen und Spaltenbreiten.
boolRemoveEmptyContenttrueAusgabe straffen, indem leerer Inhalt ausgeschlossen wird.
boolCalculateFormulatrueFormeln vor dem Rendern neu berechnen.
boolShowRowColumnHeaderstrueTabellenkopfzeilen einbeziehen.
boolExportPdfAfalseVerwendet PDF/A im PDF‑Pfad.
boolSplitWorksheetsfalseBehalte Arbeitsblätter als separate Seitengruppen.
boolShowEmptyWorkSheetsfalseLeere Arbeitsblätter einbeziehen.
boolExportLandscapefalseErzwingt Export im Querformat.
boolExportOnePagePerSheetfalsePasst jedes Arbeitsblatt auf eine Ausgabeseite.
boolMemoryOptimizationPreferencetrueReduziert den Spitzen‑Speicherverbrauch, kann jedoch etwas Geschwindigkeit kosten.
boolAutoTrimWorksheetRenderRangetrueRendert nur den sichtbaren genutzten Bereich, wenn kein expliziter Druckbereich vorhanden ist.
boolAutoTrimPreserveExistingPrintAreatrueErhält vom Arbeitsbuch definierte Druckbereiche während des automatischen Trimmens.
string?PrintAreanullExpliziter Bereich, z. B. "A1:Z100".
boolPrintGridlinesfalseDruckt Rasterlinien des Arbeitsblatts.
boolPrintHeadingsfalseDruckt Zeilen‑/Spaltenüberschriften.
List<string>SheetNamesleerBeschränkt das Rendern auf benannte Arbeitsblätter.
CustomStyleCell?CustomStylesnullOptionale Überschreibungen für Datums‑/Dezimal‑/Ganzzahl‑Formatierung.
boolAllowSearchfalseLeitet an PdfConfig.AllowSearch weiter.
boolAllowCopyfalseLeitet an PdfConfig.AllowCopy weiter.

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

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

PptConfig

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Folien‑Render; false verwendet die PDF‑Umleitung.
boolFastLoadfalseVermeidet das Rendern der ersten Folie beim Öffnen; verwendet Metadaten und rendert bei Bedarf.
PdfConfigPdfConfigneue InstanzEinstellungen für das PDF‑/Suchverhalten.
stringFontInfo""Informationen zur Schriftart‑Substitution.
string[]?FontFoldersnullZusätzliche Schriftartverzeichnisse.
boolAllowSearchfalseLeitet an PdfConfig.AllowSearch weiter.
boolAllowCopyfalseLeitet an PdfConfig.AllowCopy weiter.

Unter Linux und macOS erfordert das Präsentations‑Rendering mit der aktuellen Engine libgdiplus und System.Drawing.EnableUnixSupport=true. Installieren Sie die von der Präsentation verwendeten Schriftarten oder geben Sie FontFolders an.

CadConfig

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative CAD‑Render; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
boolExportPdfAfalseArchivierte PDF/A‑Ausgabe.
boolShowColortrueFarbe statt Monochrom.
boolWhiteBackgroundtrueWeißer Hintergrund statt schwarzem.
shortLineWidth25CAD‑Strichbreite.
boolShowLayoutsfalseRendern von Layout‑Tabs.
boolShowModeltrueRendern des Modellraums.
boolCheck3DSolidtrueVerarbeiten von 3D‑Solids.
boolExportAllLayoutsfalseExportiert alle Layouts und überschreibt die Auswahl von Modell/Layout.
boolLimitMinimumSizefalseWendet MinimumSize an.
intMinimumSize700Minimale Ausgabengröße in Pixeln.
boolLimitMaximumSizefalseWendet MaximumSize an.
intMaximumSize700Maximale Ausgabengröße in Pixeln.
boolShowAllLayoutsDgnfalseAlle DGN‑Layouts einbeziehen.
boolAutomaticLayoutScalingtrueSkaliert Layouts automatisch.
floatPdfMargins0.5PDF‑Rand in Zoll.
RenderQualityQualityImageLowRasterqualität: Low, Medium oder High.
RenderQualityQualityTextMediumTextqualität: Low, Medium oder High.

EmailConfig

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative E‑Mail‑Render; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
Encoding?EmailEncodingnullÜberschreibt die Nachrichtenkodierung.
Encoding?SubjectEncodingnullÜberschreibt die Betreffkodierung.
Encoding?BodyEncodingnullÜberschreibt die Body‑Kodierung.
boolSkipExternalImagesfalseLädt keine remote referenzierten Bilder. Empfohlen für nicht vertrauenswürdige E‑Mails.
boolRemoveLastWhitePagefalseEntfernt eine abschließende leere Seite.
boolUseAntiAliasingfalseAktiviert Kantenglättung.
boolUseHighQualityRenderingfalseBevorzugt saubereres, langsameres Rendering.
TimeSpan?TimeZoneOffsetnullÜberschreibt die für Datumsangaben verwendete Zeitzone.
boolForcePageSizefalseErzwingt feste Seitenabmessungen.

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. Die Standard‑DPI beträgt 100.

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

DicomConfig

Formate: DCM, IMA. Effektive Standard‑DPI: 100. Erfordert das DICOM‑Plugin.

TypEigenschaftStandardVerhalten
intHorizontalResolution100 (effektiv)Explizite horizontale DPI; sonst ImageResolution, dann 100.
intVerticalResolution100 (effektiv)Explizite vertikale DPI; sonst ImageResolution, dann 100.
intAnimationFrameDelayMs100Verzögerung für Mehrfachbild‑Animation; GIF‑Timing verwendet Einheiten von 10 ms.
ushortLoopCount00 wiederholt 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""Schriftartinformationen für die Textdarstellung.

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

ProjectConfig

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Gantt‑Bild; false verwendet einen textbasierten PDF‑Pfad.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
boolExportPdfAtrueArchivierte PDF/A‑Ausgabe.
MppPaperSizePaperSizeLedgerPapiergröße für Projektausgabe.
MppTimeScaleTimeScaleMonthsDays oder Months.
MppFormatPresentationFormatGanttChartGanttChart, TaskUsage, ResourceUsage, ResourceSheet oder TaskSheet.

Für eine exakte Text‑Koordinatensuche verwenden Sie DefaultRender = false.

VisioConfig

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Diagram‑Render; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
boolExportPdfAtrueArchivierte 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, HTMtrueNative Render; false für einen textbasierten PDF‑Suchpfad verwenden.
EpubConfigEPUBtrueNative Render; false verwendet PDF.
MhtConfigMHT, MHTMLtrue on the class; false in the automatic catalogDas normale Öffnen ohne Konfiguration verwendet die durchsuchbare PDF‑Umleitung. Eine explizit konstruierte Standardinstanz rendert nativ.
XpsConfigXPSfalseVerwendet standardmäßig den PDF‑Pfad; true für native Bilddarstellung setzen.

Konfigurationsbeispiele nach Familie

csharp
BaseConfig[] configs =
[
    new PdfConfig
    {
        AllowSearch = true,
        ExtractHyperlinks = true,
        HyperlinksPageCount = 0
    },
    new WordConfig
    {
        PaperSize = DocPaperSize.A4,
        RemovePaperMargin = false,
        FontFolders = ["/usr/share/fonts/truetype"],
        AllowSearch = true
    },
    new ExcelConfig
    {
        PaperLandscape = true,
        AutoFitContents = true,
        CalculateFormula = true,
        SplitWorksheets = false,
        PrintGridlines = false
    },
    new PptConfig
    {
        FastLoad = true,
        FontFolders = ["/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 Erweiterung

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 redirect → pixel-accurate native text search
    ".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
    ".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
    _ => null // fall back to the format's default config
};

War diese Seite hilfreich?