interface XTextColumns in module com::sun::star::text::

(Global Index)

Syntax

interface XTextColumns : com::sun::star::uno::XInterface ;

Description

manages columns within the object.

The values used are relative. So it is not necessary to know the width of the object. The sum of the relative width values depends on the object and is defined in "ReferenceValue."

Method Summary

getReferenceValue

getColumnCount

setColumnCount sets the number of columns.

getColumns returns the column description of the object.

setColumns sets the descriptors of all columns.

Known Services Which Export this Interface

com::sun::star::text::TextColumns

Method Details



getReferenceValue

Syntax

long getReferenceValue ();

Returns

the sum of all values.

As described above, the width values are relative.


getColumnCount

Syntax

short getColumnCount ();

Returns

the number of columns.

setColumnCount

Syntax

void setColumnCount (
short nColumns );

Description

sets the number of columns.

The minimum is 1 column.


getColumns

Syntax

sequence< com::sun::star::text::TextColumn > getColumns ();

Description

returns the column description of the object.

See also

TextColumn

setColumns

Syntax

void setColumns (
sequence< com::sun::star::text::TextColumn > Columns );

Description

sets the descriptors of all columns.

The number of members in the sequence must be the same as the number of columns of the object.

See also

TextColumn
Top of Page