BeginTagEx2

Tagovaný PDF & prístupnosť

Opis

Otvorí nový štruktúrny prvok a vloží ho na zásobník tagov, pričom v jednom volaní nastaví všetky hlavné vlastnosti prvku. BeginTagEx2 je zjednodušujúca obálka okolo BeginTagEx nasledovaného SetStructElemTitle, SetStructElemID a SetStructElemExpansion. Prázdny reťazec v ktoromkoľvek z Title, ElemID alebo Expansion preskočí príslušný setter; ostatné parametre sa správajú identicky ako pri BeginTagEx.

BeginTagEx2 použite, keď pri otváraní prvku už poznáte všetky jeho popisné vlastnosti, aby ste sa vyhli viacerým po sebe idúcim volaniam setterov. Ak sa niektorá vlastnosť určí neskôr (napríklad AltText príde asynchrónne), použite BeginTag alebo BeginTagEx a jednotlivé settery zavolajte potom.

Syntax

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

Parametre

TagType	Názov typu štruktúrneho prvku, napr. `Figure`, `Table`, `Span`, `P`. Rovnaké typy, aké prijíma BeginTag.
AltText	Alternatívny text zapísaný do položky /Alt (ISO 32000-1 §14.9.3). Ak chcete položku vynechať, zadajte prázdny reťazec.
ActualText	Skutočný text zapísaný do položky /ActualText (ISO 32000-1 §14.9.4). Ak chcete položku vynechať, zadajte prázdny reťazec.
Lang	Jazyková značka BCP 47 zapísaná do položky /Lang (ISO 32000-1 §14.9.2), napr. `en-US`, `fr`, `zh-Hant-TW`. Ak má dokument jazyk zdediť, zadajte prázdny reťazec.
Title	Ľudsky čitateľná menovka zapísaná do položky /T (ISO 32000-1 §14.7.2). Zobrazuje sa v navigačnom paneli tagov. Ak chcete položku vynechať, zadajte prázdny reťazec.
ElemID	Jedinečný identifikátor prvku zapísaný do položky /ID (ISO 32000-1 §14.7.4). Ak je nastavený, musí byť v rámci dokumentu jedinečný. Ak chcete položku vynechať, zadajte prázdny reťazec.
Expansion	Rozvinutie skratky alebo akronymu zapísané do položky /E (ISO 32000-1 §14.9.5). Ak chcete položku vynechať, zadajte prázdny reťazec.

Návratová hodnota

Vráti 1 pri úspechu, 0, ak nie je vybraný žiadny dokument

Poznámky

Pre každé úspešné volanie BeginTagEx2 zavolajte raz EndTag, aby sa prvok vybral zo zásobníka tagov. Štruktúrne prvky môžu byť vnorené: volanie BeginTagEx2, keď je otvorený iný prvok, vytvorí dcérsky prvok.

Interná implementácia je presne ekvivalentná nasledujúcemu:

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

Jednotlivé settery zostávajú dostupné pre vlastnosti určené po otvorení prvku, alebo pre vlastnosti, ktoré BeginTagEx2 nepokrýva (napríklad AddTagAttribute pre atribúty buniek tabuľky).

Príklad

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

Pozri tiež

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion