BeginTagEx2

Структурований PDF та доступність

Опис

Відкриває новий структурний елемент і кладе його на стек тегів, задаючи всі основні властивості елемента одним викликом. BeginTagEx2 — зручна обгортка над 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 якщо документ не вибрано

Примітки

Викличте 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