ViewerConfig

ViewerConfig (namespace Doconut) описывает внешний вид и поведение браузерного просмотрщика. Он не влияет на качество рендеринга документа; для этого используйте конфигурацию формата. Класс C# и устаревший плагин JavaScript имеют разные значения по умолчанию, поэтому сопоставляйте параметры явно.

Свойства C#

var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "/",                 // "/" = обработчик DocImage.axd в корне сайта (Web.config)
    ResPath = "doconut-res/images", // папка изображений внутри ResourcesPath, без начального '/'
    ShowHyperlinks = true
};
// Вывести его с помощью viewer.RenderViewer("viewerEl", token, config) - см. справку по Viewer.

Создание ViewerConfig с помощью RenderViewer

Viewer.RenderViewer(elementId, token, config) преобразует ViewerConfig в скрипт инициализации виджета. Он записывает шесть свойств из перечисленных — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom и FitType — и затем вызывает View(token). Остальные свойства не записываются: для MaxZoom, ShowHyperlinks, настроек масштабирования или любых обратных вызовов инициализируйте виджет самостоятельно, используя параметры JavaScript ниже. См. Просмотрщик для RenderViewer.

Сопоставление C# → JavaScript

Не передавайте напрямую сериализованный ViewerConfig в docViewer(...). Большинство ключей виджета используют camelCase, тогда как три установленных ключа пути/подгонки используют PascalCase.

Значения по умолчанию JavaScript

Виджет имеет более старые значения по умолчанию, которые отличаются от класса C#. Ниже перечислены значения, взятые из текущей реализации docViewer.js.

Установите все важные для поведения значения явно, вместо того чтобы полагаться на любой набор значений по умолчанию:

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

Обратные вызовы

Сохраняйте обратные вызовы быстрыми; отправляйте телеметрию асинхронно и не блокируйте рендеринг страницы.

Группы публичных методов

Файл JavaScript также содержит внутренние вспомогательные функции. Считайте стабильными только те методы, которые используются в справочном UI и задокументированы здесь или в руководствах по функциям.

Параметры повторных попыток

Виджет также принимает retryOn409 и его настройки отката (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs). Они предназначены для развертываний, у которых страницы генерируются в фоновом режиме. DocImage.axd рендерит каждую страницу во время запроса, поэтому оставьте retryOn409 выключенным.

Список проверок пути

• BasePath равен '/', когда обработчик DocImage.axd находится в корне сайта — атрибут path обработчика в Web.config определяет, где он отвечает. В виртуальном каталоге используйте имя каталога без начального / ('myapp', а не '/myapp': просмотрщик добавляет слеш, и //myapp/... является запросом к другому хосту).
• DoconutOptions.ResourcesPath указывает, где модуль ресурсов обслуживает встроенные файлы (/doconut-res по умолчанию).
• ResPath указывает на подпапку images, также без начального / ('doconut-res/images'). Указание 'doconut-res' приводит к тому, что все иконки возвращают 404, хотя документ всё ещё рендерится.
• В MVC routes.IgnoreRoute("doconut-res/{*pathInfo}") должен следовать за ResourcesPath, если вы изменяете его.
• ExtractHyperlinks должен быть включён в конфигурации формата сервера, прежде чем showHyperlinks сможет что‑то отобразить.