SetStructElemTitle

PDF balisé & accessibilité

Description

Définit l’entrée /T (titre) de l’élément de structure en cours sur la pile de balises. Le titre est une étiquette lisible caractérisant l’élément précis, par exemple Chapitre 1, Tableau récapitulatif ou Figure 3 : ventes trimestrielles, plutôt qu’une simple répétition du type

Syntaxe

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

Paramètres

Title	Chaîne de texte lisible identifiant cette instance d'élément précise. Transmettez une chaîne vide pour effacer une valeur précédemment définie

Valeur de retour

Renvoie 1 en cas de réussite, 0 si aucun élément de structure n'est actuellement ouvert ou si aucun document n'est sélectionné

Remarques

L'entrée /T est définie dans ISO 32000-1 §14.7.2 Table 324. Elle est écrite comme chaîne de texte PDF dans le dictionnaire de l'élément de structure

Title remplit une fonction distincte des autres propriétés de texte d'un élément de structure :

/T (Title) — Libellé descriptif de l'élément utilisé dans les panneaux de navigation et de balisage, adapté aux titres de section, légendes de tableau et de figure
/Alt (voir SetStructElemAltText) — Substitut textuel complet de l'élément pour les technologies d'assistance lorsqu'il ne peut pas être rendu
/ActualText (voir SetStructElemActualText) — Remplacement Unicode exact des séquences de glyphes dont le texte extrait serait incorrect

Les visualiseurs utilisent /T pour nommer les éléments dans le panneau Tags. Les outils d’accessibilité et de correction l’utilisent comme titre repère. Pour H1–H6, le contenu sert de texte de titre ; /T est surtout utile pour les éléments non textuels (Table, Figure, Form) ou les conteneurs (Sect, Div) nécessitant une étiquette descriptive

Exemple

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

Voir aussi

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemID, GetPDFUADiagnostics