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 vivem no namespace Doconut.
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
AllowSearch = true,
AllowCopy = true,
ImageResolution = 150
});Herança e configurações PDF aninhadas
Todo 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 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 construtor/propriedade. O catálogo de formatos automático substitui deliberadamente dois deles: cria ExcelConfig com SplitWorksheets = true e MhtConfig com DefaultRender = false.
BaseConfig
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
int | ImageResolution | 0 | 0 usa o padrão do formato. Faixa explícita válida é 25‑300 DPI; atribuições inválidas são ignoradas. |
string | DocumentCulture | "" | Local para datas e números. Valores não vazios são aparados; atribuições vazias são ignoradas. |
string | Password | "" | Senha de documento protegido. DocOptions.Password é copiada aqui automaticamente. |
bool | ShowUI | true | Propriedade de compatibilidade; o renderizador atual não a usa para controlar a barra de ferramentas do navegador. |
bool | CachePages | true | Armazena em cache imagens de páginas renderizadas para a sessão do documento. |
PdfConfig
Formatos: PDF. DPI padrão: 200.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
bool | DefaultRender | true | Interruptor de compatibilidade. A fábrica atual usa o visualizador PDF nativo. |
bool | AllowSearch | false | Constrói/usa o índice de busca de texto do PDF. Requer a capacidade de licença Search para solicitações. |
bool | AllowCopy | false | Permite operações de seleção/cópia de texto. |
bool | ExtractHyperlinks | false | Extrai retângulos de links para sobreposições do cliente. |
int | HyperlinksPageCount | 0 | Máximo de páginas escaneadas por links; 0 significa todas as páginas. |
bool | CompressImages | false | Comprime imagens incorporadas antes da renderização. |
int | CompressQuality | 100 | Qualidade JPEG usada quando a compressão está habilitada. |
bool | ResizeImages | false | Redimensiona imagens incorporadas antes da renderização. |
int | ResizeResolution | 300 | DPI alvo para imagens redimensionadas. |
bool | CompressFast | false | Prefere o caminho de compressão mais rápido e de menor qualidade. |
bool | FixInvalidImages | false | Tenta reparar imagens incorporadas inválidas. |
bool | SplitSegments | false | Reú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. Habilite ambos.
WordConfig
Formatos: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. DPI padrão: 200.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
bool | DefaultRender | true | Renderização nativa do Word; false usa o redirecionamento PDF. |
PdfConfig | PdfConfig | nova instância | Configurações usadas pelo caminho PDF/busca. |
DocPaperSize | PaperSize | A4 | Tamanho de papel de saída. Use Custom com largura/altura. |
int | PaperWidth | 595 | Largura personalizada em pontos. |
int | PaperHeight | 841 | Altura personalizada em pontos. |
bool | RemovePaperMargin | false | Remove margens de página do documento. |
bool | RenderPageColor | true | Preserva a cor de página configurada no Word; false renderiza páginas brancas. |
bool | ExportPdfA | false | Usa PDF/A de arquivo no caminho PDF. |
Encoding? | FileEncoding | null | Substitui a codificação de origem. |
string | FontInfo | "" | Informações de substituição de fonte. |
string[]? | FontFolders | null | Diretórios de fontes adicionais, especialmente úteis em Linux/containers. |
bool | AllowSearch | false | Delegado a PdfConfig.AllowSearch. |
bool | AllowCopy | false | Delegado a PdfConfig.AllowCopy. |
TableAutoFitBehavior | AutoFitAllTables | None | None, AutoFitToContents ou AutoFitToWindow. |
ExcelConfig
Formatos: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. DPI padrão: 200.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
bool | DefaultRender | true | Renderização nativa da planilha; false usa o redirecionamento PDF. |
PdfConfig | PdfConfig | nova instância | Configurações para o caminho PDF/busca. |
ExcelPaperSize | PaperSize | PaperA4 | Tamanho de papel de saída. |
double | PaperMargins | 0.25 | Margens de página em polegadas. |
bool | PaperLandscape | true | Renderização da planilha em paisagem. |
bool | AutoFitContents | false | Ajusta automaticamente alturas de linhas e larguras de colunas. |
bool | RemoveEmptyContent | true | Aperta a saída excluindo conteúdo vazio. |
bool | CalculateFormula | true | Recalcula fórmulas antes da renderização. |
bool | ShowRowColumnHeaders | true | Inclui cabeçalhos de planilha. |
bool | ExportPdfA | false | Usa PDF/A no caminho PDF. |
bool | SplitWorksheets | false | Mantém planilhas como grupos de páginas separados. |
bool | ShowEmptyWorkSheets | false | Inclui planilhas vazias. |
bool | ExportLandscape | false | Força exportação em paisagem. |
bool | ExportOnePagePerSheet | false | Ajusta cada planilha a uma página de saída. |
bool | MemoryOptimizationPreference | true | Reduz o pico de memória, possivelmente trocando um pouco de velocidade. |
bool | AutoTrimWorksheetRenderRange | true | Renderiza apenas a faixa usada visível quando não há área de impressão explícita. |
bool | AutoTrimPreserveExistingPrintArea | true | Preserva áreas de impressão definidas na pasta de trabalho durante o auto‑trim. |
string? | PrintArea | null | Faixa explícita como "A1:Z100". |
bool | PrintGridlines | false | Imprime linhas de grade da planilha. |
bool | PrintHeadings | false | Imprime cabeçalhos de linhas/colunas. |
List<string> | SheetNames | vazia | Restringe a renderização a planilhas nomeadas. |
CustomStyleCell? | CustomStyles | null | Sobrescritas opcionais de formatação de data/decimal/integer. |
bool | AllowSearch | false | Delegado a PdfConfig.AllowSearch. |
bool | AllowCopy | false | Delegado 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.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
bool | DefaultRender | true | Renderização nativa do slide; false usa o redirecionamento PDF. |
bool | FastLoad | false | Evita renderizar o primeiro slide durante a abertura; usa metadados e renderiza sob demanda. |
PdfConfig | PdfConfig | nova instância | Configurações para comportamento PDF/busca. |
string | FontInfo | "" | Informações de substituição de fonte. |
string[]? | FontFolders | null | Diretórios de fontes adicionais. |
bool | AllowSearch | false | Delegado a PdfConfig.AllowSearch. |
bool | AllowCopy | false | Delegado a PdfConfig.AllowCopy. |
Em Linux e macOS, a renderização de apresentações com o motor 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.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
bool | DefaultRender | true | Renderização nativa CAD; false usa o redirecionamento PDF. |
PdfConfig | PdfConfig | nova instância | Configurações do caminho PDF. |
bool | ExportPdfA | false | Saída de arquivo PDF/A. |
bool | ShowColor | true | Cor ao invés de monocromático. |
bool | WhiteBackground | true | Fundo branco ao invés de preto. |
short | LineWidth | 25 | Largura de traço CAD. |
bool | ShowLayouts | false | Renderiza abas de layout. |
bool | ShowModel | true | Renderiza o espaço de modelo. |
bool | Check3DSolid | true | Processa sólidos 3D. |
bool | ExportAllLayouts | false | Exporta todos os layouts, sobrescrevendo seleção modelo/layout. |
bool | LimitMinimumSize | false | Aplica MinimumSize. |
int | MinimumSize | 700 | Tamanho mínimo de saída em pixels. |
bool | LimitMaximumSize | false | Aplica MaximumSize. |
int | MaximumSize | 700 | Tamanho máximo de saída em pixels. |
bool | ShowAllLayoutsDgn | false | Inclui todos os layouts DGN. |
bool | AutomaticLayoutScaling | true | Redimensiona layouts automaticamente. |
float | PdfMargins | 0.5 | Margem PDF em polegadas. |
RenderQuality | QualityImage | Low | Qualidade raster: Low, Medium ou High. |
RenderQuality | QualityText | Medium | Qualidade de texto: Low, Medium ou High. |
EmailConfig
Formatos: EML, EMLX, MSG. DPI padrão: 200.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
bool | DefaultRender | true | Renderização nativa de e‑mail; false usa o redirecionamento PDF. |
PdfConfig | PdfConfig | nova instância | Configurações do caminho PDF. |
Encoding? | EmailEncoding | null | Substitui a codificação da mensagem. |
Encoding? | SubjectEncoding | null | Substitui a codificação do assunto. |
Encoding? | BodyEncoding | null | Substitui a codificação do corpo. |
bool | SkipExternalImages | false | Não carrega imagens referenciadas remotamente. Recomendado para e‑mails não confiáveis. |
bool | RemoveLastWhitePage | false | Remove uma página em branco final. |
bool | UseAntiAliasing | false | Habilita antisserrilhamento. |
bool | UseHighQualityRendering | false | Prefere renderização mais limpa e lenta. |
TimeSpan? | TimeZoneOffset | null | Substitui o fuso horário usado para datas. |
bool | ForcePageSize | false | Força dimensões de página fixas. |
ImageConfig, TiffConfig e PsdConfig
ImageConfig cobre JPG, JPEG, JPE, PNG, BMP, GIF, ICO, EPS, TGA, WEBP, CDR, CMX, DNG, EMF, WMF, AVIF e SVG. Seu DPI padrão é 100.
| Config | Propriedade | Padrão | Comportamento |
|---|---|---|---|
ImageConfig | MaxImagePixelSize | 3000 | Largura/altura máxima. 0 significa ilimitado; valores não‑zero abaixo de 50 são ignorados. |
ImageConfig | TransparentPng | true | Preserva transparência PNG; false usa fundo branco. |
TiffConfig | sem propriedades adicionais | DPI 200 | Usa apenas BaseConfig; suporta TIFF multipágina. |
PsdConfig | MaxImagePixelSize | 3000 | Mesma 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.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
int | HorizontalResolution | 100 efetivo | DPI horizontal explícito; caso contrário ImageResolution, depois 100. |
int | VerticalResolution | 100 efetivo | DPI vertical explícito; caso contrário ImageResolution, depois 100. |
int | AnimationFrameDelayMs | 100 | Atraso de animação de múltiplos quadros; temporização GIF usa unidades de 10 ms. |
ushort | LoopCount | 0 | 0 repete indefinidamente; valores positivos param após essa contagem. |
DicomDisplayMode | DisplayMode | AnimationAndFrames | AnimationOnly, FramesOnly ou visão combinada de animação + quadros estáticos. |
TxtConfig
Formato: TXT. DPI padrão: 200.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
DocPaperSize | PaperSize | A4 | Tamanho de papel de saída. |
Encoding? | FileEncoding | null | null usa UTF‑8. |
string | FontInformation | "" | Informações de fonte para renderização de texto. |
Use WordConfig quando texto simples precisar de comportamento de layout de página mais rico.
ProjectConfig
Formatos: MPP, MPPX, MPX. DPI padrão: 200.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
bool | DefaultRender | true | Imagem Gantt nativa; false usa caminho PDF baseado em texto. |
PdfConfig | PdfConfig | nova instância | Configurações do caminho PDF. |
bool | ExportPdfA | true | Saída de arquivo PDF/A de arquivo. |
MppPaperSize | PaperSize | Ledger | Tamanho de papel de saída do projeto. |
MppTimeScale | TimeScale | Months | Days ou Months. |
MppFormat | PresentationFormat | GanttChart | GanttChart, 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.
| Tipo | Propriedade | Padrão | Comportamento |
|---|---|---|---|
bool | DefaultRender | true | Renderização nativa de diagrama; false usa o redirecionamento PDF. |
PdfConfig | PdfConfig | nova instância | Configurações do caminho PDF. |
bool | ExportPdfA | true | Saída de arquivo PDF/A de arquivo. |
HtmlConfig, EpubConfig, MhtConfig e XpsConfig
Todos os quatro têm DPI padrão 200 e expõem um PdfConfig aninhado.
| Config | Formatos | DefaultRender | Propriedades/comportamento adicionais |
|---|---|---|---|
HtmlConfig | HTML, HTM | true | Renderização nativa; use false para um caminho PDF baseado em texto para busca. |
EpubConfig | EPUB | true | Renderização nativa; false usa PDF. |
MhtConfig | MHT, MHTML | true na classe; false no catálogo automático | A abertura padrão sem configuração usa o redirecionamento PDF pesquisável. Uma instância padrão explicitamente construída renderiza nativamente. |
XpsConfig | XPS | false | Usa o caminho PDF por padrão; defina true para renderização de imagem nativa. |
Exemplos de configuração por família
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
}
];Seleção por extensão
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 // recua para a configuração padrão do formato
};Esta página foi útil?