#include <DbTable.h>
Public Types inherited from Detailed Description
This class represents table entities in an OdDbDatabase instance.
<group OdDb_Classes>
Member Enumeration Documentation
◆ TableStyleOverrides
Enumeration representing the table style overrides for an OdDbTable object.
| Enumerator | |
|---|---|
| kTitleSuppressed | Title suppressed table style override for an OdDbTable object |
| kHeaderSuppressed | Header suppressed table style override for an OdDbTable object |
| kFlowDirection | Flow direction table style override for an OdDbTable object |
| kHorzCellMargin | Horizontal cell margin table style override for an OdDbTable object |
| kVertCellMargin | Vertical cell margin table style override for an OdDbTable object |
| kTitleRowColor | Title row color table style override for an OdDbTable object |
| kHeaderRowColor | Header row color table style override for an OdDbTable object |
| kDataRowColor | Data row color table style override for an OdDbTable object |
| kTitleRowFillNone | Title row no fill table style override for an OdDbTable object |
| kHeaderRowFillNone | Header row no fill table style override for an OdDbTable object |
| kDataRowFillNone | Data row no fill table style override for an OdDbTable object |
| kTitleRowFillColor | Title row fill color table style override for an OdDbTable object |
| kHeaderRowFillColor | Header row fill color table style override for an OdDbTable object |
| kDataRowFillColor | Data row fill color table style override for an OdDbTable object |
| kTitleRowAlignment | Title row alignment table style override for an OdDbTable object |
| kHeaderRowAlignment | Header row alignment table style override for an OdDbTable object |
| kDataRowAlignment | Data row alignment table style override for an OdDbTable object |
| kTitleRowTextStyle | Title row text style table style override for an OdDbTable object |
| kHeaderRowTextStyle | Header row text style table style override for an OdDbTable object |
| kDataRowTextStyle | Data row text style table style override for an OdDbTable object |
| kTitleRowTextHeight | Title row text height table style override for an OdDbTable object |
| kHeaderRowTextHeight | Header row text height table style override for an OdDbTable object |
| kDataRowTextHeight | Data row text height table style override for an OdDbTable object |
| kTitleRowDataType | Title row data type table style override for an OdDbTable object |
| kHeaderRowDataType | Header row data type table style override for an OdDbTable object |
| kDataRowDataType | Data row data type table style override for an OdDbTable object |
| kTitleHorzTopColor | Title row horizontal top gridline color table style override for an OdDbTable object |
| kTitleHorzInsideColor | Title row horizontal inside gridline color table style override for an OdDbTable object |
| kTitleHorzBottomColor | Title row horizontal bottom gridline color table style override for an OdDbTable object |
| kTitleVertLeftColor | Title row vertical left gridline color table style override for an OdDbTable object |
| kTitleVertInsideColor | Title row vertical inside gridline color table style override for an OdDbTable object |
| kTitleVertRightColor | Title row vertical right gridline color table style override for an OdDbTable object |
| kHeaderHorzTopColor | Header row horizontal top gridline color table style override for an OdDbTable object |
| kHeaderHorzInsideColor | Header row horizontal inside gridline color table style override for an OdDbTable object |
| kHeaderHorzBottomColor | Header row horizontal bottom gridline color table style override for an OdDbTable object |
| kHeaderVertLeftColor | Header row vertical left gridline color table style override for an OdDbTable object |
| kHeaderVertInsideColor | Header row vertical inside gridline color table style override for an OdDbTable object |
| kHeaderVertRightColor | Header row vertical right gridline color table style override for an OdDbTable object |
| kDataHorzTopColor | Data row horizontal top gridline color table style override for an OdDbTable object |
| kDataHorzInsideColor | Data row horizontal inside gridline color table style override for an OdDbTable object |
| kDataHorzBottomColor | Data row horizontal bottom gridline color table style override for an OdDbTable object |
| kDataVertLeftColor | Data row vertical left gridline color table style override for an OdDbTable object |
| kDataVertInsideColor | Data row vertical inside gridline color table style override for an OdDbTable object |
| kDataVertRightColor | Data row vertical right gridline color table style override for an OdDbTable object |
| kTitleHorzTopLineWeight | Title row horizontal top gridline lineweight table style override for an OdDbTable object |
| kTitleHorzInsideLineWeight | Title row horizontal inside gridline lineweight table style override for an OdDbTable object |
| kTitleHorzBottomLineWeight | Title row horizontal bottom gridline lineweight table style override for an OdDbTable object |
| kTitleVertLeftLineWeight | Title row vertical left gridline lineweight table style override for an OdDbTable object |
| kTitleVertInsideLineWeight | Title row vertical inside gridline lineweight table style override for an OdDbTable object |
| kTitleVertRightLineWeight | Title row vertical right gridline lineweight table style override for an OdDbTable object |
| kHeaderHorzTopLineWeight | Header row horizontal top gridline lineweight table style override for an OdDbTable object |
| kHeaderHorzInsideLineWeight | Header row horizontal inside gridline lineweight table style override for an OdDbTable object |
| kHeaderHorzBottomLineWeight | Header row horizontal bottom gridline lineweight table style override for an OdDbTable object |
| kHeaderVertLeftLineWeight | Header row vertical left gridline lineweight table style override for an OdDbTable object |
| kHeaderVertInsideLineWeight | Header row vertical inside gridline lineweight table style override for an OdDbTable object |
| kHeaderVertRightLineWeight | Header row vertical right gridline lineweight table style override for an OdDbTable object |
| kDataHorzTopLineWeight | Data row horizontal top gridline lineweight table style override for an OdDbTable object |
| kDataHorzInsideLineWeight | Data row horizontal inside gridline lineweight table style override for an OdDbTable object |
| kDataHorzBottomLineWeight | Data row horizontal bottom gridline lineweight table style override for an OdDbTable object |
| kDataVertLeftLineWeight | Data row vertical left gridline lineweight table style override for an OdDbTable object |
| kDataVertInsideLineWeight | Data row vertical inside gridline lineweight table style override for an OdDbTable object |
| kDataVertRightLineWeight | Data row vertical right gridline lineweight table style override for an OdDbTable object |
| kTitleHorzTopVisibility | Title row horizontal top gridline visibility table style override for an OdDbTable object |
| kTitleHorzInsideVisibility | Title row horizontal inside gridline visibility table style override for an OdDbTable object |
| kTitleHorzBottomVisibility | Title row horizontal bottom gridline visibility table style override for an OdDbTable object |
| kTitleVertLeftVisibility | Title row vertical left gridline visibility table style override for an OdDbTable object |
| kTitleVertInsideVisibility | Title row vertical inside gridline visibility table style override for an OdDbTable object |
| kTitleVertRightVisibility | Title row vertical right gridline visibility table style override for an OdDbTable object |
| kHeaderHorzTopVisibility | Header row horizontal top gridline visibility table style override for an OdDbTable object |
| kHeaderHorzInsideVisibility | Header row horizontal inside gridline visibility table style override for an OdDbTable object |
| kHeaderHorzBottomVisibility | Header row horizontal bottom gridline visibility table style override for an OdDbTable object |
| kHeaderVertLeftVisibility | Header row vertical left gridline visibility table style override for an OdDbTable object |
| kHeaderVertInsideVisibility | Header row vertical inside gridline visibility table style override for an OdDbTable object |
| kHeaderVertRightVisibility | Header row vertical right gridline visibility table style override for an OdDbTable object |
| kDataHorzTopVisibility | Data row horizontal top gridline visibility table style override for an OdDbTable object |
| kDataHorzInsideVisibility | Data row horizontal inside gridline visibility table style override for an OdDbTable object |
| kDataHorzBottomVisibility | Data row horizontal bottom gridline visibility table style override for an OdDbTable object |
| kDataVertLeftVisibility | Data row vertical left gridline visibility table style override for an OdDbTable object |
| kDataVertInsideVisibility | Data row vertical inside gridline visibility table style override for an OdDbTable object |
| kDataVertRightVisibility | Data row vertical right gridline visibility table style override for an OdDbTable object |
| kCellAlignment | Alignment table style override for a table cell |
| kCellBackgroundFillNone | Background no fill table style override for a table cell |
| kCellBackgroundColor | Background color table style override for a table cell |
| kCellContentColor | Content color table style override for a table cell |
| kCellTextStyle | Text style table style override for a table cell |
| kCellTextHeight | Text height table style override for a table cell |
| kCellTopGridColor | Top edge grid color table style override for a table cell |
| kCellRightGridColor | Right edge grid color table style override for a table cell |
| kCellBottomGridColor | Bottom edge grid color table style override for a table cell |
| kCellLeftGridColor | Left edge grid color table style override for a table cell |
| kCellTopGridLineWeight | Top edge grid lineweight table style override for a table cell |
| kCellRightGridLineWeight | Right edge grid lineweight table style override for a table cell |
| kCellBottomGridLineWeight | Bottom edge grid lineweight table style override for a table cell |
| kCellLeftGridLineWeight | Left edge grid lineweight table style override for a table cell |
| kCellTopVisibility | Top edge grid visibility table style override for a table cell |
| kCellRightVisibility | Right edge grid visibility table style override for a table cell |
| kCellBottomVisibility | Bottom edge grid visibility table style override for a table cell |
| kCellLeftVisibility | Left edge grid visibility table style override for a table cell |
| kCellDataType | Cell data type override for a table cell |
Constructor & Destructor Documentation
◆ OdDbTable()
| OdDbTable::OdDbTable | ( | ) |
Default constructor. Creates an object of the OdDbTable class.
Member Function Documentation
◆ alignment() [1/2]
|
virtual |
DEPRECATED! Returns the cell alignment for the specified row type in this table entity (DXF 170).
- Parameters
-
rowType [in] Row type.
- Remarks
- rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
alignment() returns one of the following:
Value OdDb::kTopLeft 1 OdDb::kTopCenter 2 OdDb::kTopRight 3 OdDb::kMiddleLeft 4 OdDb::kMiddleCenter 5 OdDb::kMiddleRight 6 OdDb::kBottomLeft 7 OdDb::kBottomCenter 8 OdDb::kBottomRight 9
◆ alignment() [2/2]
|
virtual |
Returns the cell alignment for the specified cell in this table entity (DXF 170).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
alignment() returns one of the following:
Value OdDb::kTopLeft 1 OdDb::kTopCenter 2 OdDb::kTopRight 3 OdDb::kMiddleLeft 4 OdDb::kMiddleCenter 5 OdDb::kMiddleRight 6 OdDb::kBottomLeft 7 OdDb::kBottomCenter 8 OdDb::kBottomRight 9
◆ appendToOwner()
|
virtual |
Appends this OdDbTable object to the specified owner object.
- Parameters
-
idPair [in] ID pair to append. pOwnerObject [in] Pointer to the owner object. ownerIdMap [in/out] Owner's ID map.
Reimplemented from OdDbEntity.
◆ attachmentPoint() [1/2]
| OdGePoint3d OdDbTable::attachmentPoint | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | content | ||
| ) | const |
Returns the attachment point of the cell as an object of the OdGePoint3d class.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. content [in] Content index.
- Returns
- Attachment point.
- Remarks
- Method generates the eNotImplementedYet exception.
◆ attachmentPoint() [2/2]
|
virtual |
Returns the attachment point of the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than number of rows or the column argument is more than number of columns.
◆ backgroundColor() [1/2]
|
virtual |
DEPRECATED! Returns the background color for the specified row type in this table entity (DXF 63).
- Parameters
-
rowType [in] Row type.
- Remarks
- rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ backgroundColor() [2/2]
Returns the background color for the specified cell in this table entity (DXF 63).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ blockRotation()
DEPRECATED! This method is deprecated. Use rotation() instead. Returns the rotation angle of the block reference in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ blockScale()
DEPRECATED! This method is deprecated. Use scale() instead. Returns the scale factor of the block reference in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ blockTableRecordId() [1/2]
| OdDbObjectId OdDbTable::blockTableRecordId | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent | ||
| ) | const |
Returns the ID of the block table record of the cell as an object of the OdDbObjectId class.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content.
◆ blockTableRecordId() [2/2]
|
virtual |
Returns the Object ID of the block table record in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ breakFlowDirection()
| OdDb::TableBreakFlowDirection OdDbTable::breakFlowDirection | ( | void | ) | const |
Returns table break flow direction of this table entity as an OdDb::TableBreakFlowDirection object.
◆ breakHeight()
| double OdDbTable::breakHeight | ( | OdUInt32 | index | ) | const |
Returns the table break height of the specified table entity as an OdUInt32 value.
- Parameters
-
index [in] Sub-table index.
- Remarks
- index parameter should be more than or equal to 0.
◆ breakOffset()
| OdGeVector3d OdDbTable::breakOffset | ( | OdUInt32 | index | ) | const |
Returns table break offset of the specified table entity as an OdUInt32 value.
- Parameters
-
index [in] Sub-table index.
- Remarks
- index parameter should be more than or equal to 1.
◆ breakOption()
| OdDb::TableBreakOption OdDbTable::breakOption | ( | void | ) | const |
Returns the table break option of this table entity as an OdDb::TableBreakOption object.
- Remarks
- breakOption() returns one of the following:
Value Description OdDb::kTableBreakNone 0 No table break. OdDb::kTableBreakEnableBreaking 0x01 Enable table breaking. OdDb::kTableBreakRepeatTopLabels 0x02 Repeat top labels in all tables. OdDb::kTableBreakRepeatBottomLabels 0x04 Repeat bottom labels in all tables. OdDb::kTableBreakAllowManualPositions 0x08 Allow manual position for each sub-table. OdDb::kTableBreakAllowManualHeights 0x10 Allow manual height for each sub-table.
◆ breakSpacing()
| double OdDbTable::breakSpacing | ( | void | ) | const |
Returns the break spacing for this table entity.
◆ canDelete()
Checks if rows or columns can be deleted from the specified index.
- Parameters
-
nIndex [in] Index. nCount [in] Number of rows or columns. bRow [in] Flag that indicates what to check: "true"" for rows or "false" for columns.
- Returns
- True if rows or columns can be deleted; false otherwise.
◆ canInsert()
| bool OdDbTable::canInsert | ( | OdInt32 | nIndex, |
| bool | bRow | ||
| ) | const |
Checks if new rows or columns can be inserted into the specified index. Returns true if rows or columns can be inserted.
- Parameters
-
nIndex [in] Index. bRow [in] Flag that indicates what to check: "true" for rows or "false" for columns.
- Returns
- True if new rows or columns can be inserted into the specified index; false otherwise.
◆ cellState()
| OdDb::CellState OdDbTable::cellState | ( | OdInt32 | row, |
| OdInt32 | col | ||
| ) | const |
Returns the cell state.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Cell state.
- Remarks
- Cell state is an enumeration and takes one of the following values:
Value kCellStateNone 0x00 kCellStateContentLocked 0x01 kCellStateContentReadOnly 0x02 kCellStateLinked 0x04 kCellStateContentModifiedAfterUpdate 0x08 kCellStateFormatLocked 0x10 kCellStateFormatReadOnly 0x20 kCellStateFormatModifiedAfterUpdate 0x40 kAllCellStates (kCellStateContentLocked | kCellStateContentReadOnly | kCellStateLinked | kCellStateContentModifiedAfterUpdate | kCellStateFormatLocked | kCellStateFormatReadOnly | kCellStateFormatModifiedAfterUpdate)
◆ cellStyle()
Returns the cell style as an OdString value. Use a valid row index and pass the column index '-1' to get the style for the row. Use a valid column index and pass the row index '-1' to get the style for the column.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Cell style.
◆ cellStyleOverrides()
|
virtual |
Returns the cell style overrides for the specified cell in this table entity.
- Parameters
-
row [in] Row index of the column [in] Column index of the cell. overrides [out] Receives the overrides.
◆ cellType()
|
virtual |
Returns the cell type of the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
- Remarks
- cellType() returns one of the following:
Value Description OdDb::kTextCell 1 Text cell type OdDb::kBlockCell 2 Block cell type
◆ clearCellOverrides()
Clears the cell overrides for the specified cell in this table entity.
- Parameters
-
row [in] Row index of the column [in] Column index of the cell.
◆ clearSubSelection()
|
virtual |
Clears the sub-selection set of cells from this table.
◆ clearTableStyleOverrides()
|
virtual |
DEPRECATED! Clears the table style overrides for this table entity and/or its cells.
- Parameters
-
option [in] Option.
- Remarks
- option can be one of the following:
Description 0 Clears all overrides. 1 Clears all table overrides. 2 Clears all cell overrides.
◆ columnWidth()
|
virtual |
Returns the width of the specified column in this table entity (DXF 142).
- Parameters
-
column [in] Column index.
◆ contentColor() [1/3]
|
virtual |
DEPRECATED! Returns the content color for the specified row type in this table entity (DXF 64).
- Parameters
-
rowType [in] Row type.
- Remarks
- rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ contentColor() [2/3]
Returns the color of the cell content as an object of the OdCmColor class.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index.
- Returns
- Color of the cell content.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ contentColor() [3/3]
Returns the content color for the specified cell in this table entity (DXF 64).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ contentLayout()
| OdDb::CellContentLayout OdDbTable::contentLayout | ( | OdInt32 | row, |
| OdInt32 | col | ||
| ) | const |
Returns the content layout of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Content layout.
- Remarks
- Returning value should have one of following values:
Value kCellContentLayoutFlow 0x1 kCellContentLayoutStackedHorizontal 0x2 kCellContentLayoutStackedVertical 0x4
◆ contentType() [1/2]
| OdDb::CellContentType OdDbTable::contentType | ( | OdInt32 | row, |
| OdInt32 | col | ||
| ) | const |
Returns the content type of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Content type.
- Remarks
- Content type is the enumeration and takes one of the following values:
Value kCellContentTypeUnknown 0x0 kCellContentTypeValue 0x1 kCellContentTypeField 0x2 kCellContentTypeBlock 0x4
◆ contentType() [2/2]
| OdDb::CellContentType OdDbTable::contentType | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nIndex | ||
| ) | const |
Returns the type of content at the specified index of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nIndex [in] Index of content.
- Returns
- Content type.
- Remarks
- Content type is the enumeration and takes one of the following values:
Value kCellContentTypeUnknown 0x0 kCellContentTypeValue 0x1 kCellContentTypeField 0x2 kCellContentTypeBlock 0x4
◆ copyFrom() [1/4]
| void OdDbTable::copyFrom | ( | const OdDbLinkedTableData * | pSrc, |
| OdDb::TableCopyOption | nOption | ||
| ) |
Copies the content and format from the source linked table data object.
- Parameters
-
pSrc [in] Source table. nOption [in] Copy option.
◆ copyFrom() [2/4]
| void OdDbTable::copyFrom | ( | const OdDbLinkedTableData * | pSrc, |
| OdDb::TableCopyOption | nOption, | ||
| const OdCellRange & | srcRange, | ||
| const OdCellRange & | targetRange, | ||
| OdCellRange * | pNewTargetRangeOut | ||
| ) |
Copies the content and format from the source linked table data object.
- Parameters
-
pSrc [in] Source table. nOption [in] Copy option. srcRange [in] Source cell range. targetRange [in] Target cell range. pNewTargetRangeOut [out] Target cell range.
◆ copyFrom() [3/4]
| void OdDbTable::copyFrom | ( | const OdDbTable * | pSrc, |
| OdDb::TableCopyOption | nOption, | ||
| const OdCellRange & | srcRange, | ||
| const OdCellRange & | targetRange, | ||
| OdCellRange * | pNewTargetRangeOut | ||
| ) |
Copies the content and format from the source table.
- Parameters
-
pSrc [in] Source table. nOption [in] Copy option. srcRange [in] Source cell range. targetRange [in] Target cell range. pNewTargetRangeOut [out] New target cell range.
◆ copyFrom() [4/4]
|
virtual |
Copies the content from the source object.
- Parameters
-
pSource [in] Source object.
Reimplemented from OdDbBlockReference.
◆ createContent()
Creates additional content for the cell. Returns index of the created content.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nIndex [in] Index at which the content will be created.
- Returns
- Index of the created content.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ createTemplate()
| void OdDbTable::createTemplate | ( | OdDbTableTemplate * | target, |
| OdDb::TableCopyOption | nCopyOption | ||
| ) |
◆ dataFormat() [1/2]
Returns the data format of the cell as an OdString value.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Data format.
◆ dataFormat() [2/2]
Returns the data format at the specified content index of the cell as an OdString value.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content.
- Returns
- Data format.
◆ deleteCellContent()
DEPRECATED! This method is deprecated. Use deleteContent() instead. Deletes the content of the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than number of rows or the column argument is more than the number of columns.
◆ deleteColumns()
Deletes the specified number of columns from this table entity.
- Parameters
-
column [in] Index of first column to delete. numColumns [in] Number of columns to delete.
- Remarks
- Method generates the eInvalidInput exception when the number of deleted columns is more than the number of columns.
◆ deleteContent() [1/3]
| void OdDbTable::deleteContent | ( | const OdCellRange & | range | ) |
Deletes content from the cells.
- Parameters
-
range [in] Range of cells.
◆ deleteContent() [2/3]
Deletes content from the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ deleteContent() [3/3]
Deletes content at the cpecified index from the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nIndex [in] Index of content.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ deleteRows()
Deletes the specified number of rows from this table entity.
- Parameters
-
row [in] Index of first row to delete. numRows [in] Number of rows to delete.
- Remarks
- Method generates the eInvalidInput exception when the number of deleted rows is more than the number of rows.
◆ direction()
|
virtual |
Returns the unit X-axis for this table entity in WCS coordinates (DXF 11, 21, 31).
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Remarks
- Returns the filer status. This function is called by dwgIn() to allow the object to read its data. When overriding this function: 1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbBlockReference.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
- This function is called by dwgIn() to allow the object to write its data. When overriding this function: 1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbBlockReference.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Remarks
- Returns the filer status. This function is called by dxfIn() to allow the object to read its data. When overriding this function: 1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbBlockReference.
◆ dxfOutFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Remarks
- Returns the filer status. This function is called by dxfIn() to allow the object to read its data. When overriding this function: 1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbBlockReference.
◆ enableBreak()
| void OdDbTable::enableBreak | ( | bool | bEnable | ) |
Enables or disables table breaking.
- Parameters
-
bEnable [in] Value for enabling or disabling the table breaking.
◆ enableMergeAll()
Sets the merge-all flag for the cell, row or column.
- Parameters
-
row [in] Row index. col [in] Column index. bEnable [in] Merge-all flag value.
- Remarks
- Method generates the eNotImplementedYet exception.
◆ fieldId() [1/2]
| OdDbObjectId OdDbTable::fieldId | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent | ||
| ) | const |
Returns the field ID at the specified content index of the cell as an object of the OdDbObjectId class.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content.
- Returns
- Object ID of the field ID.
◆ fieldId() [2/2]
|
virtual |
Returns the Object ID of the OdDbField in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ flowDirection()
|
virtual |
Returns the direction that this table entity flows from its first row to its last (DXF 70).
- Remarks
- flowDirection() Returns one of the following:
Value Description OdDb::kTtoB 0 Top to Bottom OdDb::kBtoT 1 Bottom to Top
◆ format() [1/2]
|
virtual |
DEPRECATED! For internal use only.
◆ format() [2/2]
◆ generateLayout()
|
virtual |
Updates this table entity according to its current table style.
- Returns
- Returns eOk if successful or an appropriate error code if not.
◆ getBlockAttributeValue() [1/2]
| OdString OdDbTable::getBlockAttributeValue | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdDbObjectId & | attdefId | ||
| ) | const |
Returns the attribute value of the block cell using the specified object ID key.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. attdefId [in] Object ID.
- Returns
- Block attribute value as an OdString value.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ getBlockAttributeValue() [2/2]
|
virtual |
Gets the attribute value for the specified Object ID OdDb::key for the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. attdefId [in] Object ID of the OdDbAttributeDefinition. attValue [out] Receives the attribute value.
◆ getCellExtents()
|
virtual |
Returns the cell extents for the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. isOuterCell [in] If and only if true, ignores margins. pts [out] Receives the cell extents information.
- Remarks
- If isOuterCell is true, this function returns the extents of the cell without regard to margins.
If isOuterCell is false, this function returns the extents of cell reduced by the horizontal and vertical cell margins.
Method generates the eInvalidInput exception when the row argument is more than number of rows or the column argument is more than number of columns.
◆ getColumnName()
Returns the column name as an OdString value.
- Parameters
-
nIndex [in] Column index.
- Returns
- Column name.
◆ getCustomData() [1/2]
Returns the custom data value of the cell, column or row as an OdInt32 value. Use a valid row index and pass the column index '-1' to get the row data. Use a valid column index and pass the row index '-1' to get the column data.
- Parameters
-
row [in] Row index. col [in] Column index.
- Returns
- Custom data value of the cell.
◆ getCustomData() [2/2]
Returns the custom data value of the cell, column or row as an OdInt32 value. Use a valid row index and pass the column index '-1' to get the row data. Use a valid column index and pass the row index '-1' to get the column data.
- Parameters
-
row [in] Row index. col [in] Column index. sKey [in] Key to use for the custom data.
- Returns
- Custom data value of the cell.
◆ getDataLink() [1/3]
| OdInt32 OdDbTable::getDataLink | ( | const OdCellRange & | pRange, |
| OdDbObjectIdArray & | dataLinkIds | ||
| ) | const |
Returns the number of data links and gets the data links (OdDbDataLink) for the specified cell range.
- Parameters
-
pRange [in] Cell range. dataLinkIds [out] Array of data link IDs.
- Returns
- Number of data links.
◆ getDataLink() [2/3]
| OdDbObjectId OdDbTable::getDataLink | ( | OdInt32 | row, |
| OdInt32 | col | ||
| ) | const |
Returns the data link (OdDbDataLink) for the specified row and column.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Data link object ID.
◆ getDataLink() [3/3]
| OdDbDataLinkPtr OdDbTable::getDataLink | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::OpenMode | mode | ||
| ) | const |
Opens and returns the data link (OdDbDataLink) for the specified row and column.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. mode [in] Open mode.
- Returns
- Data link.
- Remarks
- Open mode should take one of the following values:
Value kNotOpen -1 kForRead 0 kForWrite 1 kForNotify 2
◆ getDataLinkRange()
| OdCellRange OdDbTable::getDataLinkRange | ( | OdInt32 | row, |
| OdInt32 | col | ||
| ) | const |
Returns the data link cell range that includes the specified row and column.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Data link cell range.
◆ getDataType() [1/3]
| void OdDbTable::getDataType | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| OdValue::DataType & | nDataType, | ||
| OdValue::UnitType & | nUnitType | ||
| ) | const |
Gets the data type of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index. nDataType [out] Reference to the data type. nUnitType [out] Reference to the unit type.
- Remarks
- Data type should take one of the following values:
Value kUnknown 0x00 kLong 0x01 kDouble 0x02 kString 0x04 kDate 0x08 kPoint 0x10 k3dPoint 0x20 kObjectId 0x40 kBuffer 0x80 kResbuf 0x100 kGeneral 0x200 kColor 0x400
Unit type should take one of the following values:
Value kUnitless 0x00 kDistance 0x01 kAngle 0x02 kArea 0x04 kVolume 0x08 kCurrency 0x10 kPercentage 0x20
Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ getDataType() [2/3]
| void OdDbTable::getDataType | ( | OdUInt32 | row, |
| OdUInt32 | col, | ||
| OdValue::DataType & | nDataType, | ||
| OdValue::UnitType & | nUnitType | ||
| ) | const |
Returns the data type and unit type of the specified cell.
- Parameters
-
row [in] Row index. Should be more than or equal to 0 and less than the number of rows. col [in] Column index. Should be more than or equal to 0 and less than the number of columns. nDataType [out] Data type. nUnitType [out] Unit type.
◆ getDataType() [3/3]
|
virtual |
DEPRECATED! Returns the data type and unit type of the specified row type.
- Parameters
-
nDataType [out] Data type. nUnitType [out] Unit type. type [in] Row type.
- Remarks
- type must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ getFormula()
◆ getGridProperty()
| void OdDbTable::getGridProperty | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType, | ||
| OdGridProperty & | gridProp | ||
| ) | const |
Returns the grid line property of the cell, row or column. Use a valid row index and pass the column index '-1' to get the row grid property. Use a valid column index and pass the row index '-1' to get the column grid property.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetype. gridProp [out] Grid line property.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ getIndicatorSize()
| void OdDbTable::getIndicatorSize | ( | double & | dWidth, |
| double & | dHeight | ||
| ) | const |
Gets the row and column indicator size.
- Parameters
-
dWidth [out] width of the row indicator. dHeight [out] height of the column indicator .
◆ getIterator() [1/2]
| OdDbTableIteratorPtr OdDbTable::getIterator | ( | const OdCellRange * | pRange, |
| OdDb::TableIteratorOption | nOption | ||
| ) | const |
◆ getIterator() [2/2]
| OdDbTableIteratorPtr OdDbTable::getIterator | ( | void | ) | const |
◆ getMergeRange()
| OdCellRange OdDbTable::getMergeRange | ( | OdInt32 | row, |
| OdInt32 | col | ||
| ) | const |
Returns merge range of the cell as an object of the OdCellRange class. Returns invalid merge range if the cell is not part of the merge range.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Merge range.
◆ getOverride() [1/2]
| OdDb::GridProperty OdDbTable::getOverride | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType | ||
| ) | const |
Returns the override in the grid line of the cell, row or column. Use a valid row index and pass the column index '-1' to get the row property override. Use a valid column index and pass the row index '-1' to get the column property override.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetype.
- Returns
- Grid line override.
- Remarks
- Grid property should take one of the following values:
Value kGridPropInvalid 0x00 kGridPropLineStyle 0x01 kGridPropLineWeight 0x02 kGridPropLinetype 0x04 kGridPropColor 0x08 kGridPropVisibility 0x10 kGridPropDoubleLineSpacing 0x20 kGridPropAll (kGridPropLineStyle | kGridPropLineWeight | kGridPropLinetype | kGridPropColor | kGridPropVisibility | kGridPropDoubleLineSpacing)
Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ getOverride() [2/2]
| OdDb::CellProperty OdDbTable::getOverride | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent | ||
| ) | const |
Returns the override of the content of a cell, row or column. Use a valid row index and pass column index -1 to get row property overrides. Use a valid column index and pass row index -1 to get column property overrides.
- Parameters
-
row [in] Row index. col [in] Column index. nContent [in] Content index.
- Returns
- Content override.
- Remarks
- Cell property should take one of the next values:
Value kCellPropInvalid 0x00000 kCellPropDataType 0x00001 kCellPropDataFormat 0x00002 kCellPropRotation 0x00004 kCellPropScale 0x00008 kCellPropAlignment 0x00010 kCellPropContentColor 0x00020 kCellPropTextStyle 0x00040 kCellPropTextHeight 0x00080 kCellPropAutoScale 0x00100 kCellPropBackgroundColor 0x00200 kCellPropMarginLeft 0x00400 kCellPropMarginTop 0x00800 kCellPropMarginRight 0x01000 kCellPropMarginBottom 0x02000 kCellPropContentLayout 0x04000 kCellPropMergeAll 0x08000 kCellPropFlowDirBtoT 0x10000 kCellPropMarginHorzSpacing 0x20000 kCellPropMarginVertSpacing 0x40000 kCellPropDataTypeAndFormat (kCellPropDataType | kCellPropDataFormat) kCellPropContent (kCellPropDataType | kCellPropDataFormat | kCellPropRotation | kCellPropScale | kCellPropContentColor | kCellPropTextStyle | kCellPropTextHeight | kCellPropAutoScale) kCellPropBitProperties (kCellPropAutoScale | kCellPropMergeAll | kCellPropFlowDirBtoT) kCellPropAll (kCellPropDataType | kCellPropDataFormat | kCellPropRotation | kCellPropScale | kCellPropAlignment | kCellPropContentColor | kCellPropBackgroundColor | kCellPropTextStyle | kCellPropTextHeight | kCellPropMarginLeft | kCellPropMarginTop | kCellPropMarginRight | kCellPropMarginBottom | kCellPropMarginHorzSpacing | kCellPropMarginVertSpacing | kCellPropAutoScale | kCellPropMergeAll | kCellPropFlowDirBtoT | kCellPropContentLayout)
◆ getSubSelection() [1/2]
|
virtual |
Returns the row and column indexes of the cells in the sub-selection set.
- Parameters
-
rowMin [out] Lower bound of row index. rowMax [out] Upper bound of row index. colMin [out] Lower bound of column index. colMax [out] Upper bound of column index. subTable [out] Number sub table in case breaking.
- Returns
- Returns eOk if successful, eSubSelectionSetEmpty if there are no sub-selection cells, or an appropriate error code if not.
◆ getSubSelection() [2/2]
| OdCellRange OdDbTable::getSubSelection | ( | OdInt32 * | subTable = NULL | ) | const |
Returns the range of cells in the sub-selection set.
- Remarks
- If there are no sub-selection cells, returns invalid range.
- Parameters
-
subTable [out] Number sub table in case breaking.
◆ getSubTablesInfo()
| OdInt32 OdDbTable::getSubTablesInfo | ( | OdArray< OdDbSubTable > & | subTables | ) | const |
◆ getToolTip()
◆ gridColor() [1/3]
|
virtual |
DEPRECATED! Returns the grid color for the specified gridline type and row type in this table entity (DXF 63,64,65,66,68,69).
- Parameters
-
gridlineType [in] Gridline type. rowType [in] Row type.
- Remarks
- gridlineType must be one of the following:
Value Description OdDb::kHorzTop 1 Top or bottom horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kHorzInside 2 All horizontal grid lines, excluding the bottom and top lines. OdDb::kHorzBottom 4 Bottom or top horizontal table's grid line, depending on the flow direction of the table rows (down or up).
rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ gridColor() [2/3]
| OdCmColor OdDbTable::gridColor | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType | ||
| ) | const |
Returns the grid color of the cell, row or column as an object of the OdCmColor class. Use a valid row index and pass the column index '-1' to get the row grid line color. Use a valid column index and pass the row index '-1' to get the column grid line color.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetype.
- Returns
- Grid color.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ gridColor() [3/3]
|
virtual |
Returns the grid color for the specified cell and edge in this table entity (DXF 63,64,65,66,68,69).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. edgeType [in] Edge type.
- Remarks
- edgeType must be one of the following:
Value Description OdDb::kTopMask 1 Top-edge index of the table cell. OdDb::kRightMask 2 Right-edge index of the table cell. OdDb::kBottomMask 4 Bottom-edge index of the table cell. OdDb::kLeftMask 8 Left-edge index of the table cell.
◆ gridDoubleLineSpacing()
| double OdDbTable::gridDoubleLineSpacing | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType | ||
| ) | const |
Returns the grid double line spacing of the cell, row or column as a double value. Use a valid row index and pass the column index '-1' to get the row grid double line spacing. Use a valid column index and pass the row index '-1' to get the column grid double line spacing.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetype.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ gridLineStyle()
| OdDb::GridLineStyle OdDbTable::gridLineStyle | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType | ||
| ) | const |
Returns the grid linestyle of a cell, row or column. Use a valid row index and pass the column index '-1' to get the row grid line style. Use a valid column index and pass the row index '-1' to get the column grid line style.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetype.
- Returns
- Grid linestyle.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
Grid line style should take one of the following values:
Value kGridLineStyleSingle 1 kGridLineStyleDouble 2
◆ gridLinetype()
| OdDbObjectId OdDbTable::gridLinetype | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType | ||
| ) | const |
Returns the grid linetype of the cell, row or column. Use a valid row index and pass the column index '-1' to get the row grid linetype. Use a valid column index and pass the row index '-1' to get the column grid linetype.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetypes.
- Remarks
- Grid linetypes should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ gridLineWeight() [1/3]
|
virtual |
DEPRECATED! Returns the grid lineweight for the specified gridline type and row type in this table entity (DXF 274-279).
- Parameters
-
gridlineType [in] Gridline type. rowType [in] Row type.
- Remarks
- gridlineType must be one of the following:
Value Description OdDb::kHorzTop 1 Top or bottom horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kHorzInside 2 All horizontal grid lines, excluding the bottom and top lines. OdDb::kHorzBottom 4 Bottom or top horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kVertLeft 8 Left-most table's grid line. OdDb::kVertInside 0x10 All vertical grid lines, excluding the left-most and right-most lines. OdDb::kVertRight 0x20 Right-most table's grid line.
rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ gridLineWeight() [2/3]
| OdDb::LineWeight OdDbTable::gridLineWeight | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType | ||
| ) | const |
Returns the grid lineweight of a cell, row or column. Use a valid row index and pass the column index '-1' to get the row grid lineweight. Use a valid column index and pass the row index '-1' to get the column grid lineweight.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetype.
- Returns
- Grid lineweight.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
Grid lineweight should take one of the following values:
Value kLnWt000 0 kLnWt005 5 kLnWt009 9 kLnWt013 13 kLnWt015 15 kLnWt018 18 kLnWt020 20 kLnWt025 25 kLnWt030 30 kLnWt035 35 kLnWt040 40 kLnWt050 50 kLnWt053 53 kLnWt060 60 kLnWt070 70 kLnWt080 80 kLnWt090 90 kLnWt100 100 kLnWt106 106 kLnWt120 120 kLnWt140 140 kLnWt158 158 kLnWt200 200 kLnWt211 211 kLnWtByLayer -1 kLnWtByBlock -2 kLnWtByLwDefault -3
◆ gridLineWeight() [3/3]
|
virtual |
Returns the grid lineweight for the specified cell and edge in this table entity (DXF 274-279).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. edgeType [in] Edge type.
- Remarks
- edgeType must be one of the following:
Value Description OdDb::kTopMask 1 Top-edge index of the table cell. OdDb::kRightMask 2 Right-edge index of the table cell. OdDb::kBottomMask 4 Bottom-edge index of the table cell. OdDb::kLeftMask 8 Left-edge index of the table cell.
◆ gridVisibility() [1/3]
|
virtual |
DEPRECATED! Returns the grid visibility for the specified gridline type and row type in this table entity (DXF 284-289).
- Parameters
-
gridlineType [in] Gridline type. rowType [in] Row type.
- Remarks
- gridVisibility() returns one of the following:
Value OdDb::kInvisible 1 OdDb::kVisible 0
gridlineType must be one of the following:
Value Description OdDb::kHorzTop 1 Top or bottom horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kHorzInside 2 All horizontal grid lines, excluding the bottom and top lines. OdDb::kHorzBottom 4 Bottom or top horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kVertLeft 8 Left-most table's grid line. OdDb::kVertInside 0x10 All vertical grid lines, excluding the left-most and right-most lines. OdDb::kVertRight 0x20 Right-most table's grid line.
rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ gridVisibility() [2/3]
| OdDb::Visibility OdDbTable::gridVisibility | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType | ||
| ) | const |
Returns the grid visibility of the cell, row or column. Use a valid row index and pass the column index '-1' to get the row grid visibility. Use a valid column index and pass the row index '-1' to get the column grid visibility.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetype.
- Returns
- Grid visibility.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
Grid visibility should take one of the following values:
Value kInvisible 1 kVisible 0
◆ gridVisibility() [3/3]
|
virtual |
Returns the grid visibility for the specified cell and edge in this table entity (DXF 284-289).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. edgeType [in] Edge type.
- Remarks
- gridVisibility() returns one of the following:
Value OdDb::kInvisible 1 OdDb::kVisible 0
edgeType must be one of the following:
Value Description OdDb::kTopMask 1 Top-edge index of the table cell. OdDb::kRightMask 2 Right-edge index of the table cell. OdDb::kBottomMask 4 Bottom-edge index of the table cell. OdDb::kLeftMask 8 Left-edge index of the table cell.
◆ hasFormula()
Checks if the cell has a formula.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content.
- Returns
- True if the cell has a formula at the specified content index; false otherwise.
◆ hasSubSelection()
|
virtual |
Returns true if the table has a sub-selection set of cells, or returns false in the other case.
◆ height()
|
virtual |
Returns the overall height of this table entity.
◆ hitTest() [1/2]
|
virtual |
Performs a hit test for the specified point and viewing direction in this table entity. Returns the row index and the column index of the cell, hit by the ray in the output arguments. Returns true if a table set is hit or returns false in the other case.
- Parameters
-
wpt [in] Input 3D picking point in WCS. wviewVec [in] 3D vector in WCS that specifies the view direction for the hit test. wxaper [in] Width of aperture box centered at the hit point. wyaper [in] Height of aperture box centered at the hit point. resultRowIndex [out] Row index. resultColumnIndex [out] Column index. contentIndex [out] Context index. nItem [out] Hit flags, which indicate the table item at the specified point. subTable [out] Number sub table in case breaking.
◆ hitTest() [2/2]
|
virtual |
Performs a hit test for the specified point and viewing direction in this table entity. Returns the row index and the column index of the cell, hit by the ray in the output arguments. Returns true if a table set is hit or returns false in the other case.
- Parameters
-
wpt [in] Input 3D picking point in WCS. wviewVec [in] 3D vector in WCF that specifies the view direction for the hit test. wxaper [in] Width of aperture box centered at the hit point. wyaper [in] Height of aperture box centered at the hit point. resultRowIndex [out] Row index. resultColumnIndex [out] Column index. subTable [out] Number sub table in case breaking.
◆ horzCellMargin()
|
virtual |
DEPRECATED! This method is deprecated. Use margin() instead. Returns the horizontal cell margin for this table entity (DXF 40).
- Remarks
- The horizontal cell margin is the horizontal space between the cell text and the cell border.
◆ insertColumns()
|
virtual |
Inserts the specified number of columns into this table entity at the specified column index.
- Parameters
-
column [in] Column index. width [in] Width of the inserted columns. numColumns [in] Number of columns to insert.
- Remarks
- Method generates the eInvalidInput exception when the column argument is more than the number of columns or the width is zero.
◆ insertColumnsAndInherit()
Inserts columns at the specified index and inherits their format from the reference column.
- Parameters
-
col [in] Index. nInheritFrom [in] Column number in the table that the format will be inherited from. nNumCols [in] Number of inserted columns.
- Remarks
- Method generates the eInvalidInput exception when the number of rows or columns is zero.
◆ insertRows()
Inserts the specified number of rows into this table entity at the specified row index.
- Parameters
-
row [in] Row index. height [in] Height of the inserted rows. numRows [in] Number of rows to insert.
- Remarks
- Method generates the eInvalidInput exception when the height is zero.
◆ insertRowsAndInherit()
Inserts rows at the specified index and inherits their format from the reference row.
- Parameters
-
nIndex [in] Index. nInheritFrom [in] Row number in the table that the format will be inherited from. nNumRows [in] Number of inserted rows.
◆ isAutoScale() [1/2]
Checks whether data in the cell is auto-scaled or not.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index.
- Returns
- True if the cell data is auto-scaled; false otherwise.
◆ isAutoScale() [2/2]
DEPRECATED! Returns true if and only if the block in the specified cell in this table entity is automatically scaled and positioned to fit into the cell.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ isBackgroundColorNone() [1/2]
|
virtual |
DEPRECATED! Returns true if and only if the background color for the specified row type is disabled for this table entity (DXF 283).
- Parameters
-
rowType [in] Row type.
- Remarks
- rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ isBackgroundColorNone() [2/2]
Returns true if and only if the background color for the specified cell is disabled for this table entity (DXF 283).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ isBreakEnabled()
| bool OdDbTable::isBreakEnabled | ( | void | ) | const |
Returns true if the table break is enabled, or false otherwise.
◆ isContentEditable()
Returns the "editing content flag" cell property.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- True if the cell content can be edited or false if not.
◆ isEmpty()
Returns the "empty flag" cell property.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- True if the cell is empty, or false if it is not.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ isFormatEditable()
Returns the "editing format flag" cell property.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- True if the cell format can be edited or false if not.
◆ isHeaderSuppressed()
|
virtual |
DEPRECATED! Returns true if and only if the header row is suppressed for this table entity (DXF 281).
◆ isLinked()
Checks if a cell is linked to a data source.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- True if the cell is linked to a data source; false otherwise.
◆ isMergeAllEnabled()
Checks whether the merge-all flag is enabled for the cell, row or column.
- Parameters
-
row [in] Row index. col [in] Column index.
- Returns
- True if the merge-all flag is enabled or false if it is not.
- Remarks
- Method generates the eNotImplementedYet exception.
◆ isMergedCell()
|
virtual |
Returns true if and only if the specified cell has been merged, and returns the range of the merged cells in this table entity.
- Parameters
-
row [in] Row index. column [in] Column index. minRow [out] Receives the minimum row index of the merged cells. maxRow [out] Receives the maximum row index of the merged cells. minColumn [out] Receives the minimum column index of the merged cells. maxColumn [out] Receives the maximum column index of the merged cells.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows or the column argument is more than the number of columns.
◆ isRegenerateTableSuppressed()
| bool OdDbTable::isRegenerateTableSuppressed | ( | ) | const |
Returns true if regeneration of the table block is disabled. Otherwise, returns false.
◆ isTitleSuppressed()
|
virtual |
DEPRECATED! Returns true if and only if the title row is suppressed for this table entity (DXF 280).
◆ margin()
| double OdDbTable::margin | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::CellMargin | nMargin | ||
| ) | const |
Returns the margin of the cell, row or column as a double value. Use a valid row index and pass the column index '-1' to get the margin for the row. Use a valid column index and pass the row index '-1' to get the margin for the column.
- Parameters
-
row [in] Row index. col [in] Column index. nMargin [in] Margin type.
- Returns
- Margin value.
- Remarks
- Margin type should be one of the following values:
Value kCellMarginTop 0x01 kCellMarginLeft 0x02 kCellMarginBottom 0x04 kCellMarginRight 0x08 kCellMarginHorzSpacing 0x10 kCellMarginVertSpacing 0x20
◆ mergeCells()
|
virtual |
Merges a rectangular region of cells in this table entity.
- Parameters
-
minRow [in] Minimum row index of the merged cells. maxRow [in] Maximum row index of the merged cells. minColumn [in] Minimum column index of the merged cells. maxColumn [in] Maximum column index of the merged cells.
- Remarks
- Method generates the eInvalidInput exception when the minimum row index is more than the maximum row index, the minimum column index is more than the maximum column index, the maximum row index is more than the number of rows, or the maximum column index is more than the number of columns.
◆ mergedFlag()
Returns cell property "merged flag". The first cell has a value equal false. Next cells have a value equal to true.
- Parameters
-
row [in] Row index. column [in] Column index.
◆ mergedHeight()
Returns cell property "merged height". The first cell may have a value > 1. Next cells have a value equal 1.
- Parameters
-
row [in] Row index. column [in] Column index.
◆ mergedWidth()
Returns cell property "merged width". The first cell may have a value > 1. Next cells have a value equal 1.
- Parameters
-
row [in] Row index. column [in] Column index.
◆ minimumColumnWidth()
|
virtual |
Returns the minimum column width for the specified column in this table entity.
- Parameters
-
column [in] Column index.
◆ minimumRowHeight()
|
virtual |
Returns the minimum row height for the specified row in this table entity.
- Parameters
-
row [in] Row index.
◆ minimumTableHeight()
|
virtual |
Returns the minimum overall height for this table entity.
◆ minimumTableWidth()
|
virtual |
Returns the minimum overall width for this table entity.
◆ modified()
|
virtual |
Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed.
- Parameters
-
pObject [in] Pointer to the object that is being closed after being modified.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ moveContent()
Moves content in the cell from one position to another.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nFromIndex [in] Index of content to move. nToIndex [in] Target index of the content where it should be moved to.
- Remarks
- Method generates the eNotImplementedYet exception.
◆ numColumns()
|
virtual |
Returns the number of columns in this table entity (DXF 92).
◆ numContents()
Returns the number of contents in a cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Returns
- Number of contents.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ numRows()
|
virtual |
Returns the number of rows in this table entity (DXF 91).
- Remarks
- This includes title and header rows, if any.
◆ ODDB_DECLARE_MEMBERS()
| OdDbTable::ODDB_DECLARE_MEMBERS | ( | OdDbTable | ) |
◆ recomputeTableBlock()
Updates the block table record referenced by this table entity.
- Parameters
-
forceUpdate [in] Force an update of the block table record.
- Returns
- Returns eOk if successful or an appropriate error code if not.
If forceUpdate is false, the block table record is updated if and only if this table entity has been changed since the block table record was last updated.
If forceUpdate is true, the block table will be unconditionally updated.
◆ removeAllOverrides()
Removes all overrides in a cell, row or column. Use a valid row index and pass the column index '-1' to remove the row property overrides. Use a valid column index and pass the row index '-1' to remove the column property overrides.
- Parameters
-
row [in] Row index. col [in] Column index.
◆ removeDataLink() [1/2]
Removes the data link at the specified cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ removeDataLink() [2/2]
◆ reselectSubRegion()
|
virtual |
Returns an array of sub-entities of the current sub-selection cells in the output argument paths.
- Parameters
-
pPaths [out] Pointer to an OdDbFullSubentPathArray.
- Returns
- Returns true if successful or returns false if not.
If pPaths is empty, there are no sub-selection cells.
◆ resetValue()
Resets the value in a specified cell.
- Parameters
-
row [in] Row index. col [in] Column index.
- Returns
- Returns eOk if successful, or returns eInvalidInput if row and col arguments refer to an invalid cell.
◆ rotation() [1/2]
| double OdDbTable::rotation | ( | ) | const |
Returns the table rotation in radians as a double value.
◆ rotation() [2/2]
Returns the content rotation angle in radians as a double value.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index.
- Returns
- Content rotation angle value.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ rowHeight()
|
virtual |
Returns the height of the specified row in this table entity (DXF 141).
- Parameters
-
row [in] Row index.
◆ rowType()
|
virtual |
DEPRECATED! Returns the type of the specified row in this table entity.
- Parameters
-
row [in] Row index.
- Remarks
- rowType() returns one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ scale()
Returns the scale value of the cell as a double value.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index.
- Returns
- Scale value.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ select()
|
virtual |
Selects a cell in this table by the specified point, viewing direction, and orientation. Returns the row index and the column index of the selected cell that encloses the input point.
- Parameters
-
wpt [in] Input 3D picking point in WCS. wvwVec [in] 3D vector in WCS that specifies the view direction for the hit test. wvwxVec [in] 3D vector in WCS that specifies the view orientation for the hit test. wxaper [in] Width of aperture box centered at the hit point. wyaper [in] Height of aperture box centered at the hit point. allowOutside [in] Indicates whether a pick point outside the table will select a cell. bInPickFirst [in] If true, the entity is already in the pickfirst set; if false, the pickfirst logic should attempt to sub-select the entity directly. resultRowIndex [out] Row index. resultColumnIndex [out] Column index. pPaths [out] Pointer to an OdDbFullSubentPathArray.
- Returns
- Returns eOk if successful or an appropriate error code if not.
If pPaths is not null, the cell subentities will be returned in pPaths.
◆ select_next_cell()
|
virtual |
◆ selectSubRegion()
|
virtual |
Selects a set of cells in this table by the specified window box, viewing direction, and orientation. Returns the set of cells in the output arguments rowMin, rowMax, colMin, colMax.
- Parameters
-
wpt1 [in] 3D picking point in WCS that specifies the first corner point of the window box selection. wpt2 [in] 3D picking point in WCS that specifies the second corner point of the window box selection. wvwVec [in] 3D vector in WCS that specifies the view direction for the selection. wvwxVec [in] 3D vector in WCS that specifies the view orientation for the hit test. wxaper [in] Width of aperture box centered at the hit point. wyaper [in] Height of aperture box centered at the hit point. seltype [in] Selection type. bIncludeCurrentSelection [in] Indicates whether the selected cells will include currently selected cells and newly selected cells or only newly selected cells. bInPickFirst [in] If true, the entity is already in the pickfirst set; if false, the pickfirst logic should attempt to sub-select the entity directly. rowMin [out] Lower bound of row index. rowMax [out] Upper bound of row index. colMin [out] Lower bound of column index. colMax [out] Upper bound of column index. pPaths [out] Pointer to an OdDbFullSubentPathArray.
- Returns
- Returns eOk if successful or an appropriate error code if not.
If pPaths is not null, the cell sub-entities will be returned in pPaths.
◆ setAlignment() [1/2]
|
virtual |
DEPRECATED! Sets the cell alignment for the specified row types in this table entity (DXF 170).
- Parameters
-
alignment [in] Alignment. rowTypes [in] Row types.
- Remarks
- rowTypes must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
alignment must be one of the following:
Value OdDb::kTopLeft 1 OdDb::kTopCenter 2 OdDb::kTopRight 3 OdDb::kMiddleLeft 4 OdDb::kMiddleCenter 5 OdDb::kMiddleRight 6 OdDb::kBottomLeft 7 OdDb::kBottomCenter 8 OdDb::kBottomRight 9
Method generates the eInvalidInput exception when the alignment is out of the available range 1 to 9, when the row argument is more than the number of rows, or when the column argument is more than the number of columns.
◆ setAlignment() [2/2]
|
virtual |
Sets the cell alignment for the specified cell in this table entity (DXF 170).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. alignment [in] Alignment.
Alignment must be one of the following:
Value OdDb::kTopLeft 1 OdDb::kTopCenter 2 OdDb::kTopRight 3 OdDb::kMiddleLeft 4 OdDb::kMiddleCenter 5 OdDb::kMiddleRight 6 OdDb::kBottomLeft 7 OdDb::kBottomCenter 8 OdDb::kBottomRight 9
Method generates the eInvalidInput exception when the alignment is out of the available range 1 to 9, when the row argument is more than the number of rows, or when the column argument is more than the number of columns.
◆ setAutoScale() [1/2]
Sets the auto-scaled flag to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index. autoFit [in] Auto-scaled flag.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when format is not editable (!isFormatEditable()).
◆ setAutoScale() [2/2]
DEPRECATED! Determines if the block in the specified cell in this table entity is to be automatically scaled and positioned to fit into the cell.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. autoScale [in] True to autoscale the block to the cell.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument is more than the number of columns, or the cell type is not OdDb::kBlockCell.
◆ setBackgroundColor() [1/2]
|
virtual |
DEPRECATED! Sets the background color for the specified row types in this table entity (DXF 63).
- Parameters
-
color [in] Background color. rowTypes [in] Row types.
- Remarks
- rowTypes must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
Method generates the eInvalidInput exception when the row type mask is more than 7, the row argument is more than the number of rows, or the column argument is more than the number of columns.
◆ setBackgroundColor() [2/2]
|
virtual |
Sets the background color for the specified cell in this table entity (DXF 63).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. color [in] Background color.
Method generates the eInvalidInput exception when the row type mask is more than 7, the row argument is more than the number of rows, or the column argument is more than the number of columns.
◆ setBackgroundColorNone() [1/2]
|
virtual |
DEPRECATED! Controls the background color setting for the specified row types in this table entity (DXF 283).
- Parameters
-
disable [in] Disables the background color if true, enables if false. rowTypes [in] Row types.
- Remarks
- rowTypes must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
Method generates the eInvalidInput exception when the row type mask is more than 7, the row argument is more than the number of rows, or the column argument is more than the number of columns.
◆ setBackgroundColorNone() [2/2]
|
virtual |
Controls the background color setting for the specified cell in this table entity (DXF 283).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. disable [in] Disables the background color if true, enables if false.
Method generates the eInvalidInput exception when the row type mask is more than 7, the row argument is more than the number of rows, or the column argument is more than the number of columns.
◆ setBlockAttributeValue() [1/2]
| void OdDbTable::setBlockAttributeValue | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdDbObjectId & | attdefId, | ||
| const OdString & | atrValue | ||
| ) |
Sets the attribute value of the block cell using the specified object ID key.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. attdefId [in] Attribute object ID. atrValue [in] Attribute value as an OdString value.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ setBlockAttributeValue() [2/2]
|
virtual |
Sets the attribute value for the specified Object ID OdDb::key for the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. attdefId [in] Object ID of the OdDbAttributeDefinition. attValue [out] Sets the attribute value.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument is more than the number of columns, or the cell type is not OdDb::kBlockCell.
◆ setBlockRotation()
|
virtual |
DEPRECATED! This method is deprecated. Use setRotation() instead. Sets the rotation angle of the block reference in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. blockRotation [in] Rotation angle.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument is more than the number of columns, or the cell type is not OdDb::kBlockCell.
◆ setBlockScale()
DEPRECATED! This method is deprecated. Use setScale() instead. Sets the scale factor of the block reference in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. blockScale [in] Uniform scale factor.
- Remarks
- blockScale cannot be zero.
Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument is more than the number of columns, or the cell type is not OdDb::kBlockCell.
◆ setBlockTableRecordId() [1/2]
| void OdDbTable::setBlockTableRecordId | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdDbObjectId & | blkId, | ||
| bool | autoFit | ||
| ) |
Sets the ID of the block table record of the cell as an object of the OdDbObjectId class.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. blkId [in] Id of block table record. autoFit [in] Flag that indicates whether the block should be auto fit.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ setBlockTableRecordId() [2/2]
|
virtual |
Sets the Object ID of the block table record in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. blockId [in] Object ID of the block. autoScale [in] If true, autoscales the block to the cell.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument is more than the number of columns, the cell type is not OdDb::kBlockCell, or the object ID is invalid or kNull.
◆ setBreakFlowDirection()
| void OdDbTable::setBreakFlowDirection | ( | OdDb::TableBreakFlowDirection | flowDir | ) |
Sets table break flow direction of this table entity.
- Parameters
-
flowDir [in] Table break flow direction.
◆ setBreakHeight()
Sets the table break height of the specified table entity.
- Parameters
-
index [in] Sub-table index. height [in] Sub-table break height.
- Remarks
- index parameter should be more than or equal to 0.
◆ setBreakOffset()
| void OdDbTable::setBreakOffset | ( | OdUInt32 | index, |
| const OdGeVector3d & | vec | ||
| ) |
Sets the table break offset of the specified table entity.
- Parameters
-
index [in] Sun-table index. vec [in] Vector for table break offset.
- Remarks
- index parameter should be more than or equal to 1.
◆ setBreakOption()
| void OdDbTable::setBreakOption | ( | OdDb::TableBreakOption | option | ) |
Sets the table break option of this table entity.
- Parameters
-
option [in] Table break option.
- Remarks
- option should be a combination of one or more of the following:
Value Description OdDb::kTableBreakNone 0 No table break. OdDb::kTableBreakEnableBreaking 0x01 Enable table breaking. OdDb::kTableBreakRepeatTopLabels 0x02 Repeat top labels in all tables. OdDb::kTableBreakRepeatBottomLabels 0x04 Repeat bottom labels in all tables. OdDb::kTableBreakAllowManualPositions 0x08 Allow manual position for each sub-table. OdDb::kTableBreakAllowManualHeights 0x10 Allow manual height for each sub-table.
◆ setBreakSpacing()
| void OdDbTable::setBreakSpacing | ( | double | spacing | ) |
Sets the break spacing for this table entity.
- Parameters
-
spacing [in] Spacing value.
- Remarks
- Method generates the eInvalidInput exception when the spacing is negative.
◆ setCellState()
| void OdDbTable::setCellState | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::CellState | nLock | ||
| ) |
Sets the cell state.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nLock [in] Cell state.
- Remarks
- Cell state should take one of the following values:
Value kCellStateNone 0x00 kCellStateContentLocked 0x01 kCellStateContentReadOnly 0x02 kCellStateLinked 0x04 kCellStateContentModifiedAfterUpdate 0x08 kCellStateFormatLocked 0x10 kCellStateFormatReadOnly 0x20 kCellStateFormatModifiedAfterUpdate 0x40 kAllCellStates (kCellStateContentLocked | kCellStateContentReadOnly | kCellStateLinked | kCellStateContentModifiedAfterUpdate | kCellStateFormatLocked | kCellStateFormatReadOnly | kCellStateFormatModifiedAfterUpdate)
Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than table size.
◆ setCellStyle()
Sets the cell style. Use a valid row index and pass the column index '-1' to set the style for the row. Use a valid column index and pass the row index '-1' to set the style for the column.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. sCellStyle [in] Cell style.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ setCellType()
|
virtual |
DEPRECATED! Sets the cell type for the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. cellType [in] Cell type.
- Remarks
- cellType must be one of the following:
Value Description OdDb::kTextCell 1 Text cell type OdDb::kBlockCell 2 Block cell type
Method generates the eInvalidInput exception when the text cell type number is out of the range 1 to 2, the row argument is more than the number of rows, or the column argument is more than the number of columns.
◆ setColumnName()
Sets the column name.
- Parameters
-
nIndex [in] Column index. sName [in] Column name.
◆ setColumnWidth() [1/2]
|
virtual |
Sets the width of all columns in this table entity (DXF 142).
- Parameters
-
width [in] Column width.
- Remarks
- Method generates the eInvalidInput exception when the column width is negative.
◆ setColumnWidth() [2/2]
Sets the width of the specified column in this table entity (DXF 142).
- Parameters
-
column [in] Column index. width [in] Column width.
- Remarks
- Method generates the eInvalidInput exception when the column width is negative.
◆ setContentColor() [1/3]
|
virtual |
DEPRECATED! Sets the content color for the specified row types in this table entity (DXF 64).
- Parameters
-
color [in] Content color. nRowType [in] Row types.
- Remarks
- nRowType must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
Method generates the eInvalidInput exception when the row type mask is more than 7, the row argument is more than the number of rows, or the column argument is more than the number of columns.
◆ setContentColor() [2/3]
| void OdDbTable::setContentColor | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdCmColor & | color | ||
| ) |
Sets the color of the cell content.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index. color [in] Color content.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when format is not editable (!isFormatEditable()).
◆ setContentColor() [3/3]
|
virtual |
Sets the content color for the specified cell in this table entity (DXF 64).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. color [in] Content color.
Method generates the eInvalidInput exception when the row type mask is more than 7, the row argument is more than the number of rows, or the column argument is more than the number of columns.
◆ setContentLayout()
| void OdDbTable::setContentLayout | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::CellContentLayout | nLayout | ||
| ) |
Sets the content layout to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nLayout [in] Content layout.
- Remarks
- Content layout should take one of following values:
Value kCellContentLayoutFlow 0x1 kCellContentLayoutStackedHorizontal 0x2 kCellContentLayoutStackedVertical 0x4
Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when format is not editable (!isFormatEditable()).
◆ setCustomData() [1/2]
| void OdDbTable::setCustomData | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| const OdString & | sKey, | ||
| const OdValue * | pData | ||
| ) |
Sets the custom data value of the cell, column or row. Use a valid row index and pass the column index '-1' to get the row data. Use a valid column index and pass the row index '-1' to get the column data.
- Parameters
-
row [in] Row index. col [in] Column index. sKey [in] Key to use for the custom data. pData [in] Custom data value.
◆ setCustomData() [2/2]
Sets the custom data value of the cell, column or row. Use a valid row index and pass the column index '-1' to set the row data. Use a valid column index and pass the row index '-1' to set the column data.
- Parameters
-
row [in] Row index. col [in] Column index. nData [in] Custom data value.
◆ setDataFormat() [1/2]
Sets the data format of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. sFormat [in] Data format.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ setDataFormat() [2/2]
| void OdDbTable::setDataFormat | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdString & | sFormat | ||
| ) |
Sets the data format at the specified content index of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. sFormat [in] Data format.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ setDataLink() [1/2]
| void OdDbTable::setDataLink | ( | const OdCellRange & | range, |
| const OdDbObjectId & | idDataLink, | ||
| bool | bUpdate | ||
| ) |
Sets the data link (OdDbDataLink) for the specified cell range.
- Parameters
-
range [in] Cell range. idDataLink [in] Array of data link IDs. bUpdate [in] Flag that indicates whether or not the data link should be updated after setting.
- Remarks
- Method generates the eNotThatKindOfClass exception when idDataLink is not an OdDbDataLink object ID.
◆ setDataLink() [2/2]
| void OdDbTable::setDataLink | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| const OdDbObjectId & | idDataLink, | ||
| bool | bUpdate | ||
| ) |
Sets the data link (OdDbDataLink) for the specified row and column.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. idDataLink [in] Data link object ID. bUpdate [in] Flag that indicates whether or not the data link should be updated after setting.
- Remarks
- Method generates the eNotThatKindOfClass exception when idDataLink is not an OdDbDataLink object ID.
◆ setDataType() [1/4]
| void OdDbTable::setDataType | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| OdValue::DataType | nDataType, | ||
| OdValue::UnitType | nUnitType | ||
| ) |
Sets the data type to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index. nDataType [in] Data type. nUnitType [in] Unit type.
- Remarks
- Data type should take one of following values:
Value kUnknown 0x00 kLong 0x01 kDouble 0x02 kString 0x04 kDate 0x08 kPoint 0x10 k3dPoint 0x20 kObjectId 0x40 kBuffer 0x80 kResbuf 0x100 kGeneral 0x200 kColor 0x400
Unit type should take one of following values:
Value kUnitless 0x00, kDistance 0x01, kAngle 0x02, kArea 0x04, kVolume 0x08, kCurrency 0x10, kPercentage 0x20
Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when format is not editable (!isFormatEditable()).
◆ setDataType() [2/4]
| void OdDbTable::setDataType | ( | OdUInt32 | row, |
| OdUInt32 | col, | ||
| OdValue::DataType | nDataType, | ||
| OdValue::UnitType | nUnitType | ||
| ) |
Sets the data type and unit type of the specified cell.
- Parameters
-
row [in] Row index. Should be more than or equal to 0 and less than the number of rows. col [in] Column index. Should be more than or equal to 0 and less than the number of columns. nDataType [in] Data type. nUnitType [in] Unit type.
◆ setDataType() [3/4]
|
virtual |
DEPRECATED! Sets the data type and unit type for all row types.
- Parameters
-
nDataType [in] Data type. nUnitType [in] Unit type.
◆ setDataType() [4/4]
|
virtual |
DEPRECATED! Sets the data type and unit type for the specified row types.
- Parameters
-
nDataType [in] Data type. nUnitType [in] Unit type. nRowTypes [in] Row types.
◆ setDirection()
|
virtual |
Sets the X-axis for this table entity in WCS coordinates (DXF 11, 21, 31).
- Parameters
-
horizVector [in] Horizontal vector.
◆ setFieldId() [1/2]
| void OdDbTable::setFieldId | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdDbObjectId & | fieldId, | ||
| OdDb::CellOption | nFlag | ||
| ) |
Sets a field ID to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. fieldId [in] Field ID. nFlag [in] Cell option.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ setFieldId() [2/2]
|
virtual |
Sets the Object ID for OdDbField in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. fieldId [in] Object ID of the AdDbField.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument is more than the number of columns, or the cell type is not OdDb::kTextCell.
◆ setFlowDirection()
|
virtual |
Sets the direction that this table entity flows from its first row to its last. (DXF 70).
- Parameters
-
flowDirection [in] Flow direction.
- Remarks
- flowDirection must be one of the following:
Value Description OdDb::kTtoB 0 Top to Bottom OdDb::kBtoT 1 Bottom to Top
Method generates the eInvalidInput exception when the flow direction is not equal to 0 or 1.
◆ setFormat() [1/3]
DEPRECATED! For internal use only.
◆ setFormat() [2/3]
DEPRECATED! For internal use only.
◆ setFormat() [3/3]
DEPRECATED! For internal use only.
◆ setFormula()
| void OdDbTable::setFormula | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdString & | pszFormula | ||
| ) |
Sets the formula at the specified content index of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. pszFormula [in] Formula.
- Remarks
- Method generates the eNotImplementedYet exception.
◆ setGridColor() [1/3]
|
virtual |
DEPRECATED! Sets the grid color for the specified gridline types and row type in this table entity (DXF 63,64,65,66,68,69).
- Parameters
-
color [in] Grid color. gridlineTypes [in] Gridline types. rowTypes [in] Row types.
- Remarks
- gridlineTypes must be a combination of one or more of the following:
Value Description OdDb::kHorzTop 1 Top or bottom horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kHorzInside 2 All horizontal grid lines, excluding the bottom and top lines. OdDb::kHorzBottom 4 Bottom or top horizontal table's grid line, depending on the flow direction of the table rows (down or up).
rowTypes must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
Method generates the eInvalidInput exception when the row argument is more than the number of rows or the column argument is more than the number of columns.
◆ setGridColor() [2/3]
| void OdDbTable::setGridColor | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridlineTypes, | ||
| const OdCmColor & | color | ||
| ) |
Sets the grid color of the cell, row or column. Use a valid row index and pass the column index '-1' to get the row grid line color. Use a valid column index and pass the row index '-1' to get the column grid line color.
- Parameters
-
row [in] Row index. col [in] Column index. nGridlineTypes [in] Grid linetypes. color [in] Grid color.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ setGridColor() [3/3]
|
virtual |
Sets the grid color for the specified cell and edges in this table entity (DXF 63,64,65,66,68,69).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. edgeTypes [in] Edge types. color [in] Grid color.
- Remarks
- edgeTypes must be a combination of one or more of the following:
Value Description OdDb::kTopMask 1 Top-edge index of the table cell. OdDb::kRightMask 2 Right-edge index of the table cell. OdDb::kBottomMask 4 Bottom-edge index of the table cell. OdDb::kLeftMask 8 Left-edge index of the table cell.
Method generates the eInvalidInput exception when the row argument is more than the number of rows or the column argument is more than the number of columns.
◆ setGridDoubleLineSpacing()
| void OdDbTable::setGridDoubleLineSpacing | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineTypes, | ||
| double | fSpacing | ||
| ) |
Sets the grid double line spacing of the cell, row or column. Use a valid row index and pass the column index '-1' to set the row grid double line spacing. Use a valid column index and pass the row index '-1' to set the column grid double line spacing.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineTypes [in] Grid linetypes. fSpacing [in] Grid double line spacing.
- Remarks
- Grid linetypes should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ setGridLineStyle()
| void OdDbTable::setGridLineStyle | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineTypes, | ||
| OdDb::GridLineStyle | nLineStyle | ||
| ) |
Sets the grid line style to a cell, row or column. Use a valid row index and pass the column index '-1' to set the row grid line style. Use a valid column index and pass the row index '-1' to set the column grid line style.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineTypes [in] Grid linetype. nLineStyle [in] Grid line style.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
Grid line style should take one of the following values:
Value kGridLineStyleSingle 1 kGridLineStyleDouble 2
◆ setGridLinetype()
| void OdDbTable::setGridLinetype | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineTypes, | ||
| const OdDbObjectId & | idLinetype | ||
| ) |
Sets the grid linetype of the cell, row or column. Use a valid row index and pass the column index '-1' to set the row grid linetype. Use a valid column index and pass the row index '-1' to set the column grid linetype.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineTypes [in] Grid linetypes. idLinetype [in] Grid linetype to set.
- Remarks
- Grid linetypes should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ setGridLineWeight() [1/3]
|
virtual |
DEPRECATED! Sets the grid lineweight for the specified gridline types and row types in this table entity (DXF 274-279).
- Parameters
-
lineWeight [in] Lineweight. gridlineTypes [in] Gridline types. rowTypes [in] Row types.
- Remarks
- gridlineTypes must be a combination of one or more of the following:
Value Description OdDb::kHorzTop 1 Top or bottom horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kHorzInside 2 All horizontal grid lines, excluding the bottom and top lines. OdDb::kHorzBottom 4 Bottom or top horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kVertLeft 8 Left-most table's grid line. OdDb::kVertInside 0x10 All vertical grid lines, excluding the left-most and right-most lines. OdDb::kVertRight 0x20 Right-most table's grid line.
rowTypes must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
Method generates the eInvalidInput exception when the row argument is more than the number of rows or the column argument is more than the number of columns.
◆ setGridLineWeight() [2/3]
| void OdDbTable::setGridLineWeight | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineTypes, | ||
| OdDb::LineWeight | nLineWeight | ||
| ) |
Sets the grid lineweight of a cell, row or column. Use a valid row index and pass the column index '-1' to set the row grid lineweight. Use a valid column index and pass the row index '-1' to set the column grid lineweight.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineTypes [in] Grid linetype. nLineWeight [in] Grid lineweight.
- Remarks
- Grid linetype should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
Grid lineweight should take one of the following values:
Value kLnWt000 0 kLnWt005 5 kLnWt009 9 kLnWt013 13 kLnWt015 15 kLnWt018 18 kLnWt020 20 kLnWt025 25 kLnWt030 30 kLnWt035 35 kLnWt040 40 kLnWt050 50 kLnWt053 53 kLnWt060 60 kLnWt070 70 kLnWt080 80 kLnWt090 90 kLnWt100 100 kLnWt106 106 kLnWt120 120 kLnWt140 140 kLnWt158 158 kLnWt200 200 kLnWt211 211 kLnWtByLayer -1 kLnWtByBlock -2 kLnWtByLwDefault -3
◆ setGridLineWeight() [3/3]
|
virtual |
Sets the grid lineweight for the specified cell and edges in this table entity (DXF 274-279).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. edgeTypes [in] Edge types. lineWeight [in] Lineweight.
- Remarks
- edgeTypes must be a combination of one or more of the following:
Value Description OdDb::kTopMask 1 Top-edge index of the table cell. OdDb::kRightMask 2 Right-edge index of the table cell. OdDb::kBottomMask 4 Bottom-edge index of the table cell. OdDb::kLeftMask 8 Left-edge index of the table cell.
Method generates the eInvalidInput exception when the row argument is more than the number of rows or the column argument is more than the number of columns.
◆ setGridProperty() [1/2]
| void OdDbTable::setGridProperty | ( | const OdCellRange & | rangeIn, |
| OdDb::GridLineType | nGridLineTypes, | ||
| const OdGridProperty & | gridProp | ||
| ) |
Sets the grid line property of the cell, row or column.
- Parameters
-
rangeIn [in] Cell range, row range or column range. nGridLineTypes [in] Grid linetypes. gridProp [in] Grid line property.
- Remarks
- Grid linetypes should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ setGridProperty() [2/2]
| void OdDbTable::setGridProperty | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineTypes, | ||
| const OdGridProperty & | gridProp | ||
| ) |
Sets the grid line property of the cell, row or column. Use a valid row index and pass the column index '-1' to get the row grid property. Use a valid column index and pass the row index '-1' to get the column grid property.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineTypes [in] Grid linetypes. gridProp [in] Grid line property.
- Remarks
- Grid linetypes should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ setGridVisibility() [1/3]
|
virtual |
DEPRECATED! Sets the grid visibility for the specified gridline types and row types in this table entity (DXF 284-289).
- Parameters
-
gridVisibility [in] Grid visibility. gridlineTypes [in] Gridline types. rowTypes [in] Row types.
- Remarks
- gridVisibility must be one of the following:
Value OdDb::kInvisible 1 OdDb::kVisible 0
gridlineTypes must be a combination of one or more of the following:
Value Description OdDb::kHorzTop 1 Top or bottom horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kHorzInside 2 All horizontal grid lines, excluding the bottom and top lines. OdDb::kHorzBottom 4 Bottom or top horizontal table's grid line, depending on the flow direction of the table rows (down or up). OdDb::kVertLeft 8 Left-most table's grid line. OdDb::kVertInside 0x10 All vertical grid lines, excluding the left-most and right-most lines. OdDb::kVertRight 0x20 Right-most table's grid line.
rowTypes must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
Method generates the eInvalidInput exception when the row argument is more than the number of rows or the column argument is more than the number of columns.
◆ setGridVisibility() [2/3]
| void OdDbTable::setGridVisibility | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineTypes, | ||
| OdDb::Visibility | nVisibility | ||
| ) |
Sets the grid visibility of the cell, row or column. Use a valid row index and pass the column index '-1' to set the row grid visibility. Use a valid column index and pass the row index '-1' to set the column grid visibility.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineTypes [in] Grid linetypes. nVisibility [in] Grid line visibility.
- Remarks
- Grid linetypes should take one of the following values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
Grid visibility should take one of the following values:
Value kInvisible 1 kVisible 0
◆ setGridVisibility() [3/3]
|
virtual |
Sets the grid visibility for the specified cell and edges in this table entity (DXF 284-289).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. edgeTypes [in] Edge types. gridVisibility [in] Grid visibility.
- Remarks
- gridVisibility must be one of the following:
Value OdDb::kInvisible 1 OdDb::kVisible 0
edgeTypes must be a combination of one or more of the following:
Value Description OdDb::kTopMask 1 Top-edge index of the table cell. OdDb::kRightMask 2 Right-edge index of the table cell. OdDb::kBottomMask 4 Bottom-edge index of the table cell. OdDb::kLeftMask 8 Left-edge index of the table cell.
Method generates the eInvalidInput exception when the row argument is more than the number of rows or the column argument is more than the number of columns.
◆ setHeight()
|
virtual |
Sets the overall height of this table entity.
- Parameters
-
height [in] Overall height.
- Remarks
- Row heights may be adjusted proportionally.
Method generates the eInvalidInput exception when the height is negative.
◆ setHorzCellMargin()
|
virtual |
DEPRECATED! This method is deprecated. Use setMargin() instead. Sets the horizontal cell margin for this table entity (DXF 40).
- Parameters
-
cellMargin [in] Cell margin.
- Remarks
- The horizontal cell margin is the horizontal space between the horizontal cell text and the cell border.
Method generates the eInvalidInput exception when the cell margin is negative or zero.
◆ setMargin()
| void OdDbTable::setMargin | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::CellMargin | nMargins, | ||
| double | fMargin | ||
| ) |
Sets the margin to the cell, row or column. Use a valid row index and pass the column index '-1' to set the margin for the row. Use a valid column index and pass the row index '-1' to set the margin for the column.
- Parameters
-
row [in] Row index. col [in] Column index. nMargins [in] Margin type. fMargin [in] Margin value.
- Remarks
- Margin type should be a combination of one or more of the following values:
Value kCellMarginTop 0x01 kCellMarginLeft 0x02 kCellMarginBottom 0x04 kCellMarginRight 0x08 kCellMarginHorzSpacing 0x10 kCellMarginVertSpacing 0x20
◆ setNumColumns()
DEPRECATED! This method is deprecated. Use setSize() instead. Sets the number of columns for this table entity (DXF 92).
- Parameters
-
numColumns [in] Number of columns.
- Remarks
- The number of columns must be greater than zero.
Method generates the eInvalidInput exception when the number of columns is less than one.
◆ setNumRows()
DEPRECATED! This method is deprecated. Use setSize() instead. Sets the number of rows for this table entity (DXF 91).
- Parameters
-
numRows [in] Number of rows.
- Remarks
- This includes title and header rows, if any. The number of rows must be greater than zero.
Method generates the eInvalidInput exception when the number of rows is less than one.
◆ setOverride() [1/2]
| void OdDbTable::setOverride | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::GridLineType | nGridLineType, | ||
| OdDb::GridProperty | nOverride | ||
| ) |
Sets the grid linetype property override in a cell, row or column. Use a valid row index and pass the column index '-1' to set the row property overrides. Use a valid column index and pass the row index '-1' to set the column property overrides.
- Parameters
-
row [in] Row index. col [in] Column index. nGridLineType [in] Grid linetype. nOverride [in] Override.
- Remarks
- Grid linetype should take one of the next values:
Value kInvalidGridLine 0x00 kHorzTop 0x01 kHorzInside 0x02 kHorzBottom 0x04 kVertLeft 0x08 kVertInside 0x10 kVertRight 0x20 kHorzGridLineTypes kHorzTop | kHorzBottom | kHorzInside kVertGridLineTypes kVertLeft | kVertRight | kVertInside kOuterGridLineTypes kHorzTop | kHorzBottom | kVertLeft | kVertRight kInnerGridLineTypes kHorzInside | kVertInside kAllGridLineTypes kOuterGridLineTypes | kInnerGridLineTypes
◆ setOverride() [2/2]
| void OdDbTable::setOverride | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| OdDb::CellProperty | nOverride | ||
| ) |
Sets the content property override in a cell, row or column. Use a valid row index and pass the column index '-1' to set the row property overrides. Use a valid column index and pass the row index '-1' to set the column property overrides.
- Parameters
-
row [in] Row index. col [in] Column index. nContent [in] Content index. nOverride [in] Override.
- Remarks
- Cell property should take one of the following values:
Value kCellPropInvalid 0x00000 kCellPropDataType 0x00001 kCellPropDataFormat 0x00002 kCellPropRotation 0x00004 kCellPropScale 0x00008 kCellPropAlignment 0x00010 kCellPropContentColor 0x00020 kCellPropTextStyle 0x00040 kCellPropTextHeight 0x00080 kCellPropAutoScale 0x00100 kCellPropBackgroundColor 0x00200 kCellPropMarginLeft 0x00400 kCellPropMarginTop 0x00800 kCellPropMarginRight 0x01000 kCellPropMarginBottom 0x02000 kCellPropContentLayout 0x04000 kCellPropMergeAll 0x08000 kCellPropFlowDirBtoT 0x10000 kCellPropMarginHorzSpacing 0x20000 kCellPropMarginVertSpacing 0x40000 kCellPropDataTypeAndFormat (kCellPropDataType | kCellPropDataFormat) kCellPropContent (kCellPropDataType | kCellPropDataFormat | kCellPropRotation | kCellPropScale | kCellPropContentColor | kCellPropTextStyle | kCellPropTextHeight | kCellPropAutoScale) kCellPropBitProperties (kCellPropAutoScale | kCellPropMergeAll | kCellPropFlowDirBtoT) kCellPropAll (kCellPropDataType | kCellPropDataFormat | kCellPropRotation | kCellPropScale | kCellPropAlignment | kCellPropContentColor | kCellPropBackgroundColor | kCellPropTextStyle | kCellPropTextHeight | kCellPropMarginLeft | kCellPropMarginTop | kCellPropMarginRight | kCellPropMarginBottom | kCellPropMarginHorzSpacing | kCellPropMarginVertSpacing | kCellPropAutoScale | kCellPropMergeAll | kCellPropFlowDirBtoT | kCellPropContentLayout)
◆ setRotation() [1/2]
|
virtual |
Sets the table rotation angle.
- Parameters
-
fAngle [in] Rotation angle value in radians.
Reimplemented from OdDbBlockReference.
◆ setRotation() [2/2]
Sets the content rotation angle.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index. fAngle [in] Rotation angle value in radians.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when format is not editable (!isFormatEditable()).
◆ setRowHeight() [1/2]
|
virtual |
Sets the height of all rows in this table entity (DXF 141).
- Parameters
-
height [in] Row height.
- Remarks
- Method generates the eInvalidInput exception when the row height is negative.
◆ setRowHeight() [2/2]
Sets the height of the specified row in this table entity (DXF 141).
- Parameters
-
row [in] Row index. height [in] Row height.
- Remarks
- Method generates the eInvalidInput exception when the row height is negative.
◆ setScale()
Sets the scale value to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index. scale [in] Scale value.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ setSize()
Sets the size for this table entity.
- Parameters
-
rows [in] Number of rows. cols [in] Number of columns.
- Remarks
- Method generates the eInvalidInput exception when the number of rows or columns is zero.
◆ setSubSelection() [1/2]
|
virtual |
Sets the cell range to the sub-selection set.
- Parameters
-
range [in] Cell range. subTable [in] Number sub table in case breaking.
- Returns
- Returns eOk if successful or appropriate error code in the other case.
◆ setSubSelection() [2/2]
|
virtual |
Sets the row and column indexes of the cells in the sub-selection set.
- Parameters
-
rowMin [in] Lower bound of row index. rowMax [in] Upper bound of row index. colMin [in] Lower bound of column index. colMax [in] Upper bound of column index. subTable [in] Number sub table in case breaking
- Returns
- Returns eOk if successful or eInvalidInput if the input indexes are out of range.
◆ setTableStyle()
|
virtual |
Sets the Object ID of the OdDbTableStyle for use by this table entity (DXF 342).
- Parameters
-
tableStyleId [in] Object ID of the table style.
- Remarks
- Method generates the eInvalidInput exception when the object ID is invalid.
◆ setTextHeight() [1/3]
|
virtual |
DEPRECATED! Sets the text height for the specified row types or cell in this table entity (DXF 140).
- Parameters
-
height [in] Text height. rowTypes [in] Row types.
- Remarks
- rowTypes must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
Method generates the eInvalidInput exception when the row type mask is more than 7 or the text height is negative.
◆ setTextHeight() [2/3]
Sets the text height of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index. height [in] Text height value.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when format is not editable (!isFormatEditable()).
◆ setTextHeight() [3/3]
Sets the text height for the specified cell in this table entity (DXF 140).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. height [in] Text height.
Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument is more than the number of columns, or the cell type is not OdDb::kTextCell.
◆ setTextRotation()
|
virtual |
DEPRECATED! This method is deprecated. Use setRotation() instead. Sets the text rotation angle of the text in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. textRotation [in] Text rotation angle.
- Remarks
- textRotation must be one of the following:
Value Description OdDb::kDegrees000 0 0° OdDb::kDegrees090 1 90° CCW OdDb::kDegrees180 2 180° OdDb::kDegrees270 3 90° CW
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument s more than the number of columns, or the cell type is not OdDb::kTextCell.
◆ setTextString() [1/2]
Sets a text string to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. text [in] Text string.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ setTextString() [2/2]
|
virtual |
Sets the text string for the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. textString [in] Text string.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows or the column argument is more than the number of columns.
◆ setTextStyle() [1/3]
|
virtual |
DEPRECATED! Sets the Object ID of the text style for the specified row types in this table entity (DXF 7).
- Parameters
-
textStyleId [in] Text style Object ID. rowTypes [in] Row types.
- Remarks
- rowTypes must be a combination of one or more of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
Method generates the eInvalidInput exception when the row type mask is more than 7 or the object ID is invalid or kNull.
◆ setTextStyle() [2/3]
| void OdDbTable::setTextStyle | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdDbObjectId & | id | ||
| ) |
Sets the text style to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index.
id [in] Text style object ID.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when format is not editable (!isFormatEditable()).
◆ setTextStyle() [3/3]
|
virtual |
Sets the Object ID of the text style for the specified cell in this table entity (DXF 7).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell. textStyleId [in] Text style Object ID.
- Remarks
- Method generates the eInvalidInput exception when the row argument is more than the number of rows, the column argument is more than the number of columns, or the cell type is not OdDb::kTextCell.
◆ setToolTip()
Sets the tooltip of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. sToolTip [in] Tooltip.
◆ setValue() [1/5]
Sets a value to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. val [in] Value.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ setValue() [2/5]
| void OdDbTable::setValue | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| const OdValue & | val, | ||
| OdValue::ParseOption | nOption | ||
| ) |
Sets a value to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. val [in] Value. nOption [in] Parse option of the value.
- Remarks
- Parse option is the enumeration and takes one of the following values:
Value kParseOptionNone 0x00 kSetDefaultFormat 0x01 kPreserveMtextFormat 0x02 kConvertTextToValue 0x04 kChangeDataType 0x08 kParseTextForFieldCode 0x10
Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size. Method generates the eIsWriteProtected exception when content is not editable (!isContentEditable()).
◆ setValue() [3/5]
| void OdDbTable::setValue | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| OdString | sText, | ||
| OdValue::ParseOption | nOption | ||
| ) |
Sets a value to the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. sText [in] Text of the value. nOption [in] Parse option of the value.
- Remarks
- Parse option is the enumeration and takes one of the following values:
Value kParseOptionNone 0x00 kSetDefaultFormat 0x01 kPreserveMtextFormat 0x02 kConvertTextToValue 0x04 kChangeDataType 0x08 kParseTextForFieldCode 0x10
Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ setValue() [4/5]
Sets the value of the first content of a cell.
- Parameters
-
row [in] Row index. Should be more than or equal to 0 and less than the number of rows. col [in] Column index. Should be more than or equal to 0 and less than the number of columns. val [in] Content value.
- Returns
- Returns eOk if successful or an appropriate error code.
◆ setValue() [5/5]
| void OdDbTable::setValue | ( | OdUInt32 | row, |
| OdUInt32 | col, | ||
| OdString & | pszText, | ||
| OdValue::ParseOption | nOption | ||
| ) |
Sets the value of the first content of a cell.
- Parameters
-
row [in] Row index. Should be more than or equal to 0 and less than the number of rows. col [in] Column index. Should be more than or equal to 0 and less than the number of columns. pszText [in] Text for converting to set value. nOption [out] Parse option.
- Returns
- Returns eOk if successful or an appropriate error code.
◆ setVertCellMargin()
|
virtual |
DEPRECATED! This method is deprecated. Use setMargin() instead. Sets the vertical cell margin for this table entity (DXF 41).
- Parameters
-
cellMargin [in] Cell margin.
- Remarks
- The vertical cell margin is the vertical space between the cell text and the cell border.
Method generates the eInvalidInput exception when the vertical cell margin is negative or zero.
◆ setWidth()
|
virtual |
Sets the overall width for this table entity.
- Parameters
-
width [in] Overall width.
- Remarks
- Column widths may be adjusted proportionally.
Method generates the eInvalidInput exception when the width is negative.
- See also
- columWidth
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database-resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operations. When overriding this function: 1) If the OdDbObject's state is incorrect, throw exception. 2) Call parent class's subClose(). 3) If other actions are required before close, do them. The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbBlockReference.
◆ subErase()
|
virtual |
Called as the first operation as this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.
Returns eOk if and only if erase() is to continue.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subErase() returns anything other than eOk, immediately return it.
3) If other actions are required before erase, do them.
4) Return eOk.
If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented from OdDbEntity.
◆ subExplode()
|
virtual |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [in] Receives an array of pointers to the new entities.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbBlockReference.
◆ subGetClassID()
Overridables.
Reimplemented from OdDbBlockReference.
◆ subGetGeomExtents()
|
virtual |
Returns the geometry extents.
- Parameters
-
extents [out] An output extents.
Reimplemented from OdDbBlockReference.
◆ subGetTransformedCopy()
|
virtual |
This is subGetTransformedCopy, a member of class OdDbBlockReference.
- Parameters
-
xfm [in] Input matrix for transforming the copy of the entity. pCopy [out] Pointer to the transformed copy of the entity.
Reimplemented from OdDbBlockReference.
◆ subHighlight()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSetDatabaseDefaults()
|
virtual |
- Remarks
- This function is an override for OdDbEntity::subSetDatabaseDefaults() to set the dimension style of this entity to the current style for the specified database.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Applies the specified 3D transformation matrix to this entity.
- Parameters
-
xfm [in] 3D transformation matrix.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbBlockReference.
◆ subWblockClone()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Returns true if the entity has no view-dependent graphics. In another case returns false.
- Parameters
-
pWd [in] Pointer to the OdGiWorldDraw object.
Reimplemented from OdDbBlockReference.
◆ suppressHeaderRow()
|
virtual |
DEPRECATED! Controls the suppression of the header row for this table entity (DXF 280).
- Parameters
-
suppress [in] Controls suppression.
◆ suppressRegenerateTable()
| void OdDbTable::suppressRegenerateTable | ( | bool | bSuppress | ) |
This method allows the user to disable the regeneration of the table block during property changes.
- Parameters
-
bSuppress [in] Input boolean value to suppress or enable the regeneration of a table object.
◆ suppressTitleRow()
|
virtual |
DEPRECATED! Controls the suppression of the title row (DXF 280).
- Parameters
-
suppress [in] Controls suppression.
◆ tableStyle()
|
virtual |
Returns the Object ID of the OdDbTableStyle used by this table entity (DXF 342).
◆ tableStyleOverrides()
|
virtual |
DEPRECATED! Returns the table style overrides for this table entity.
- Parameters
-
overrides [out] Receives an array of table style overrides for this table entity.
- Returns
- Returns true only if successful.
◆ textHeight() [1/3]
|
virtual |
DEPRECATED! Returns the text height for the specified row type in this table entity (DXF 140).
- Parameters
-
rowType [in] Row type.
- Remarks
- rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ textHeight() [2/3]
Returns the text height of the cell as a double value.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index.
- Returns
- Text height value.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ textHeight() [3/3]
Returns the text height for the specified cell in this table entity (DXF 140).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ textRotation()
|
virtual |
DEPRECATED! This method is deprecated. Use rotation() instead. Returns the text rotation angle for the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
- Remarks
- textRotation() returns one of the following:
Value Description OdDb::kDegrees000 0 0° OdDb::kDegrees090 1 90° CCW OdDb::kDegrees180 2 180° OdDb::kDegrees270 3 90° CW
◆ textString() [1/4]
Returns the text string of the cell as an OdString value.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content.
- Returns
- Text string.
◆ textString() [2/4]
| OdString OdDbTable::textString | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| OdValue::FormatOption | nOption | ||
| ) | const |
Returns the text string of the cell as an OdString value.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. nOption [in] Format option of the value.
- Returns
- Text string.
- Remarks
- Format option is the enumeration and takes one of the following values:
Value kFormatOptionNone 0x00 kForEditing 0x01 kForExpression 0x02 kUseMaximumPrecision 0x04 kIgnoreMtextFormat 0x08
◆ textString() [3/4]
| OdString OdDbTable::textString | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdValue::FormatOption | nOption | ||
| ) | const |
Returns the text string of the cell as an OdString value.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nOption [in] Format option of the value.
- Remarks
- Format option is the enumeration and takes one of the following values:
Value kFormatOptionNone 0x00 kForEditing 0x01 kForExpression 0x02 kUseMaximumPrecision 0x04 kIgnoreMtextFormat 0x08
◆ textString() [4/4]
Returns the text string in the specified cell in this table entity.
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ textStyle() [1/3]
|
virtual |
DEPRECATED! Returns the Object ID of the text style for the specified row type in this table entity (DXF 7).
- Parameters
-
rowType [in] Row type.
- Remarks
- rowType must be one of the following:
Value Description OdDb::kTitleRow 1 The top-most or bottom-most row of the table, depending on the flow direction of the table rows (down or up). OdDb::kHeaderRow 2 The first row, which is placed after or before the title row. OdDb::kDataRow 4 The row, which is neither title row nor header row.
◆ textStyle() [2/3]
| OdDbObjectId OdDbTable::textStyle | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent | ||
| ) | const |
Returns the text style of the cell as an object of the OdDbObjectId class.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Content index.
- Returns
- Text style object ID.
- Remarks
- Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ textStyle() [3/3]
|
virtual |
Returns the Object ID of the text style for the specified cell in this table entity (DXF 7).
- Parameters
-
row [in] Row index of the cell. column [in] Column index of the cell.
◆ unmergeCells()
|
virtual |
Unmerges a rectangular region of cells in this table entity.
- Parameters
-
minRow [in] Minimum row index of the merged cells. maxRow [in] Maximum row index of the merged cells. minColumn [in] Minimum column index of the merged cells. maxColumn [in] Maximum column index of the merged cells.
- Remarks
- Method generates the eInvalidInput exception when the minimum row index is more than the maximum row index, the minimum column index is more than the maximum column index, the maximum row index is more than the number of rows, or the maximum column index is more than the number of columns.
◆ updateDataLink() [1/2]
| void OdDbTable::updateDataLink | ( | OdDb::UpdateDirection | nDir, |
| OdDb::UpdateOption | nOption | ||
| ) |
Updates the data link in the table.
- Parameters
-
nDir [in] Direction of update. nOption [out] Update option.
- Remarks
- Direction of update should take one of the following values:
Value kUpdateDirectionSourceToData 0x1 kUpdateDirectionDataToSource 0x2
Update option should take one of the following values:
Value kUpdateOptionNone 0 kUpdateOptionSkipFormat 0x20000 kUpdateOptionUpdateRowHeight 0x40000 kUpdateOptionUpdateColumnWidth 0x80000 kUpdateOptionAllowSourceUpdate 0x100000 kUpdateOptionForceFullSourceUpdate 0x200000 kUpdateOptionOverwriteContentModifiedAfterUpdate 0x400000 kUpdateOptionOverwriteFormatModifiedAfterUpdate 0x800000 kUpdateOptionForPreview 0x1000000 kUpdateOptionIncludeXrefs 0x2000000 kUpdateOptionSkipFormatAfterFirstUpdate 0x4000000
◆ updateDataLink() [2/2]
| void OdDbTable::updateDataLink | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdDb::UpdateDirection | nDir, | ||
| OdDb::UpdateOption | nOption | ||
| ) |
Updates the data link of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nDir [in] Direction of update. nOption [in] Update option.
- Remarks
- Direction of update should take one of the following values:
Value kUpdateDirectionSourceToData 0x1 kUpdateDirectionDataToSource 0x2
Update option should take one of the following values:
Value kUpdateOptionNone 0 kUpdateOptionSkipFormat 0x20000 kUpdateOptionUpdateRowHeight 0x40000 kUpdateOptionUpdateColumnWidth 0x80000 kUpdateOptionAllowSourceUpdate 0x100000 kUpdateOptionForceFullSourceUpdate 0x200000 kUpdateOptionOverwriteContentModifiedAfterUpdate 0x400000 kUpdateOptionOverwriteFormatModifiedAfterUpdate 0x800000 kUpdateOptionForPreview 0x1000000 kUpdateOptionIncludeXrefs 0x2000000 kUpdateOptionSkipFormatAfterFirstUpdate 0x4000000
Method generates the eInvalidInput exception when the input row number and column number are less than 0 or greater than the table size.
◆ value() [1/3]
Returns the value of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content.
- Returns
- Cell value.
◆ value() [2/3]
| OdValue OdDbTable::value | ( | OdInt32 | row, |
| OdInt32 | col, | ||
| OdInt32 | nContent, | ||
| OdValue::FormatOption | nOption | ||
| ) | const |
Returns the value at the cpecified content index of the cell.
- Parameters
-
row [in] Row index of the cell. col [in] Column index of the cell. nContent [in] Number of content. nOption [in] Format option of the value.
- Remarks
- Format option is the enumeration and takes one of the following values:
Value kFormatOptionNone 0x00 kForEditing 0x01 kForExpression 0x02 kUseMaximumPrecision 0x04 kIgnoreMtextFormat 0x08
◆ value() [3/3]
Returns the content value at the specified content index.
- Parameters
-
row [in] Row index. Should be more than or equal to 0 and less than the number of rows. col [in] Column index. Should be more than or equal to 0 and less than the number of columns.
◆ vertCellMargin()
|
virtual |
DEPRECATED! This method is deprecated. Use margin() instead. Returns the vertical cell margin for this table entity (DXF 41).
- Remarks
- The vertical cell margin is the vertical space between the cell text and the cell border.
◆ width()
|
virtual |
Returns the overall width of this table entity.
The documentation for this class was generated from the following file: