rtfWriteTableHeader

DESCRIPTION:

Creates the RTF tags to add a table header row to the given RTF file

USAGE:

rtfWriteTableHeader(colheadings, rtfFile, tableInitList, 
        colspans = rep(1, tableInitList$numCols), rowright = "", 
        writeText = T, cellBorder = rep(list(rep(0, 4)), length(colspans)), 
        rowTopBorder = SOLIDCELLBORDER, rowBotBorder = SOLIDCELLBORDER, 
        tableHeaderStyle = TableHeader10Style, tablejust = "")

ARGUMENTS:

colheadings
Text to output as column headings (no default).
rtfFile
rtfFile to write the output to if writeText=T.
tableInitList
A list with information about the table produced by rtfTableInit (no default).
colspans
numeric vector specifying the number of columns that each column spans.For example, c(2,3) would imply 5 columns in the table with the current row merging the first two cells together and the last three cells together. (default=rep(1,tableInitList$numCols))
rowright
Border for the right of the row (default="").
writeText
T/F determining whether RTF text for row should be written to the given file or not or if the string should just be returned.
cellBorder
Used when need different border on each cell; values are overriden by rowxxx parameters; list of vectors for each cell going clockwise in the following order - c(left,top,right,bottom); the values should be the RTF text to be used for each border and contain one entry for each cell; predefined border values are NOCELLOBORDER, SOLIDCELLBORDER and DASHCELLBORDER (default=rep(list(rep(NOCELLBORDER,4)), tableInit$numCols)).
rowTopBorder
A border for the top of the row (default=SOLIDCELLBORDER).
rowBotBorder
A border for the bottom of the row (default=SOLIDCELLBORDER).
tableHeaderStyle
RTF style to use for table header (default=TableHeader10Style)
tablejust
Justification to use for the row (e.g. \\trqc for centered) (default="").
cellvertAlign
vertical aligment of text in cell, t-top, c-centered, b-bottom, (default is top)

VALUE:

String containing the RTF that will create this header row as specified; if writeText=T, the return string can be ignored, otherwise the calling function will need to write the string to the RTF file.

AUTHOR(S):

TIBCO Software Inc.

SEE ALSO: