BeginTagEx2

taggad PDF & tillgänglighet

Beskrivning

Öppnar ett nytt strukturelement och pushar det på taggstacken, med alla huvudelementegenskaper satta i ett enda anrop. BeginTagEx2 är en bekvämlighetswrapper för BeginTagEx följt av SetStructElemTitle, SetStructElemID och SetStructElemExpansion. Att skicka en tom sträng för någon av Title, ElemID eller Expansion hoppar över motsvarande setter; de övriga parametrarna beter sig identiskt med BeginTagEx

Använd BeginTagEx2 när du redan känner till alla elementets beskrivande egenskaper när du öppnar det, för att slippa flera setters i rad. Om någon egenskap bestäms senare (till exempel kommer AltText asynkront), använd BeginTag eller BeginTagEx och anropa de enskilda setters i efterhand

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

Parametrar

TagType	Strukturelementtypens namn, t.ex. `Figure`, `Table`, `Span`, `P`. Samma typer som BeginTag accepterar
AltText	Alternativ text som skrivs till posten /Alt (ISO 32000-1 §14.9.3). Ange en tom sträng för att utelämna
ActualText	Faktisk text som skrivs till posten /ActualText (ISO 32000-1 §14.9.4). Ange en tom sträng för att utelämna
Lang	BCP 47-språktagg som skrivs till posten /Lang (ISO 32000-1 §14.9.2), t.ex. `en-US`, `fr`, `zh-Hant-TW`. Ange en tom sträng för att ärva dokumentspråket
Title	Läsbar etikett som skrivs till posten /T (ISO 32000-1 §14.7.2). Visas i navigeringspanelen Tags. Ange en tom sträng för att utelämna
ElemID	Unik elementidentifierare som skrivs till posten /ID (ISO 32000-1 §14.7.4). Måste vara unik inom dokumentet om den sätts. Ange en tom sträng för att utelämna
Expansion	Expansion av en förkortning eller akronym som skrivs till posten /E (ISO 32000-1 §14.9.5). Ange en tom sträng för att utelämna

Returvärde

Returnerar 1 vid lyckat anrop, 0 om inget dokument är valt

Anmärkningar

Anropa EndTag en gång för varje lyckat BeginTagEx2-anrop för att poppa elementet från taggstacken. Strukturelement får nästlas: att anropa BeginTagEx2 medan ett annat element är öppet skapar ett barn-element

Den interna implementationen är exakt ekvivalent med:

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

Enskilda setters förblir tillgängliga för egenskaper som bestäms efter att elementet öppnats, eller för egenskaper som BeginTagEx2 inte täcker (som AddTagAttribute för tabellcellattribut)

Exempel

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

Se även

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion