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 langjährig bestehende JavaScript‑Widget haben unterschiedliche Vorgaben, daher sollten Werte explizit zugeordnet werden.

Zwei clientseitige Änderungen in dieser Version schlagen stillschweigend fehl. Handler‑Funktionen werden als Optionen übergeben — das Widget leitet keine globalen Funktionsnamen mehr aus der Container‑ID ab — und ResPath muss auf das Ressourcen‑Präfix statt auf die Anwendungswurzel zeigen. Beide lassen den Server einwandfrei arbeiten und melden nichts in der Browser‑Konsole. Wenn Sie eine Seite aus der vorherigen Bibliothek übernehmen, lesen Sie zuerst Rückrufe und Pfad‑Checkliste bevor Sie etwas anderes tun.

C#-Eigenschaften

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // kein führender '/' : der Viewer fügt ihn hinzu ("/doconut" würde zu //doconut, ein anderer Host)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

C# zu JavaScript Zuordnung

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

JavaScript-Standardwerte

Das Widget hat ältere Standardwerte, 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 Standardsätze 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: 'doconut',
    ResPath: 'doconut-res/images',
    onViewerReady: function () {},
    onError: function (message) { console.error('DocViewer:', message); }
});
</script>

Rückrufe

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

Jede dieser ist eine Option im Init‑Objekt. Der vorherige Viewer suchte globale Funktionen, deren Namen er aus der Container‑ID ableitete — eine Seite mit <div id="div_ctlDoc"> musste nur function ctlDoc_OnViewerReady() deklarieren. Diese Suche ist weggefallen. Übergeben Sie die Funktion explizit:

objctlDoc = $('#div_ctlDoc').docViewer({
    // ... Ihre bestehenden Optionen ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // wurde nach Namen gefunden
    onViewerReady:    ctlDoc_OnViewerReady,     // wurde nach Namen gefunden
    onCopy:           ctlDoc_Copy,              // war ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // war ctlDoc_AutoLoadStatus(page)
});

Die alte Suche war in ein leeres catch eingebettet, sodass nie etwas gemeldet wurde. In dieser Version werden die Funktionen einfach nie ausgeführt: Das übliche Symptom ist ein ständig drehender Ladeindikator, der nie stoppt, weil der Handler, der ihn ausblendet, onViewerReady war. Das dahinterliegende Dokument wird korrekt gerendert.

Es gibt keinen Link‑Klick‑Rückruf — die Hyperlink‑Verarbeitung ist integriert und wird von showHyperlinks gesteuert.

Öffentliche Methoden‑Gruppen

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

Wiederholen, während eine verteilte Seite noch gerendert wird

retryOn409 behält seinen historischen Namen. Es dient der asynchronen Seitenerstellung und wiederholt die aktuelle 202 Accepted‑Bereitschaftsantwort sowie das ältere 409 Conflict‑Signal. Wenn aktiviert, fragt das Widget mit diesen JavaScript‑Standardwerten ab:

Lassen Sie es für den normalen Single‑Node‑Viewer deaktiviert. Das Aktivieren kann ein nicht unterstütztes synchrones Rendering nicht asynchron machen.

Aktivieren Sie es, wenn Seiten aus gemeinsam genutztem Speicher mit FirstPagePriority bereitgestellt werden, wobei spätere Seiten legitimerweise 202 Accepted beantworten, bis sie geschrieben sind. Ein Client, der nicht wiederholt, zeigt fehlerhafte Kacheln für noch rendernde Seiten – siehe Verteilte Deployments.

Pfad‑Checkliste

• DoconutOptions.MiddlewarePath muss den Zweig beschreiben, den Sie tatsächlich zuordnen.
• BasePath muss diesen Zweig anvisieren, geschrieben ohne ein führendes / ('doconut', nicht '/doconut': Der Viewer fügt den Schrägstrich hinzu, und //doconut/... ist eine Anfrage an einen anderen Host). Die Referenzanwendung behält die historische DocImage.axd‑Anfrageform auf einem MapWhen‑Zweig bei und setzt daher BasePath: '/'.
• DoconutOptions.ResourcesPath ist die eingebettete Ressourcenroute.
• ResPath zielt normalerweise auf sein images‑Unterverzeichnis ab, ohne ein führendes / — 'doconut-res/images' mit dem Standardpräfix. Ein leeres ResPath war in der vorherigen Bibliothek korrekt, wo Ressourcen vom Anwendungs‑Root kamen; hier ist es nicht korrekt und es schlägt fehl, ohne einen Fehler anzuzeigen.
• ExtractHyperlinks muss in der Server‑Format‑Konfiguration aktiviert sein, bevor showHyperlinks irgendetwas anzeigen kann.