SetOutlineRemoteDestination

نشانک‌ها

توضیحات

مورد نشانک (bookmark) را طوری تنظیم می‌کند که با کلیک، PDF دیگری باز شود

می‌توان شمارهٔ صفحهٔ آغازین و مقادیر گوناگون اندازه/موقعیت را مشخص کرد

توجه: چون اندازه صفحه سند مقصد مشخص نیست، همه موقعیت‌ها برحسب points و از گوشه پایین-چپ صفحه آغازین مشخص می‌شوند

نحو

Delphi

Function TPDFlib.SetOutlineRemoteDestination(OutlineID: Integer; Const FileName: WideString; OpenPage, Zoom, DestType: Integer; PntLeft, PntTop, PntRight, PntBottom: Double; NewWindow: Integer): Integer;

ActiveX

Function PDFlib::SetOutlineRemoteDestination(OutlineID As Long, FileName As String, OpenPage As Long, Zoom As Long, DestType As Long, PntLeft As Double, PntTop As Double, PntRight As Double, PntBottom As Double, NewWindow As Long) As Long

DLL

int DLSetOutlineRemoteDestination(int InstanceID, int OutlineID, const wchar_t * FileName, int OpenPage, int Zoom, int DestType, double PntLeft, double PntTop, double PntRight, double PntBottom, int NewWindow);

پارامترها

OutlineID

شناسه outline، همان‌طور که تابع NewOutline برمی‌گرداند. راه دیگر این است که برای گرفتن یک outline ID معتبر از تابع GetOutlineID استفاده کنید

FileName

نام فایل سند PDF که هنگام کلیک روی outline باز می‌شود. این نام باید قالب مشخصی داشته باشد. بک‌اسلش‌ها باید به اسلش تبدیل شوند و درایو، در صورت وجود، باید فقط به‌صورت حرف درایو بین اسلش‌ها و بدون دونقطه مشخص شود. برای نمونه، فایل "c:\my documents\hello.pdf" باید به‌صورت "/c/my documents/hello.pdf" مشخص شود. نام مسیرهای نسبی معتبرند، از جمله مسیرهایی که عملگر ".." را برای رفتن به پوشه بالاتر دربر می‌گیرند

OpenPage

شمارهٔ صفحه برای پرش هنگام باز شدن سند هدف؛ اولین صفحه شاخص صفر (0) دارد

Zoom

درصد zoom هنگام باز شدن سند؛ مقادیر معتبر از 0 تا 6400. فقط برای DestType = 1 استفاده می‌شود و برای سایر DestTypeها باید صفر تنظیم شود

DestType

1 = "XYZ" - صفحهٔ مقصد در نقطه‌ای قرار می‌گیرد که پارامترهای Left و Top مشخص می‌کنند؛ پارامتر Zoom درصد zoom را تعیین می‌کند

2 = "Fit" - کل صفحه طوری zoom می‌شود که در پنجره جا شود؛ از سایر پارامترها استفاده نمی‌شود و باید صفر تنظیم شوند

3 = "FitH" - صفحه چنان zoom می‌شود که تمام عرض آن دیده شود. ارتفاع صفحه ممکن است از ارتفاع پنجره بیشتر یا کمتر باشد. صفحه در موقعیت عمودی تعیین‌شده توسط پارامتر Top قرار می‌گیرد

4 = "FitV" - صفحه طوری zoom می‌شود که کل ارتفاعش دیده شود؛ عرض صفحه می‌تواند از عرض پنجره بیشتر یا کمتر باشد؛ صفحه در موقعیت افقی‌ای قرار می‌گیرد که پارامتر Left مشخص می‌کند

5 = "FitR" - صفحه طوری zoom می‌شود که مستطیل معینی از آن دیده شود؛ پارامترهای Left، Top، Right و Bottom ناحیهٔ مستطیلی روی صفحه را تعریف می‌کنند

6 = "FitB" - صفحه طوری zoom می‌شود که کادر مرزی آن دیده شود

7 = "FitBH" - صفحه به‌صورت عمودی در موقعیت قرار می‌گیرد که پارامتر Top مشخص می‌کند و طوری zoom می‌شود که کل عرض کادر مرزی صفحه دیده شود

8 = "FitBV" - صفحه در موقعیت افقی‌ای قرار می‌گیرد که پارامتر Left مشخص می‌کند و فقط به اندازه‌ای zoom می‌شود که کل ارتفاع کادر مرزی در پنجره جا شود

PntLeft

موقعیت افقی مورد استفاده برای DestType = 1، 4، 5 و 8. موقعیت برحسب point و از گوشه پایین‌چپ صفحه document's سند مقصد اندازه‌گیری می‌شود

PntTop

موقعیت عمودی مورد استفاده توسط DestType = 1، 3، 5 و 7. موقعیت بر حسب point و اندازه‌گیری‌شده از گوشهٔ پایین-چپ صفحهٔ سند هدف مشخص می‌شود

PntRight

موقعیت افقی لبهٔ راست مستطیل؛ توسط DestType = 5 استفاده می‌شود. موقعیت بر حسب point و اندازه‌گیری‌شده از گوشهٔ پایین-چپ صفحهٔ سند هدف مشخص می‌شود

PntBottom

موقعیت افقی لبهٔ پایین مستطیل؛ توسط DestType = 5 استفاده می‌شود. موقعیت بر حسب point و اندازه‌گیری‌شده از گوشهٔ پایین-چپ صفحهٔ سند هدف مشخص می‌شود

NewWindow

0 = جایگزینی سند جاری با سند مقصد

1 = باز کردن سند مقصد در پنجرهٔ جدید، مگر آنکه کاربر در PDF viewer ترجیح دیگری تعیین کرده باشد

مقادیر بازگشتی

0مقدار OutlineID نامعتبر بود
1مقصد نشانک با موفقیت تنظیم شد double PntBottom, int NewWindow);