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 Vorgabe erstellen. Alle untenstehenden Klassen befinden sich im Namespace Doconut.

Dieser einzelne Namespace ist neu. Die vorherige .NET Standard-Bibliothek verteilte diese Typen über 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 löschen. 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 umleiten 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 aus. Bei Formaten mit einer PDF‑Umleitung konvertiert false zunächst in ein PDF im Speicher und verwendet dann den PDF‑Betrachter. Dieser Pfad 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. Nichtleere 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 verwendet sie nicht, um die Browser‑Symbolleiste zu steuern.
boolCachePagestrueCache für gerenderte Seitenbilder während der Dokumentsitzung.

PdfConfig

Formate: PDF. Standard‑DPI: 200.

TypEigenschaftStandardVerhalten
boolDefaultRendertrueKompatibilitätsschalter. Die aktuelle Fabrik verwendet den nativen PDF‑Betrachter.
boolAllowSearchfalseErstellen/Verwenden des PDF‑Textsuch‑Index. Erfordert die Lizenzfunktion Search für Anfragen.
boolAllowCopyfalseErmöglicht Textauswahl‑/Kopier‑Operationen.
boolExtractHyperlinksfalseExtrahiert Link‑Rechtecke für Client‑Overlays.
intHyperlinksPageCount0Maximale Seitenzahl, die für Links gescannt wird; 0 bedeutet jede Seite.
boolCompressImagesfalseKomprimiert eingebettete Bilder vor dem Rendern.
intCompressQuality100JPEG‑Qualität, die bei aktivierter Kompression verwendet wird.
boolResizeImagesfalseGröße eingebetteter Bilder vor dem Rendern ändern.
intResizeResolution300Ziel‑DPI für skalierte Bilder.
boolCompressFastfalseBevorzugt den schnelleren, geringeren Qualitäts‑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 steuert. 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.
DocPaperSizePaperSizeA4Ausgabe-Papiergröß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 archiviertes PDF/A im PDF‑Pfad.
Encoding?FileEncodingnullÜberschreibt die Quellkodierung.
stringFontInfo""Informationen zur Schriftart‑Substitution.
string[]?FontFoldersnullZusätzliche Schriftart‑Verzeichnisse – nützlich auf einem Server, dem die vom Dokument verwendeten Schriftarten fehlen.
boolAllowSearchfalseDelegiert an PdfConfig.AllowSearch.
boolAllowCopyfalseDelegiert an PdfConfig.AllowCopy.
TableAutoFitBehaviorAutoFitAllTablesNoneNone, AutoFitToContents, or AutoFitToWindow.

Excel-Konfiguration

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Blattdarstellung; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfignew instanceEinstellungen für den PDF‑/Suchpfad.
ExcelPaperSizePaperSizePaperA4Ausgabe‑Papiergröße.
doublePaperMargins0.25Seitenränder in Zoll.
boolPaperLandscapetrueQuerformat‑Blattdarstellung.
boolAutoFitContentsfalseAutomatisches Anpassen von Zeilenhöhen und Spaltenbreiten.
boolRemoveEmptyContenttrueAusgabe straffen, indem leerer Inhalt ausgeschlossen wird.
boolCalculateFormulatrueFormeln vor dem Rendern neu berechnen.
boolShowRowColumnHeaderstrueTabellenkopfzeilen einbeziehen.
boolExportPdfAfalsePDF/A auf dem PDF‑Pfad verwenden.
boolSplitWorksheetsfalseArbeitsblätter als separate Seitengruppen behalten.
boolShowEmptyWorkSheetsfalseLeere Arbeitsblätter einbeziehen.
boolExportLandscapefalseExport im Querformat erzwingen.
boolExportOnePagePerSheetfalseJedes Arbeitsblatt auf eine Ausgabeseite anpassen.
boolMemoryOptimizationPreferencetrueSpitzenverbrauch reduzieren, möglicherweise auf etwas Geschwindigkeit verzichten.
boolAutoTrimWorksheetRenderRangetrueNur den sichtbaren benutzten Bereich rendern, wenn kein expliziter Druckbereich existiert.
boolAutoTrimPreserveExistingPrintAreatrueArbeitsbuchdefinierte Druckbereiche beim automatischen Trimmen beibehalten.
string?PrintAreanullExpliziter Bereich wie "A1:Z100".
boolPrintGridlinesfalseGitternetzlinien des Arbeitsblatts drucken.
boolPrintHeadingsfalseZeilen‑/Spaltenüberschriften drucken.
List<string>SheetNamesemptyRendern auf benannte Arbeitsblätter beschränken.
CustomStyleCell?CustomStylesnullOptionale Überschreibungen für Datums‑/Dezimal‑/Ganzzahlformatierung.
boolAllowSearchfalseDelegiert an PdfConfig.AllowSearch.
boolAllowCopyfalseDelegiert an PdfConfig.AllowCopy.

