Description
Returns or sets properties of a table cell or range from an ADDTABLE command.
To use this option you must precede the addtable message with a starttable and you must follow the TABLECELL message with an ENDTABLE message.
Parameters
An @fm delimited array of parameters.
| Parameter | Description of Fields | Comments | Default |
|---|---|---|---|
| Setting | Type of setting to be modified. | SEE PROPERTIES BELOW. | "" |
| Row1 | Starting row of cells to be modified | "" | |
| Col1 | Starting column of cells to be modified | ||
| Row2 | Ending row of cells to be modified | Null if changing only 1 cell. | Row 1 |
| Col2 | Ending column of cells to be modified | Null if changing only 1 cell. | Col 1 |
| Value | Property change | Based on the setting parameter. ex. If the property is background color this contains the RGB or OIPRINT_EQUATES color. |
Example
Set_Printer("INIT","","","",1,2)
Set_Printer("STARTTABLE")
colFormat = '<_1440':@vm:'<_1440':@vm:'<_1440'
colHeader = 'Column 1':@vm:'Column 2':@vm:'Column 3'
data = ''
for i = 1 to 30
data<-1> = 'Col 1 - ':i:@vm:'Col 2 - ':i:@vm:'Col 3 ':i
next i
Set_Printer("ADDTABLE",colFormat,colHeader,data,'','','','')
* Set First Column to Bold
Set_Printer("TABLECELL",25:@fm:1:@fm:1:@fm:30:@fm:1:@fm:1)
* Set Second Column to Underline
Set_Printer("TABLECELL",27:@fm:1:@fm:2:@fm:30:@fm:2:@fm:1)
Set_Printer("ENDTABLE")
Set_Printer("TERM")
See also
STARTTABLE Set_Printer Message, ENDTABLE Set_Printer Message, ADDTABLE Set_Printer Message
Properties
These properties are outline in OIPI_EQUATES.
Table Properties: These settings affect the entire table.
| Type | Value | Description |
|---|---|---|
| TcIndent | 0 | Returns or sets the indent for the table. You may specify units with this value (the default unit is twips). |
| TcRows | 1 | Returns or sets the number of rows on the table. The header row is not included in this count. If you change the number of rows, rows are added or deleted from the bottom of the table. |
| TcCols | 2 | Returns or sets the number of columns on the table. If you change the number of columns, columns are added or deleted from the right of the table. |
| TcInsertRow | 3 | Inserts a row at the specified position (Row1). |
| TcInsertCol | 4 | Inserts a column at the specified position (Col1). |
| TcDeleteRow | 5 | Deletes the row at the specified position (Row1). |
| TcDeleteCol | 6 | Deletes the column at the specified position (Col1). |
Row Properties: These settings affect entire rows or row ranges. The Col1 and Col2 parameters are ignored:
| Type | Value | Description |
|---|---|---|
| TcRowHeight | 7 | Returns or sets the height of the rows. The header row has index zero. You may specify units with this value (the default unit is twips). |
| TcRowBorder | 8 | Returns or sets whether the rows will have a border drawn above them. Possible values are: 0 (no border), 1 (force border), and 2 (honor TableBorder setting). |
| TcRowData | 9 | Returns or sets a Variant associated with the row. This value is for your own use, and is not used by the control. |
| TcRowSource | 10 | Returns or sets the array row used as a data source for the table row. This setting only applies if the table was bound to an array (with the AddTableArray method). Note that array indices are zero-based, and table indices are one-based. |
| TcRowKeepWithNext | 11 | Returns or sets whether the control should prevent page breaks after the rows. |
| TcRowIsSubHeader | 12 | Returns or sets whether the row should become the table header after it is rendered (useful for subtitles). |
| TcRowSpaceBefore | 34 | Returns or sets the amount of vertical space to insert before each cell on the row. |
| TcRowSpaceAfter | 35 | Returns or sets the amount of vertical space to insert after each cell on the row. |
| TcRowBorderAbove | 36 | Returns or sets the thickness of a custom border to be drawn above the row. |
| TcRowBorderBelow | 37 | Returns or sets the thickness of a custom border to be drawn below the row. |
| TcRowBorderColor | 38 | Returns or sets the color of the custom borders drawn above and below the row. |
| TcRowNewPage | 39 | Returns or sets whether the row should be the first on a page (forcing a page break if necessary). |
| TcRowKeepTogether | 40 | Returns or sets whether the row should be kept together on a page or whether it can be broken and rendered on two pages. |
Column Properties: These settings affect entire columns or column ranges. The Row1 and Row2 parameters are ignored:
| Type | Value | Description |
|---|---|---|
| TcColWidth | 13 | Returns or sets the width of the columns. You may specify units with this value (the default unit is twips). |
| TcColBorder | 14 | Returns or sets whether the columns will have a border drawn on their right-hand side. Possible values are: 0 (no border), 1 (force border), and 2 (honor TableBorder setting). |
| TcColData | 15 | Returns or sets a Variant associated with the column. This value is for your own use, and is not used by the control. |
| TcColSource | 16 | Returns or sets the array column used as a data source for the table column. This setting only applies if the table was bound to an array (with the AddTableArray method). Note that array indices are zero-based, and table indices are one-based. |
| TcColAlign | 31 | Returns or sets the alignment for the column. Valid settings are the same used with the TextAlign property. |
| TcColNoWrap | 32 | Returns or sets whether long text entries should be allowed to wrap within cells on this column. |
| TcColSkipRepeats | 33 | Returns or sets whether repeated text entries (with the same text as the cell above) should be skipped on this column. |
| TcColBorderLeft | 43 | Returns or sets the thickness of a custom border to be drawn to the left of this column. |
| TcColBorderRight | 44 | Returns or sets the thickness of a custom border to be drawn to the right of this column. |
| TcColBorderColor | 45 | Returns or sets the color of the custom borders drawn to the left and right of this column. |
Cell Properties: These settings affect individual cells or cell ranges:
| Type | Value | Description |
|---|---|---|
| TcColSpan | 17 | Returns or sets the number of columns that the cell should span (column merging). |
| TcText | 18 | Returns or sets the cell text. If the table is bound to an array, setting the property will change the table, but not the source array. |
| TcAlign | 19 | Returns or sets the alignment of text in the cells. Valid settings are the same used with the TextAlign property. |
| TcBackColor | 20 | Returns or sets the background color for the cell. |
| TcForeColor | 21 | Returns or sets the foreground (text) color for the cell. |
| TcFont | 22 | Returns or sets the cell font. |
| TcFontName | 23 | Returns or sets the name of the cell font. |
| TcFontSize | 24 | Returns or sets the size of the cell font. |
| TcFontBold | 25 | Returns or sets the bold attribute of the cell font. |
| TcFontItalic | 26 | Returns or sets the italic attribute of the cell font. |
| TcFontUnderline | 27 | Returns or sets the underline of the cell font. |
| TcFontStrikethru | 28 | Returns or sets the strikethrough attribute of the cell font. |
| TcPicture | 29 | Returns or sets the cell picture. |
| TcPictureAlign | 30 | Returns or sets the alignment of pictures in the cells. Valid settings are the same used with the TextAlign property. |
| TcRowSpan | 41 | Returns or sets the number of rows that the cell should span (row merging). |
| TcVertical | 42 | Returns or sets whether the cell text should be rendered in the vertical direction. |
