Конфігурації Форматів
Повні параметри рендерингу для кожного формату
Кожен документ відкривається за допомогою реалізації 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 | новий екземпляр | Налаштування шляху 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 | порожньо | Обмежує рендеринг іменованими листами. |
CustomStyleCell? | CustomStyles | null | Необов'язкові перевизначення форматування дати/десяткових/цілих чисел. |
bool | AllowSearch | false | Делегується до PdfConfig.AllowSearch. |
bool | AllowCopy | false | Делегується до PdfConfig.AllowCopy. |
CustomStyleCell надає CustomStyleDateTime, CustomStyleNumberDecimal і CustomStyleNumberInteger, всі nullable strings.
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 | новий екземпляр | Налаштування поведінки PDF/пошуку. |
string | FontInfo | "" | Інформація про заміну шрифтів. |
string[]? | FontFolders | null | Додаткові каталоги шрифтів. |
bool | AllowSearch | false | Делегується до PdfConfig.AllowSearch. |
bool | AllowCopy | false | Делегується до PdfConfig.AllowCopy. |
Сторінки малюються шрифтами, встановленими на сервері. У Linux встановіть шрифти, які використовують презентації, або вкажіть FontFolders на них: відсутній шрифт замінюється без помилки, тому розриви рядків можуть відрізнятися від Windows. fonts-liberation, fonts-crosextra-carlito і fonts-crosextra-caladea надають метрично сумісні замінники для поширених шрифтів Windows. Linux потребує лише libfontconfig1 (libgdiplus не потрібен).
CadConfig
Формати: DWG, DXF, DGN. Типова роздільна здатність DPI: 200.
| Тип | Властивість | За замовчуванням | Поведінка |
|---|---|---|---|
bool | DefaultRender | true | Рендеринг CAD у рідному форматі; false використовує перенаправлення PDF. |
PdfConfig | PdfConfig | новий екземпляр | Налаштування шляху 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 | новий екземпляр | Налаштування шляху 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 | без додаткових властивостей | DPI 200 | Використовує лише BaseConfig; підтримує багатосторінковий TIFF. |
PsdConfig | MaxImagePixelSize | 3000 | Те саме 0/мінімальна-50 валідація, що й у ImageConfig; типова роздільна здатність DPI становить 100. |
DicomConfig
Формати: DCM, IMA. Типова ефективна роздільна здатність DPI: 100. Потрібен плагін DICOM. У цьому пакеті файли DICOM рендеряться повністю, але технічні метадані недоступні — дивіться Плагін DICOM.
| Тип | Властивість | Типово | Поведінка |
|---|---|---|---|
int | HorizontalResolution | 100 ефективна | Явна горизонтальна роздільна здатність DPI; інакше ImageResolution, потім 100. |
int | VerticalResolution | 100 ефективна | Явна вертикальна роздільна здатність 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 | Рідне зображення Gantt; false використовує текстовий шлях PDF. |
PdfConfig | PdfConfig | новий екземпляр | Налаштування шляху 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 | новий екземпляр | Налаштування шляху 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 у класі; false в автоматичному каталозі | Звичайне відкриття без налаштувань використовує перенаправлення PDF з можливістю пошуку. Явно створений екземпляр за замовчуванням рендериться у рідному форматі. |
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 → піксельно-точний нативний пошук тексту
".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
_ => null // повернутись до типової конфігурації формату
};Чи була ця сторінка корисною?