AddPageHeaderFooter
معالجة الصفحات، التعليقات
الوصف
الأساس المشترك وراء AddPageHeader وAddPageFooter. يختم سطرًا جاريًا عند الحافة العليا أو السفلى لكل صفحة في النطاق، باستخدام الخط المحدد حاليًا بوضع التراكب، مع توسيع رموز الختم في مواجهة كل صفحة هدف، وإحاطة النتيجة بنتيجة اصطناعية للترقيم من النوع الفرعي Header أو Footer
الصيغة
Delphi
Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;المعاملات
| PageRange | تعبير نطاق صفحات، أو سلسلة فارغة تعني كل الصفحات |
|---|---|
| Text | نص السطر؛ تتوسع الرموز التي يفهمها ExpandStampTokens في مواجهة كل صفحة هدف |
| Margin | المسافة من الحافة العليا (للرأس) أو الحافة السفلى (للتذييل) إلى السطر، بالنقاط وفق مقاس PDF |
| Opacity | عتامة النص بين 0 و1، حيث ترسم القيمة 1 نصًا معتمًا تمامًا |
| Alignment | القيمة 0 تحاذي يسارًا عند الهامش، والقيمة 1 توسّط بين الهامشين، والقيمة 2 تحاذي يمينًا مع الاحتفاظ بمسافة الهامش من الحافة اليمنى |
| IsHeader | القيمة True تختم رأسًا عند الهامش العلوي، والقيمة False تختم تذييلًا عند الهامش السفلي |
القيم المُعادة
عدد الصفحات التي خُتم عليها السطر، أو 0 حين لا يكون هناك مستند محدد، أو يكون Text فارغًا، أو يتعذّر تحديد أي صفحة من النطاق
ملاحظات
يُقاس السطر بالخط والحجم الحاليين، فاستدعِ SelectFont أولًا. مع IsHeader بالقيمة True يجلس السطر على مسافة Margin من الحافة العليا؛ ومع False يجلس على مسافة Margin من الحافة السفلى، محسوبةً في مواجهة ارتفاع الصفحة الحالي وارتفاع النص. وتُستعاد الصفحة المحددة عند عودة الاستدعاء
مثال
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);