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. Formaty, które mogą przekierowywać przez PDF, udostępniają zagnieżdżony PdfConfig. W WordConfig, ExcelConfig i PptConfig właściwości AllowSearch i AllowCopy są właściwościami wygodnymi, które odczytują i zapisują zagnieżdżony PdfConfig.
DefaultRender = true wybiera natywny renderer formatu. W formatach z przekierowaniem PDF, false najpierw konwertuje do pamięciowego PDF, 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ślne | Zachowanie |
|---|---|---|---|
int | ImageResolution | 0 | 0 używa domyślnej rozdzielczości formatu. Poprawny zakres to 25‑300 DPI; nieprawidłowe przypisania są ignorowane. |
string | DocumentCulture | "" | Ustawienie regionalne dla dat i liczb. Niepuste wartości są przycinane; puste przypisania są ignorowane. |
string | Password | "" | Hasło dokumentu zabezpieczonego. DocOptions.Password jest tutaj kopiowane automatycznie. |
bool | ShowUI | true | Właściwość kompatybilności; bieżący renderer nie używa jej do sterowania paskiem narzędzi przeglądarki. |
bool | CachePages | true | Buforuje renderowane obrazy stron na czas sesji dokumentu. |
PdfConfig
Formaty: PDF. Domyślne DPI: 200.
| Typ | Właściwość | Domyślne | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Przełącznik kompatybilności. Bieżąca fabryka używa natywnej przeglądarki PDF. |
bool | AllowSearch | false | Tworzy/używa indeksu wyszukiwania tekstu w PDF. Wymaga licencji Search dla żądań. |
bool | AllowCopy | false | Zezwala na zaznaczanie i kopiowanie tekstu. |
bool | ExtractHyperlinks | false | Wyodrębnia prostokąty linków dla nakładek po stronie klienta. |
int | HyperlinksPageCount | 0 | Maksymalna liczba stron skanowanych w poszukiwaniu linków; 0 oznacza wszystkie strony. |
bool | CompressImages | false | Kompresuje osadzone obrazy przed renderowaniem. |
int | CompressQuality | 100 | Jakość JPEG używana przy włączonej kompresji. |
bool | ResizeImages | false | Zmienia rozmiar osadzonych obrazów przed renderowaniem. |
int | ResizeResolution | 300 | Docelowa rozdzielczość DPI dla zmienionych rozmiarowo obrazów. |
bool | CompressFast | false | Preferuje szybszą, niższą jakość ścieżkę kompresji. |
bool | FixInvalidImages | false | Próbuje naprawić nieprawidłowe osadzone obrazy. |
bool | SplitSegments | false | Łączy ponownie słowa podzielone na segmenty linii, aby poprawić wyszukiwanie/kopiowanie. |
showHyperlinks w ViewerConfig steruje nakładką po stronie klienta, natomiast 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ślne | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie Word; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia używane w ścieżce 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 | Usuwa marginesy stron dokumentu. |
bool | RenderPageColor | true | Zachowuje skonfigurowany kolor strony w Word; false renderuje białe strony. |
bool | ExportPdfA | false | Używa archiwalnego PDF/A w ścieżce PDF. |
Encoding? | FileEncoding | null | Zastępuje kodowanie źródła. |
string | FontInfo | "" | Informacje o zastępowaniu czcionek. |
string[]? | FontFolders | null | Dodatkowe katalogi czcionek, szczególnie przydatne w Linux/kontenerach. |
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ślne DPI: 200.
| Typ | Właściwość | Domyślne | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie arkusza; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia dla ś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śnia wyjście przez wykluczenie pustej zawartości. |
bool | CalculateFormula | true | Ponownie oblicza formuły przed renderowaniem. |
bool | ShowRowColumnHeaders | true | Dołącza nagłówki arkusza kalkulacyjnego. |
bool | ExportPdfA | false | Używa PDF/A w ścieżce PDF. |
bool | SplitWorksheets | false | Trzyma arkusze jako oddzielne grupy stron. |
bool | ShowEmptyWorkSheets | false | Dołącza puste arkusze. |
bool | ExportLandscape | false | Wymusza eksport w orientacji poziomej. |
bool | ExportOnePagePerSheet | false | Dopasowuje każdy arkusz do jednej strony wyjściowej. |
bool | MemoryOptimizationPreference | true | Redukuje szczytowe zużycie pamięci, potencjalnie kosztem nieco mniejszej prędkości. |
bool | AutoTrimWorksheetRenderRange | true | Renderuje tylko widoczny używany zakres, gdy nie istnieje wyraźny obszar druku. |
bool | AutoTrimPreserveExistingPrintArea | true | Zachowuje zdefiniowane w skoroszycie obszary druku podczas automatycznego przycinania. |
string? | PrintArea | null | Wyraźny zakres, np. "A1:Z100". |
bool | PrintGridlines | false | Drukuje linie siatki arkusza. |
bool | PrintHeadings | false | Drukuje nagłówki wierszy/kolumn. |
List<string> | SheetNames | empty | Ogranicza renderowanie do nazwanych arkuszy. |
CustomStyleCell? | CustomStyles | null | Opcjonalne nadpisania formatowania daty/liczby dziesiętnej/całkowitej. |
bool | AllowSearch | false | Deleguje do PdfConfig.AllowSearch. |
bool | AllowCopy | false | Deleguje do PdfConfig.AllowCopy. |
new ExcelConfig() ustawia SplitWorksheets na false; otwarcie pliku Excel bez wyraźnej konfiguracji używa katalogu formatów, który ustawia ją na true.
PptConfig
Formaty: PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. Domyślne DPI: 200.
| Typ | Właściwość | Domyślne | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie slajdu; false używa przekierowania PDF. |
bool | FastLoad | false | Unika renderowania pierwszego slajdu przy otwieraniu; używa metadanych i renderuje na żądanie. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia zachowania PDF/wyszukiwania. |
string | FontInfo | "" | Informacje o zastępowaniu czcionek. |
string[]? | FontFolders | null | Dodatkowe katalogi czcionek. |
bool | AllowSearch | false | Deleguje do PdfConfig.AllowSearch. |
bool | AllowCopy | false | Deleguje do PdfConfig.AllowCopy. |
W systemach Linux i macOS renderowanie prezentacji przy użyciu bieżącego silnika wymaga libgdiplus oraz System.Drawing.EnableUnixSupport=true. Zainstaluj czcionki używane w prezentacji lub podaj FontFolders.
CadConfig
Formaty: DWG, DXF, DGN. Domyślne DPI: 200.
| Typ | Właściwość | Domyślne | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie CAD; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia ścieżki PDF. |
bool | ExportPdfA | false | Wyjście archiwalne PDF/A. |
bool | ShowColor | true | Kolor zamiast monochromu. |
bool | WhiteBackground | true | Białe zamiast czarnego tła. |
short | LineWidth | 25 | Szerokość kreski CAD. |
bool | ShowLayouts | false | Renderuje zakładki układów. |
bool | ShowModel | true | Renderuje przestrzeń modelu. |
bool | Check3DSolid | true | Przetwarza bryły 3D. |
bool | ExportAllLayouts | false | Eksportuje wszystkie układy, nadpisując wybór modelu/układu. |
bool | LimitMinimumSize | false | Stosuje MinimumSize. |
int | MinimumSize | 700 | Minimalny rozmiar wyjścia w pikselach. |
bool | LimitMaximumSize | false | Stosuje MaximumSize. |
int | MaximumSize | 700 | Maksymalny rozmiar wyjścia w pikselach. |
bool | ShowAllLayoutsDgn | false | Dołącza wszystkie układy DGN. |
bool | AutomaticLayoutScaling | true | Automatycznie skaluj układy. |
float | PdfMargins | 0.5 | Margines PDF w calach. |
RenderQuality | QualityImage | Low | Jakość rastrowa: Low, Medium lub High. |
RenderQuality | QualityText | Medium | Jakość tekstu: Low, Medium lub High. |
EmailConfig
Formaty: EML, EMLX, MSG. Domyślne DPI: 200.
| Typ | Właściwość | Domyślne | 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ępuje kodowanie wiadomości. |
Encoding? | SubjectEncoding | null | Zastępuje kodowanie tematu. |
Encoding? | BodyEncoding | null | Zastępuje kodowanie treści. |
bool | SkipExternalImages | false | Nie ładuje zdalnie odwoływanych obrazów. Zalecane dla niezweryfikowanych e‑mail. |
bool | RemoveLastWhitePage | false | Usuwa końcową pustą stronę. |
bool | UseAntiAliasing | false | Włącza antyaliasing. |
bool | UseHighQualityRendering | false | Preferuje czystsze, wolniejsze renderowanie. |
TimeSpan? | TimeZoneOffset | null | Zastępuje strefę czasową używaną dla dat. |
bool | ForcePageSize | false | Wymusza 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. Domyślne DPI to 100.
| Konfiguracja | Właściwość | Domyślne | Zachowanie |
|---|---|---|---|
ImageConfig | MaxImagePixelSize | 3000 | Maksymalna szerokość/wysokość. 0 oznacza nieograniczone; niezerowe wartości poniżej 50 są ignorowane. |
ImageConfig | TransparentPng | true | Zachowuje 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 wielostronicowe TIFF. |
PsdConfig | MaxImagePixelSize | 3000 | Ta sama walidacja 0/minimum‑50 jak w ImageConfig; domyślne DPI to 100. |
DicomConfig
Formaty: DCM, IMA. Domyślne efektywne DPI: 100. Wymaga wtyczki DICOM.
| Typ | Właściwość | Domyślne | Zachowanie |
|---|---|---|---|
int | HorizontalResolution | 100 effective | Jawne DPI w poziomie; w przeciwnym razie ImageResolution, potem 100. |
int | VerticalResolution | 100 effective | Jawne DPI w pionie; w przeciwnym razie ImageResolution, potem 100. |
int | AnimationFrameDelayMs | 100 | Opóźnienie klatek animacji wieloklatkowej; timing GIF używa jednostek 10 ms. |
ushort | LoopCount | 0 | 0 pętli w nieskończoność; dodatnie wartości zatrzymują po podanej liczbie. |
DicomDisplayMode | DisplayMode | AnimationAndFrames | AnimationOnly, FramesOnly lub połączony podgląd plus statyczne klatki. |
TxtConfig
Format: TXT. Domyślne DPI: 200.
| Typ | Właściwość | Domyślne | 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 zaawansowanego układu strony.
ProjectConfig
Formaty: MPP, MPPX, MPX. Domyślne DPI: 200.
| Typ | Właściwość | Domyślne | 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 | Wyjście archiwalne 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. |
Aby uzyskać dokładne wyszukiwanie po współrzędnych tekstu, użyj DefaultRender = false.
VisioConfig
Formaty: VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. Domyślne DPI: 200.
| Typ | Właściwość | Domyślne | Zachowanie |
|---|---|---|---|
bool | DefaultRender | true | Natywne renderowanie diagramu; false używa przekierowania PDF. |
PdfConfig | PdfConfig | nowa instancja | Ustawienia ścieżki PDF. |
bool | ExportPdfA | true | Wyjście archiwalne 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 | Domyślnie używa ś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 = 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
}
};Wybór konfiguracji według rozszerzenia
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
};Czy ta strona była pomocna?