Конфігурації Форматів
Повні параметри рендерингу для кожного формату
Кожен документ відкривається з реалізацією 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 | новий екземпляр | Налаштування, що використовуються шляхом 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 | 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 | новий екземпляр | Налаштування для поведінки 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 | новий екземпляр | Налаштування шляху 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.
| Тип | Властивість | Типове значення | Поведінка |
|---|---|---|---|
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 | новий екземпляр | Налаштування шляху 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
Усі чотири за замовчуванням мають DPI 200 і містять вкладений 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 = ["/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
}
];Вибір конфігурації за розширенням файлу
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
};Чи була ця сторінка корисною?