BeginTagEx2

Tagged PDF i dostępność

Opis

Otwiera nowy element struktury i umieszcza go na stosie tagów, ustawiając wszystkie główne właściwości elementu w jednym wywołaniu. BeginTagEx2 jest wygodnym opakowaniem wywołania BeginTagEx, po którym następują SetStructElemTitle, SetStructElemID i SetStructElemExpansion. Przekazanie pustego ciągu dla dowolnego z parametrów Title, ElemID lub Expansion pomija odpowiednią funkcję ustawiającą; pozostałe parametry działają identycznie jak w BeginTagEx.

Użyj BeginTagEx2, gdy wszystkie właściwości opisowe elementu są znane już podczas jego otwierania, aby uniknąć kilku kolejnych wywołań funkcji ustawiających. Jeśli którakolwiek właściwość zostanie ustalona później (na przykład AltText nadejdzie asynchronicznie), użyj BeginTag lub BeginTagEx, a następnie wywołaj poszczególne funkcje ustawiające.

Składnia

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

Parametry

TagType	Nazwa typu elementu struktury, np. `Figure`, `Table`, `Span`, `P`. Akceptowane są te same typy co przez BeginTag.
AltText	Tekst alternatywny zapisywany we wpisie /Alt (ISO 32000-1 §14.9.3). Przekaż pusty ciąg, aby go pominąć.
ActualText	Tekst rzeczywisty zapisywany we wpisie /ActualText (ISO 32000-1 §14.9.4). Przekaż pusty ciąg, aby go pominąć.
Lang	Znacznik języka BCP 47 zapisywany we wpisie /Lang (ISO 32000-1 §14.9.2), np. `en-US`, `fr`, `zh-Hant-TW`. Przekaż pusty ciąg, aby odziedziczyć język dokumentu.
Title	Czytelna dla użytkownika etykieta zapisywana we wpisie /T (ISO 32000-1 §14.7.2). Jest wyświetlana w panelu nawigacyjnym Tags. Przekaż pusty ciąg, aby ją pominąć.
ElemID	Unikatowy identyfikator elementu zapisywany we wpisie /ID (ISO 32000-1 §14.7.4). Jeśli jest ustawiony, musi być unikatowy w obrębie dokumentu. Przekaż pusty ciąg, aby go pominąć.
Expansion	Rozwinięcie skrótu lub akronimu zapisywane we wpisie /E (ISO 32000-1 §14.9.5). Przekaż pusty ciąg, aby je pominąć.

Wartość zwracana

Zwraca 1 w przypadku powodzenia, 0, jeśli nie wybrano dokumentu

Uwagi

Wywołaj EndTag raz dla każdego pomyślnego wywołania BeginTagEx2, aby zdjąć element ze stosu tagów. Elementy struktury można zagnieżdżać: wywołanie BeginTagEx2 przy otwartym innym elemencie tworzy element potomny.

Implementacja wewnętrzna jest dokładnie równoważna:

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

Poszczególne funkcje ustawiające pozostają dostępne dla właściwości ustalonych po otwarciu elementu oraz właściwości nieobsługiwanych przez BeginTagEx2 (na przykład AddTagAttribute dla atrybutów komórek tabeli).

Przykład

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

Zobacz również

BeginTag, BeginTagEx, EndTag, SetStructElemTitle, SetStructElemID, SetStructElemExpansion