BeginTagEx2

PDF برچسب‌گذاری‌شده و دسترس‌پذیری

توضیحات

عنصر ساختاری جدیدی باز و روی پشتهٔ تگ می‌گذارد و همهٔ ویژگی‌های اصلی عنصر را در یک فراخوانی تنظیم می‌کند. BeginTagEx2 wrapper راحتی برای BeginTagEx همراه SetStructElemTitle، SetStructElemID و SetStructElemExpansion است. پاس دادن رشتهٔ خالی برای هر یک از Title، ElemID یا Expansion، تنظیم‌کنندهٔ مربوطه را رد می‌کند؛ سایر پارامترها دقیقاً مانند BeginTagEx رفتار می‌کنند

وقتی از قبل همهٔ ویژگی‌های توصیفی عنصر را هنگام باز کردنش می‌دانید از BeginTagEx2 استفاده کنید تا از چند فراخوانی تنظیم‌کنندهٔ پشت‌سرهم پرهیز شود. اگر ویژگی‌ای بعداً تعیین می‌شود (مثلاً AltText غیرهمگام می‌رسد) از BeginTag یا BeginTagEx استفاده و بعد تنظیم‌کننده‌های جدا را صدا بزنید

نحو

Delphi

Function TPDFlib.BeginTagEx2(Const TagType, AltText, ActualText, Lang, Title, ElemID, Expansion: WideString): Integer;

ActiveX

Function PDFlib::BeginTagEx2(TagType As String, AltText As String, ActualText As String, Lang As String, Title As String, ElemID As String, Expansion As String) As Long

DLL

int DLBeginTagEx2(int InstanceID, const wchar_t * TagType, const wchar_t * AltText, const wchar_t * ActualText, const wchar_t * Lang, const wchar_t * Title, const wchar_t * ElemID, const wchar_t * Expansion);

پارامترها

TagType	نام نوع عنصر ساختاری، مثلاً `Figure`، `Table`، `Span`، `P`. همان نوع‌هایی که BeginTag می‌پذیرد
AltText	متن جایگزین که به مدخل /Alt (ISO 32000-1 §14.9.3) نوشته می‌شود. برای حذف، رشتهٔ خالی بدهید
ActualText	متن واقعی که به مدخل /ActualText (ISO 32000-1 §14.9.4) نوشته می‌شود. برای حذف، رشتهٔ خالی بدهید
Lang	برچسب زبان BCP 47 که به مدخل /Lang (ISO 32000-1 §14.9.2) نوشته می‌شود، مثلاً `en-US`، `fr`، `zh-Hant-TW`. برای ارث‌بری زبان سند، رشتهٔ خالی بدهید
Title	برچسب خوانا برای انسان که به مدخل /T (ISO 32000-1 §14.7.2) نوشته می‌شود. در پنل ناوبری Tags نمایش داده می‌شود. برای حذف، رشتهٔ خالی بدهید
ElemID	شناسهٔ یکتای عنصر که به مدخل /ID (ISO 32000-1 §14.7.4) نوشته می‌شود. در صورت تنظیم، باید درون سند یکتا باشد. برای حذف، رشتهٔ خالی بدهید
Expansion	بسط یک مخفف یا سرواژه که در ورودی /E نوشته می‌شود (ISO 32000-1 §14.9.5)؛ برای حذف آن، یک رشته خالی ارسال کنید

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

در صورت موفقیت 1 برمی‌گرداند؛ اگر سندی انتخاب نشده باشد 0

ملاحظات

برای خارج‌کردن عنصر از پشته tag، برای هر فراخوانی موفق EndTag یک‌بار BeginTagEx2 را فراخوانی کنید. عناصر ساختاری می‌توانند تو‌در‌تو باشند؛ وقتی عنصر دیگری باز است، فراخوانی BeginTagEx2 یک عنصر فرزند ایجاد می‌کند

پیاده‌سازی داخلی دقیقاً معادل این است:

BeginTagEx(TagType, AltText, ActualText, Lang);
if Title <> '' then SetStructElemTitle(Title);
if ElemID <> '' then SetStructElemID(ElemID);
if Expansion <> '' then SetStructElemExpansion(Expansion);

تنظیم‌کننده‌های جدا برای ویژگی‌هایی که پس از باز شدن عنصر تعیین می‌شوند یا برای ویژگی‌هایی که BeginTagEx2 نمی‌پوشاند (مثل AddTagAttribute برای ویژگی‌های سلول جدول) همچنان در دسترس‌اند

مثال

// Tag a figure with all descriptive properties in one call
PDFlib.BeginTagEx2(
  'Figure',                              // TagType
  'Bar chart: Q1 120, Q2 145, Q3 98',   // AltText
  '',                                    // ActualText (not needed for images)
  '',                                    // Lang (inherit document language)
  'Figure 3: Quarterly Sales',           // Title
  'fig-quarterly-sales',                 // ElemID
  ''                                     // Expansion (not an abbreviation)
);
PDFlib.SetStructElemBBox(x, y, x + w, y + h);
PDFlib.DrawImage(imgHandle, x, y, w, h);
PDFlib.EndTag;

// Tag an acronym span with its expansion
PDFlib.BeginTagEx2(
  'Span',
  '',                                          // AltText
  '',                                          // ActualText
  '',                                          // Lang
  '',                                          // Title
  '',                                          // ElemID
  'World Wide Web Consortium'                  // Expansion
);
PDFlib.WriteText('W3C');
PDFlib.EndTag;

همچنین ببینید

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion