Konfiguracje formatów
Pełne opcje renderowania dla każdego formatu
Każdy dokument otwiera się z implementacją BaseConfig. Przekaż ją do OpenDocumentAsync lub pozwól katalogowi formatów utworzyć domyślną. Wszystkie klasy poniżej znajdują się w przestrzeni nazw Doconut.
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
AllowSearch = true,
AllowCopy = true,
ImageResolution = 150
});Dziedziczenie i zagnieżdżone ustawienia PDF
Każdy format dziedziczy pięć właściwości BaseConfig. Formatom, które mogą przekierowywać przez PDF, udostępniany jest zagnieżdżony PdfConfig. W WordConfig, ExcelConfig i PptConfig, AllowSearch oraz AllowCopy są właściwościami ułatwiającymi, które odczytują i zapisują zagnieżdżony PdfConfig.
DefaultRender = true wybiera natywny renderer formatu. W formatach z przekierowaniem PDF, false najpierw konwertuje do PDF w pamięci, a następnie używa przeglądarki PDF. Ta ścieżka jest często przydatna do wyszukiwania po współrzędnych tekstu, ale wymaga dodatkowej konwersji.
O ile nie zaznaczono inaczej, tabele pokazują domyślne wartości konstruktorów/właściwości. Automatyczny katalog formatów celowo nadpisuje dwie z nich: tworzy ExcelConfig z SplitWorksheets = true oraz MhtConfig z DefaultRender = false.
BaseConfig
| Typ | Właściwość | Domyślna | Zachowanie |
|---|---|---|---|
int | ImageResolution | 0 | 0 używa domyślnego formatu. Prawidłowy zakres wyraźny to 25‑300 DPI; nieprawidłowe przypisania są ignorowane. |
string | DocumentCulture | "" | Ustawienia regionalne dla dat i liczb. Niepuste wartości są przycinane; puste przypisania są ignorowane. |
string | Password | "" | Hasło dokumentu chronionego. DocOptions.Password jest tutaj kopiowane automatycznie. |
bool | ShowUI | true | Właściwość kompatybilności; bieżący renderer nie używa jej do kontrolowania paska narzędzi przeglądarki. |
bool | CachePages | true | Buforuj renderowane obrazy stron dla sesji dokumentu. |
PdfConfig
Formaty: PDF. Domyślne DPI: 200.
| Typ | Właściwość | Domyślna | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Przełącznik kompatybilności. Bieżąca fabryka używa natywnej przeglądarki PDF. |
bool | AllowSearch | false | Buduj/używaj indeksu wyszukiwania tekstu w PDF. Wymaga uprawnienia licencji Search dla żądań. |
bool | AllowCopy | false | Zezwalaj na operacje zaznaczania/kopiowania tekstu. |
bool | ExtractHyperlinks | false | Wyodrębniaj prostokąty linków dla nakładek klienta. |
int | HyperlinksPageCount | 0 | Maksymalna liczba stron skanowanych pod kątem linków; 0 oznacza każdą stronę. |
bool | CompressImages | false | Kompresuj osadzone obrazy przed renderowaniem. |
int | CompressQuality | 100 | Jakość JPEG używana, gdy włączona jest kompresja. |
bool | ResizeImages | false | Zmieniaj rozmiar osadzonych obrazów przed renderowaniem. |
int | ResizeResolution | 300 | Docelowe DPI dla zmienionych rozmiarów obrazów. |
bool | CompressFast | false | Preferuj szybszą, niższej jakości ścieżkę kompresji. |
bool | FixInvalidImages | false | Próbuj naprawić nieprawidłowe osadzone obrazy. |
bool | SplitSegments | false | Łącz ponownie słowa podzielone na segmenty linii, aby poprawić wyszukiwanie/kopiowanie. |
showHyperlinks w ViewerConfig kontroluje nakładkę klienta, podczas gdy ExtractHyperlinks kontroluje wyodrębnianie po stronie serwera. Włącz oba.
WordConfig
Formaty: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. Domyślne DPI: 200.
| Typ | Właściwość | Domyślna | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie Word; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia używane przez ścieżkę PDF/wyszukiwania. |
DocPaperSize | PaperSize | A4 | Rozmiar papieru wyjściowego. Użyj Custom z szerokością/wysokością. |
int | PaperWidth | 595 | Niestandardowa szerokość w punktach. |
int | PaperHeight | 841 | Niestandardowa wysokość w punktach. |
bool | RemovePaperMargin | false | Usuń marginesy stron dokumentu. |
bool | RenderPageColor | true | Zachowaj skonfigurowany kolor strony w Word; false renderuje białe strony. |
bool | ExportPdfA | false | Użyj archiwalnego PDF/A w ścieżce PDF. |
Encoding? | FileEncoding | null | Zastąp kodowanie źródłowe. |
string | FontInfo | "" | Informacje o podstawianiu czcionek. |
string[]? | FontFolders | null | Dodatkowe katalogi czcionek, szczególnie przydatne w Linux/containers. |
bool | AllowSearch | false | Deleguje do PdfConfig.AllowSearch. |
bool | AllowCopy | false | Deleguje do PdfConfig.AllowCopy. |
TableAutoFitBehavior | AutoFitAllTables | None | None, AutoFitToContents lub AutoFitToWindow. |
ExcelConfig
Formaty: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. Domyślna DPI: 200.
| Typ | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie arkusza; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia ścieżki PDF/wyszukiwania. |
ExcelPaperSize | PaperSize | PaperA4 | Rozmiar papieru wyjściowego. |
double | PaperMargins | 0.25 | Marginesy strony w calach. |
bool | PaperLandscape | true | Renderowanie arkusza w orientacji poziomej. |
bool | AutoFitContents | false | Automatyczne dopasowanie wysokości wierszy i szerokości kolumn. |
bool | RemoveEmptyContent | true | Zacieśnianie wyjścia przez wykluczenie pustej zawartości. |
bool | CalculateFormula | true | Przeliczenie formuł przed renderowaniem. |
bool | ShowRowColumnHeaders | true | Dołączenie nagłówków arkusza. |
bool | ExportPdfA | false | Użycie PDF/A na ścieżce PDF. |
bool | SplitWorksheets | false | Zachowanie arkuszy jako oddzielnych grup stron. |
bool | ShowEmptyWorkSheets | false | Dołączenie pustych arkuszy. |
bool | ExportLandscape | false | Wymuszenie eksportu w orientacji poziomej. |
bool | ExportOnePagePerSheet | false | Dopasowanie każdego arkusza do jednej strony wyjściowej. |
bool | MemoryOptimizationPreference | true | Redukcja szczytowego zużycia pamięci, potencjalnie kosztem nieco większej prędkości. |
bool | AutoTrimWorksheetRenderRange | true | Renderowanie tylko widocznego używanego zakresu, gdy nie istnieje wyraźny obszar wydruku. |
bool | AutoTrimPreserveExistingPrintArea | true | Zachowanie obszarów wydruku zdefiniowanych w skoroszycie podczas automatycznego przycinania. |
string? | PrintArea | null | Wyraźny zakres, taki jak "A1:Z100". |
bool | PrintGridlines | false | Drukowanie linii siatki arkusza. |
bool | PrintHeadings | false | Drukowanie nagłówków wierszy/kolumn. |
List<string> | SheetNames | puste | Ograniczenie renderowania do nazwanych arkuszy. |
CustomStyleCell? | CustomStyles | null | Opcjonalne nadpisania formatowania daty/liczby dziesiętnej/liczby całkowitej. |
bool | AllowSearch | false | Deleguje do PdfConfig.AllowSearch. |
bool | AllowCopy | false | Deleguje do PdfConfig.AllowCopy. |
CustomStyleCell udostępnia CustomStyleDateTime, CustomStyleNumberDecimal i CustomStyleNumberInteger, wszystkie jako łańcuchy dopuszczalne do wartości null.
new ExcelConfig() ustawia SplitWorksheets na false; otwarcie pliku Excel bez wyraźnej konfiguracji używa katalogu formatów, który ustawia to na true.
PptConfig
Formaty: PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. Domyślna DPI: 200.
| Typ | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie slajdu; false używa przekierowania PDF. |
bool | FastLoad | false | Unikanie renderowania pierwszego slajdu podczas otwierania; użycie metadanych i renderowanie na żądanie. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia zachowania PDF/wyszukiwania. |
string | FontInfo | "" | Informacje o podstawianiu czcionek. |
string[]? | FontFolders | null | Dodatkowe katalogi czcionek. |
bool | AllowSearch | false | Deleguje do PdfConfig.AllowSearch. |
bool | AllowCopy | false | Deleguje do PdfConfig.AllowCopy. |
Strony są rysowane czcionkami zainstalowanymi na serwerze. W systemie Linux zainstaluj czcionki używane w prezentacjach lub skieruj FontFolders do nich: brakująca czcionka jest zastępowana bez błędu, więc podziały linii mogą różnić się od Windows. fonts-liberation, fonts-crosextra-carlito i fonts-crosextra-caladea dostarczają zamienniki o zgodnych metrykach dla typowych czcionek Windows. Linux potrzebuje tylko libfontconfig1 (libgdiplus nie jest wymagany).
CadConfig
Formaty: DWG, DXF, DGN. Domyślna DPI: 200.
| Typ | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie CAD; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia ścieżki PDF. |
bool | ExportPdfA | false | Archiwalny wyjściowy PDF/A. |
bool | ShowColor | true | Kolor zamiast monochromu. |
bool | WhiteBackground | true | Białe tło zamiast czarnego. |
short | LineWidth | 25 | Szerokość kreski CAD. |
bool | ShowLayouts | false | Renderowanie zakładek układu. |
bool | ShowModel | true | Renderowanie przestrzeni modelu. |
bool | Check3DSolid | true | Przetwarzanie brył 3D. |
bool | ExportAllLayouts | false | Eksport wszystkich układów, nadpisując wybór model/układ. |
bool | LimitMinimumSize | false | Zastosowanie MinimumSize. |
int | MinimumSize | 700 | Minimalny rozmiar wyjścia w pikselach. |
bool | LimitMaximumSize | false | Zastosowanie MaximumSize. |
int | MaximumSize | 700 | Maksymalny rozmiar wyjścia w pikselach. |
bool | ShowAllLayoutsDgn | false | Dołączenie wszystkich układów DGN. |
bool | AutomaticLayoutScaling | true | Automatyczne skalowanie układów. |
float | PdfMargins | 0.5 | Margines PDF w calach. |
RenderQuality | QualityImage | Low | Jakość rastra: Low, Medium lub High. |
RenderQuality | QualityText | Medium | Jakość tekstu: Low, Medium lub High. |
EmailConfig
Formaty: EML, EMLX, MSG. Domyślna DPI: 200.
| Typ | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie e‑mail; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia ścieżki PDF. |
Encoding? | EmailEncoding | null | Zastąp kodowanie wiadomości. |
Encoding? | SubjectEncoding | null | Zastąp kodowanie tematu. |
Encoding? | BodyEncoding | null | Zastąp kodowanie treści. |
bool | SkipExternalImages | false | Nie ładuj zdalnie odwoływanych obrazów. Zalecane dla niepewnych e‑maili. |
bool | RemoveLastWhitePage | false | Usuń końcową pustą stronę. |
bool | UseAntiAliasing | false | Włącz antyaliasing. |
bool | UseHighQualityRendering | false | Preferuj czystsze, wolniejsze renderowanie. |
TimeSpan? | TimeZoneOffset | null | Zastąp strefę czasową używaną dla dat. |
bool | ForcePageSize | false | Wymuś stałe wymiary strony. |
ImageConfig, TiffConfig i PsdConfig
ImageConfig obejmuje JPG, JPEG, JPE, PNG, BMP, GIF, ICO, EPS, TGA, WEBP, CDR, CMX, DNG, EMF, WMF, AVIF i SVG. Jego domyślna DPI to 100.
| Konfiguracja | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
ImageConfig | MaxImagePixelSize | 3000 | Maksymalna szerokość/wysokość. 0 oznacza nieograniczone; niezerowe wartości poniżej 50 są ignorowane. |
ImageConfig | TransparentPng | true | Zachowaj przeźroczystość PNG; false używa białego tła. |
TiffConfig | brak dodatkowych właściwości | DPI 200 | Używa tylko BaseConfig; obsługuje wielostronicowy TIFF. |
PsdConfig | MaxImagePixelSize | 3000 | Ta sama walidacja 0/minimum-50 co ImageConfig; domyślna DPI to 100. |
DicomConfig
Formaty: DCM, IMA. Domyślna efektywna DPI: 100. Wymaga wtyczki DICOM.
| Typ | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
int | HorizontalResolution | 100 efektywna | Jawna pozioma DPI; w przeciwnym razie ImageResolution, potem 100. |
int | VerticalResolution | 100 efektywna | Jawna pionowa DPI; w przeciwnym razie ImageResolution, potem 100. |
int | AnimationFrameDelayMs | 100 | Opóźnienie animacji wieloklatkowej; czasowanie GIF używa jednostek 10 ms. |
ushort | LoopCount | 0 | 0 pętli w nieskończoność; dodatnie wartości zatrzymują po tej liczbie. |
DicomDisplayMode | DisplayMode | AnimationAndFrames | AnimationOnly, FramesOnly, lub połączony przegląd plus statyczne klatki. |
TxtConfig
Format: TXT. Domyślna DPI: 200.
| Typ | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
DocPaperSize | PaperSize | A4 | Rozmiar papieru wyjściowego. |
Encoding? | FileEncoding | null | null używa UTF-8. |
string | FontInformation | "" | Informacje o czcionce dla renderowania tekstu. |
Użyj WordConfig, gdy zwykły tekst wymaga bardziej rozbudowanego zachowania układu strony.
ProjectConfig
Formaty: MPP, MPPX, MPX. Domyślna DPI: 200.
| Typ | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywny obraz Gantt; false używa tekstowej ścieżki PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia ścieżki PDF. |
bool | ExportPdfA | true | Archiwalny wyjściowy PDF/A. |
MppPaperSize | PaperSize | Ledger | Rozmiar papieru wyjściowego projektu. |
MppTimeScale | TimeScale | Months | Days lub Months. |
MppFormat | PresentationFormat | GanttChart | GanttChart, TaskUsage, ResourceUsage, ResourceSheet, lub TaskSheet. |
Do dokładnego wyszukiwania po współrzędnych tekstu użyj DefaultRender = false.
VisioConfig
Formaty: VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. Domyślna DPI: 200.
| Typ | Właściwość | Domyślnie | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie diagramu; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia ścieżki PDF. |
bool | ExportPdfA | true | Archiwalny wyjściowy PDF/A. |
HtmlConfig, EpubConfig, MhtConfig i XpsConfig
Wszystkie cztery domyślnie mają 200 DPI i udostępniają zagnieżdżony PdfConfig.
| Konfiguracja | Formaty | DefaultRender | Dodatkowe właściwości/zachowanie |
|---|---|---|---|
HtmlConfig | HTML, HTM | true | Natywne renderowanie; użyj false dla tekstowej ścieżki wyszukiwania PDF. |
EpubConfig | EPUB | true | Natywne renderowanie; false używa PDF. |
MhtConfig | MHT, MHTML | true w klasie; false w automatycznym katalogu | Normalne otwarcie bez konfiguracji używa przekierowania PDF z możliwością wyszukiwania. Jawnie skonstruowana domyślna instancja renderuje natywnie. |
XpsConfig | XPS | false | Używa domyślnie ścieżki PDF; ustaw true dla natywnego renderowania obrazu. |
Przykłady konfiguracji według rodziny
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
}
];Wybór per-rozszerzenie
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 przekierowanie → dokładne do piksela natywne wyszukiwanie tekstu
".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
_ => null // przywróć domyślną konfigurację formatu
};Czy ta strona była pomocna?