AddPageHeader

دستکاری صفحه, حاشیه‌نویسی‌ها

توضیحات

یک خط سرصفحه‌ی جاری را روی یک یا چند صفحه از سند انتخاب‌شده مهر می‌زند. متن در حالت پوشش با قلم انتخاب‌شده‌ی جاری ترسیم می‌شود، نشانه‌های مهر مانند <%PageNo%> پیش از اندازه‌گیری خط بر پایه‌ی هر صفحه‌ی هدف بسط می‌یابند و خط مهرشده درون یک artifact از نوع Pagination با زیرنوع Header قرار می‌گیرد تا خواننده‌های PDF برچسب‌دار آن را جزو اجزای صفحه ببینند، نه محتوای تکرارشونده

نحو

Delphi

Function TPDFlib.AddPageHeader(Const PageRange, Text: WideString;
  Margin, Opacity: Double; Alignment: Integer): Integer;

پارامترها

PageRangeعبارت گستره‌ی صفحه، یا رشته‌ی خالی برای همه‌ی صفحه‌ها
Textمتن سرصفحه؛ نشانه‌هایی که ExpandStampTokens می‌فهمد بر پایه‌ی هر صفحه‌ی هدف بسط می‌یابند
Marginفاصله از لبه‌ی بالایی صفحه تا خط سرصفحه، بر حسب پوینت PDF
Opacityشفافیت متن بین 0 و 1، که در آن 1 کاملاً مات ترسیم می‌کند
Alignmentمقدار 0 در حاشیه چپ‌چین می‌کند، مقدار 1 میان حاشیه‌ها وسط‌چین می‌کند و مقدار 2 راست‌چین می‌کند و فاصله‌ی حاشیه را از لبه‌ی راست نگه می‌دارد

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

شمار صفحه‌هایی که سرصفحه رویشان مهر خورد، یا 0 وقتی هیچ سندی انتخاب نشده، Text خالی است یا هیچ صفحه‌ای از گستره قابل انتخاب نبود

ملاحظات

خط با قلم و اندازه‌ی جاری اندازه‌گیری می‌شود، پس نخست SelectFont را فراخوانید؛ محتوای از قبل موجود روی صفحه زیر پوشش مرئی می‌ماند. صفحه‌ی انتخاب‌شده هنگام بازگشت فراخوان بازگردانده می‌شود

برای نقش‌های سرصفحه‌ی صفحه‌ی نخست، صفحه‌ی فرد و صفحه‌ی زوج با پشتیبانی محتوای HTML به ApplyPageHeaderFooterSet مراجعه کنید

مثال

PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeader('', 'Quarterly report - page <%PageNo%> of <%TotalPages%>',
  28, 1, 1);