SetStructElemTitleA

taggad PDF & tillgänglighet

Beskrivning

Det avslutande A:et betecknar ANSI (char)-DLL-ingångspunkten; ActiveX/COM-ytan exponerar bara Unicode-formen. Beteendet är identiskt med SetStructElemTitle och strängargument tolkas med aktuell SetAnsiMode-kod sida

Sätter posten /T (titel) på det strukturelement som för tillfället byggs på taggstacken. Titeln är en läsbar etikett som karaktäriserar det specifika elementet — till exempel Chapter 1, Summary Table eller Figure 3: Quarterly Sales — i stället för att bara upprepa elementtypen

Syntax

Delphi

Function DLSetStructElemTitleA(InstanceID: Integer; Title: PAnsiChar): Integer;

DLL

int DLSetStructElemTitleA(int InstanceID, const char * Title);

Parametrar

Title	En läsbar textsträng som identifierar den här specifika elementinstansen. Ange en tom sträng för att rensa ett tidigare satt värde

Returvärde

Returnerar 1 vid lyckat anrop, 0 om inget strukturelement för tillfället är öppet eller inget dokument är valt

Anmärkningar

Posten /T är definierad i ISO 32000-1 §14.7.2 tabell 324. Den skrivs som en PDF-textsträng i strukturelementdictionaryn

Title har ett eget syfte, skilt från elementets övriga textegenskaper:

/T (Title) – En beskrivande etikett för elementet, som den används i navigerings- och taggpaneler. Lämplig för sektionsrubriker, tabellrubriker och figurtexter.
/Alt (se SetStructElemAltText) – En fullständig textuell ersättning för elementet, för hjälpmedel när elementet inte kan renderas.
/ActualText (see SetStructElemActualText) — An exact Unicode replacement for glyph sequences whose extracted text would be incorrect.

PDF-läsare använder /T för att etikettera element i navigeringspanelen Tags. Tillgänglighetsverktyg och saneringsprogram använder den som ett landmärke namn för dokumentnavigering. För rubrikelement (H1–H6) fungerar elementets innehåll i sig som rubriktext; /T är mer användbart för icke-textelement (Table, Figure, Form) eller containers (Sect, Div) som behöver en beskrivande etikett

Exempel

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

Se även

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemID, GetPDFUADiagnostics