ITextRow interface (tom.h)

The ITextRow interface provides methods to insert one or more identical table rows, and to retrieve and change table row properties. To insert nonidentical rows, call ITextRow::Insert for each different row configuration.

Inheritance

The ITextRow interface inherits from the IDispatch interface. ITextRow also has these types of members:

Methods

The ITextRow interface has these methods.

Remarks

To select a table, a row, or a cell, use ITextRange::Expand, with the Unit parameter set to tomTable, tomRow, or tomCell, respectively. These units can also be used with the ITextRange::Move methods to navigate and select multiple rows or cells.

Some of the ITextRow properties apply to the whole row, such as the row alignment. In addition, there are a number of properties, such as cell alignment, that apply to a cell with the index set via the ITextRow::SetCellIndex method. This cell is referred to as the active cell.

ITextRow works similarly to ITextPara2, but doesn't modify the document until either the ITextRow::Apply or ITextRow::Insert methods are called. In addition, the row and cell parameters are always active, that is, they cannot have the value tomDefault.

On initialization, the ITextRow object acquires the table row properties, if any, at the active end of the associated ITextRange2. The ITextRow::Reset method can be used to update these properties to the current values for ITextRange2 object.

A rich edit control table consists of a sequence of table rows, which, in turn, consist of sequences of paragraphs. A table row starts with the special two-character delimiter paragraph U+FFF9 U+000D and ends with the two-character delimiter paragraph U+FFFB U+000D. Each cell is terminated by the cell mark U+0007, which is treated as a hard end-of-paragraph mark just as U+000D (CR) is. The table row and cell parameters are treated as special paragraph formatting of the table-row delimiters. The cell parameters are stored in an expanded version of the tabs array. This format allows tables to be nested within other tables and is allowed to go fifteen levels deep.

The architecture is quite flexible in that each table row can have any valid table-row parameters, regardless of the parameters for other rows (except for vertical merge flags). For example, the number of cells and the start indents of table rows can differ, unlike in HTML which has n×m rectangular format with all rows starting at the same indent.

On the other hand, no formal table description is stored anywhere. Information such as the number of rows must be figured out by navigating through the table. For example, the count of rows in a table can be obtained by calling ITextRange::StartOf (tomTable, tomFalse, NULL) to move to the start of the current table and then calling ITextRange::Move (tomRow, tomForward, &dcRow). The quantity &dcRow + 1 then contains the count of rows in the table, because moving by tomRow increments doesn't move beyond the last table row.

Requirements