BeginTagEx2

Tagged PDF & tilgængelighed

Beskrivelse

Åbner et nyt strukturelement og skubber det på tagstakken, mens alle elementets vigtigste egenskaber indstilles i ét kald. BeginTagEx2 er en hjælpeindpakning for BeginTagEx efterfulgt af SetStructElemTitle, SetStructElemID og SetStructElemExpansion. Hvis der angives en tom streng for Title, ElemID eller Expansion, springes den tilsvarende setter over; de øvrige parametre opfører sig på samme måde som i BeginTagEx

Brug BeginTagEx2, når du allerede kender alle et elements beskrivende egenskaber, når du åbner det, for at undgå flere efterfølgende setterkald. Hvis en egenskab først fastlægges senere (for eksempel hvis AltText modtages asynkront), skal du bruge BeginTag eller BeginTagEx og derefter kalde de enkelte settere.

Syntaks

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	Strukturelementets typenavn, f.eks. `Figure`, `Table`, `Span`, `P`. De samme typer, som BeginTag accepterer.
AltText	Alternativ tekst skrevet til /Alt-posten (ISO 32000-1 §14.9.3). Angiv en tom streng for at udelade den.
ActualText	Den faktiske tekst, der skrives til posten /ActualText (ISO 32000-1 §14.9.4). Angiv en tom streng for at udelade den.
Lang	BCP 47-sprogtag skrevet til posten /Lang (ISO 32000-1 §14.9.2), f.eks. `en-US`, `fr`, `zh-Hant-TW`. Angiv en tom streng for at arve dokumentets sprog.
Title	Menneskeligt læsbar etiket, der skrives til /T-posten (ISO 32000-1 §14.7.2). Vises i navigationspanelet Tags. Angiv en tom streng for at udelade den.
ElemID	Entydig elementidentifikator, der skrives til posten /ID (ISO 32000-1 §14.7.4). Skal være entydig i dokumentet, hvis den angives. Angiv en tom streng for at udelade den
Expansion	Udfoldelse af en forkortelse eller et akronym, der skrives til posten /E (ISO 32000-1 §14.9.5). Angiv en tom streng for at udelade den

Returværdi

Returnerer 1 ved succes, 0 hvis intet dokument er valgt.

Bemærkninger

Kald EndTag én gang for hvert vellykket kald til BeginTagEx2 for at fjerne elementet fra tagstakken. Strukturelementer kan indlejres: Et kald til BeginTagEx2, mens et andet element er åbent, opretter et underordnet element

Den interne implementering svarer nøjagtigt til:

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

Individuelle settere er fortsat tilgængelige for egenskaber, der bestemmes efter åbning af elementet, eller for egenskaber, der ikke dækkes af BeginTagEx2 (f.eks. AddTagAttribute til tabelcelleattributter).

Eksempel

// 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 også

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion