SetStructElemScope

Tagged PDF, Accessibility

Description

Устанавливает атрибут /Scope (владелец атрибута Table) для структурного элемента, открытого в данный момент в стеке тегов; область действия определяет, относится ли ячейка TH (заголовок таблицы) к столбцу, строке или к обоим — требуется по стандарту PDF/UA-1 для таблиц с ячейками заголовков; эквивалентно вызову AddTagAttribute с параметрами Owner=Table, Name=Scope и названием области действия в качестве значения

Syntax

Delphi

Function TPDFlib.SetStructElemScope(Const Scope: WideString): Integer;

ActiveX

Function PDFlib::SetStructElemScope(Scope As String) As Long

DLL

int DLSetStructElemScope(int InstanceID, const wchar_t * Scope);

Parameters

ScopeОбласть действия ячейки заголовка; должна принимать одно из следующих значений (чувствительно к регистру).

Column — заголовок применяется ко всем ячейкам в столбце.
Row — заголовок применяется ко всем ячейкам в строке.
Both — заголовок применяется как к столбцу, так и к строке

Return value

Returns 1 on success. Returns 0 if no document is open or no tag is currently open on the tag stack.

Remarks

Вызывайте эту функцию после BeginTag (с типом тега TH) и перед EndTag; атрибут /Scope определен в ISO 32000-1 §14.8.5.7.2 (владелец атрибута Table)

PDF/UA-1 (ISO 14289-1 §7.10) requires that table header cells clearly associate with their data cells. Providing the /Scope attribute is the recommended mechanism when the table layout allows it.

Example

// Tag a column header cell
PDFlib.BeginTag('TH', 'Product Name', '', '');
PDFlib.SetStructElemScope('Column');
PDFlib.DrawText('Product Name', 100, 700);
PDFlib.EndTag;

// Tag a row header cell
PDFlib.BeginTag('TH', 'Row 1', '', '');
PDFlib.SetStructElemScope('Row');
PDFlib.DrawText('Row 1', 72, 680);
PDFlib.EndTag;

See also

AddTagAttribute, SetStructElemBBox, BeginTag, EndTag, SetPDFUAMode