Конфігурації Форматів

Повний набір параметрів рендерингу для кожного формату

Кожен документ відкривається за допомогою реалізації BaseConfig. Передайте її до OpenDocumentAsync або дозвольте каталогу форматів створити типову. Усі класи нижче знаходяться у просторі імен Doconut.

Цей окремий простір імен новий. Попередня бібліотека .NET Standard розподіляла ці типи між Doconut.Configs, Doconut.Configs.View та Doconut.Models. Назви типів не змінилися — у більшості файлів зміна полягає у видаленні двох рядків using. Дивіться посібник з міграції.

csharp
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

ТипВластивістьТиповеПоведінка
intImageResolution00 використовує типове значення формату. Дійсний явний діапазон — 25‑300 DPI; недійсні призначення ігноруються.
stringDocumentCulture""Локаль для дат і чисел. Непорожні значення обрізаються; порожні призначення ігноруються.
stringPassword""Пароль захищеного документа. DocOptions.Password копіюється сюди автоматично.
boolShowUItrueВластивість сумісності; поточний рендерер не використовує її для керування панеллю інструментів браузера.
boolCachePagestrueКешувати зображення відрендерених сторінок протягом сеансу документа.

PdfConfig

Формати: PDF. Типове DPI: 200.

ТипВластивістьТиповеПоведінка
boolDefaultRendertrueПеремикач сумісності. Поточна фабрика використовує рідний переглядач PDF.
boolAllowSearchfalseСтворює/використовує індекс пошуку тексту в PDF. Потрібна можливість ліцензії Search для запитів.
boolAllowCopyfalseДозволяє операції виділення/копіювання тексту.
boolExtractHyperlinksfalseВитягує прямокутники посилань для накладок клієнта.
intHyperlinksPageCount0Максимальна кількість сторінок, сканованих для посилань; 0 означає кожну сторінку.
boolCompressImagesfalseСтискає вбудовані зображення перед рендерингом.
intCompressQuality100Якість JPEG, що використовується при увімкненому стисненні.
boolResizeImagesfalseЗмінює розмір вбудованих зображень перед рендерингом.
intResizeResolution300Цільове DPI для змінених зображень.
boolCompressFastfalseВіддає перевагу швидшому, менш якісному шляху стиснення.
boolFixInvalidImagesfalseСпроба виправити недійсні вбудовані зображення.
boolSplitSegmentsfalseОб'єднує слова, розділені між сегментами рядка, для покращення пошуку/копіювання.

showHyperlinks у ViewerConfig керує накладкою клієнта, тоді як ExtractHyperlinks керує витягом на сервері. Увімкніть обидва.

WordConfig

Формати: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. Типове DPI: 200.

ТипВластивістьТиповеПоведінка
boolDefaultRendertrueРідний рендер Word; false використовує перенаправлення PDF.
PdfConfigPdfConfigновий екземплярНалаштування, що використовуються шляхом PDF/пошуку.
DocPaperSizePaperSizeA4Розмір вихідного паперу. Використовуйте Custom з шириною/висотою.
intPaperWidth595Користувацька ширина у пунктах.
intPaperHeight841Користувацька висота у пунктах.
boolRemovePaperMarginfalseВидалити поля сторінки документа.
boolRenderPageColortrueЗберегти налаштований колір сторінки Word; false рендерить білі сторінки.
boolExportPdfAfalseВикористовувати архівний PDF/A у шляху PDF.
Encoding?FileEncodingnullПеревизначити кодування джерела.
stringFontInfo""Інформація про заміну шрифтів.
string[]?FontFoldersnullДодаткові каталоги шрифтів — корисно на сервері, який не містить шрифтів, що використовуються в документах.
boolAllowSearchfalseДелегує PdfConfig.AllowSearch.
boolAllowCopyfalseДелегує PdfConfig.AllowCopy.
TableAutoFitBehaviorAutoFitAllTablesNoneNone, AutoFitToContents або AutoFitToWindow.

ExcelConfig

Формати: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. DPI за замовчуванням: 200.

