ViewerConfig

ViewerConfig (namespace Doconut) descrive l'aspetto e il comportamento del visualizzatore del browser. Non influisce sulla qualità del rendering del documento; per questo usa una configurazione di formato. La classe C# e il plugin JavaScript legacy hanno impostazioni predefinite diverse, quindi mappa i valori esplicitamente.

Proprietà C#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = gestore DocImage.axd nella radice del sito (Web.config)
    ResPath = "doconut-res/images", // cartella images sotto ResourcesPath, senza '/' iniziale
    ShowHyperlinks = true
};
// Genera lo script con viewer.RenderViewer("viewerEl", token, config) – vedi la sezione Visualizzatore.

Emissione di un ViewerConfig con RenderViewer

Viewer.RenderViewer(elementId, token, config) trasforma un ViewerConfig nello script di inizializzazione del widget. Scrive sei delle proprietà sopra — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom e FitType — e poi chiama View(token). Le altre proprietà non vengono scritte: per MaxZoom, ShowHyperlinks, le impostazioni di zoom o qualsiasi callback, inizializza il widget da solo con le opzioni JavaScript riportate di seguito. Vedi Visualizzatore per RenderViewer.

Mappatura da C# a JavaScript

Non passare un ViewerConfig serializzato direttamente a docViewer(...). La maggior parte delle chiavi del widget sono camelCase, mentre tre chiavi di percorso/adattamento consolidate sono PascalCase.

Impostazioni predefinite JavaScript

Il widget ha impostazioni predefinite più vecchie che differiscono dalla classe C#. I seguenti valori provengono dall'attuale implementazione di docViewer.js.

Imposta tutti i valori comportamentali importanti invece di fare affidamento su uno dei due set di valori predefiniti:

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

Callback

Mantieni le callback rapide; invia la telemetria in modo asincrono e non bloccare il rendering della pagina.

Gruppi di metodi pubblici

Il file JavaScript contiene anche helper interni. Considera stabili solo i metodi utilizzati dall'interfaccia di riferimento e documentati qui o nelle guide delle funzionalità come punti di integrazione.

Opzioni di ritentativo

Il widget accetta anche retryOn409 e le sue impostazioni di backoff (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). Esse servono le distribuzioni le cui pagine sono generate in background. DocImage.axd rende ogni pagina durante la richiesta, quindi lascia retryOn409 disattivato.

Checklist del percorso

• BasePath è '/' quando il gestore DocImage.axd si trova alla radice del sito — l'attributo path del gestore in Web.config decide dove risponde. In una directory virtuale, usa il nome della directory senza una barra iniziale / ('myapp', non '/myapp': il visualizzatore aggiunge la barra, e //myapp/... è una richiesta a un altro host).
• DoconutOptions.ResourcesPath è dove il modulo delle risorse serve i file incorporati (/doconut-res per impostazione predefinita).
• ResPath punta alla sua sottocartella images, anch'essa senza una barra iniziale / ('doconut-res/images'). Puntarlo a 'doconut-res' fa sì che ogni icona restituisca 404 mentre il documento continua a essere renderizzato.
• In MVC, routes.IgnoreRoute("doconut-res/{*pathInfo}") deve seguire ResourcesPath se lo modifichi.
• ExtractHyperlinks deve essere abilitato nella configurazione del formato server prima che showHyperlinks possa visualizzare qualcosa.