BeginTagEx2

Tagged PDF ja saavutettavuus

Kuvaus

Avaa uuden rakennetyylielementin ja pinoaa sen tagipinoon asettaen kaikki elementin pääominaisuudet yhdellä kutsulla. BeginTagEx2 on apukääre, joka yhdistää BeginTagExin ja sitä seuraavat SetStructElemTitle-, SetStructElemID- ja SetStructElemExpansion-kutsut. Tyhjä merkkijono jossakin Title-, ElemID- tai Expansion-kohdasta ohittaa vastaavan asettajan; muut parametrit toimivat samoin kuin BeginTagExissa

Käytä BeginTagEx2ia, kun tunnet jo elementin kaikki kuvausominaisuudet avaamishetkellä, jolloin vältät useita peräkkäisiä asettajakutsuja. Jos jokin ominaisuus selviää vasta myöhemmin (esimerkiksi AltText saapuu asynkronisesti), käytä funktiota BeginTag tai BeginTagEx ja kutsu yksittäisiä asettajia sen jälkeen

Syntaksi

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

Parametrit

TagType	Rakennetyylielementin tyyppinimi, esimerkiksi `Figure`, `Table`, `Span`, `P`. Samat tyypit, jotka BeginTag hyväksyy
AltText	/Alt-tietueeseen kirjoitettava vaihtoehtoteksti (ISO 32000-1 §14.9.3). Anna tyhjä merkkijono ohittaaksesi
ActualText	/ActualText-tietueeseen kirjoitettava korvaava teksti (ISO 32000-1 §14.9.4). Anna tyhjä merkkijono ohittaaksesi
Lang	/Lang-tietueeseen kirjoitettava BCP 47 -kielitunnus (ISO 32000-1 §14.9.2), esim. `en-US`, `fr`, `zh-Hant-TW`. Anna tyhjä merkkijono periäksesi asiakirjan kielen
Title	/T-tietueeseen kirjoitettava ihmisluettava nimike (ISO 32000-1 §14.7.2). Näkyy Tags-navigointipaneelissa. Anna tyhjä merkkijono ohittaaksesi
ElemID	/ID-tietueeseen kirjoitettava yksilöllinen elementtitunniste (ISO 32000-1 §14.7.4). Asetettuna sen on oltava yksilöllinen asiakirjassa. Anna tyhjä merkkijono ohittaaksesi
Expansion	Lyhenteen tai akronyymin laajennus, joka kirjoitetaan merkintään /E (ISO 32000-1 §14.9.5). Ohita välittämällä tyhjä merkkijono.

Paluuarvo

Palauttaa arvon 1 onnistuessaan, arvon 0, jos mikään asiakirja ei ole valittuna

Huomautukset

Kutsu EndTagia kerran jokaista onnistunutta BeginTagEx2-kutsua kohden poistaaksesi elementin tagipinosta. Rakennetyylielementit voivat olla sisäkkäin: BeginTagEx2-kutsu toisen elementin ollessa avoinna luo lapsielementin

Sisäinen toteutus on täsmälleen sama kuin:

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

Yksittäiset asettajat ovat edelleen käytettävissä ominaisuuksille, jotka selviävät elementin avaamisen jälkeen, tai ominaisuuksille, joita BeginTagEx2 ei kata (esimerkiksi AddTagAttribute taulukon solujen attribuuteille)

Esimerkki

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

Katso myös

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion