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

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

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

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

PdfConfig

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

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

WordConfig

Формати: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. DPI за замовчуванням: 200.

ExcelConfig

Формати: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. Типова роздільна здатність DPI: 200.

CustomStyleCell надає CustomStyleDateTime, CustomStyleNumberDecimal та CustomStyleNumberInteger, усі є nullable рядками.

new ExcelConfig() встановлює SplitWorksheets у false; відкриття Excel‑файлу без явної конфігурації використовує каталог форматів, який встановлює його у true.

PptConfig

Формати: PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. Типова роздільна здатність DPI: 200.

У Linux та macOS рендеринг презентацій поточним рушієм вимагає libgdiplus та System.Drawing.EnableUnixSupport=true. Встановіть шрифти, що використовуються у презентації, або вкажіть FontFolders.

CadConfig

Формати: DWG, DXF, DGN. Типова роздільна здатність DPI: 200.

EmailConfig

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

ImageConfig, TiffConfig та PsdConfig

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

DicomConfig

Формати: DCM, IMA. Ефективний DPI за замовчуванням: 100. Потрібний плагін DICOM.

TxtConfig

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

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

ProjectConfig

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

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

VisioConfig

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

HtmlConfig, EpubConfig, MhtConfig та XpsConfig

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

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

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
};