OdDbTable Class

Class Hierarchy

Syntax

C++

class OdDbTable : public OdDbBlockReference;

File

DbTable.h

Description

This class represents table entities in an OdDbDatabase instance.

Group

OdDb Classes

Public Methods

	Name	Description
	OdDbTable	Default constructor. Creates an object of the OdDbTable class.

OdDbTable Enumerations

	Name	Description
	TableStyleOverrides	Enumeration representing the table style overrides for an OdDbTable object.

OdDbTable Methods

	Name	Description
	alignment	Returns the cell alignment for the specified cell in this table entity (DXF 170).
	appendToOwner	Appends this OdDbTable object to the specified owner object.
	attachmentPoint	This is the overview for the attachmentPoint method overload.
	backgroundColor	Returns the background color for the specified cell in this table entity (DXF 63).
	blockTableRecordId	This is the overview for the blockTableRecordId method overload.
	breakFlowDirection	Returns table break flow direction of this table entity as an OdDb::TableBreakFlowDirection object.
	breakHeight	Returns the table break height of the specified table entity as an OdUInt32 value.
	breakOffset	Returns table break offset of the specified table entity as an OdUInt32 value.
	breakOption	Returns the table break option of this table entity as an OdDb::TableBreakOption object.
	breakSpacing	Returns the break spacing for this table entity.
	canDelete	Checks if rows or columns can be deleted from the specified index.
	canInsert	Checks if new rows or columns can be inserted into the specified index. Returns true if rows or columns can be inserted.
	cellState	Returns the cell state.
	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.
	cellStyleOverrides	Returns the cell style overrides for the specified cell in this table entity.
	cellType	Returns the cell type of the specified cell in this table entity.
	clearCellOverrides	Clears the cell overrides for the specified cell in this table entity.
	clearSubSelection	Clears the sub-selection set of cells from this table.
	columnWidth	Returns the width of the specified column in this table entity (DXF 142).
	contentColor	This is the overview for the contentColor method overload.
	contentLayout	Returns the content layout of the cell.
	contentType	This is the overview for the contentType method overload.
	copyFrom	This is the overview for the copyFrom method overload.
	createContent	Creates additional content for the cell. Returns index of the created content.
	createTemplate
	dataFormat	This is the overview for the dataFormat method overload.
	deleteColumns	Deletes the specified number of columns from this table entity.
	deleteContent	This is the overview for the deleteContent method overload.
	deleteRows	Deletes the specified number of rows from this table entity.
	direction	Returns the unit X-axis for this table entity in WCS coordinates (DXF 11, 21, 31).
	dwgInFields	Reads the .dwg file data of this object.
	dwgOutFields	Writes the .dwg file data of this object.
	dxfInFields	Reads the DXF data of this object.
	dxfOutFields	Reads the DXF data of this object.
	enableBreak	Enables or disables table breaking.
	enableMergeAll	Sets the merge-all flag for the cell, row or column.
	fieldId	This is the overview for the fieldId method overload.
	flowDirection	Returns the direction that this table entity flows from its first row to its last (DXF 70).
	generateLayout	Updates this table entity according to its current table style.
	getBlockAttributeValue	This is the overview for the getBlockAttributeValue method overload.
	getCellExtents	Returns the cell extents for the specified cell in this table entity.
	getColumnName	Returns the column name as an OdString value.
	getCustomData	This is the overview for the getCustomData method overload.
	getDataLink	This is the overview for the getDataLink method overload.
	getDataLinkRange	Returns the data link cell range that includes the specified row and column.
	getDataType	This is the overview for the getDataType method overload.
	getFormula	Returns the formula at the specified content index of the cell as an object of the OdString class.
	getGridProperty	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.
	getIterator	This is the overview for the getIterator method overload.
	getMergeRange	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.
	getOverride	This is the overview for the getOverride method overload.
	getSubSelection	This is the overview for the getSubSelection method overload.
	getSubTablesInfo
	getToolTip	Returns the tooltip of the cell as an OdString value.
	gridColor	This is the overview for the gridColor method overload.
	gridDoubleLineSpacing	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.
	gridLineStyle	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.
	gridLinetype	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.
	gridLineWeight	This is the overview for the gridLineWeight method overload.
	gridVisibility	This is the overview for the gridVisibility method overload.
	hasFormula	Checks if the cell has a formula.
	hasSubSelection	Returns true if the table has a sub-selection set of cells, or returns false in the other case.
	height	Returns the overall height of this table entity.
	hitTest	This is the overview for the hitTest method overload.
	insertColumns	Inserts the specified number of columns into this table entity at the specified column index.
	insertColumnsAndInherit	Inserts columns at the specified index and inherits their format from the reference column.
	insertRows	Inserts the specified number of rows into this table entity at the specified row index.
	insertRowsAndInherit	Inserts rows at the specified index and inherits their format from the reference row.
	isAutoScale	Checks whether data in the cell is auto-scaled or not.
	isBackgroundColorNone	Returns true if and only if the background color for the specified cell is disabled for this table entity (DXF 283).
	isBreakEnabled	Returns true if the table break is enabled, or false otherwise.
	isContentEditable	Returns the "editing content flag" cell property.
	isEmpty	Returns the "empty flag" cell property.
	isFormatEditable	Returns the "editing format flag" cell property.
	isLinked	Checks if a cell is linked to a data source.
	isMergeAllEnabled	Checks whether the merge-all flag is enabled for the cell, row or column.
	isMergedCell	Returns true if and only if the specified cell has been merged, and returns the range of the merged cells in this table entity.
	isRegenerateTableSuppressed	Returns true if regeneration of the table block is disabled. Otherwise, returns false.
	margin	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.
	mergeCells	Merges a rectangular region of cells in this table entity.
	mergedFlag	Returns cell property "merged flag". The first cell has a value equal false. Next cells have a value equal to true.
	mergedHeight	Returns cell property "merged height". The first cell may have a value > 1. Next cells have a value equal 1.
	mergedWidth	Returns cell property "merged width". The first cell may have a value > 1. Next cells have a value equal 1.
	minimumColumnWidth	Returns the minimum column width for the specified column in this table entity.
	minimumRowHeight	Returns the minimum row height for the specified row in this table entity.
	minimumTableHeight	Returns the minimum overall height for this table entity.
	minimumTableWidth	Returns the minimum overall width for this table entity.
	modified	virtual void objectClosed(const OdDbObjectId objId); virtual void erased(const OdDbObject* dbObj, bool pErasing = true);
	moveContent	Moves content in the cell from one position to another.
	numColumns	Returns the number of columns in this table entity (DXF 92).
	numContents	Returns the number of contents in a cell.
	numRows	Returns the number of rows in this table entity (DXF 91).
	recomputeTableBlock	Updates the block table record referenced by this table entity.
	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.
	removeDataLink	This is the overview for the removeDataLink method overload.
	reselectSubRegion	Returns an array of sub-entities of the current sub-selection cells in the output argument paths.
	resetValue	Resets the value in a specified cell.
	rotation	This is the overview for the rotation method overload.
	rowHeight	Returns the height of the specified row in this table entity (DXF 141).
	scale	Returns the scale value of the cell as a double value.
	select	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.
	select_next_cell
	selectSubRegion	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.
	setAlignment	Sets the cell alignment for the specified cell in this table entity (DXF 170).
	setAutoScale	Sets the auto-scaled flag to the cell.
	setBackgroundColor	Sets the background color for the specified cell in this table entity (DXF 63).
	setBackgroundColorNone	Controls the background color setting for the specified cell in this table entity (DXF 283).
	setBlockAttributeValue	This is the overview for the setBlockAttributeValue method overload.
	setBlockTableRecordId	This is the overview for the setBlockTableRecordId method overload.
	setBreakFlowDirection	Sets table break flow direction of this table entity.
	setBreakHeight	Sets the table break height of the specified table entity.
	setBreakOffset	Sets the table break offset of the specified table entity.
	setBreakOption	Sets the table break option of this table entity.
	setBreakSpacing	Sets the break spacing for this table entity.
	setCellState	Sets the cell state.
	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.
	setColumnName	Sets the column name.
	setColumnWidth	This is the overview for the setColumnWidth method overload.
	setContentColor	This is the overview for the setContentColor method overload.
	setContentLayout	Sets the content layout to the cell.
	setCustomData	This is the overview for the setCustomData method overload.
	setDataFormat	This is the overview for the setDataFormat method overload.
	setDataLink	This is the overview for the setDataLink method overload.
	setDataType	This is the overview for the setDataType method overload.
	setDirection	Sets the X-axis for this table entity in WCS coordinates (DXF 11, 21, 31).
	setFieldId	This is the overview for the setFieldId method overload.
	setFlowDirection	Sets the direction that this table entity flows from its first row to its last. (DXF 70).
	setFormula	Sets the formula at the specified content index of the cell.
	setGridColor	This is the overview for the setGridColor method overload.
	setGridDoubleLineSpacing	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.
	setGridLineStyle	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.
	setGridLinetype	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.
	setGridLineWeight	This is the overview for the setGridLineWeight method overload.
	setGridProperty	This is the overview for the setGridProperty method overload.
	setGridVisibility	This is the overview for the setGridVisibility method overload.
	setHeight	Sets the overall height of this table entity.
	setMargin	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.
	setOverride	This is the overview for the setOverride method overload.
	setRotation	This is the overview for the setRotation method overload.
	setRowHeight	This is the overview for the setRowHeight method overload.
	setScale	Sets the scale value to the cell.
	setSize	Sets the size for this table entity.
	setSubSelection	This is the overview for the setSubSelection method overload.
	setTableStyle	Sets the Object ID of the OdDbTableStyle for use by this table entity (DXF 342).
	setTextHeight	This is the overview for the setTextHeight method overload.
	setTextString	This is the overview for the setTextString method overload.
	setTextStyle	This is the overview for the setTextStyle method overload.
	setToolTip	Sets the tooltip of the cell.
	setValue	This is the overview for the setValue method overload.
	setWidth	Sets the overall width for this table entity.
	subClose	Called as the first operation as this object is being closed, for database-resident objects only.
	subErase	Called as the first operation as this object is being erased or unerased.
	subExplode	Replace OdRxObjectPtrArray details Explodes this entity into a set of simpler entities.
	subGetClassID	Overridables.
	subGetGeomExtents	Returns the geometry extents.
	subGetTransformedCopy	This is subGetTransformedCopy, a member of class OdDbBlockReference.
	subHighlight
	subSetDatabaseDefaults
	subTransformBy	Applies the specified 3D transformation matrix to this entity.
	subWblockClone
	subWorldDraw	Returns true if the entity has no view-dependent graphics. In another case returns false.
	suppressRegenerateTable	This method allows the user to disable the regeneration of the table block during property changes.
	tableStyle	Returns the Object ID of the OdDbTableStyle used by this table entity (DXF 342).
	textHeight	This is the overview for the textHeight method overload.
	textString	This is the overview for the textString method overload.
	textStyle	This is the overview for the textStyle method overload.
	unmergeCells	Unmerges a rectangular region of cells in this table entity.
	updateDataLink	This is the overview for the updateDataLink method overload.
	value	This is the overview for the value method overload.
	width	Returns the overall width of this table entity.

Send feedback about this topic