AddRoleMapA

Tagged PDF, Barrierefreiheit

Beschreibung

Das abschließende A bezeichnet den ANSI-DLL-Einstiegspunkt (char); die ActiveX/COM-Oberfläche stellt nur die Unicode-Form bereit. Das Verhalten ist identisch mit AddRoleMap, und Zeichenfolgenargumente werden anhand der aktuellen Codepage von SetAnsiMode interpretiert

Registriert im Wörterbuch RoleMap des Dokuments eine Zuordnung von einem benutzerdefinierten Strukturelement-Typnamen zu einem standardmäßigen PDF-Strukturtyp

Wenn Tagged-PDF-Inhalte nicht standardmäßige Tag-Namen verwenden, beispielsweise unternehmens- oder anwendungsspezifische Elementtypen, verlangt die PDF-Spezifikation eine Zuordnung dieser Namen zu einem standardmäßigen PDF-Strukturtyp im Eintrag /RoleMap der Strukturbaumwurzel. ISO 14289-1 §7.1 schreibt diese Zuordnung für alle PDF/UA-1-Dokumente mit nicht standardmäßigen Strukturelementtypen vor.

Rufen Sie AddRoleMap einmal pro benutzerdefiniertem Typ auf, bevor Sie BeginTag oder BeginTagEx mit diesem Typ aufrufen. Mehrere Zuordnungen können registriert werden. Wird derselbe benutzerdefinierte Typ mehrfach registriert, gilt die letzte Zuordnung.

Wenn mindestens eine Zuordnung registriert wurde, wird die RoleMap beim Speichern des Dokuments in die Wurzel des Strukturbaums geschrieben.

Syntax

Delphi

Function DLAddRoleMapA(InstanceID: Integer; CustomType, StandardType: PAnsiChar): Integer;

DLL

int DLAddRoleMapA(int InstanceID, const char * CustomType, const char * StandardType);

Parameter

CustomType	Der benutzerdefinierte, nicht standardmäßige Strukturelementtypname, der in Aufrufen von BeginTag oder BeginTagEx verwendet wird, beispielsweise `Headline`, `Caption` oder `Callout`
StandardType	Der PDF-Standardstrukturtyp, dem der benutzerdefinierte Typ zugeordnet wird: `P`, `H1`–`H6`, `Figure`, `Table`, `Span`, `Link`, `Note` usw. (siehe ISO 32000-1 §14.8.4). Für PDF/UA-Konformitätsprüfer muss dies ein anerkannter Standardtyp sein

Rückgabewerte

0	Fehlgeschlagen (kein Dokument ist geöffnet)
1	Zuordnung erfolgreich registriert

Beispiel

// Document with custom element types mapped to standard PDF structure types
PDF.SetPDFUAMode('en-US');
PDF.AddRoleMap('Headline', 'H1');
PDF.AddRoleMap('Subheadline', 'H2');
PDF.AddRoleMap('Caption', 'P');

PDF.BeginTag('Headline', '', '');
PDF.PrintText(50, 750, 'Annual Report 2026');
PDF.EndTag;

PDF.BeginTag('Subheadline', '', '');
PDF.PrintText(50, 720, 'Financial Highlights');
PDF.EndTag;