SetOutlineDestinationFull
نشانک‌ها
توضیحات
مقصد مورد نشانک (bookmark) را روی موقعیت و درصد zoom مشخصی تنظیم می‌کند
نحو
Delphi
Function TPDFlib.SetOutlineDestinationFull(OutlineID, DestPage, Zoom, DestType: Integer; Left, Top, Right, Bottom: Double): Integer;ActiveX
Function PDFlib::SetOutlineDestinationFull(OutlineID As Long, DestPage As Long, Zoom As Long, DestType As Long, Left As Double, Top As Double, Right As Double, Bottom As Double) As LongDLL
int DLSetOutlineDestinationFull(int InstanceID, int OutlineID, int DestPage, int Zoom, int DestType, double Left, double Top, double Right, double Bottom);پارامترها
| OutlineID | شناسهٔ نشانک که توسط تابع NewOutline بازگردانده می‌شود؛ به‌جای آن می‌توانید با تابع GetOutlineID یک شناسهٔ نشانک معتبر بگیرید |
|---|---|
| DestPage | شمارهٔ صفحه‌ای که این مورد نشانک به آن پیوند می‌خورد درصد zoom مورد استفاده وقتی مقصد نشانک باز می‌شود؛ مقادیر معتبر از 0 تا 6400. فقط برای DestType = 1 استفاده می‌شود و باید برای سایر DestTypeها صفر تنظیم شود |
| Zoom | |
| 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 می‌شود که کل ارتفاع کادر مرزی در پنجره جا شود. موقعیت افقی مورد استفاده توسط DestType = 1، 4، 5 و 8 |
| Left | |
| Top | موقعیت عمودی مورد استفاده توسط DestType = 1، 3، 5 و 7 |
| Right | موقعیت افقی لبهٔ راست مستطیل؛ توسط DestType = 5 استفاده می‌شود |
| Bottom | موقعیت افقی لبهٔ پایین مستطیل؛ توسط DestType = 5 استفاده می‌شود |
مقادیر بازگشتی
| 0 | مقصد نشانک تنظیم نشد؛ این معمولاً یعنی پارامترهای Zoom یا DestType خارج از بازه‌اند یا OutlineID نامعتبر است |
|---|---|
| 1 | مقصد نشانک با موفقیت تنظیم شد |