ViewerConfig

Opções do widget de visualizador do cliente

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 widget JavaScript de longa data têm padrões diferentes, portanto mapeie os valores explicitamente.

Propriedades C#

TipoPropriedadePadrãoDescrição
boolShowThumbstrueExibir o painel de miniaturas.
boolAutoLoadfalseCarregar automaticamente após a inicialização. O fluxo normal de tokens chama View(token) explicitamente.
boolAutoFocustrueMover o foco/rolagem do navegador para o visualizador durante a inicialização.
boolAutoPageFocustrueManter a miniatura atual visível enquanto as páginas mudam.
intPageZoom100Porcentagem de zoom inicial.
intZoomStep10Porcentagem adicionada ou removida pelos comandos de zoom.
intMaxZoom300Porcentagem máxima de zoom.
boolShowToolTiptrueExibir a dica de posição da página ao rolar.
stringToolTipPageText"Page "Prefixo usado na dica da página.
boolCacheEnabledfalseManter uma janela móvel de imagens de página na memória do navegador. Não usa localStorage.
boolLargeDocfalseAnexar elementos de página em lotes cronometrados para documentos grandes.
boolShowHyperlinksfalseRenderizar sobreposições de hiperlink quando a configuração do servidor as extraiu.
boolFixedZoomtrueUsar uma porcentagem de zoom fixa em vez de recalculação responsiva.
intFixedZoomPercent100Zoom fixo para desktop.
intFixedZoomPercentMobile75Zoom fixo para dispositivos móveis.
stringBasePath"/"Onde o visualizador envia solicitações de página. "/" está DocImage.axd na raiz do site; caso contrário, o ramo onde o host mapeia UseDoconut(), sem um / inicial ("doconut" significa /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" antes)Pasta de onde o widget carrega suas próprias imagens: a pasta images sob ResourcesPath, sem um / inicial.
stringFitType"width""width", "height", ou vazio para nenhum ajuste automático. "page" não é aceito pelo widget atual.
boolRetryOn409falseHabilitar polling quando a produção de página assíncrona/distribuída responde 202 Accepted; 409 também é aceito para compatibilidade com servidores mais antigos. Não é necessário para o visualizador síncrono normal.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // sem '/' inicial: o visualizador o adiciona ("/doconut" se tornaria //doconut, outro host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

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 de caminho/ajuste estabelecidas estão em PascalCase.

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

Padrões do JavaScript

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

OpçãoPadrãoObservações
leftMinWidth / leftMaxWidth220 / 800Limites de largura do painel de miniaturas.
showThumbstrueVisibilidade inicial da miniatura.
autoFocus / autoPageFocustrue / falseautoPageFocus difere do padrão C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10Geometria da miniatura em pixels.
pageZoom / zoomStep / maxZoom100 / 10 / 200maxZoom do JavaScript difere do C# (300).
showToolTip / toolTipPageTexttrue / "Page "Tooltip de posição da página.
format / doc / AccessToken"" / 0 / ""Valores internos de inicialização; normalmente preenchidos por View(token).
debugModefalseDiagnósticos adicionais do cliente.
FitType""Nenhum ajuste automático a menos que seja fornecido.
BasePath"DocImage.axd"Padrão histórico do cliente mantido por compatibilidade. Hosts atuais do ASP.NET Core devem defini‑lo explicitamente para o ramo de middleware mapeado.
ResPath""Defina explicitamente para o caminho das imagens incorporadas.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3Janela e atraso de pré‑carregamento de página em memória.
autoLoadfalseRecomenda‑se fluxo de token explícito.
largeDoctrueDifere do padrão C#.
fixedZoomfalseDifere do padrão C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50Valor móvel difere do C# (75).
showHyperlinkstrueRequer extração no lado do servidor para produzir sobreposições.

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

html
<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: 'doconut',
    ResPath: 'doconut-res/images',
    onViewerReady: function () {},
    onError: function (message) { console.error('DocViewer:', message); }
});
</script>

Callbacks

CallbackArgumentosPropósito
onPageLoadingpageNumUma solicitação de página está iniciando.
onPageLoadedpageNumUma imagem de página terminou de carregar.
onThumbnailClickedpageNumO usuário selecionou uma miniatura.
onPageClickedpageNumO usuário selecionou uma página.
onDoubleClicknoneO visualizador recebeu um duplo clique.
onViewerBusynoneO visualizador entrou em estado ocupado.
onViewerReadynoneInicialização concluída.
onViewerErrornoneO visualizador entrou em seu estado de erro.
onErrormessageUma operação retornou uma mensagem de erro.
onCopydataDados de cópia de texto estão disponíveis.
onAutoLoadStatuspageNumO carregamento automático avançou para uma página.
onThumbsShownnoneO painel de miniaturas tornou‑se visível.
onAnnLoadednoneDados de anotação carregados.
onAnnSavednoneDados de anotação salvos.
onAnnSaveErrornoneFalha ao salvar anotação.
onAnnClosednoneInterface de anotação fechada.

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

GrupoMétodos comuns
Ciclo de vidaView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
NavegaçãoGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
Zoom e ajusteZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
OrientaçãoRotate(page, angle), Flip(page, flipType)
MiniaturasHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
BuscaCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
AnotaçãoSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
CópiaCopy(...), CopyPage(pageNumber), CopyMode(enabled)

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.

Repetir enquanto uma página distribuída ainda está renderizando

retryOn409 mantém seu nome histórico. É para produção assíncrona de página e repetição da resposta de prontidão atual do 202 Accepted assim como do sinal mais antigo do 409 Conflict. Quando habilitado, o widget consulta com esses padrões JavaScript:

OpçãoPadrão
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

Deixe desativado para o visualizador normal. Habilitá‑lo não pode tornar uma renderização síncrona não suportada assíncrona.

Lista de verificação de caminho

  • DoconutOptions.MiddlewarePath deve descrever o ramo que você realmente mapeia.
  • BasePath deve apontar para esse ramo, escrito sem um / inicial ('doconut', não '/doconut': o visualizador adiciona a barra, e //doconut/... é uma solicitação para outro host).
  • DoconutOptions.ResourcesPath é a rota do recurso incorporado.
  • ResPath normalmente aponta para sua subpasta images, também sem um / inicial ('doconut-res/images').
  • ExtractHyperlinks deve estar habilitado na configuração de formato do servidor antes que showHyperlinks possa exibir qualquer coisa.

Esta página foi útil?