AddPageHeader
معالجة الصفحات، التعليقات
الوصف
يختم سطر رأس جارٍ على صفحة واحدة أو أكثر من المستند المحدد. يُرسم النص بوضع التراكب بالخط المحدد حاليًا، وتُوسَّع رموز الختم مثل <%PageNo%> في مواجهة كل صفحة هدف قبل قياس السطر، ويُحاط السطر المختوم بنتيجة اصطناعية للترقيم من النوع الفرعي 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);