SetStructElemColSpan

Tagged PDF, Accessibility

Description

Устанавливает атрибут /ColSpan (владелец атрибута Table) для структурного элемента, открытого в данный момент в стеке тегов; значение указывает, сколько столбцов объединяет текущая ячейка таблицы; эквивалентно вызову AddTagAttribute с параметрами Owner=Table, Name=ColSpan и целочисленным значением в виде строки

Syntax

Delphi

Function TPDFlib.SetStructElemColSpan(ColSpan: Integer): Integer;

ActiveX

Function PDFlib::SetStructElemColSpan(ColSpan As Long) As Long

DLL

int DLSetStructElemColSpan(int InstanceID, int ColSpan);

Parameters

ColSpanКоличество столбцов, которые объединяет текущая ячейка таблицы; должно быть положительным целым числом; значение 1 означает, что ячейка занимает ровно один столбец (поведение по умолчанию, когда ColSpan не задан); значения больше 1 указывают на объединенную ячейку заголовка или данных

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 или TD) и перед EndTag; атрибут /ColSpan определен в ISO 32000-1 §14.8.5.7.2 (владелец атрибута Table, таблица 337)

Объединенные ячейки часто встречаются в сложных таблицах — например, заголовок столбца, объединяющий два столбца данных; предоставление атрибута /ColSpan позволяет вспомогательные технологии правильно вычислять положение ячеек и связывать заголовки с ячейками данных по всей сетке таблицы

Когда ячейка также объединяет несколько строк, используйте SetStructElemRowSpan в сочетании с этой функцией

Example

// A header cell spanning two columns
PDFlib.BeginTag('TH', 'Q1 and Q2 Revenue', '', '');
PDFlib.SetStructElemScope('Column');
PDFlib.SetStructElemColSpan(2);
PDFlib.DrawText('Q1 and Q2 Revenue', 100, 700);
PDFlib.EndTag;

See also

SetStructElemRowSpan, SetStructElemScope, AddTagAttribute, BeginTag, EndTag