Configurações de Formato

Opções completas de renderização por formato

Todo documento abre com uma implementação de BaseConfig. Passe uma para OpenDocumentAsync ou deixe o catálogo de formatos criar sua padrão. Todas as classes abaixo estão no namespace Doconut.

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true,
    ImageResolution = 150
});

Herança e configurações PDF aninhadas

Cada formato herda as cinco propriedades de BaseConfig. Formatos que podem redirecionar através de PDF expõem um PdfConfig aninhado. Em WordConfig, ExcelConfig e PptConfig, AllowSearch e AllowCopy são propriedades de conveniência que leem e gravam o PdfConfig aninhado.

DefaultRender = true seleciona o renderizador nativo do formato. Em formatos com redirecionamento para PDF, false converte primeiro para um PDF em memória e então usa o visualizador de PDF. Esse caminho costuma ser útil para busca por coordenadas de texto, mas custa uma conversão extra.

Salvo indicação em contrário, as tabelas mostram os valores padrão de construtores/propriedades. O catálogo automático de formatos substitui deliberadamente dois deles: ele cria ExcelConfig com SplitWorksheets = true e MhtConfig com DefaultRender = false.

BaseConfig

TipoPropriedadePadrãoComportamento
intImageResolution00 usa o padrão do formato. Faixa explícita válida é 25-300 DPI; atribuições inválidas são ignoradas.
stringDocumentCulture""Local para datas e números. Valores não vazios são aparados; atribuições vazias são ignoradas.
stringPassword""Senha de documento protegido. DocOptions.Password é copiada aqui automaticamente.
boolShowUItruePropriedade de compatibilidade; o renderizador atual não a usa para controlar a barra de ferramentas do navegador.
boolCachePagestrueArmazena em cache imagens de páginas renderizadas para a sessão do documento.

PdfConfig

Formatos: PDF. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
boolDefaultRendertrueChave de compatibilidade. A fábrica atual usa o visualizador PDF nativo.
boolAllowSearchfalseConstrói/usa o índice de busca de texto PDF. Requer a capacidade de licença Search para solicitações.
boolAllowCopyfalsePermite operações de seleção/cópia de texto.
boolExtractHyperlinksfalseExtrai retângulos de links para sobreposições do cliente.
intHyperlinksPageCount0Máximo de páginas escaneadas para links; 0 significa todas as páginas.
boolCompressImagesfalseCompacta imagens incorporadas antes da renderização.
intCompressQuality100Qualidade JPEG usada quando a compactação está habilitada.
boolResizeImagesfalseRedimensiona imagens incorporadas antes da renderização.
intResizeResolution300DPI alvo para imagens redimensionadas.
boolCompressFastfalsePrefere o caminho de compactação mais rápido e de menor qualidade.
boolFixInvalidImagesfalseTenta reparar imagens incorporadas inválidas.
boolSplitSegmentsfalseReúne palavras divididas entre segmentos de linha para melhorar busca/cópia.

showHyperlinks em ViewerConfig controla a sobreposição do cliente, enquanto ExtractHyperlinks controla a extração no servidor. Ative ambos.

WordConfig

Formatos: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
boolDefaultRendertrueRenderização nativa do Word; false usa o redirecionamento PDF.
PdfConfigPdfConfignew instanceConfigurações usadas pelo caminho PDF/busca.
DocPaperSizePaperSizeA4Tamanho de papel de saída. Use Custom com largura/altura.
intPaperWidth595Largura personalizada em pontos.
intPaperHeight841Altura personalizada em pontos.
boolRemovePaperMarginfalseRemove margens de página do documento.
boolRenderPageColortruePreserva a cor de página configurada no Word; false renderiza páginas brancas.
boolExportPdfAfalseUsa PDF/A de arquivamento no caminho PDF.
Encoding?FileEncodingnullSubstitui a codificação de origem.
stringFontInfo""Informações de substituição de fonte.
string[]?FontFoldersnullDiretórios de fontes adicionais, especialmente úteis em Linux/containers.
boolAllowSearchfalseDelegado a PdfConfig.AllowSearch.
boolAllowCopyfalseDelegado a PdfConfig.AllowCopy.
TableAutoFitBehaviorAutoFitAllTablesNoneNone, AutoFitToContents ou AutoFitToWindow.

ExcelConfig

