BeginTagEx2

Getagde PDF en toegankelijkheid

Beschrijving

Opent een nieuw structuurelement en zet het op de tagstack, met alle hoofdeigenschappen in één aanroep. BeginTagEx2 is een handige wrapper voor BeginTagEx gevolgd door SetStructElemTitle, SetStructElemID en SetStructElemExpansion. Een lege string doorgeven voor Title, ElemID of Expansion slaat de bijbehorende setter over; de overige parameters gedragen zich identiek aan BeginTagEx

Gebruik BeginTagEx2 wanneer u alle beschrijvende eigenschappen van een element al kent op het moment van openen, om verschillende opeenvolgende setter-aanroepen te vermijden. Staat een eigenschap pas later vast (bijvoorbeeld: de AltText komt asynchroon binnen), gebruik dan BeginTag of BeginTagEx en roep daarna de afzonderlijke setters aan

Syntaxis

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

Parameters

TagType	De structuurelement-typenaam, bijv. `Figure`, `Table`, `Span`, `P`. Dezelfde types die BeginTag accepteert
AltText	Alternatieve tekst die naar de /Alt-entry wordt geschreven (ISO 32000-1 §14.9.3). Geef een lege string door om die weg te laten
ActualText	Feitelijke tekst die naar de /ActualText-entry wordt geschreven (ISO 32000-1 §14.9.4). Geef een lege string door om die weg te laten
Lang	BCP 47-taaltag die naar de /Lang-entry wordt geschreven (ISO 32000-1 §14.9.2), bijv. `en-US`, `fr`, `zh-Hant-TW`. Geef een lege string door om de documenttaal te erven
Title	Voor mensen leesbaar label dat naar de /T-entry wordt geschreven (ISO 32000-1 §14.7.2). Wordt getoond in het Tags-navigatiepaneel. Geef een lege string door om die weg te laten
ElemID	Unieke elementidentificator die naar de /ID-entry wordt geschreven (ISO 32000-1 §14.7.4). Eenmaal gezet moet hij uniek zijn binnen het document. Geef een lege string door om die weg te laten
Expansion	Uitgeschreven vorm van een afkorting of acroniem die naar de /E-vermelding wordt geschreven (ISO 32000-1 §14.9.5). Geef een lege tekenreeks door om deze weg te laten

Retourwaarde

Geeft bij succes 1 terug, of 0 als er geen document is geselecteerd

Opmerkingen

Roep EndTag één keer aan per geslaagde BeginTagEx2-aanroep om het element van de tagstack te halen. Structuurelementen kunnen genest zijn: BeginTagEx2 aanroepen terwijl er al een element open staat, maakt een child-element

De interne implementatie is exact gelijk aan:

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

Afzonderlijke setters blijven beschikbaar voor eigenschappen die pas na het openen van het element vaststaan, of voor eigenschappen die BeginTagEx2 niet dekt (zoals AddTagAttribute voor tabelcelattributen)

Voorbeeld

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

Zie ook

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion