ViewerConfig

ViewerConfig (namespace Doconut) beschreibt das Aussehen und Verhalten des Browser‑Viewers. Es beeinflusst nicht die Qualität der Dokumentendarstellung; dafür verwenden Sie eine Format‑Konfiguration. Die C#‑Klasse und das veraltete JavaScript‑Plugin haben unterschiedliche Vorgaben, daher Werte explizit zuordnen.

C#‑Eigenschaften

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = the DocImage.axd handler at the site root (Web.config)
    ResPath = "doconut-res/images", // the images folder under ResourcesPath, no leading '/'
    ShowHyperlinks = true
};
// Emit it with viewer.RenderViewer("viewerEl", token, config) - see the Viewer reference.

Erzeugen einer ViewerConfig mit RenderViewer

Viewer.RenderViewer(elementId, token, config) wandelt eine ViewerConfig in das Initialisierungsskript des Widgets um. Es schreibt sechs der oben genannten Eigenschaften — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom und FitType — und ruft anschließend View(token) auf. Die anderen Eigenschaften werden nicht geschrieben: Für MaxZoom, ShowHyperlinks, die Zoom‑Einstellungen oder jegliche Callback‑Funktion initialisieren Sie das Widget selbst mit den untenstehenden JavaScript‑Optionen. Siehe Viewer für RenderViewer.

C#‑zu‑JavaScript‑Zuordnung

Übergeben Sie nicht eine direkt serialisierte ViewerConfig an docViewer(...). Die meisten Widget‑Schlüssel sind camelCase, während drei etablierte Pfad‑/Fit‑Schlüssel PascalCase sind.

JavaScript-Standardwerte

Das Widget hat ältere Vorgaben, die von der C#‑Klasse abweichen. Die folgenden Werte stammen aus der aktuellen docViewer.js‑Implementierung.

Setzen Sie alle verhaltensrelevanten Werte, anstatt sich auf einen der beiden Standards zu verlassen:

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

Rückruffunktionen

Halten Sie Rückruffunktionen schnell; senden Sie Telemetrie asynchron und blockieren Sie das Rendern der Seite nicht.

Öffentliche Methodengruppen

Die JavaScript‑Datei enthält ebenfalls interne Hilfsfunktionen. Betrachten Sie nur die Methoden, die von der Referenz‑UI verwendet und hier oder in den Feature‑Leitfäden dokumentiert sind, als stabile Integrationspunkte.

Wiederholungsoptionen

Das Widget akzeptiert außerdem retryOn409 und seine Backoff‑Einstellungen (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). Sie dienen Deployments, deren Seiten im Hintergrund erzeugt werden. DocImage.axd rendert jede Seite während der Anfrage, daher sollte retryOn409 deaktiviert bleiben.

Pfad‑Checkliste

• BasePath ist '/', wenn der DocImage.axd‑Handler im Site‑Root liegt — das path‑Attribut des Handlers in Web.config bestimmt, wo er antwortet. In einem virtuellen Verzeichnis verwenden Sie den Verzeichnisnamen ohne führenden / ('myapp', nicht '/myapp': der Viewer fügt den Schrägstrich hinzu, und //myapp/... ist eine Anfrage an einen anderen Host).
• DoconutOptions.ResourcesPath ist der Ort, an dem das Ressourcenmodul die eingebetteten Dateien bereitstellt (/doconut-res standardmäßig).
• ResPath verweist auf den Unterordner images, ebenfalls ohne führenden / ('doconut-res/images'). Wenn er auf 'doconut-res' zeigt, erhalten alle Icons einen 404‑Fehler, während das Dokument weiterhin gerendert wird.
• In MVC muss routes.IgnoreRoute("doconut-res/{*pathInfo}") nach ResourcesPath kommen, falls Sie diesen ändern.
• ExtractHyperlinks muss in der Server‑Format‑Konfiguration aktiviert sein, bevor showHyperlinks etwas anzeigen kann.