Formatos: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
boolDefaultRendertrueRenderização nativa da planilha; false usa o redirecionamento PDF.
PdfConfigPdfConfignew instanceConfigurações para o caminho PDF/busca.
ExcelPaperSizePaperSizePaperA4Tamanho de papel de saída.
doublePaperMargins0.25Margens de página em polegadas.
boolPaperLandscapetrueRenderização da planilha em paisagem.
boolAutoFitContentsfalseAutoajuste de alturas de linhas e larguras de colunas.
boolRemoveEmptyContenttrueAperta a saída excluindo conteúdo vazio.
boolCalculateFormulatrueRecalcula fórmulas antes da renderização.
boolShowRowColumnHeaderstrueInclui cabeçalhos da planilha.
boolExportPdfAfalseUsa PDF/A no caminho PDF.
boolSplitWorksheetsfalseMantém planilhas como grupos de páginas separados.
boolShowEmptyWorkSheetsfalseInclui planilhas vazias.
boolExportLandscapefalseForça exportação em paisagem.
boolExportOnePagePerSheetfalseAjusta cada planilha a uma página de saída.
boolMemoryOptimizationPreferencetrueReduz o pico de memória, potencialmente trocando alguma velocidade.
boolAutoTrimWorksheetRenderRangetrueRenderiza apenas o intervalo usado visível quando não existe área de impressão explícita.
boolAutoTrimPreserveExistingPrintAreatruePreserva áreas de impressão definidas na pasta de trabalho durante o auto‑trim.
string?PrintAreanullIntervalo explícito como "A1:Z100".
boolPrintGridlinesfalseImprime linhas de grade da planilha.
boolPrintHeadingsfalseImprime cabeçalhos de linhas/colunas.
List<string>SheetNamesemptyRestringe a renderização a planilhas nomeadas.
CustomStyleCell?CustomStylesnullSubstituições opcionais de formatação de data/decimal/integer.
boolAllowSearchfalseDelegado a PdfConfig.AllowSearch.
boolAllowCopyfalseDelegado a PdfConfig.AllowCopy.

CustomStyleCell expõe CustomStyleDateTime, CustomStyleNumberDecimal e CustomStyleNumberInteger, todos strings anuláveis.

new ExcelConfig() define SplitWorksheets como false; abrir um arquivo Excel sem configuração explícita usa o catálogo de formatos, que o define como true.

PptConfig

Formatos: PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
boolDefaultRendertrueRenderização nativa do slide; false usa o redirecionamento PDF.
boolFastLoadfalseEvita renderizar o primeiro slide durante a abertura; usa metadados e renderiza sob demanda.
PdfConfigPdfConfignew instanceConfigurações para comportamento PDF/busca.
stringFontInfo""Informações de substituição de fonte.
string[]?FontFoldersnullDiretórios de fontes adicionais.
boolAllowSearchfalseDelegado a PdfConfig.AllowSearch.
boolAllowCopyfalseDelegado a PdfConfig.AllowCopy.

No Linux e macOS, a renderização de apresentações com o mecanismo atual requer libgdiplus e System.Drawing.EnableUnixSupport=true. Instale as fontes usadas pela apresentação ou forneça FontFolders.

CadConfig

Formatos: DWG, DXF, DGN. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
boolDefaultRendertrueRenderização nativa CAD; false usa o redirecionamento PDF.
PdfConfigPdfConfignew instanceConfigurações do caminho PDF.
boolExportPdfAfalseSaída de arquivamento PDF/A.
boolShowColortrueCor em vez de monocromático.
boolWhiteBackgroundtrueFundo branco em vez de preto.
shortLineWidth25Largura de traço CAD.
boolShowLayoutsfalseRenderiza abas de layout.
boolShowModeltrueRenderiza o espaço modelo.
boolCheck3DSolidtrueProcessa sólidos 3D.
boolExportAllLayoutsfalseExporta todos os layouts, sobrescrevendo seleção modelo/layout.
boolLimitMinimumSizefalseAplica MinimumSize.
intMinimumSize700Tamanho mínimo de saída em pixels.
boolLimitMaximumSizefalseAplica MaximumSize.
intMaximumSize700Tamanho máximo de saída em pixels.
boolShowAllLayoutsDgnfalseInclui todos os layouts DGN.
boolAutomaticLayoutScalingtrueEscala layouts automaticamente.
floatPdfMargins0.5Margem PDF em polegadas.
RenderQualityQualityImageLowQualidade raster: Low, Medium ou High.
RenderQualityQualityTextMediumQualidade de texto: Low, Medium ou High.

EmailConfig

