SetStructElemTitle

Tagged PDF i dostępność

Opis

Ustawia wpis /T (tytuł) w elemencie struktury aktualnie tworzonym na stosie tagów. Tytuł jest czytelną dla człowieka etykietą opisującą konkretny element — na przykład Chapter 1, Summary Table lub Figure 3: Quarterly Sales — a nie jedynie powtórzeniem typu elementu

Składnia

Delphi

Function TPDFlib.SetStructElemTitle(Const Title: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemTitle(Title As String) As Long

DLL

int DLSetStructElemTitle(int InstanceID, const wchar_t * Title);

Parametry

Title	Czytelny dla człowieka ciąg tekstowy identyfikujący tę konkretną instancję elementu. Przekaż pusty ciąg, aby usunąć wcześniej ustawioną wartość

Wartość zwracana

Zwraca 1 w przypadku powodzenia albo 0, gdy żaden element struktury nie jest obecnie otwarty lub nie wybrano dokumentu

Uwagi

Wpis /T zdefiniowano w tabeli 324 normy ISO 32000-1 §14.7.2. Jest zapisywany jako ciąg tekstowy PDF w słowniku elementu struktury

Title pełni inną funkcję niż pozostałe właściwości tekstowe elementu struktury:

/T (Title) — Opisowa etykieta elementu używana w panelach nawigacji i tagów. Odpowiednia dla nagłówków sekcji, podpisów tabel i podpisów ilustracji
/Alt (zobacz SetStructElemAltText) — Pełny tekstowy zamiennik elementu dla technologii asystującej, gdy elementu nie można wyrenderować
/ActualText (zobacz SetStructElemActualText) — Dokładny zamiennik Unicode dla sekwencji glifów, których wyodrębniony tekst byłby nieprawidłowy

Przeglądarki PDF używają /T do etykietowania elementów w panelu nawigacyjnym Tags. Narzędzia dostępności i oprogramowanie naprawcze wykorzystują go jako tytuł punktu orientacyjnego w nawigacji po dokumencie. Dla elementów nagłówków (H1–H6) sam tekst elementu pełni rolę nagłówka; /T jest bardziej przydatny dla elementów nietekstowych (Table, Figure, Form) lub kontenerów (Sect, Div), które wymagają etykiety opisowej

Przykład

// Tag a data table with a title for navigation and accessibility tools
PDFlib.BeginTag('Table', '', '');
PDFlib.SetStructElemTitle('Table 2: Annual Revenue by Region');
// ... table rows and cells
PDFlib.EndTag;

// Tag a document section
PDFlib.BeginTag('Sect', '', '');
PDFlib.SetStructElemTitle('Chapter 3: Implementation');
// ... section content
PDFlib.EndTag;

Zobacz również

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemID, GetPDFUADiagnostics