SetStructElemExpansion

Tagovaný PDF & prístupnosť

Opis

Nastavuje položku /E (text rozvinutia) na štruktúrnom prvku, ktorý sa práve zostavuje na zásobníku tagov. Text rozvinutia je plná podoba skratky alebo akronymu obsiahnutého v prvku — napríklad World Wide Web pre prvok Span s obsahom WWW, alebo International Organization for Standardization pre Span obsahujúci ISO.

Čítačky obrazovky a iná asistívna technológia prednesú text rozvinutia namiesto pokusu vysloviť skrátené znaky, čo je nevyhnutné pre skratky, ktoré sa nedajú prečítať ako slová

Syntax

Delphi

Function TPDFlib.SetStructElemExpansion(Const Expansion: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemExpansion(Expansion As String) As Long

DLL

int DLSetStructElemExpansion(int InstanceID, const wchar_t * Expansion);

Parametre

Expansion	Úplne rozvinutý text skratky alebo akronymu v aktuálnom štruktúrnom prvku. Na zrušenie skôr nastavenej hodnoty odovzdajte prázdny reťazec.

Návratová hodnota

Vráti 1 pri úspechu, 0, ak práve nie je otvorený žiadny štruktúrny element alebo nie je vybraný žiadny dokument

Poznámky

Túto funkciu zavolajte ihneď po BeginTag, kým je cieľový prvok na vrchu zásobníka tagov, alebo kedykoľvek pred zodpovedajúcim volaním EndTag.

Položka /E je definovaná v ISO 32000-1 §14.9.5. Zapisuje sa ako textový reťazec PDF do slovníka štruktúrneho prvku a odlišuje sa od ostatných textových vlastností:

/E (Expansion) — Plná podoba skratky alebo akronymu. Používa sa na výslovnosť skráteného inline obsahu čítačkami obrazovky (screen readers).
/Alt (see SetStructElemAltText) — A complete substitute description for elements that cannot be rendered visually (images, figures, formulas).
/ActualText (see SetStructElemActualText) — An exact Unicode replacement for glyph sequences whose extracted text would otherwise be incorrect (ligatures, glyph variants).

PDF/UA-1 (ISO 14289-1 §7.2) vyžaduje, aby bolo možné jednoznačne určiť prirodzený jazyk každého textu. Pri skratkách a akronymoch, ktorých skrátená podoba sa nedá prečítať nahlas ako slovo, je /E štandardný mechanizmus na dodanie tejto informácie.

Aplikujte /E na najvnútornejší prvok obklopujúci skratku — typicky prvok Span. Rozvinutie sa týka iba obsahu tohto prvku a potomkovia ho nededia.

Príklad

// Tag an abbreviation with its expansion
PDFlib.BeginTag('Span', '', '');
PDFlib.SetStructElemExpansion('World Wide Web');
PDFlib.WriteText('WWW');
PDFlib.EndTag;

// Tag a standards acronym
PDFlib.BeginTag('Span', '', '');
PDFlib.SetStructElemExpansion('International Organization for Standardization');
PDFlib.WriteText('ISO');
PDFlib.EndTag;

Pozri tiež

BeginTag, SetStructElemAltText, SetStructElemActualText, SetStructElemLang, GetPDFUADiagnostics