CustomStyleCell stellt CustomStyleDateTime, CustomStyleNumberDecimal und CustomStyleNumberInteger bereit, alle nullable Zeichenketten.

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

Ppt-Konfiguration

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Folien‑Rendern; false verwendet die PDF‑Umleitung.
boolFastLoadfalseVermeiden Sie das Rendern der ersten Folie beim Öffnen; verwenden Sie Metadaten und rendern Sie bei Bedarf.
PdfConfigPdfConfignew instanceEinstellungen für das PDF‑/Suchverhalten.
stringFontInfo""Informationen zur Schriftart‑Substitution.
string[]?FontFoldersnullZusätzliche Schriftartverzeichnisse.
boolAllowSearchfalseDelegiert an PdfConfig.AllowSearch.
boolAllowCopyfalseDelegiert an PdfConfig.AllowCopy.

Installieren Sie die Schriftarten, die die Präsentationen verwenden, auf dem Server, oder verweisen Sie FontFolders auf einen Ordner, der sie enthält. Fehlende Schriftarten werden ohne Fehlermeldung substituiert.

CAD-Konfiguration

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative CAD‑Rendern; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfignew instancePDF‑Pfadeinstellungen.
boolExportPdfAfalseArchivierter PDF/A‑Ausgabe.
boolShowColortrueFarbe statt Monochrom.
boolWhiteBackgroundtrueWeißer statt schwarzer Hintergrund.
shortLineWidth25CAD‑Strichbreite.
boolShowLayoutsfalseLayout‑Registerkarten rendern.
boolShowModeltrueModellraum rendern.
boolCheck3DSolidtrue3D‑Körper verarbeiten.
boolExportAllLayoutsfalseAlle Layouts exportieren, überschreibe Modell‑/Layoutauswahl.
boolLimitMinimumSizefalseWendet MinimumSize an.
intMinimumSize700Minimale Ausgabengröße in Pixeln.
boolLimitMaximumSizefalseWendet MaximumSize an.
intMaximumSize700Maximale Ausgabengröße in Pixeln.
boolShowAllLayoutsDgnfalseAlle DGN‑Layouts einbeziehen.
boolAutomaticLayoutScalingtrueLayouts automatisch skalieren.
floatPdfMargins0.5PDF‑Rand in Zoll.
RenderQualityQualityImageLowRasterqualität: Low, Medium oder High.
RenderQualityQualityTextMediumTextqualität: Low, Medium oder High.

E‑Mail‑Konfiguration

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative E‑Mail‑Render; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
Encoding?EmailEncodingnullÜberschreibe Nachrichtenkodierung.
Encoding?SubjectEncodingnullÜberschreibe Betreffkodierung.
Encoding?BodyEncodingnullÜberschreibe Körperkodierung.
boolSkipExternalImagesfalseLade nicht remote referenzierte Bilder. Empfohlen für nicht vertrauenswürdige E‑Mails.
boolRemoveLastWhitePagefalseEntferne eine abschließende leere Seite.
boolUseAntiAliasingfalseAnti‑Aliasing aktivieren.
boolUseHighQualityRenderingfalseBevorzuge saubereres, langsameres Rendering.
TimeSpan?TimeZoneOffsetnullÜberschreibe die für Datumsangaben verwendete Zeitzone.
boolForcePageSizefalseErzwinge feste Seitenabmessungen.

