Classes | Enumerations
Text Table Elements

Table elements are dgn elements that display text in tabular format. More...

Classes

struct  TableCellIndex
 Specifies a <row, col> position within a table. More...
 
struct  TableCellMarginValues
 Used to specify the minimum gap between a cell's contents and its edges. More...
 
struct  TableTextPartId
 When querying a text table element using ITextEdit and ITextQuery the returned object is a TableTextPartId. More...
 
struct  TableSymbologyValues
 Used to query and modify the color, style and weight of table edge lines and fills. More...
 
struct  TextTableCell
 Represents a location within a TextTable that can display text. More...
 
struct  TextTableRow
 Represents a horizontal grouping of cells within a table. More...
 
struct  TextTableColumn
 
struct  TextTableCellIterator
 An iterator that can step through the set of cells in a table. More...
 
struct  TextTableCellCollection
 A collection that can iterate through the set of cells in a table. More...
 
struct  TextTable
 
struct  TextTableHandler
 

Enumerations

enum  TextTableRegion {
  Body = 0, TitleRow = 1, HeaderRow = 2, FooterRow = 3,
  HeaderColumn = 4, FooterColumn = 5
}
 This enum represents the distinct regions within a TextTable. More...
 
enum  TableInsertDirection { Before = 0, After = 1 }
 Used by TextTable::InsertRow and TextTable::InsertColumn. More...
 
enum  TableBreakType { None = 0, Horizontal = 1, Vertical = 2 }
 Describes how a table is broken up to be displayed as sub tables. More...
 
enum  TableBreakPosition {
  Right = 0, Left = 1, Above = 2, Below = 3,
  Manual = 4
}
 Describes how each sub table is positioned relative to the previous sub table. More...
 
enum  TableCellAlignment {
  LeftTop = 0, LeftMiddle = 1, LeftBottom = 2, CenterTop = 3,
  CenterMiddle = 4, CenterBottom = 5, RightTop = 6, RightMiddle = 7,
  RightBottom = 8
}
 Describes how text will be positioned within a table cell. More...
 
enum  TableCellOrientation { Horizontal = 0, Rotate90 = 1, Rotate270 = 2, Vertical = 3 }
 Describes how text within a cell will be rotated relative to the table. More...
 
enum  TableHeaderFooterType { Title = 0, Header = 1, Body = 2, Footer = 3 }
 Describes the type of a table row or column. More...
 
enum  TableCellListEdges {
  Top = 0, Top = 1, Top = 0, Top = 5,
  Top = 2, Bottom = 1, Bottom = 2, Bottom = 4,
  Bottom = 0, Left = 2, Left = 0, Left = 3,
  Left = 1, Left = 0xff, Left = 1, Right = 3,
  Right, Right = 4, Right = 2, Right = 0x01,
  Right = 0, Interior = 4, Interior = 600, Exterior = 5,
  InteriorHorizontal = 6, InteriorVertical = 7, All = 50, All = 0xffffffff,
  All = 0x7fffffff, All = 0x007f, All = (XAndY | ZLow | ZHigh), All = 0x7fffffff,
  All = 5, All = 3, All = 0
}
 Describes the various edge lines that surround a group of one or more table cells. More...
 
enum  TableRows { Odd = 0, Even = 1, All = 50 }
 Used to specify the default fill of a table row. More...
 

Detailed Description

Table elements are dgn elements that display text in tabular format.

In order to query or modify the contents of a table element first use TextTableHandler to create a TextTable from the element. After that the table's properties can be accessed via the classes TextTableRow, TextTableColumn and TextTableCell.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Enumeration Type Documentation

enum TableBreakPosition
strong

Describes how each sub table is positioned relative to the previous sub table.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib
Enumerator
Right 
Left 
Above 
Below 
Manual 
enum TableBreakType
strong

Describes how a table is broken up to be displayed as sub tables.

Enumerator
None 
Horizontal 
Vertical 
enum TableCellAlignment
strong

Describes how text will be positioned within a table cell.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib
Enumerator
LeftTop 
LeftMiddle 
LeftBottom 
CenterTop 
CenterMiddle 
CenterBottom 
RightTop 
RightMiddle 
RightBottom 
enum TableCellListEdges

Describes the various edge lines that surround a group of one or more table cells.

Enumerator
Top 
Top 
Top 
Top 
Top 

Surrounding text's cell box top matches the top of the fraction numerator's cell box.

Bottom 
Bottom 
Bottom 
Bottom 

Surrounding text's baseline matches the baseline of the denominator.

Left 
Left 
Left 
Left 
Left 

The unoccupied length is padded to the right with spaces.

Left 
Right 
Right 

Drawing Title bubble is on left hand side.

Right 
Right 
Right 

The unoccupied length is padded to the left with spaces.

Right 
Interior 
Interior 
Exterior 
InteriorHorizontal 
InteriorVertical 
All 
All 

Hosted on any host type.

All 
All 

find all SHX fonts (including bigfonts)

All 
All 
All 
All 
All 
enum TableCellOrientation
strong

Describes how text within a cell will be rotated relative to the table.

Enumerator
Horizontal 
Rotate90 
Rotate270 
Vertical 
enum TableHeaderFooterType
strong

Describes the type of a table row or column.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib
Enumerator
Title 
Header 
Body 
Footer 
enum TableInsertDirection
strong

Used by TextTable::InsertRow and TextTable::InsertColumn.

Enumerator
Before 
After 
enum TableRows
strong

Used to specify the default fill of a table row.

Enumerator
Odd 
Even 
All 
enum TextTableRegion
strong

This enum represents the distinct regions within a TextTable.

A table can hold a unique TextStyle for each region that will be used when adding text to an empty cell.

Enumerator
Body 
TitleRow 
HeaderRow 
FooterRow 
HeaderColumn 
FooterColumn 

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.