ViewerConfig

ViewerConfig (namespace Doconut) describes the browser viewer's appearance and behavior. It does not affect document rendering quality; use a format config for that. The C# class and the long-standing JavaScript widget have different defaults, so map values explicitly.

Two client-side changes in this release fail silently. Handler functions are passed as options — the widget no longer derives global function names from the container id — and ResPath must point at the resources prefix rather than the application root. Both leave the server working perfectly and report nothing in the browser console. If you are carrying a page forward from the previous library, read Callbacks and Path checklist before anything else.

C# properties

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/doconut",
    ResPath = "/doconut-res/images",
    ShowHyperlinks = true
};

C# to JavaScript mapping

Do not pass a directly serialized ViewerConfig to docViewer(...). Most widget keys are camelCase, while three established path/fit keys are PascalCase.

JavaScript defaults

The widget has older defaults that differ from the C# class. The following values come from the current docViewer.js implementation.

Set all behaviorally important values instead of relying on either set of defaults:

<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

Keep callbacks fast; send telemetry asynchronously and do not block page rendering.

Every one of these is an option on the init object. The previous viewer looked up global functions whose names it derived from the container id — a page with <div id="div_ctlDoc"> only had to declare function ctlDoc_OnViewerReady(). That lookup is gone. Pass the function explicitly:

objctlDoc = $('#div_ctlDoc').docViewer({
    // ... your existing options ...
    onViewerBusy:     ctlDoc_OnViewerBusy,      // was found by name
    onViewerReady:    ctlDoc_OnViewerReady,     // was found by name
    onCopy:           ctlDoc_Copy,              // was ctlDoc_Copy(text)
    onAutoLoadStatus: ctlDoc_AutoLoadStatus     // was ctlDoc_AutoLoadStatus(page)
});

The old lookup was wrapped in an empty catch, so nothing was ever reported. On this release the functions simply never run: the usual symptom is a busy spinner that never stops, because the handler that hid it was onViewerReady. The document behind it is rendering correctly.

There is no link-click callback — hyperlink handling is built in and driven by showHyperlinks.

Public method groups

The JavaScript file contains internal helpers too. Treat only methods used by the reference UI and documented here or in the feature guides as stable integration points.

Retry while a distributed page is still rendering

retryOn409 retains its historical name. It is for asynchronous page production and retries the current 202 Accepted readiness response as well as the older 409 Conflict signal. When enabled, the widget polls with these JavaScript defaults:

Leave it disabled for the normal single-node viewer. Enabling it cannot make an unsupported synchronous render asynchronous.

Enable it when pages are served from shared storage with FirstPagePriority, where later pages legitimately answer 202 Accepted until they are written. A client that does not retry shows broken tiles for pages still rendering — see Distributed Deployments.

Path checklist

• DoconutOptions.MiddlewarePath must describe the branch you actually map.
• BasePath must target that branch. The reference application keeps the historic DocImage.axd request shape on a MapWhen branch and therefore sets BasePath: '/'.
• DoconutOptions.ResourcesPath is the embedded resource route.
• ResPath normally targets its /images subfolder — 'doconut-res/images' with the default prefix. An empty ResPath was correct in the previous library, where resources came from the application root; it is not correct here, and it fails without an error.
• ExtractHyperlinks must be enabled in the server format config before showHyperlinks can display anything.