ТипВластивістьЗа замовчуваннямПоведінка
boolDefaultRendertrueРендеринг листа у рідному форматі; false використовує перенаправлення на PDF.
PdfConfigPdfConfigновий екземплярНалаштування шляху PDF/пошуку.
ExcelPaperSizePaperSizePaperA4Розмір вихідного паперу.
doublePaperMargins0.25Поля сторінки в дюймах.
boolPaperLandscapetrueРендеринг листа у альбомній орієнтації.
boolAutoFitContentsfalseАвтоматичне підгонка висоти рядків і ширини колонок.
boolRemoveEmptyContenttrueСкорочення вихідних даних шляхом виключення порожнього вмісту.
boolCalculateFormulatrueПерерахунок формул перед рендерингом.
boolShowRowColumnHeaderstrueВключення заголовків електронних таблиць.
boolExportPdfAfalseВикористання PDF/A у шляху PDF.
boolSplitWorksheetsfalseЗбереження листів як окремих груп сторінок.
boolShowEmptyWorkSheetsfalseВключення порожніх листів.
boolExportLandscapefalseПримусове експортування в альбомній орієнтації.
boolExportOnePagePerSheetfalseПідгонка кожного листа до однієї вихідної сторінки.
boolMemoryOptimizationPreferencetrueЗменшення пікового використання пам’яті, можливо за рахунок швидкості.
boolAutoTrimWorksheetRenderRangetrueРендеринг лише видимого використаного діапазону, якщо явна область друку не вказана.
boolAutoTrimPreserveExistingPrintAreatrueЗбереження областей друку, визначених у книзі, під час автоматичного обрізання.
string?PrintAreanullЯвний діапазон, наприклад "A1:Z100".
boolPrintGridlinesfalseДрук сітки листа.
boolPrintHeadingsfalseДрук заголовків рядків/стовпців.
List<string>SheetNamesпорожнійОбмеження рендерингу іменованими листами.
CustomStyleCell?CustomStylesnullДодаткові перевизначення форматування дати/десяткових/цілих чисел.
boolAllowSearchfalseДелегується до PdfConfig.AllowSearch.
boolAllowCopyfalseДелегується до 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.

ТипВластивістьЗа замовчуваннямПоведінка
boolDefaultRendertrueРендеринг слайдів у рідному форматі; false використовує перенаправлення на PDF.
boolFastLoadfalseУникати рендерингу першого слайду під час відкриття; використати метадані та рендерити за запитом.
PdfConfigPdfConfigновий екземплярНалаштування поведінки PDF/пошуку.
stringFontInfo""Інформація про підстановку шрифтів.
string[]?FontFoldersnullДодаткові каталоги шрифтів.
boolAllowSearchfalseДелегується до PdfConfig.AllowSearch.
boolAllowCopyfalseДелегується до PdfConfig.AllowCopy.

Встановіть шрифти, які використовуються у презентаціях, на сервері, або вкажіть FontFolders на теку, що їх містить. Відсутні шрифти підміняються без жодної помилки.

CadConfig

Формати: DWG, DXF, DGN. DPI за замовчуванням: 200.

ТипВластивістьЗа замовчуваннямПоведінка
boolDefaultRendertrueРендеринг CAD у рідному форматі; false використовує перенаправлення на PDF.
PdfConfigPdfConfigновий екземплярНалаштування шляху PDF.
boolExportPdfAfalseАрхівний вихід у форматі PDF/A.
boolShowColortrueКольоровий, а не монохромний.
boolWhiteBackgroundtrueБілий фон замість чорного.
shortLineWidth25Ширина штриху CAD.
boolShowLayoutsfalseРендеринг вкладок макету.
boolShowModeltrueРендеринг простору моделі.
boolCheck3DSolidtrueОбробка 3D‑тіл.
boolExportAllLayoutsfalseЕкспорт усіх макетів, перевизначаючи вибір моделі/макету.
boolLimitMinimumSizefalseЗастосування MinimumSize.
intMinimumSize700Мінімальний розмір виходу в пікселях.
boolLimitMaximumSizefalseЗастосування MaximumSize.
intMaximumSize700Максимальний розмір виходу в пікселях.
boolShowAllLayoutsDgnfalseВключення всіх DGN‑макетів.
boolAutomaticLayoutScalingtrueАвтоматичне масштабування макетів.
floatPdfMargins0.5Поля PDF у дюймах.
RenderQualityQualityImageLowЯкість растру: Low, Medium або High.
RenderQualityQualityTextMediumЯкість тексту: Low, Medium або High.

EmailConfig

Формати: EML, EMLX, MSG. DPI за замовчуванням: 200.

ТипВластивістьЗа замовчуваннямПоведінка
boolDefaultRendertrueРендеринг електронної пошти у рідному вигляді; false використовує перенаправлення PDF.
PdfConfigPdfConfigновий екземплярНалаштування шляху PDF.
Encoding?EmailEncodingnullПеревизначити кодування повідомлення.
Encoding?SubjectEncodingnullПеревизначити кодування теми.
Encoding?BodyEncodingnullПеревизначити кодування тіла.
boolSkipExternalImagesfalseНе завантажувати віддалено посилані зображення. Рекомендовано для недовіреної електронної пошти.
boolRemoveLastWhitePagefalseВидалити останню порожню сторінку.
boolUseAntiAliasingfalseУвімкнути згладжування.
boolUseHighQualityRenderingfalseНадавати перевагу чистішому, повільнішому рендерингу.
TimeSpan?TimeZoneOffsetnullПеревизначити часовий пояс, що використовується для дат.
boolForcePageSizefalseПримусово встановити фіксовані розміри сторінки.

ImageConfig, TiffConfig, і PsdConfig

ImageConfig охоплює JPG, JPEG, JPE, PNG, BMP, GIF, ICO, EPS, TGA, WEBP, CDR, CMX, DNG, EMF, WMF, AVIF та SVG. DPI за замовчуванням: 100.

