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 Doconut‑Namespace.
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 eine verschachtelte PdfConfig bereit. In WordConfig, ExcelConfig und PptConfig sind AllowSearch und AllowCopy Komfort‑Eigenschaften, die die verschachtelte PdfConfig lesen und schreiben.
DefaultRender = true wählt den nativen Format‑Renderer. Bei Formaten mit einer PDF‑Umleitung konvertiert false zunächst in ein PDF im Speicher und verwendet anschließend den PDF‑Viewer. Dieser Pfad ist häufig nützlich für textkoordinatenbasierte Suche, 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
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
int | ImageResolution | 0 | 0 verwendet den Format‑Standard. Gültiger expliziter Bereich ist 25‑300 DPI; ungültige Zuweisungen werden ignoriert. |
string | DocumentCulture | "" | Gebietsschema für Datums‑ und Zahlenangaben. Nicht‑leere Werte werden getrimmt; leere Zuweisungen werden ignoriert. |
string | Password | "" | Passwort für geschützte Dokumente. DocOptions.Password wird hier automatisch kopiert. |
bool | ShowUI | true | Kompatibilitätseigenschaft; der aktuelle Renderer verwendet sie nicht zur Steuerung der Browser‑Symbolleiste. |
bool | CachePages | true | Zwischenspeichern gerenderter Seitenbilder für die Dokumentsitzung. |
PdfConfig
Formate: PDF. Standard‑DPI: 200.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
bool | DefaultRender | true | Kompatibilitätsschalter. Die aktuelle Fabrik verwendet den nativen PDF‑Viewer. |
bool | AllowSearch | false | Erstellen/Verwenden des PDF‑Textsuch‑Indexes. Erfordert die Lizenzfunktion Search für Anfragen. |
bool | AllowCopy | false | Erlaubt Textauswahl‑/Kopier‑Operationen. |
bool | ExtractHyperlinks | false | Extrahiert Link‑Rechtecke für Client‑Overlays. |
int | HyperlinksPageCount | 0 | Maximale Seitenzahl, die nach Links durchsucht wird; 0 bedeutet alle Seiten. |
bool | CompressImages | false | Komprimiert eingebettete Bilder vor dem Rendern. |
int | CompressQuality | 100 | JPEG‑Qualität, die bei aktivierter Kompression verwendet wird. |
bool | ResizeImages | false | Größenänderung eingebetteter Bilder vor dem Rendern. |
int | ResizeResolution | 300 | Ziel‑DPI für skalierte Bilder. |
bool | CompressFast | false | Bevorzugt den schnelleren, qualitativ geringeren Komprimierungspfad. |
bool | FixInvalidImages | false | Versucht, ungültige eingebettete Bilder zu reparieren. |
bool | SplitSegments | false | Fügt Wörter, die über Zeilenabschnitte hinweg getrennt wurden, wieder zusammen, um Suche/Kopie 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.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
bool | DefaultRender | true | Native‑Word‑Render; false verwendet die PDF‑Umleitung. |
PdfConfig | PdfConfig | new instance | Einstellungen, die vom PDF‑/Suchpfad verwendet werden. |
DocPaperSize | PaperSize | A4 | Ausgabepapiergröße. Verwenden Sie Custom mit Breite/Höhe. |
int | PaperWidth | 595 | Benutzerdefinierte Breite in Punkten. |
int | PaperHeight | 841 | Benutzerdefinierte Höhe in Punkten. |
bool | RemovePaperMargin | false | Entfernt Seitenränder des Dokuments. |
bool | RenderPageColor | true | Erhält die in Word konfigurierte Seitenfarbe; false rendert weiße Seiten. |
bool | ExportPdfA | false | Verwendet archiviertes PDF/A im PDF‑Pfad. |
Encoding? | FileEncoding | null | Überschreibt die Quell‑Kodierung. |
string | FontInfo | "" | Informationen zur Schriftart‑Substitution. |
string[]? | FontFolders | null | Zusätzliche Schriftverzeichnisse, besonders nützlich unter Linux/Containern. |
bool | AllowSearch | false | Leitet an PdfConfig.AllowSearch weiter. |
bool | AllowCopy | false | Leitet an PdfConfig.AllowCopy weiter. |
TableAutoFitBehavior | AutoFitAllTables | None | None, AutoFitToContents oder AutoFitToWindow. |
ExcelConfig
Formate: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. Standard‑DPI: 200.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
bool | DefaultRender | true | Native‑Tabellenblatt‑Render; false verwendet die PDF‑Umleitung. |
PdfConfig | PdfConfig | new instance | Einstellungen für den PDF‑/Suchpfad. |
ExcelPaperSize | PaperSize | PaperA4 | Ausgabepapiergröße. |
double | PaperMargins | 0.25 | Seitenränder in Zoll. |
bool | PaperLandscape | true | Querformat‑Tabellenblatt‑Render. |
bool | AutoFitContents | false | Automatisches Anpassen von Zeilenhöhen und Spaltenbreiten. |
bool | RemoveEmptyContent | true | Ausgabe straffen, indem leerer Inhalt ausgeschlossen wird. |
bool | CalculateFormula | true | Formeln vor dem Rendern neu berechnen. |
bool | ShowRowColumnHeaders | true | Tabellenkopfzeilen einbeziehen. |
bool | ExportPdfA | false | Verwendet PDF/A im PDF‑Pfad. |
bool | SplitWorksheets | false | Behält Arbeitsblätter als separate Seitengruppen. |
bool | ShowEmptyWorkSheets | false | Leere Arbeitsblätter einbeziehen. |
bool | ExportLandscape | false | Erzwingt Export im Querformat. |
bool | ExportOnePagePerSheet | false | Passt jedes Arbeitsblatt auf eine Ausgabeseite. |
bool | MemoryOptimizationPreference | true | Reduziert den Spitzen‑Speicherverbrauch, möglicherweise zulasten etwas Geschwindigkeit. |
bool | AutoTrimWorksheetRenderRange | true | Rendert nur den sichtbaren genutzten Bereich, wenn kein expliziter Druckbereich existiert. |
bool | AutoTrimPreserveExistingPrintArea | true | Erhält vom Arbeitsbuch definierte Druckbereiche während des automatischen Trimmens. |
string? | PrintArea | null | Expliziter Bereich, z. B. "A1:Z100". |
bool | PrintGridlines | false | Druckt Gitternetzlinien des Arbeitsblatts. |
bool | PrintHeadings | false | Druckt Zeilen‑/Spaltenüberschriften. |
List<string> | SheetNames | empty | Beschränkt das Rendern auf benannte Arbeitsblätter. |
CustomStyleCell? | CustomStyles | null | Optionale Überschreibungen für Datum/Dezimal/Ganzzahl‑Formatierung. |
bool | AllowSearch | false | Leitet an PdfConfig.AllowSearch weiter. |
bool | AllowCopy | false | Leitet an PdfConfig.AllowCopy weiter. |
CustomStyleCell stellt CustomStyleDateTime, CustomStyleNumberDecimal und CustomStyleNumberInteger bereit, alle 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.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
bool | DefaultRender | true | Native‑Folien‑Render; false verwendet die PDF‑Umleitung. |
bool | FastLoad | false | Vermeidet das Rendern der ersten Folie beim Öffnen; verwendet Metadaten und rendert bei Bedarf. |
PdfConfig | PdfConfig | new instance | Einstellungen für das PDF‑/Suchverhalten. |
string | FontInfo | "" | Informationen zur Schriftart‑Substitution. |
string[]? | FontFolders | null | Zusätzliche Schriftverzeichnisse. |
bool | AllowSearch | false | Leitet an PdfConfig.AllowSearch weiter. |
bool | AllowCopy | false | Leitet 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 Schriften oder stellen Sie FontFolders bereit.
CadConfig
Formate: DWG, DXF, DGN. Standard‑DPI: 200.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
bool | DefaultRender | true | Native‑CAD‑Render; false verwendet die PDF‑Umleitung. |
PdfConfig | PdfConfig | new instance | PDF‑Pfad‑Einstellungen. |
bool | ExportPdfA | false | Archivierte PDF/A‑Ausgabe. |
bool | ShowColor | true | Farbe statt Monochrom. |
bool | WhiteBackground | true | Weißer Hintergrund statt schwarzem. |
short | LineWidth | 25 | CAD‑Strichbreite. |
bool | ShowLayouts | false | Rendern von Layout‑Tabs. |
bool | ShowModel | true | Rendern des Modellraums. |
bool | Check3DSolid | true | Verarbeitung von 3D‑Solids. |
bool | ExportAllLayouts | false | Exportiert alle Layouts und überschreibt die Modell-/Layout‑Auswahl. |
bool | LimitMinimumSize | false | Wendet MinimumSize an. |
int | MinimumSize | 700 | Minimale Ausgabengröße in Pixeln. |
bool | LimitMaximumSize | false | Wendet MaximumSize an. |
int | MaximumSize | 700 | Maximale Ausgabengröße in Pixeln. |
bool | ShowAllLayoutsDgn | false | Alle DGN‑Layouts einbeziehen. |
bool | AutomaticLayoutScaling | true | Skaliert Layouts automatisch. |
float | PdfMargins | 0.5 | PDF‑Rand in Zoll. |
RenderQuality | QualityImage | Low | Rasterqualität: Low, Medium oder High. |
RenderQuality | QualityText | Medium | Textqualität: Low, Medium oder High. |
EmailConfig
Formate: EML, EMLX, MSG. Standard‑DPI: 200.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
bool | DefaultRender | true | Native‑E‑Mail‑Render; false verwendet die PDF‑Umleitung. |
PdfConfig | PdfConfig | new instance | PDF‑Pfad‑Einstellungen. |
Encoding? | EmailEncoding | null | Überschreibt die Nachrichten‑Kodierung. |
Encoding? | SubjectEncoding | null | Überschreibt die Betreff‑Kodierung. |
Encoding? | BodyEncoding | null | Überschreibt die Body‑Kodierung. |
bool | SkipExternalImages | false | Lädt keine remote referenzierten Bilder. Empfohlen für nicht vertrauenswürdige E‑Mails. |
bool | RemoveLastWhitePage | false | Entfernt eine nachfolgende leere Seite. |
bool | UseAntiAliasing | false | Anti‑Aliasing aktivieren. |
bool | UseHighQualityRendering | false | Bevorzugt saubereres, langsameres Rendering. |
TimeSpan? | TimeZoneOffset | null | Überschreibt die für Datumsangaben verwendete Zeitzone. |
bool | ForcePageSize | false | Erzwingt 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 ist 100.
| Config | Property | Default | Verhalten |
|---|---|---|---|
ImageConfig | MaxImagePixelSize | 3000 | Maximale Breite/Höhe. 0 bedeutet unbegrenzt; von Null verschiedene Werte unter 50 werden ignoriert. |
ImageConfig | TransparentPng | true | Erhält PNG‑Transparenz; false verwendet einen weißen Hintergrund. |
TiffConfig | no additional properties | DPI 200 | Verwendet nur BaseConfig; unterstützt mehrseitige TIFF. |
PsdConfig | MaxImagePixelSize | 3000 | Gleiche 0/Mindest‑50‑Validierung wie ImageConfig; Standard‑DPI ist 100. |
DicomConfig
Formate: DCM, IMA. Effektive Standard‑DPI: 100. Erfordert das DICOM‑Plugin.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
int | HorizontalResolution | 100 effective | Explizite horizontale DPI; sonst ImageResolution, dann 100. |
int | VerticalResolution | 100 effective | Explizite vertikale DPI; sonst ImageResolution, dann 100. |
int | AnimationFrameDelayMs | 100 | Mehrrahmen‑Animationsverzögerung; GIF‑Timing verwendet Einheiten von 10 ms. |
ushort | LoopCount | 0 | 0 schleift unendlich; positive Werte stoppen nach dieser Anzahl. |
DicomDisplayMode | DisplayMode | AnimationAndFrames | AnimationOnly, FramesOnly oder kombinierte Übersicht plus statische Frames. |
TxtConfig
Format: TXT. Standard‑DPI: 200.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
DocPaperSize | PaperSize | A4 | Ausgabepapiergröße. |
Encoding? | FileEncoding | null | null verwendet UTF-8. |
string | FontInformation | "" | Schriftinformationen für die Textdarstellung. |
Verwenden Sie WordConfig, wenn Klartext ein umfangreicheres Seitenlayout‑Verhalten benötigt.
ProjectConfig
Formate: MPP, MPPX, MPX. Standard‑DPI: 200.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
bool | DefaultRender | true | Native‑Gantt‑Bild; false verwendet einen textbasierten PDF‑Pfad. |
PdfConfig | PdfConfig | new instance | PDF‑Pfad‑Einstellungen. |
bool | ExportPdfA | true | Archivierte PDF/A‑Ausgabe. |
MppPaperSize | PaperSize | Ledger | Projekt‑Ausgabepapiergröße. |
MppTimeScale | TimeScale | Months | Days oder Months. |
MppFormat | PresentationFormat | GanttChart | GanttChart, TaskUsage, ResourceUsage, ResourceSheet oder TaskSheet. |
Für exakte textkoordinatenbasierte Suche verwenden Sie DefaultRender = false.
VisioConfig
Formate: VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. Standard‑DPI: 200.
| Typ | Eigenschaft | Standard | Verhalten |
|---|---|---|---|
bool | DefaultRender | true | Native‑Diagram‑Render; false verwendet die PDF‑Umleitung. |
PdfConfig | PdfConfig | new instance | PDF‑Pfad‑Einstellungen. |
bool | ExportPdfA | true | Archivierte PDF/A‑Ausgabe. |
HtmlConfig, EpubConfig, MhtConfig und XpsConfig
Alle vier haben standardmäßig 200 DPI und stellen eine verschachtelte PdfConfig bereit.
| Config | Formate | DefaultRender | Zusätzliche Eigenschaften/Verhalten |
|---|---|---|---|
HtmlConfig | HTML, HTM | true | Native‑Render; false für einen textbasierten PDF‑Suchpfad verwenden. |
EpubConfig | EPUB | true | Native‑Render; false verwendet PDF. |
MhtConfig | MHT, MHTML | true on the class; false in the automatic catalog | Der normale Öffnungsvorgang ohne Konfiguration verwendet die durchsuchbare PDF‑Umleitung. Eine explizit konstruierte Standardinstanz rendert nativ. |
XpsConfig | XPS | false | Verwendet standardmäßig den PDF‑Pfad; true für native Bilddarstellung setzen. |
Konfigurationsbeispiele nach Familie
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 nach Dateierweiterung
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?