Налаштування форматів
Повний набір параметрів рендерингу для кожного формату
Кожен документ відкривається з реалізацією BaseConfig. Передайте її у OpenDocumentAsync або дозвольте каталогу форматів створити типову. Усі класи нижче знаходяться у просторі імен Doconut.
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
AllowSearch = true,
AllowCopy = true,
ImageResolution = 150
});Наслідування та вкладені налаштування PDF
Кожен формат успадковує п'ять властивостей BaseConfig. Формати, які можуть перенаправлятися через PDF, надають вкладений PdfConfig. У WordConfig, ExcelConfig та PptConfig властивості AllowSearch і AllowCopy є зручними властивостями, що читають і записують у вкладений PdfConfig.
DefaultRender = true вибирає рендерер рідного формату. Для форматів з перенаправленням у PDF, false спочатку конвертує у PDF у пам'яті, а потім використовує переглядач PDF. Такий шлях часто корисний для пошуку за текстовими координатами, але вимагає додаткової конверсії.
Якщо не зазначено інше, у таблицях показані типові значення конструкторів/властивостей. Автоматичний каталог форматів навмисно перевизначає два з них: створює ExcelConfig з SplitWorksheets = true та MhtConfig з DefaultRender = false.
BaseConfig
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
int | ImageResolution | 0 | 0 використовує типове значення формату. Дійсний явний діапазон — 25‑300 DPI; недійсні присвоєння ігноруються. |
string | DocumentCulture | "" | Локаль для дат і чисел. Непорожні значення обрізаються; порожні присвоєння ігноруються. |
string | Password | "" | Пароль захищеного документа. DocOptions.Password копіюється сюди автоматично. |
bool | ShowUI | true | Властивість сумісності; поточний рендерер не використовує її для керування панеллю інструментів браузера. |
bool | CachePages | true | Кешувати зображення відрендерених сторінок протягом сеансу документа. |
PdfConfig
Формати: PDF. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Перемикач сумісності. Поточна фабрика використовує рідний переглядач PDF. |
bool | AllowSearch | false | Створює/використовує індекс пошуку тексту в PDF. Потрібна ліцензійна можливість Search для запитів. |
bool | AllowCopy | false | Дозволяє операції виділення/копіювання тексту. |
bool | ExtractHyperlinks | false | Витягує прямокутники посилань для накладок на клієнті. |
int | HyperlinksPageCount | 0 | Максимальна кількість сторінок, сканованих на посилання; 0 означає всі сторінки. |
bool | CompressImages | false | Стискає вбудовані зображення перед рендерингом. |
int | CompressQuality | 100 | Якість JPEG, що використовується при увімкненому стисненні. |
bool | ResizeImages | false | Змінює розмір вбудованих зображень перед рендерингом. |
int | ResizeResolution | 300 | Цільове DPI для змінених зображень. |
bool | CompressFast | false | Надає перевагу швидшому, менш якісному шляху стиснення. |
bool | FixInvalidImages | false | Спроба виправити недійсні вбудовані зображення. |
bool | SplitSegments | false | Об'єднує слова, розділені між сегментами рядка, для покращення пошуку/копіювання. |
showHyperlinks у ViewerConfig керує накладкою на клієнті, тоді як ExtractHyperlinks керує витягом на сервері. Увімкніть обидва.
WordConfig
Формати: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Рендеринг рідного Word; false використовує перенаправлення у PDF. |
PdfConfig | PdfConfig | new instance | Налаштування, що використовуються шляхом PDF/пошуку. |
DocPaperSize | PaperSize | A4 | Розмір вихідного листа. Використовуйте Custom з шириною/висотою. |
int | PaperWidth | 595 | Користувацька ширина у пунктах. |
int | PaperHeight | 841 | Користувацька висота у пунктах. |
bool | RemovePaperMargin | false | Видалити поля сторінки документа. |
bool | RenderPageColor | true | Зберігати налаштований колір сторінки Word; false рендерить білі сторінки. |
bool | ExportPdfA | false | Використовувати архівний PDF/A у шляху PDF. |
Encoding? | FileEncoding | null | Перевизначити кодування джерела. |
string | FontInfo | "" | Інформація про заміну шрифтів. |
string[]? | FontFolders | null | Додаткові каталоги шрифтів, особливо корисно в Linux/контейнерах. |
bool | AllowSearch | false | Делегується до PdfConfig.AllowSearch. |
bool | AllowCopy | false | Делегується до PdfConfig.AllowCopy. |
TableAutoFitBehavior | AutoFitAllTables | None | None, AutoFitToContents або AutoFitToWindow. |
ExcelConfig
Формати: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Рендеринг рідного листа; false використовує перенаправлення у PDF. |
PdfConfig | PdfConfig | new instance | Налаштування для шляху PDF/пошуку. |
ExcelPaperSize | PaperSize | PaperA4 | Розмір вихідного листа. |
double | PaperMargins | 0.25 | Поля сторінки в дюймах. |
bool | PaperLandscape | true | Рендеринг листа у альбомній орієнтації. |
bool | AutoFitContents | false | Автоматичне підгонка висоти рядків і ширини колонок. |
bool | RemoveEmptyContent | true | Стискає вихід, виключаючи порожній вміст. |
bool | CalculateFormula | true | Перераховує формули перед рендерингом. |
bool | ShowRowColumnHeaders | true | Включає заголовки рядків/стовпців. |
bool | ExportPdfA | false | Використовує PDF/A у шляху PDF. |
bool | SplitWorksheets | false | Зберігає листи як окремі групи сторінок. |
bool | ShowEmptyWorkSheets | false | Включає порожні листи. |
bool | ExportLandscape | false | Примусово експортує в альбомній орієнтації. |
bool | ExportOnePagePerSheet | false | Підганяє кожен лист до однієї вихідної сторінки. |
bool | MemoryOptimizationPreference | true | Зменшує пікове споживання пам'яті, можливо за рахунок швидкості. |
bool | AutoTrimWorksheetRenderRange | true | Рендерить лише видимий використаний діапазон, коли немає явної області друку. |
bool | AutoTrimPreserveExistingPrintArea | true | Зберігає визначені у книзі області друку під час автопідрізання. |
string? | PrintArea | null | Явний діапазон, наприклад "A1:Z100". |
bool | PrintGridlines | false | Друкує лінії сітки листа. |
bool | PrintHeadings | false | Друкує заголовки рядків/стовпців. |
List<string> | SheetNames | empty | Обмежує рендеринг іменованими листами. |
CustomStyleCell? | CustomStyles | null | Необов'язкові перевизначення форматування дати/десяткового/цілого числа. |
bool | AllowSearch | false | Делегується до PdfConfig.AllowSearch. |
bool | AllowCopy | false | Делегується до PdfConfig.AllowCopy. |
CustomStyleCell надає CustomStyleDateTime, CustomStyleNumberDecimal та CustomStyleNumberInteger, усі – nullable рядки.
new ExcelConfig() встановлює SplitWorksheets у false; відкриття Excel‑файлу без явної конфігурації використовує каталог форматів, який встановлює його у true.
PptConfig
Формати: PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Рендеринг рідних слайдів; false використовує перенаправлення у PDF. |
bool | FastLoad | false | Уникає рендерингу першого слайду під час відкриття; використовує метадані та рендерить за запитом. |
PdfConfig | PdfConfig | new instance | Налаштування поведінки PDF/пошуку. |
string | FontInfo | "" | Інформація про заміну шрифтів. |
string[]? | FontFolders | null | Додаткові каталоги шрифтів. |
bool | AllowSearch | false | Делегується до PdfConfig.AllowSearch. |
bool | AllowCopy | false | Делегується до PdfConfig.AllowCopy. |
У Linux та macOS рендеринг презентацій поточним рушієм вимагає libgdiplus та System.Drawing.EnableUnixSupport=true. Встановіть шрифти, що використовуються у презентації, або вкажіть FontFolders.
CadConfig
Формати: DWG, DXF, DGN. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Рендеринг рідного CAD; false використовує перенаправлення у PDF. |
PdfConfig | PdfConfig | new instance | Налаштування шляху PDF. |
bool | ExportPdfA | false | Вивід архівного PDF/A. |
bool | ShowColor | true | Колір, а не монохром. |
bool | WhiteBackground | true | Білий фон замість чорного. |
short | LineWidth | 25 | Ширина штриху CAD. |
bool | ShowLayouts | false | Відображати вкладки макетів. |
bool | ShowModel | true | Відображати простір моделі. |
bool | Check3DSolid | true | Обробляти 3D‑ті тверді тіла. |
bool | ExportAllLayouts | false | Експортувати всі макети, перевизначаючи вибір моделі/макету. |
bool | LimitMinimumSize | false | Застосовувати MinimumSize. |
int | MinimumSize | 700 | Мінімальний розмір виводу у пікселях. |
bool | LimitMaximumSize | false | Застосовувати MaximumSize. |
int | MaximumSize | 700 | Максимальний розмір виводу у пікселях. |
bool | ShowAllLayoutsDgn | false | Включати всі DGN‑макети. |
bool | AutomaticLayoutScaling | true | Автоматично масштабувати макети. |
float | PdfMargins | 0.5 | Поле PDF у дюймах. |
RenderQuality | QualityImage | Low | Якість растру: Low, Medium або High. |
RenderQuality | QualityText | Medium | Якість тексту: Low, Medium або High. |
EmailConfig
Формати: EML, EMLX, MSG. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Рендеринг рідної електронної пошти; false використовує перенаправлення у PDF. |
PdfConfig | PdfConfig | new instance | Налаштування шляху PDF. |
Encoding? | EmailEncoding | null | Перевизначити кодування повідомлення. |
Encoding? | SubjectEncoding | null | Перевизначити кодування теми. |
Encoding? | BodyEncoding | null | Перевизначити кодування тіла. |
bool | SkipExternalImages | false | Не завантажувати зовнішні зображення. Рекомендовано для недовіреної пошти. |
bool | RemoveLastWhitePage | false | Видаляти останню порожню сторінку. |
bool | UseAntiAliasing | false | Увімкнути згладжування. |
bool | UseHighQualityRendering | false | Надає перевагу чистішому, повільнішому рендерингу. |
TimeSpan? | TimeZoneOffset | null | Перевизначити часовий пояс, що використовується для дат. |
bool | ForcePageSize | false | Примусово встановити фіксовані розміри сторінки. |
ImageConfig, TiffConfig та PsdConfig
ImageConfig охоплює JPG, JPEG, JPE, PNG, BMP, GIF, ICO, EPS, TGA, WEBP, CDR, CMX, DNG, EMF, WMF, AVIF та SVG. Його типове DPI — 100.
| Конфіг | Властивість | Типове значення | Поведінка |
|---|---|---|---|
ImageConfig | MaxImagePixelSize | 3000 | Максимальна ширина/висота. 0 означає без обмежень; ненульові значення менше 50 ігноруються. |
ImageConfig | TransparentPng | true | Зберігати прозорість PNG; false використовує білий фон. |
TiffConfig | no additional properties | DPI 200 | Не має додаткових властивостей. DPI 200. Використовує лише BaseConfig; підтримує багатосторінковий TIFF. |
PsdConfig | MaxImagePixelSize | 3000 | Те ж саме 0/мінімум-50 перевірка, що й у ImageConfig; типове DPI — 100. |
DicomConfig
Формати: DCM, IMA. Типове ефективне DPI: 100. Потрібен плагін DICOM.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
int | HorizontalResolution | 100 effective | Явне горизонтальне DPI; якщо не вказано, використовується ImageResolution, потім 100. |
int | VerticalResolution | 100 effective | Явне вертикальне DPI; якщо не вказано, використовується ImageResolution, потім 100. |
int | AnimationFrameDelayMs | 100 | Затримка кадру багатокадрової анімації; таймінг GIF використовує одиниці по 10 мс. |
ushort | LoopCount | 0 | 0 — безкінечний цикл; позитивні значення зупиняються після зазначеної кількості. |
DicomDisplayMode | DisplayMode | AnimationAndFrames | AnimationOnly, FramesOnly або комбінований огляд плюс статичні кадри. |
TxtConfig
Формат: TXT. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
DocPaperSize | PaperSize | A4 | Розмір вихідного листа. |
Encoding? | FileEncoding | null | null використовує UTF-8. |
string | FontInformation | "" | Інформація про шрифт для рендерингу тексту. |
Використовуйте WordConfig, коли простий текст потребує більш розширеного макетування сторінки.
ProjectConfig
Формати: MPP, MPPX, MPX. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Рендеринг рідного зображення Ганта; false використовує текстовий шлях PDF. |
PdfConfig | PdfConfig | new instance | Налаштування шляху PDF. |
bool | ExportPdfA | true | Вивід архівного PDF/A. |
MppPaperSize | PaperSize | Ledger | Розмір вихідного листа проекту. |
MppTimeScale | TimeScale | Months | Days або Months. |
MppFormat | PresentationFormat | GanttChart | GanttChart, TaskUsage, ResourceUsage, ResourceSheet або TaskSheet. |
Для точного пошуку за текстовими координатами використовуйте DefaultRender = false.
VisioConfig
Формати: VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. Типове DPI: 200.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Рендеринг рідної діаграми; false використовує перенаправлення у PDF. |
PdfConfig | PdfConfig | new instance | Налаштування шляху PDF. |
bool | ExportPdfA | true | Вивід архівного PDF/A. |
HtmlConfig, EpubConfig, MhtConfig та XpsConfig
Усі чотири за замовчуванням мають 200 DPI і надають вкладений PdfConfig.
| Конфіг | Формати | DefaultRender | Додаткові властивості/поведінка |
|---|---|---|---|
HtmlConfig | HTML, HTM | true | Рендеринг рідний; використайте false для текстового шляху PDF пошуку. |
EpubConfig | EPUB | true | Рендеринг рідний; false використовує PDF. |
MhtConfig | MHT, MHTML | true on the class; false in the automatic catalog | true у класі; false у автоматичному каталозі |
XpsConfig | XPS | false | За замовчуванням використовує шлях PDF; встановіть true для рендерингу нативного зображення. |
Приклади конфігурацій за сімейством
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
}
};Вибір за розширенням
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
};Чи була ця сторінка корисною?