Formatos: EML, EMLX, MSG. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
boolDefaultRendertrueRenderização nativa de email; false usa o redirecionamento PDF.
PdfConfigPdfConfignew instanceConfigurações do caminho PDF.
Encoding?EmailEncodingnullSubstitui a codificação da mensagem.
Encoding?SubjectEncodingnullSubstitui a codificação do assunto.
Encoding?BodyEncodingnullSubstitui a codificação do corpo.
boolSkipExternalImagesfalseNão carrega imagens referenciadas remotamente. Recomendado para email não confiável.
boolRemoveLastWhitePagefalseRemove uma página em branco final.
boolUseAntiAliasingfalseHabilita anti‑aliasing.
boolUseHighQualityRenderingfalsePrefere renderização mais limpa e lenta.
TimeSpan?TimeZoneOffsetnullSubstitui o fuso horário usado para datas.
boolForcePageSizefalseForça dimensões de página fixas.

ImageConfig, TiffConfig, and PsdConfig

ImageConfig abrange JPG, JPEG, JPE, PNG, BMP, GIF, ICO, EPS, TGA, WEBP, CDR, CMX, DNG, EMF, WMF, AVIF e SVG. Seu DPI padrão é 100.

ConfigPropriedadePadrãoComportamento
ImageConfigMaxImagePixelSize3000Largura/altura máxima. 0 significa ilimitado; valores diferentes de zero abaixo de 50 são ignorados.
ImageConfigTransparentPngtruePreserva a transparência PNG; false usa fundo branco.
TiffConfigno additional propertiesDPI 200Usa apenas BaseConfig; suporta TIFF multipágina.
PsdConfigMaxImagePixelSize3000Mesma validação 0/mínimo‑50 de ImageConfig; DPI padrão é 100.

DicomConfig

Formatos: DCM, IMA. DPI efetivo padrão: 100. Requer o plugin DICOM.

TipoPropriedadePadrãoComportamento
intHorizontalResolution100 effectiveDPI horizontal explícito; caso contrário ImageResolution, depois 100.
intVerticalResolution100 effectiveDPI vertical explícito; caso contrário ImageResolution, depois 100.
intAnimationFrameDelayMs100Atraso de animação multiquadro; temporização GIF usa unidades de 10 ms.
ushortLoopCount00 repete indefinidamente; valores positivos param após essa contagem.
DicomDisplayModeDisplayModeAnimationAndFramesAnimationOnly, FramesOnly ou visão geral combinada mais quadros estáticos.

TxtConfig

Formato: TXT. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
DocPaperSizePaperSizeA4Tamanho de papel de saída.
Encoding?FileEncodingnullnull usa UTF-8.
stringFontInformation""Informações de fonte para renderização de texto.

Use WordConfig quando texto simples precisar de um comportamento de layout de página mais rico.

ProjectConfig

Formatos: MPP, MPPX, MPX. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
boolDefaultRendertrueImagem Gantt nativa; false usa um caminho PDF baseado em texto.
PdfConfigPdfConfignew instanceConfigurações do caminho PDF.
boolExportPdfAtrueSaída de arquivamento PDF/A.
MppPaperSizePaperSizeLedgerTamanho de papel de saída do projeto.
MppTimeScaleTimeScaleMonthsDays ou Months.
MppFormatPresentationFormatGanttChartGanttChart, TaskUsage, ResourceUsage, ResourceSheet ou TaskSheet.

Para busca exata por coordenadas de texto, use DefaultRender = false.

VisioConfig

Formatos: VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. DPI padrão: 200.

TipoPropriedadePadrãoComportamento
boolDefaultRendertrueRenderização nativa de diagrama; false usa o redirecionamento PDF.
PdfConfigPdfConfignew instanceConfigurações do caminho PDF.
boolExportPdfAtrueSaída de arquivamento PDF/A.

HtmlConfig, EpubConfig, MhtConfig, and XpsConfig

Todos os quatro têm padrão de 200 DPI e expõem um PdfConfig aninhado.

ConfiguraçãoFormatosDefaultRenderPropriedades/comportamento adicionais
HtmlConfigHTML, HTMtrueRenderização nativa; use false para um caminho de PDF baseado em texto para busca.
EpubConfigEPUBtrueRenderização nativa; false usa PDF.
MhtConfigMHT, MHTMLtrue on the class; false in the automatic catalogA abertura normal sem configuração usa o redirecionamento PDF pesquisável. Uma instância padrão explicitamente construída renderiza nativamente.
XpsConfigXPSfalseUsa o caminho PDF por padrão; defina true para renderização nativa de imagem.

Exemplos de configuração por família

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

Seleção por extensão

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

Esta página foi útil?