BeginTagEx2

Tagged PDF & Accessibility

Popis

Otevře nový strukturální prvek, uloží ho na zásobník tagů a nastaví všechny hlavní vlastnosti prvku jediným voláním. BeginTagEx2 je praktický obal nad BeginTagEx následovaným SetStructElemTitle, SetStructElemID a SetStructElemExpansion. Prázdný řetězec u Title, ElemID nebo Expansion odpovídající setter přeskočí; ostatní parametry se chovají stejně jako u BeginTagEx

BeginTagEx2 použijte, znáte-li už při otevírání prvku všechny jeho popisné vlastnosti, abyste se vyhnuli několika setter voláním za sebou. Určí-li se některá vlastnost později (například AltText dorazí asynchronně), použijte BeginTag nebo BeginTagEx a jednotlivé setter funkce zavolejte poté

Syntaxe

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

Parametry

TagType	Název typu strukturálního prvku, například Figure, Table, Span, P. Týž typy, jaké přijímá BeginTag
AltText	Alternative text written to the /Alt entry (ISO 32000-1 §14.9.3). Pass an empty string to omit.
ActualText	Actual text written to the /ActualText entry (ISO 32000-1 §14.9.4). Pass an empty string to omit.
Lang	BCP 47 language tag written to the /Lang entry (ISO 32000-1 §14.9.2), e.g. `en-US`, `fr`, `zh-Hant-TW`. Pass an empty string to inherit the document language.
Title	Human-readable label written to the /T entry (ISO 32000-1 §14.7.2). Shown in the Tags navigation panel. Pass an empty string to omit.
ElemID	Unique element identifier written to the /ID entry (ISO 32000-1 §14.7.4). Must be unique within the document if set. Pass an empty string to omit.
Expansion	Rozvinutí zkratky nebo akronymu zapisované do položky /E (ISO 32000-1 §14.9.5). Pro vynechání předejte prázdný řetězec

Návratová hodnota

Returns 1 on success, 0 if no document is selected.

Poznámky

Po každém úspěšném volání BeginTagEx2 zavolejte jednou EndTag, čímž prvek ze zásobníku tagů odeberete. Strukturální prvky lze zanořovat: volání BeginTagEx2 za stavu, kdy je jiný prvek otevřený, vytvoří potomka

Interní implementace je přesně ekvivalentní tomuto:

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

Jednotlivé setter funkce zůstávají k dispozici pro vlastnosti určené až po otevření prvku, případně pro vlastnosti, které BeginTagEx2 nepokrývá (například AddTagAttribute pro atributy buněk tabulky)

Pří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;

Viz také

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion