ViewerConfig

ViewerConfig (namespace Doconut) tarayıcı görüntüleyicisinin görünüm ve davranışını tanımlar. Belge render kalitesini etkilemez; bunun için bir format yapılandırması kullanın. C# sınıfı ve eski JavaScript eklentisi farklı varsayıllara sahiptir, bu yüzden değerleri açıkça eşleyin.

C# özellikleri

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.

RenderViewer ile ViewerConfig Yayınlama

Viewer.RenderViewer(elementId, token, config) bir ViewerConfig'i widget'ın başlatma betiğine dönüştürür. Yukarıdaki altı özelliği yazar — BasePath, ResPath, ShowThumbs, AutoLoad, PageZoom ve FitType — ve ardından View(token)'ı çağırır. Diğer özellikler yazılmaz: MaxZoom, ShowHyperlinks, yakınlaştırma ayarları veya herhangi bir geri çağırma için, widget'ı aşağıdaki JavaScript seçenekleriyle kendiniz başlatın. RenderViewer için Görüntüleyici sayfasına bakın.

C#'tan JavaScript'e eşleme

Doğrudan serileştirilmiş bir ViewerConfig'i docViewer(...)'a geçirmeyin. Çoğu widget anahtarı camelCase iken, üç belirlenmiş yol/fit anahtarı PascalCase'dir.

JavaScript varsayılanları

Widget, C# sınıfından farklı eski varsayılanlara sahiptir. Aşağıdaki değerler mevcut docViewer.js uygulamasından gelmektedir.

Davranışsal olarak önemli tüm değerleri ayarlayın, varsayılanlardan birine güvenmek yerine:

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

Geri çağrılar

Geri çağrıları hızlı tutun; telemetrileri asenkron gönderin ve sayfa renderını engellemeyin.

Genel yöntem grupları

JavaScript dosyası ayrıca dahili yardımcılar içerir. Referans UI tarafından kullanılan ve burada ya da özellik kılavuzlarında belgelenen yöntemleri, kararlı entegrasyon noktaları olarak değerlendirin.

Yeniden deneme seçenekleri

Widget ayrıca retryOn409 ve geri çekilme ayarlarını (retryInitialDelayMs, retryBackoffFactor, retryMaxDelayMs, retryMaxAttempts, retryMaxTotalMs) kabul eder. Bunlar, sayfalarının arka planda üretildiği dağıtımlara hizmet eder. DocImage.axd istek sırasında her sayfayı render eder, bu yüzden retryOn409 kapalı bırakılmalıdır.

Yol kontrol listesi

• BasePath, DocImage.axd işleyicisi site kökünde olduğunda '/' olur — Web.config içindeki işleyicinin path özniteliği nerede yanıt vereceğini belirler. Sanal bir dizinde, başında / olmadan dizin adını kullanın ('myapp', '/myapp' değil: görüntüleyici eğik çizgiyi ekler ve //myapp/... başka bir ana bilgisayara istek olur).
• DoconutOptions.ResourcesPath, kaynak modülünün gömülü dosyaları hizmet ettiği yerdir (/doconut-res varsayılan olarak).
• ResPath, images alt klasörünü hedefler ve yine başında / olmadan ('doconut-res/images'). Bunu 'doconut-res' olarak ayarlamak, her simgenin 404 hatası almasına neden olurken belge yine de render edilir.
• MVC'de, ResourcesPath'i değiştirdiğinizde routes.IgnoreRoute("doconut-res/{*pathInfo}") bu ayarın ardından gelmelidir.
• ExtractHyperlinks, showHyperlinks'in bir şey gösterebilmesi için sunucu format yapılandırmasında etkinleştirilmelidir.