BeginTagEx2

Маркиран PDF & достъпност

Описание

Отваря нов структурен елемент и го поставя в стека на етикетите, като задава всички основни свойства на елемента с едно извикване. BeginTagEx2 е удобен обгръщащ слой за BeginTagEx, последван от SetStructElemTitle, SetStructElemID и SetStructElemExpansion. Ако подадете празен низ за някое от Title, ElemID или Expansion, съответният setter се пропуска; останалите параметри се държат точно както при BeginTagEx

Използвайте BeginTagEx2, когато вече знаете всички описателни свойства на елемента в момента, в който го отваряте, за да избегнете няколко последователни извиквания на setter. Ако някое свойство се определя по-късно (например AltText пристига асинхронно), използвайте BeginTag или BeginTagEx и извикайте отделните setter-и след това

Синтаксис

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);

Отделните setter-и остават налични за свойства, определени след отварянето на елемента, или за свойства, които не са обхванати от 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