Bild‑Konfiguration, Tiff‑Konfiguration und Psd‑Konfiguration

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 ungleich null unter 50 werden ignoriert.
ImageConfigTransparentPngtruePNG‑Transparenz erhalten; false verwendet einen weißen Hintergrund.
TiffConfigkeine zusätzlichen EigenschaftenDPI 200Verwendet nur BaseConfig; unterstützt mehrseitige TIFF.
PsdConfigMaxImagePixelSize3000Gleiche 0/Minimum‑50‑Validierung wie ImageConfig; Standard‑DPI ist 100.

Dicom‑Konfiguration

Formate: DCM, IMA. Standard effektives DPI: 100. Erfordert das DICOM‑Plugin. In diesem Paket werden DICOM‑Dateien vollständig gerendert, aber technische Metadaten sind nicht verfügbar — siehe DICOM‑Plugin.

TypEigenschaftStandardVerhalten
intHorizontalResolution100 effektivExplizites horizontales DPI; sonst ImageResolution, dann 100.
intVerticalResolution100 effektivExplizites vertikales DPI; sonst ImageResolution, dann 100.
intAnimationFrameDelayMs100Mehrrahmen‑Animationsverzögerung; GIF‑Timing verwendet Einheiten von 10 ms.
ushortLoopCount00 wiederholt sich unendlich; positive Werte stoppen nach dieser Anzahl.
DicomDisplayModeDisplayModeAnimationAndFramesAnimationOnly, FramesOnly oder kombinierte Übersicht plus statische Frames.

Txt‑Konfiguration

Format: TXT. Standard‑DPI: 200.

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

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

Projekt‑Konfiguration

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.
MppPaperSizePaperSizeLedgerProjekt‑Ausgabe‑Papiergröße.
MppTimeScaleTimeScaleMonthsDays oder Months.
MppFormatPresentationFormatGanttChartGanttChart, TaskUsage, ResourceUsage, ResourceSheet oder TaskSheet.

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

Visio‑Konfiguration

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

TypEigenschaftStandardVerhalten
boolDefaultRendertrueNative Diagramm‑Render; false verwendet die PDF‑Umleitung.
PdfConfigPdfConfigneue InstanzPDF‑Pfad‑Einstellungen.
boolExportPdfAtrueArchivierte PDF/A‑Ausgabe.

Html‑Konfiguration, Epub‑Konfiguration, Mht‑Konfiguration und Xps‑Konfiguration

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

KonfigurationFormateDefaultRenderZusätzliche Eigenschaften/Verhalten
HtmlConfigHTML, HTMtrueNative Darstellung; verwenden Sie false für einen textbasierten PDF‑Suchpfad.
EpubConfigEPUBtrueNative Darstellung; false verwendet PDF.
MhtConfigMHT, MHTMLtrue in der Klasse; false im automatischen KatalogDie normale Öffnung ohne Konfiguration verwendet die durchsuchbare PDF‑Umleitung. Eine explizit konstruierte Standardinstanz rendert nativ.
XpsConfigXPSfalseVerwendet standardmäßig den PDF‑Pfad; setzen Sie true für native Bilddarstellung.

Konfigurationsbeispiele nach Familie

csharp
BaseConfig[] configs =
{
    new PdfConfig
    {
        AllowSearch = true,
        ExtractHyperlinks = true,
        HyperlinksPageCount = 0
    },
    new WordConfig
    {
        PaperSize = DocPaperSize.A4,
        RemovePaperMargin = false,
        FontFolders = new[] { Path.Combine(AppContext.BaseDirectory, "Fonts") },
        AllowSearch = true
    },
    new ExcelConfig
    {
        PaperLandscape = true,
        AutoFitContents = true,
        CalculateFormula = true,
        SplitWorksheets = false,
        PrintGridlines = false
    },
    new PptConfig
    {
        FastLoad = true,
        FontFolders = new[] { Path.Combine(AppContext.BaseDirectory, "Fonts") },
        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-Umleitung → pixelgenaue native Textsuche
    ".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
    ".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
    _ => null // Zurückgreifen auf die Standardkonfiguration des Formats
};

War diese Seite hilfreich?