ViewerConfig

ViewerConfig (namespace Doconut) descreve a aparência e o comportamento do visualizador do navegador. Não afeta a qualidade de renderização do documento; use uma configuração de formato para isso. A classe C# e o plugin JavaScript legado têm padrões diferentes, portanto mapeie os valores explicitamente.

Propriedades C#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = o manipulador DocImage.axd na raiz do site (Web.config)
    ResPath = "doconut-res/images", // a pasta de imagens sob ResourcesPath, sem '/' inicial
    ShowHyperlinks = true
};
// Emita com viewer.RenderViewer("viewerEl", token, config) - veja a referência Viewer.

Emitindo um ViewerConfig com RenderViewer

Viewer.RenderViewer(elementId, token, config) transforma um ViewerConfig no script de inicialização do widget. Ele grava seis das propriedades acima — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom e FitType — e então chama View(token). As demais propriedades não são gravadas: para MaxZoom, ShowHyperlinks, as configurações de zoom ou qualquer callback, inicialize o widget você mesmo com as opções JavaScript abaixo. Veja Viewer para RenderViewer.

Mapeamento de C# para JavaScript

Não passe um ViewerConfig serializado diretamente para docViewer(...). A maioria das chaves do widget está em camelCase, enquanto três chaves estabelecidas de caminho/ajuste estão em PascalCase.

Padrões de JavaScript

O widget tem padrões mais antigos que diferem da classe C#. Os valores a seguir provêm da implementação atual do docViewer.js.

Defina todos os valores importantes de comportamento em vez de confiar em qualquer conjunto de padrões:

<div id="divDocViewer"><div id="div_ctlDoc"></div></div>

<script>
const objViewer = $('#div_ctlDoc').docViewer({
    showThumbs: true,
    autoLoad: false,
    autoFocus: true,
    autoPageFocus: true,
    pageZoom: 100,
    zoomStep: 10,
    maxZoom: 300,
    FitType: 'width',
    cacheEnabled: false,
    largeDoc: false,
    showHyperlinks: true,
    fixedZoom: true,
    fixedZoomPercent: 100,
    fixedZoomPercentMobile: 75,
    BasePath: '/',
    ResPath: 'doconut-res/images',
    onViewerReady: function () {},
    onError: function (message) { console.error('DocViewer:', message); }
});
</script>

Retornos de chamada

Mantenha os callbacks rápidos; envie telemetria de forma assíncrona e não bloqueie a renderização da página.

Grupos de métodos públicos

O arquivo JavaScript contém auxiliares internos também. Considere estáveis apenas os métodos usados pela UI de referência e documentados aqui ou nos guias de recursos.

Opções de nova tentativa

O widget também aceita retryOn409 e suas configurações de backoff (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). Elas atendem implantações cujas páginas são produzidas em segundo plano. DocImage.axd renderiza cada página durante a requisição, portanto deixe retryOn409 desativado.

Lista de verificação de caminho

• BasePath é '/' quando o manipulador DocImage.axd está na raiz do site — o atributo path do manipulador em Web.config decide onde ele responde. Em um diretório virtual, use o nome do diretório sem uma barra inicial / ('myapp', não '/myapp': o visualizador adiciona a barra, e //myapp/... é uma requisição para outro host).
• DoconutOptions.ResourcesPath é onde o módulo de recursos serve os arquivos incorporados (/doconut-res por padrão).
• ResPath aponta para sua subpasta images, também sem uma barra inicial / ('doconut-res/images'). Definir como 'doconut-res' faz com que todos os ícones retornem 404 enquanto o documento ainda é renderizado.
• No MVC, routes.IgnoreRoute("doconut-res/{*pathInfo}") deve vir após ResourcesPath se você alterá-lo.
• ExtractHyperlinks deve estar habilitado na configuração de formato do servidor antes que showHyperlinks possa exibir qualquer coisa.