КонфігураціяВластивістьЗа замовчуваннямПоведінка
ImageConfigMaxImagePixelSize3000Максимальна ширина/висота. 0 означає необмежено; ненульові значення нижче 50 ігноруються.
ImageConfigTransparentPngtrueЗберігати прозорість PNG; false використовує білий фон.
TiffConfigнемає додаткових властивостейDPI 200Використовує лише BaseConfig; підтримує багатосторінковий TIFF.
PsdConfigMaxImagePixelSize3000Те ж 0/мінімальна-50 валідація, що і у ImageConfig; DPI за замовчуванням: 100.

DicomConfig

Формати: DCM, IMA. Типовий ефективний DPI: 100. Потрібен плагін DICOM. У цьому пакеті файли DICOM рендеряться повністю, але технічні метадані недоступні — дивіться Плагін DICOM.

ТипВластивістьЗа замовчуваннямПоведінка
intHorizontalResolution100 ефективнийЯвний горизонтальний DPI; інакше ImageResolution, потім 100.
intVerticalResolution100 ефективнийЯвний вертикальний DPI; інакше ImageResolution, потім 100.
intAnimationFrameDelayMs100Затримка анімації багатокадрових зображень; таймінг GIF використовує одиниці 10 мс.
ushortLoopCount00 зациклюється назавжди; позитивні значення зупиняються після вказаної кількості.
DicomDisplayModeDisplayModeAnimationAndFramesAnimationOnly, FramesOnly, або комбінований огляд плюс статичні кадри.

TxtConfig

Формат: TXT. DPI за замовчуванням: 200.

ТипВластивістьЗа замовчуваннямПоведінка
DocPaperSizePaperSizeA4Розмір вихідного паперу.
Encoding?FileEncodingnullnull використовує UTF-8.
stringFontInformation""Інформація про шрифти для рендерингу тексту.

Використовуйте WordConfig, коли простий текст потребує більш розширеної поведінки розмітки сторінки.

ProjectConfig

Формати: MPP, MPPX, MPX. DPI за замовчуванням: 200.

ТипВластивістьЗа замовчуваннямПоведінка
boolDefaultRendertrueРідне зображення Gantt; false використовує текстовий шлях PDF.
PdfConfigPdfConfigновий екземплярНалаштування шляху PDF.
boolExportPdfAtrueАрхівний вихід PDF/A.
MppPaperSizePaperSizeLedgerРозмір вихідного паперу проекту.
MppTimeScaleTimeScaleMonthsDays або Months.
MppFormatPresentationFormatGanttChartGanttChart, TaskUsage, ResourceUsage, ResourceSheet, або TaskSheet.

Для точного пошуку за текстовими координатами використовуйте DefaultRender = false.

VisioConfig

Формати: VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. DPI за замовчуванням: 200.

ТипВластивістьЗа замовчуваннямПоведінка
boolDefaultRendertrueРідний рендеринг діаграми; false використовує перенаправлення PDF.
PdfConfigPdfConfigновий екземплярНалаштування шляху PDF.
boolExportPdfAtrueАрхівний вихід PDF/A.

HtmlConfig, EpubConfig, MhtConfig, і XpsConfig

Усі чотири за замовчуванням мають DPI 200 і відкривають вкладений PdfConfig.

КонфігураціяФорматиDefaultRenderДодаткові властивості/поведінка
HtmlConfigHTML, HTMtrueРідний рендеринг; використайте false для текстового шляху пошуку PDF.
EpubConfigEPUBtrueРідний рендеринг; false використовує PDF.
MhtConfigMHT, MHTMLtrue у класі; false в автоматичному каталозіЗвичайне відкриття без налаштувань використовує перенаправлення PDF з можливістю пошуку. Явно створений екземпляр за замовчуванням рендериться рідно.
XpsConfigXPSfalseЗа замовчуванням використовує шлях PDF; встановіть true для рідного рендерингу зображень.

Приклади конфігурації за сімейством

csharp
BaseConfig[] configs =
{
    new PdfConfig
    {
        AllowSearch = true,
        ExtractHyperlinks = true,
        HyperlinksPageCount = 0
    },
    new WordConfig
    {
        PaperSize = DocPaperSize.A4,
        RemovePaperMargin = false,
        FontFolders = new[] { Path.Combine(AppContext.BaseDirectory, "Fonts") },
        AllowSearch = true
    },
    new ExcelConfig
    {
        PaperLandscape = true,
        AutoFitContents = true,
        CalculateFormula = true,
        SplitWorksheets = false,
        PrintGridlines = false
    },
    new PptConfig
    {
        FastLoad = true,
        FontFolders = new[] { Path.Combine(AppContext.BaseDirectory, "Fonts") },
        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
    }
};

Вибір за розширенням

csharp
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 перенаправлення → піксельно-точний нативний пошук тексту
    ".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
    ".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
    _ => null // повернутися до типових налаштувань формату default config
};

Чи була ця сторінка корисною?