ViewerConfig

خيارات عنصر واجهة المشاهد للعميل

ViewerConfig (namespace Doconut) يصف مظهر وسلوك عارض المتصفح. لا يؤثر على جودة عرض المستند؛ استخدم تكوين تنسيق لهذا الغرض. فئة C# وإضافة JavaScript القديمة لهما إعدادات افتراضية مختلفة، لذا قم بربط القيم صراحةً.

خصائص C#

النوعالخاصيةالافتراضيالوصف
boolShowThumbstrueإظهار لوحة الصور المصغرة.
boolAutoLoadfalseتحميل تلقائي بعد التهيئة. تدفق الرموز العادي يستدعي View(token) صراحةً.
boolAutoFocustrueنقل تركيز المتصفح/التمرير إلى العارض أثناء التهيئة.
boolAutoPageFocustrueإبقاء الصورة المصغرة الحالية مرئية أثناء تغيير الصفحات.
intPageZoom100نسبة التكبير الأولية.
intZoomStep10النسبة المضافة أو المزالة بأوامر التكبير.
intMaxZoom300الحد الأقصى لنسبة التكبير.
boolShowToolTiptrueإظهار تلميح موضع الصفحة أثناء التمرير.
stringToolTipPageText"Page "البادئة المستخدمة في تلميح الصفحة.
boolCacheEnabledfalseالاحتفاظ بنفذة متحركة من صور الصفحات في ذاكرة المتصفح. لا يستخدم localStorage.
boolLargeDocfalseإضافة عناصر الصفحة على دفعات زمنية للوثائق الكبيرة.
boolShowHyperlinksfalseعرض طبقات الروابط الفوقية عندما يستخرجها تكوين الخادم.
boolFixedZoomtrueاستخدام نسبة تكبير ثابتة بدلاً من إعادة حساب استجابية.
intFixedZoomPercent100تكبير ثابت لسطح المكتب.
intFixedZoomPercentMobile75تكبير ثابت للجوال.
stringBasePath"/"المكان الذي يرسل فيه العارض طلبات الصفحات. "/" هو DocImage.axd في جذر الموقع؛ وإلا الفرع حيث يطابق المضيف UseDoconut()، بدون / أولية ("doconut" يعني /doconut/DocImage.axd).
stringResPath"doconut-res/images" (26.9.0; "doconut-res" before)المجلد الذي يحمل منه العنصر صوره الخاصة: مجلد images تحت ResourcesPath، بدون / أولية.
stringFitType"width""width"، "height"، أو فارغ لعدم وجود ملاءمة تلقائية. "page" غير مقبول في العنصر الحالي.
boolRetryOn409falseتمكين الاستطلاع عندما تستجيب إنتاج الصفحات غير المتزامنة/الموزعة 202 Accepted؛ 409 مقبول أيضًا للتوافق مع الخوادم القديمة. غير مطلوب من قبل العارض المتزامن العادي.
csharp
var config = new ViewerConfig
{
    ShowThumbs = true,
    AutoLoad = false,
    PageZoom = 100,
    MaxZoom = 300,
    FitType = "width",
    BasePath = "doconut",           // لا يوجد '/' في البداية: العارض يضيفه ("/doconut" سيصبح //doconut، مضيف آخر)
    ResPath = "doconut-res/images",
    ShowHyperlinks = true
};

ربط C# إلى JavaScript

لا تمرر ViewerConfig مسلسلاً مباشرةً إلى docViewer(...). معظم مفاتيح العنصر هي camelCase، بينما ثلاثة مفاتيح مسار/ملاءمة معروفة هي PascalCase.

C#JavaScript
ShowThumbsshowThumbs
AutoLoadautoLoad
AutoFocusautoFocus
AutoPageFocusautoPageFocus
PageZoompageZoom
ZoomStepzoomStep
MaxZoommaxZoom
ShowToolTipshowToolTip
ToolTipPageTexttoolTipPageText
CacheEnabledcacheEnabled
LargeDoclargeDoc
ShowHyperlinksshowHyperlinks
FixedZoomfixedZoom
FixedZoomPercentfixedZoomPercent
FixedZoomPercentMobilefixedZoomPercentMobile
BasePathBasePath
ResPathResPath
FitTypeFitType
RetryOn409retryOn409

الإعدادات الافتراضية لجافاسكريبت

الودجت يحتوي على إعدادات افتراضية أقدم تختلف عن فئة C#. القيم التالية مأخوذة من تنفيذ docViewer.js الحالي.

