Конфигурации Форматов
Полные параметры рендеринга для каждого формата
Каждый документ открывается с реализацией 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, все строки, допускающие null.
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/minimum-50 как у ImageConfig; DPI по умолчанию — 100. |
DicomConfig
Форматы: DCM, IMA. Эффективный DPI по умолчанию: 100. Требуется плагин 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
Все четыре по умолчанию используют DPI 200 и раскрывают вложенный PdfConfig.
| Config | Форматы | 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 → пиксельно‑точный нативный поиск текста
".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
_ => null // возврат к конфигу по умолчанию формата
};Была ли эта страница полезной?