SetStructElemWritingMode

Tagged PDF, Barrierefreiheit

Beschreibung

Legt das Attribut /WritingMode (Attributinhaber Layout) für das aktuell im Tag-Stack geöffnete Strukturelement fest. Der Schreibmodus deklariert die hauptsächliche Schreibrichtung des Texts innerhalb des Elements und beeinflusst, wie Hilfstechnologien die Lesereihenfolge interpretieren. Entspricht einem Aufruf von AddTagAttribute mit Owner=Layout, Name=WritingMode und dem Modusnamen als Wert

Syntax

Delphi

Function TPDFlib.SetStructElemWritingMode(Const WritingMode: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemWritingMode(WritingMode As String) As Long

DLL

int DLSetStructElemWritingMode(int InstanceID, const wchar_t * WritingMode);

Parameter

WritingModeDie Schreibrichtung des Elements. Muss einer der folgenden Werte sein (Groß-/Kleinschreibung beachten):

LrTb — von links nach rechts, von oben nach unten (Standard; Lateinisch, Kyrillisch, Griechisch und die meisten Schriften)
RlTb — von rechts nach links, von oben nach unten (Arabisch, Hebräisch)
TbRl — von oben nach unten, von rechts nach links (traditioneller vertikaler CJK-Text)

Rückgabewert

Gibt bei Erfolg 1 zurück. Gibt 0 zurück, wenn kein Dokument geöffnet oder aktuell kein Tag im Tag-Stapel geöffnet ist.

Anmerkungen

Rufen Sie diese Funktion nach BeginTag oder BeginTagEx und vor EndTag auf. Das Attribut /WritingMode ist in ISO 32000-1 §14.8.5.4.2 definiert (Layout-Attributbesitzer, Tabelle 340).

Wenn ein Dokument durchgehend dieselbe Schreibrichtung verwendet, muss /WritingMode nicht für jedes Element festgelegt werden — fehlt das Attribut, gilt standardmäßig LrTb. Das Attribut sollte ausdrücklich für Blockelemente gesetzt werden, deren Schreibrichtung vom umgebenden Inhalt abweicht, beispielsweise für ein hebräisches Zitat in einem englischen Absatz.

PDF/UA-1 (ISO 14289-1 §7.2) verlangt, dass die natürliche Sprache jedes Textteils eindeutig bestimmbar ist. /WritingMode ergänzt das Attribut /Lang (SetStructElemLang): /Lang deklariert die gesprochene Sprache, während /WritingMode die physische Schreibrichtung deklariert, die Hilfstechnologien zur Darstellung verwenden sollen.

Beispiel

// Arabic paragraph — right-to-left writing direction
PDFlib.BeginTagEx('P', '', '', 'ar-SA');
PDFlib.SetStructElemWritingMode('RlTb');
PDFlib.DrawText('...Arabic text...', 450, 700);
PDFlib.EndTag;

// Vertical CJK heading
PDFlib.BeginTagEx('H1', '', '', 'zh-TW');
PDFlib.SetStructElemWritingMode('TbRl');
PDFlib.DrawText('...CJK vertical text...', 500, 700);
PDFlib.EndTag;

Siehe auch

SetStructElemBBox, SetStructElemLang, AddTagAttribute, BeginTag, EndTag