الخيارالافتراضيالملاحظات
leftMinWidth / leftMaxWidth220 / 800حدود عرض لوحة المصغرات.
showThumbstrueرؤية المصغرات الأولية.
autoFocus / autoPageFocustrue / falseautoPageFocus يختلف عن الإعداد الافتراضي للغة C#.
thumbWidth / thumbHeight / thumbPadding150 / 200 / 10هندسة المصغرات بالبكسل.
pageZoom / zoomStep / maxZoom100 / 10 / 200JavaScript maxZoom يختلف عن C# (300).
showToolTip / toolTipPageTexttrue / "Page "تلميح موضع الصفحة.
format / doc / AccessToken"" / 0 / ""قيم التهيئة الداخلية؛ عادةً ما يملأها View(token).
debugModefalseتشخيصات إضافية للعميل.
FitType""لا يوجد تعديل تلقائي ما لم يتم توفيره.
BasePath"DocImage.axd"الإعداد الافتراضي للمعالج القديم. قم بتعيينه صراحةً لـ ASP.NET Core.
ResPath""قم بتعيينه صراحةً إلى مسار الصور المدمجة.
cacheEnabled / cacheCount / cacheDelayfalse / 3 / 3نافذة تحميل الصفحات مسبقًا في الذاكرة والمدة.
autoLoadfalseيُوصى بتدفق الرموز الصريح.
largeDoctrueيختلف عن الإعداد الافتراضي للغة C#.
fixedZoomfalseيختلف عن الإعداد الافتراضي للغة C#.
fixedZoomPercent / fixedZoomPercentMobile100 / 50القيمة المحمولة تختلف عن C# (75).
showHyperlinkstrueيتطلب استخراجًا من جانب الخادم لإنتاج الطبقات المتراكبة.

قم بتعيين جميع القيم المهمة سلوكيًا بدلاً من الاعتماد على أي من مجموعتي الإعدادات الافتراضية:

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

ردود النداء

رد النداءالمعلماتالغرض
onPageLoadingpageNumبدء طلب صفحة.
onPageLoadedpageNumانتهى تحميل صورة الصفحة.
onThumbnailClickedpageNumاختار المستخدم مصغرة.
onPageClickedpageNumاختار المستخدم صفحة.
onDoubleClicknoneاستقبل المشاهد نقرة مزدوجة.
onViewerBusynoneدخل المشاهد حالة الانشغال.
onViewerReadynoneاكتملت التهيئة.
onViewerErrornoneدخل المشاهد حالة الخطأ.
onErrormessageأرجعت عملية رسالة خطأ.
onCopydataبيانات نسخ النص متاحة.
onAutoLoadStatuspageNumتقدم التحميل التلقائي إلى صفحة.
onThumbsShownnoneظهرت لوحة المصغرات.
onAnnLoadednoneتم تحميل بيانات التعليقات التوضيحية.
onAnnSavednoneتم حفظ بيانات التعليقات التوضيحية.
onAnnSaveErrornoneفشل حفظ التعليقات التوضيحية.
onAnnClosednoneتم إغلاق واجهة التعليقات التوضيحية.

حافظ على سرعة ردود النداء؛ أرسل بيانات القياس بشكل غير متزامن ولا تحجب عرض الصفحة.

مجموعات الطرق العامة

المجموعةالطرق الشائعة
دورة الحياةView(token, accessToken?), Close(server?), Token(), Init(), IsLoaded()
التنقلGotoPage(page), ShowPage(page, focus?), Next(next), CurrentPage(), TotalPages()
التكبير والملاءمةZoom(zoomIn), CurrentZoom(), FitType(value), Refit()
الاتجاهRotate(page, angle), Flip(page, flipType)
المصغراتHideThumbs(hide), ThumbSize(size), ReloadThumbs(width), ScrollToThumb(thumb)
البحثCanSearch(), Search(...), SearchMatchCount(), SearchSummary(...), GotoSearchMatch(...)
التعليقات التوضيحيةSaveAnnotations(), GetAnnotations(), PushAnnotations(...), CloseAnnotations(...), ShowAnnotations(...)
النسخCopy(...), CopyPage(pageNumber), CopyMode(enabled)

يحتوي ملف جافاسكريبت أيضًا على مساعدات داخلية. اعتبر فقط الطرق المستخدمة من قبل واجهة المستخدم المرجعية والموثقة هنا أو في أدلة الميزات كنقاط دمج مستقرة.

إعادة المحاولة بينما لا يزال الصفحة الموزعة تُعرض

retryOn409 يحتفظ باسمه التاريخي. وهو مخصص لإنتاج الصفحات غير المتزامنة ويعيد محاولة استجابة الجاهزية الحالية 202 Accepted بالإضافة إلى الإشارة القديمة 409 Conflict. عند التمكين، يقوم الودجت بالاستطلاع باستخدام هذه الإعدادات الافتراضية لجافاسكريبت:

الخيارالافتراضي
retryInitialDelayMs250
retryBackoffFactor1.6
retryMaxDelayMs2500
retryMaxAttempts150
retryMaxTotalMs300000

اتركه معطلاً للمشاهد العادي. تمكينه لا يمكن أن يجعل عرضًا متزامنًا غير مدعومًا غير متزامن.

قائمة التحقق من المسار

  • DoconutOptions.MiddlewarePath يجب أن يصف الفرع الذي تقوم بربطه فعليًا.
  • BasePath يجب أن يستهدف ذلك الفرع، مكتوبًا بدون / البادئ ('doconut'، وليس '/doconut': يضيف المشاهد الشرطة المائلة، و//doconut/... هو طلب إلى مضيف آخر).
  • DoconutOptions.ResourcesPath هو مسار المورد المدمج.
  • ResPath عادةً ما يستهدف المجلد الفرعي images الخاص به، أيضًا بدون / البادئ ('doconut-res/images').
  • ExtractHyperlinks يجب تمكينه في تكوين تنسيق الخادم قبل أن يتمكن showHyperlinks من عرض أي شيء.

هل كانت هذه الصفحة مفيدة؟