BeginTagEx2

Címkézett PDF & akadálymentesség

Leírás

Új struktúraelemet nyit meg, a tagverembe helyezi, és egyetlen hívással beállítja az elem összes fő tulajdonságát. A BeginTagEx2 a BeginTagEx kényelmi wrapperje, amelyet a SetStructElemTitle, a SetStructElemID és a SetStructElemExpansion hívása követ. Ha a Title, ElemID vagy Expansion bármelyikéhez üres karakterláncot ad át, a megfelelő setter kimarad; a többi paraméter a BeginTagEx paramétereivel azonosan működik

Használja a BeginTagEx2 függvényt, amikor egy elem megnyitásakor már ismeri annak minden leíró tulajdonságát, így elkerülheti több egymást követő setterhívást. Ha valamelyik tulajdonság csak később határozható meg (például az AltText aszinkron módon érkezik), használja a BeginTag vagy BeginTagEx függvényt, majd ezután hívja meg az egyes settereket

Szintaxis

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

Paraméterek

TagType	A struktúraelem típusneve, például `Figure`, `Table`, `Span`, `P`. Ugyanazok a típusok engedélyezettek, mint az BeginTag esetén
AltText	A /Alt bejegyzésbe írt alternatív szöveg (ISO 32000-1 §14.9.3) Az elhagyásához adjon át üres karakterláncot
ActualText	A /ActualText bejegyzésbe írt tényleges szöveg (ISO 32000-1 §14.9.4). Az elhagyásához adjon át üres karakterláncot
Lang	A /Lang bejegyzésbe írt BCP 47 nyelvi címke (ISO 32000-1 §14.9.2), például `en-US`, `fr`, `zh-Hant-TW`. A dokumentumnyelv örökléséhez üres karakterláncot adjon át
Title	A /T bejegyzésbe írt, ember számára olvasható címke (ISO 32000-1 §14.7.2) A Címkék navigációs panelen jelenik meg Üres karakterlánc átadásával elhagyható
ElemID	Egyedi elemazonosító, amely a /ID bejegyzésbe íródik (ISO 32000-1 §14.7.4). Beállítás esetén a dokumentumon belül egyedinek kell lennie. Az elhagyásához üres karakterláncot adjon át
Expansion	A /E bejegyzésbe írt rövidítés vagy mozaikszó kibontása (ISO 32000-1 §14.9.5). Az elhagyáshoz adjon át üres karakterláncot

Visszatérési érték

Siker esetén 1-et, dokumentum kiválasztásának hiányakor 0-t ad vissza

Megjegyzések

Minden sikeres EndTag híváshoz egyszer hívja meg az BeginTagEx2 után az elem címkeveremből való eltávolításához. A struktúraelemek beágyazhatók: ha másik elem nyitva van, a BeginTagEx2 hívása gyermekelemet hoz létre

A belső megvalósítás pontosan egyenértékű a következővel:

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

Az egyedi beállítók továbbra is elérhetők az elem megnyitása után meghatározott tulajdonságokhoz, illetve a BeginTagEx2 által nem lefedett tulajdonságokhoz (például táblázatcellák attribútumaihoz a AddTagAttribute)

Példa

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

Lásd még

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion