BeginTagEx2

PDF מתויג ונגישות

תיאור

פותח structure element חדש ודוחף אותו אל מחסנית התגים, תוך הגדרת כל מאפייני האלמנט הראשיים בקריאה אחת. ‏BeginTagEx2 הוא wrapper נוח עבור BeginTagEx ואחריו SetStructElemTitle, SetStructElemID ו-SetStructElemExpansion. העברת מחרוזת ריקה עבור כל אחד מ-Title, ElemID או Expansion מדלגה על ה-setter המתאים; שאר הפרמטרים מתנהגים בדיוק כמו ב-BeginTagEx

השתמשו ב-BeginTagEx2 כשאתם כבר יודעים את כל המאפיינים התיאוריים של אלמנט ברגע שאתם פותחים אותו, כדי להימנע מכמה קריאות setter עוקבות. אם מאפיין כלשהו נקבע מאוחר יותר (למשל, ה-AltText מגיע אסינכרונית), השתמשו ב-BeginTag או ב-BeginTagEx וקראו ל-setters הבודדים לאחר מכן

תחביר

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	שם טיפוס ה-structure element, למשל `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 אם לא נבחר מסמך

הערות

יש לקרוא ל-EndTag פעם אחת עבור כל קריאה מוצלחת ל-BeginTagEx2, כדי להוציא את הרכיב ממחסנית התגים. ניתן לקנן רכיבי מבנה: קריאה ל-BeginTagEx2 כשכבר פתוח רכיב אחר יוצרת רכיב צאצא.

המימוש הפנימי זהה לחלוטין ל:

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

ה-setters הבודדים נשארים זמינים עבור מאפיינים שנקבעים אחרי שהאלמנט נפתח, או עבור מאפיינים שאינם מכוסים על ידי 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