SetStructElemLang

Tagged PDF & Accessibility

Description

Устанавливает запись /Lang для структурного элемента, создаваемого в данный момент в стеке тегов; языковой тег переопределяет язык уровня документа для этого элемента и всех его потомков, позволяя документам со смешанными языками объявлять правильный естественный язык для каждого фрагмента содержимого

Syntax

Delphi

Function TPDFlib.SetStructElemLang(Const Lang: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemLang(Lang As String) As Long

DLL

int DLSetStructElemLang(int InstanceID, const wchar_t * Lang);

Parameters

Lang	Строка языкового тега BCP 47, например `en-US`, `fr`, `de-CH` или `zh-Hant-TW`; передайте пустую строку, чтобы очистить ранее установленное значение и унаследовать язык на уровне документа

Return value

Returns 1 on success, 0 if no structure element is currently open or no document is selected.

Remarks

Вызывайте эту функцию сразу после вызова BeginTag или BeginTagEx, пока целевой элемент находится на вершине стека тегов It is equivalent to passing a non-empty Lang argument to BeginTagEx, but may be more convenient when the language is determined separately from the element type.

Запись /Lang на уровне элемента определена в ISO 32000-1 §14.9.2; она применяется к элементу структуры и, путем наследования, ко всем дочерним элементам, которые сами не объявляют /Lang; программы чтения с экрана используют эту запись для выбора подходящего голоса синтеза речи или языкового движка при чтении документа вслух

PDF/UA-1 (ISO 14289-1 §7.3) requires that all natural language content be identified. The document-level /Lang set by SetDocumentLanguage or SetPDFUAMode covers the primary language; SetStructElemLang covers sections whose language differs from the primary.

Example

// A French phrase embedded in an English document
PDFlib.SetPDFUAMode('en-US');
// ... English content
PDFlib.BeginTag('P', '', '');
PDFlib.SetStructElemLang('fr');
PDFlib.TextOut(x, y, 'Bonjour le monde');
PDFlib.EndTag;