SetStructElemColSpan

Tagged PDF, Accessibility

Description

Sätter /ColSpan-attributet (Table-attributägare) på det strukturelement som för tillfället är öppet på taggstacken. Värdet anger hur många kolumner den aktuella tabellcellen spänner över. Ekvivalent med att anropa AddTagAttribute med Owner=Table, Name=ColSpan och heltalsvärdet som sträng

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

ColSpanAntalet kolumner den aktuella tabellcellen spänner över. Måste vara ett positivt heltal. Värdet 1 betyder att cellen upptar exakt en kolumn (standardbeteende när ingen ColSpan satts). Värden större än 1 indikerar en spännande rubrik- eller datacell

Return value

Returnerar 1 vid lyckat anrop. Returnerar 0 om inget dokument är öppet eller om ingen tagg för tillfället ligger överst på taggstacken

Remarks

Anropa den här funktionen efter BeginTag (med taggtyp TH eller TD) och före EndTag. Attributet /ColSpan är definierat i ISO 32000-1 §14.8.5.7.2 (Table-attributägare, tabell 337)

Spännande celler är vanliga i komplexa tabeller — till exempel en kolumnrubrik som spänner över två datakolumner. Att tillhandahålla attributet /ColSpan låter hjälpmedelsteknik korrekt beräkna cellpositioner och para rubriker med dataceller över hela tabellrutnätet

När en cell också spänner över flera rader, använd SetStructElemRowSpan i kombination med den här funktionen

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