#include <DbLinkedTableData.h>

Inheritance diagram for OdDbLinkedTableData:

Public Member Functions
	ODDB_DECLARE_MEMBERS (OdDbLinkedTableData)

	OdDbLinkedTableData ()

virtual void	setSize (OdInt32 nRows, OdInt32 nCols)

virtual OdInt32	numColumns () const

virtual OdString	getColumnName (OdInt32 nIndex) const

virtual void	setColumnName (OdInt32 nIndex, const OdString name)

virtual OdInt32	appendColumn (OdInt32 nNumCols)

virtual OdInt32	insertColumn (OdInt32 nIndex, OdInt32 nNumCols)

virtual void	deleteColumn (OdInt32 nIndex, OdInt32 nNumColsToDelete)

virtual OdInt32	numRows () const

virtual bool	canInsert (OdInt32 nIndex, bool bRow) const

virtual OdInt32	appendRow (OdInt32 nNumRows)

virtual OdInt32	insertRow (OdInt32 nIndex, OdInt32 nNumRows)

virtual bool	canDelete (OdInt32 nIndex, OdInt32 nCount, bool bRow) const

virtual void	deleteRow (OdInt32 nIndex, OdInt32 nNumRowsToDelete)

virtual bool	isContentEditable (OdInt32 nRow, OdInt32 nCol) const

virtual OdDb::CellState	cellState (OdInt32 nRow, OdInt32 nCol) const

virtual void	setCellState (OdInt32 nRow, OdInt32 nCol, OdDb::CellState nCellState)

virtual OdString	getToolTip (OdInt32 nRow, OdInt32 nCol) const

virtual void	setToolTip (OdInt32 nRow, OdInt32 nCol, const OdString &sToolTip)

virtual OdInt32	getCustomData (OdInt32 nRow, OdInt32 nCol) const

virtual void	setCustomData (OdInt32 nRow, OdInt32 nCol, OdInt32 nData)

virtual OdValue	getCustomData (OdInt32 nRow, OdInt32 nCol, const OdString &sKey) const

virtual void	setCustomData (OdInt32 nRow, OdInt32 nCol, const OdString &sKey, const OdValue *pData)

virtual OdUInt32	numContents (OdInt32 nRow, OdInt32 nCol) const

virtual OdUInt32	createContent (OdInt32 nRow, OdInt32 nCol, OdInt32 nIndex)

virtual void	moveContent (OdInt32 nRow, OdInt32 nCol, OdInt32 nFromIndex, OdInt32 nToIndex)

virtual void	deleteContent (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent)

virtual void	deleteContent (OdInt32 nRow, OdInt32 nCol)

virtual void	deleteContent (const OdCellRange &range)

virtual OdDb::CellContentType	contentType (OdInt32 nRow, OdInt32 nCol) const

virtual OdDb::CellContentType	contentType (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent) const

virtual void	getDataType (OdInt32 nRow, OdInt32 nCol, OdValue::DataType &nDataType, OdValue::UnitType &nUnitType) const

virtual void	getDataType (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, OdValue::DataType &nDataType, OdValue::UnitType &nUnitType) const

virtual void	setDataType (OdInt32 nRow, OdInt32 nCol, OdValue::DataType nDataType, OdValue::UnitType nUnitType)

virtual void	setDataType (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, OdValue::DataType nDataType, OdValue::UnitType nUnitType)

virtual OdString	dataFormat (OdInt32 nRow, OdInt32 nCol) const

virtual OdString	dataFormat (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent) const

virtual void	setDataFormat (OdInt32 nRow, OdInt32 nCol, const OdString sFormat)

virtual void	setDataFormat (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdString sFormat)

virtual OdValue	getValue (OdInt32 nRow, OdInt32 nCol) const

virtual OdValue	getValue (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, OdValue::FormatOption nOption) const

virtual void	setValue (OdInt32 nRow, OdInt32 nCol, const OdValue &value)

virtual void	setValue (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdValue &value)

virtual void	setValue (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdValue &value, OdValue::ParseOption nOption)

virtual OdString	getText (OdInt32 nRow, OdInt32 nCol) const

virtual OdString	getText (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent) const

virtual OdString	getText (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, OdValue::FormatOption nOption) const

virtual void	setText (OdInt32 nRow, OdInt32 nCol, const OdString &sText)

virtual void	setText (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdString &sText)

virtual bool	hasFormula (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent) const

virtual OdString	getFormula (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent) const

virtual void	setFormula (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdString sFormula)

virtual OdDbObjectId	getFieldId (OdInt32 nRow, OdInt32 nCol) const

virtual OdDbObjectId	getFieldId (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent) const

virtual void	setFieldId (OdInt32 nRow, OdInt32 nCol, const OdDbObjectId &idField)

virtual void	setFieldId (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdDbObjectId &idField)

virtual OdDbFieldPtr	getField (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, OdDb::OpenMode mode) const

virtual OdDbObjectId	getBlockTableRecordId (OdInt32 nRow, OdInt32 nCol) const

virtual OdDbObjectId	getBlockTableRecordId (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent) const

virtual void	setBlockTableRecordId (OdInt32 nRow, OdInt32 nCol, const OdDbObjectId &idBTR)

virtual void	setBlockTableRecordId (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdDbObjectId &idBTR)

virtual OdString	getBlockAttributeValue (OdInt32 nRow, OdInt32 nCol, const OdDbObjectId &idAttDef) const

virtual OdString	getBlockAttributeValue (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdDbObjectId &idAttDef) const

virtual void	setBlockAttributeValue (OdInt32 nRow, OdInt32 nCol, const OdDbObjectId &idAttDef, const OdString sAttValue)

virtual void	setBlockAttributeValue (OdInt32 nRow, OdInt32 nCol, OdUInt32 nContent, const OdDbObjectId &idAttDef, const OdString sAttValue)

virtual bool	isLinked (OdInt32 nRow, OdInt32 nCol) const

virtual OdDbObjectId	getDataLink (OdInt32 nRow, OdInt32 nCol) const

virtual OdDbDataLinkPtr	getDataLink (OdInt32 nRow, OdInt32 nCol, OdDb::OpenMode mode) const

virtual OdInt32	getDataLink (const OdCellRange &pRange, OdDbObjectIdArray &dataLinkIds) const

virtual void	setDataLink (OdInt32 nRow, OdInt32 nCol, const OdDbObjectId &idDataLink, bool bUpdate)

virtual void	setDataLink (const OdCellRange &range, const OdDbObjectId &idDataLink, bool bUpdate)

virtual OdCellRange	getDataLinkRange (OdInt32 nRow, OdInt32 nCol) const

virtual void	removeDataLink (OdInt32 nRow, OdInt32 nCol)

virtual void	removeDataLink (void)

virtual void	updateDataLink (OdInt32 nRow, OdInt32 nCol, OdDb::UpdateDirection nDir, OdDb::UpdateOption nOption)

virtual void	updateDataLink (OdDb::UpdateDirection nDir, OdDb::UpdateOption nOption)

virtual void	clear ()

virtual void	copyFrom (const OdRxObject *pSource)

virtual void	copyFrom (const OdDbLinkedTableData *pSrc, OdDb::TableCopyOption nOption)

virtual void	copyFrom (const OdDbLinkedTableData pSrc, OdDb::TableCopyOption nOption, const OdCellRange &srcRange, const OdCellRange &targetRange, OdCellRange pNewTargetRange)

OdDbTableIteratorPtr	getIterator (void) const

OdDbTableIteratorPtr	getIterator (const OdCellRange *pRange, OdDb::TableIteratorOption nOption) const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

Public Member Functions inherited from OdDbLinkedData
	ODDB_DECLARE_MEMBERS (OdDbLinkedData)

	OdDbLinkedData ()

virtual const OdString	name (void) const

virtual void	setName (const OdString &name)

virtual const OdString	description (void) const

virtual void	setDescription (const OdString &description)

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

Public Member Functions inherited from OdDbObject
	ODDB_DECLARE_MEMBERS (OdDbObject)

	~OdDbObject ()

void	addRef ()

void	release ()

long	numRefs () const

OdDbObjectId	objectId () const

OdDbHandle	getDbHandle () const

OdDbHandle	handle () const

OdDbObjectId	ownerId () const

virtual void	setOwnerId (OdDbObjectId ownerId)

OdDbDatabase *	database () const

void	createExtensionDictionary ()

OdDbObjectId	extensionDictionary () const

bool	releaseExtensionDictionary ()

OdDbXrecordPtr	createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)

void	upgradeOpen ()

void	downgradeOpen ()

void	cancel ()

virtual OdResult	subOpen (OdDb::OpenMode mode)

virtual void	subClose ()

OdResult	erase (bool eraseIt=true)

virtual OdResult	subErase (bool erasing)

void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)

virtual void	subHandOverTo (OdDbObject *pNewObject)

void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)

virtual void	dxfOut (OdDbDxfFiler *pFiler) const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdDb::DuplicateRecordCloning	mergeStyle () const

virtual OdResBufPtr	xData (const OdString &regappName=OdString::kEmpty) const

virtual void	setXData (const OdResBuf *pRb)

bool	isEraseStatusToggled () const

bool	isErased () const

bool	isReadEnabled () const

bool	isWriteEnabled () const

bool	isNotifyEnabled () const

bool	isModified () const

bool	isModifiedXData () const

bool	isModifiedGraphics () const

bool	isNewObject () const

bool	isNotifying () const

bool	isUndoing () const

bool	isReallyClosing () const

bool	isDBRO () const

void	assertReadEnabled () const

void	assertWriteEnabled (bool autoUndo=true, bool recordModified=true)

void	assertNotifyEnabled () const

void	disableUndoRecording (bool disable)

bool	isUndoRecordingDisabled () const

OdDbDwgFiler *	undoFiler ()

virtual void	applyPartialUndo (OdDbDwgFiler pUndoFiler, OdRxClass pClassObj)

void	addReactor (OdDbObjectReactor *pReactor) const

void	removeReactor (OdDbObjectReactor *pReactor) const

virtual void	addPersistentReactor (const OdDbObjectId &objId)

virtual void	removePersistentReactor (const OdDbObjectId &objId)

bool	hasPersistentReactor (const OdDbObjectId &objId) const

OdDbObjectIdArray	getPersistentReactors () const

OdDbObjectReactorArray	getTransientReactors () const

virtual void	recvPropagateModify (const OdDbObject *pSubObj)

virtual void	xmitPropagateModify () const

ODRX_SEALED_VIRTUAL OdDbObjectPtr	deepClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdDbObjectPtr	wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &idMap)

void	setOdDbObjectIdsInFlux ()

bool	isOdDbObjectIdsInFlux () const

virtual void	copied (const OdDbObject pObject, const OdDbObject pNewObject)

virtual void	erased (const OdDbObject *pObject, bool erasing=true)

virtual void	goodbye (const OdDbObject *pObject)

virtual void	openedForModify (const OdDbObject *pObject)

virtual void	modified (const OdDbObject *pObject)

virtual void	subObjModified (const OdDbObject pObject, const OdDbObject pSubObj)

virtual void	modifyUndone (const OdDbObject *pObject)

virtual void	modifiedXData (const OdDbObject *pObject)

virtual void	unappended (const OdDbObject *pObject)

virtual void	reappended (const OdDbObject *pObject)

bool	isAProxy () const

virtual void	objectClosed (const OdDbObjectId &objectId)

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	copyFrom (const OdRxObject *pSource)

bool	hasSaveVersionOverride () const

void	setHasSaveVersionOverride (bool hasSaveVersionOverride)

virtual OdDb::DwgVersion	getObjectSaveVersion (const OdDbFiler pFiler, OdDb::MaintReleaseVer pMaintVer=0) const

virtual OdDbObjectPtr	decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

virtual OdDbObjectPtr	decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

void	convertForSave (OdDb::DwgVersion ver)

virtual void	composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)

virtual OdGiDrawable *	drawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

virtual bool	isPersistent () const

virtual OdDbStub *	id () const

ODRX_SEALED_VIRTUAL OdResult	getClassID (void *pClsid) const ODRX_SEALED

void	setGsNode (OdGsCache *pNode)

OdGsCache *	gsNode () const

void	xDataTransformBy (const OdGeMatrix3d &xfm)

bool	hasFields () const

OdDbObjectId	getField (const OdString &fieldName) const

OdDbObjectPtr	getField (const OdString &fieldName, OdDb::OpenMode mode) const

virtual OdDbObjectId	setField (const OdString &fieldName, OdDbField *pField)

virtual OdResult	removeField (OdDbObjectId fieldId)

virtual OdDbObjectId	removeField (const OdString &fieldName)

OdDbObjectId	getFieldDictionary () const

OdDbObjectPtr	getFieldDictionary (OdDb::OpenMode mode) const

virtual OdRxClass *	saveAsClass (OdRxClass *pClass) const

Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)

virtual DrawableType	drawableType () const

ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual bool	isPersistent () const =0

virtual OdDbStub *	id () const =0

virtual void	setGsNode (OdGsCache *pGsNode)=0

virtual OdGsCache *	gsNode () const =0

ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const

ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_SEALED

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Public Types inherited from OdGiDrawable
enum	SetAttributesFlags { kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 , kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 , kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 , kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 , kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff }

enum	DrawableType { kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 , kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground , kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground , kImageBasedLightingBackground }

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Member Functions inherited from OdDbObject
	OdDbObject ()

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

Protected Member Functions inherited from OdGiDrawable
	OdGiDrawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const =0

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const =0

virtual void	subViewportDraw (OdGiViewportDraw *vd) const =0

virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const

virtual OdUInt32	subRegenSupportFlags () const

Protected Attributes inherited from OdDbObject
OdDbObjectImpl *	m_pImpl

Detailed Description

This class represents LinkedTableData objects in an OdDbDatabase instance. This enables linking to Excel data.

Remarks: Work in progress!

Definition at line 48 of file DbLinkedTableData.h.

Constructor & Destructor Documentation

◆ OdDbLinkedTableData()

OdDbLinkedTableData::OdDbLinkedTableData ( )

Default constructor. Creates an object of the OdDbLinkedTableData class.

Member Function Documentation

◆ appendColumn()

virtual OdInt32 OdDbLinkedTableData::appendColumn ( OdInt32 nNumCols )

virtual

Appends the specified number of columns into this linked table object.

Parameters

nNumCols [in] Number of columns to add.

Returns: Starting index of the appended columns.

Remarks: Method generates the eInvalidInput exception when the row argument is zero or negative.

◆ appendRow()

virtual OdInt32 OdDbLinkedTableData::appendRow ( OdInt32 nNumRows )

virtual

Appends the specified number of rows into this linked table object.

Parameters

nNumRows [in] Number of rows to add.

Returns: Starting index of the appended rows.

Remarks: Method generates the eInvalidInput exception when the nNumRows argument is zero or negative.

◆ canDelete()

virtual bool OdDbLinkedTableData::canDelete	(	OdInt32	nIndex,
		OdInt32	nCount,
		bool	bRow
	)		const

virtual

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()

virtual bool OdDbLinkedTableData::canInsert	(	OdInt32	nIndex,
		bool	bRow
	)		const

virtual

Checks if new rows or columns can be inserted into the specified index.

Parameters

nIndex	[in] Index.
bRow	[in] Flag that indicates what to check: "true" for rows or "false" for columns.

Returns: True if rows or columns can be inserted; false otherwise.

◆ cellState()

virtual OdDb::CellState OdDbLinkedTableData::cellState	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the state of the cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: Cell state.

Remarks: Cell state is an enumerator 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)

◆ clear()

virtual void OdDbLinkedTableData::clear ( )

virtual

Clears all data.

◆ contentType() [1/2]

virtual OdDb::CellContentType OdDbLinkedTableData::contentType	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns content type of the first content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: Content type.

Remarks: Content type is an enumerator and takes one of the following values:

Value kCellContentTypeUnknown 0x0 kCellContentTypeValue 0x1 kCellContentTypeField 0x2 kCellContentTypeBlock 0x4

◆ contentType() [2/2]

virtual OdDb::CellContentType OdDbLinkedTableData::contentType	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent
	)		const

virtual

Returns content type of content at the specified index in a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Index of content.

Returns: Content type.

Remarks: Content type is an enumerator and takes one of the following values:

Value kCellContentTypeUnknown 0x0 kCellContentTypeValue 0x1 kCellContentTypeField 0x2 kCellContentTypeBlock 0x4

◆ copyFrom() [1/3]

virtual void OdDbLinkedTableData::copyFrom	(	const OdDbLinkedTableData *	pSrc,
		OdDb::TableCopyOption	nOption
	)

virtual

Copies the content from a source table to this table.

Parameters

pSrc	[in] Pointer to source table.
nOption	[in] Copy option.

Remarks: Option should take one of the following values:

Value kTableCopyOptionNone 0 kTableCopyOptionExpandOrContractTable 0x1 kTableCopyOptionSkipContent 0x2 kTableCopyOptionSkipValue 0x4 kTableCopyOptionSkipField 0x8 kTableCopyOptionSkipFormula 0x10 kTableCopyOptionSkipBlock 0x20 kTableCopyOptionSkipDataLink 0x40 kTableCopyOptionSkipLabelCell 0x80 kTableCopyOptionSkipDataCell 0x100 kTableCopyOptionSkipFormat 0x200 kTableCopyOptionSkipCellStyle 0x400 kTableCopyOptionConvertFormatToOverrides 0x800 kTableCopyOptionSkipCellState 0x1000 kTableCopyOptionSkipContentFormat 0x2000 kTableCopyOptionSkipDissimilarContentFormat 0x4000 kTableCopyOptionSkipGeometry 0x8000 kTableCopyOptionSkipMerges 0x10000 kTableCopyOptionFillTarget 0x20000 kTableCopyOptionOverwriteReadOnlyContent 0x40000 kTableCopyOptionOverwriteContentModifiedAfterUpdate 0x100000 kTableCopyOptionOverwriteFormatModifiedAfterUpdate 0x200000 kTableCopyOptionOnlyContentModifiedAfterUpdate 0x400000 kTableCopyOptionOnlyFormatModifiedAfterUpdate 0x800000 kTableCopyOptionRowHeight 0x1000000 kTableCopyOptionColumnWidth 0x2000000 kTableCopyOptionFullCellState 0x4000000 kTableCopyOptionForRountrip 0x8000000 kTableCopyOptionConvertFieldToValue 0x10000000 kTableCopyOptionSkipFieldTranslation 0x20000000

◆ copyFrom() [2/3]

virtual void OdDbLinkedTableData::copyFrom	(	const OdDbLinkedTableData *	pSrc,
		OdDb::TableCopyOption	nOption,
		const OdCellRange &	srcRange,
		const OdCellRange &	targetRange,
		OdCellRange *	pNewTargetRange
	)

virtual

Copies the content from a source table to this table.

Parameters

pSrc	[in] Pointer to source table.
nOption	[in] Copy option.
srcRange	[in] Source cell range.
targetRange	[in] Target cell range.
pNewTargetRange	[out] New target cell range.

Remarks: Option should take one of the following values:

Value kTableCopyOptionNone 0 kTableCopyOptionExpandOrContractTable 0x1 kTableCopyOptionSkipContent 0x2 kTableCopyOptionSkipValue 0x4 kTableCopyOptionSkipField 0x8 kTableCopyOptionSkipFormula 0x10 kTableCopyOptionSkipBlock 0x20 kTableCopyOptionSkipDataLink 0x40 kTableCopyOptionSkipLabelCell 0x80 kTableCopyOptionSkipDataCell 0x100 kTableCopyOptionSkipFormat 0x200 kTableCopyOptionSkipCellStyle 0x400 kTableCopyOptionConvertFormatToOverrides 0x800 kTableCopyOptionSkipCellState 0x1000 kTableCopyOptionSkipContentFormat 0x2000 kTableCopyOptionSkipDissimilarContentFormat 0x4000 kTableCopyOptionSkipGeometry 0x8000 kTableCopyOptionSkipMerges 0x10000 kTableCopyOptionFillTarget 0x20000 kTableCopyOptionOverwriteReadOnlyContent 0x40000 kTableCopyOptionOverwriteContentModifiedAfterUpdate 0x100000 kTableCopyOptionOverwriteFormatModifiedAfterUpdate 0x200000 kTableCopyOptionOnlyContentModifiedAfterUpdate 0x400000 kTableCopyOptionOnlyFormatModifiedAfterUpdate 0x800000 kTableCopyOptionRowHeight 0x1000000 kTableCopyOptionColumnWidth 0x2000000 kTableCopyOptionFullCellState 0x4000000 kTableCopyOptionForRountrip 0x8000000 kTableCopyOptionConvertFieldToValue 0x10000000 kTableCopyOptionSkipFieldTranslation 0x20000000

◆ copyFrom() [3/3]

virtual void OdDbLinkedTableData::copyFrom ( const OdRxObject * pSource )

virtual

Copies the content from a source table to this table with specified option.

Parameters

pSource [in] Source table.

Reimplemented from OdDbObject.

◆ createContent()

virtual OdUInt32 OdDbLinkedTableData::createContent	(	OdInt32	nRow,
		OdInt32	nCol,
		OdInt32	nIndex
	)

virtual

Creates additional content for the cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[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.

◆ dataFormat() [1/2]

virtual OdString OdDbLinkedTableData::dataFormat	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns data format of the zero content of a cell as an OdString value.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: Data format.

◆ dataFormat() [2/2]

virtual OdString OdDbLinkedTableData::dataFormat	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent
	)		const

virtual

Returns data format of the specified content of a cell as an OdString value.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.

◆ deleteColumn()

virtual void OdDbLinkedTableData::deleteColumn	(	OdInt32	nIndex,
		OdInt32	nNumColsToDelete
	)

virtual

Deletes the specified number of columns from this linked table object.

Parameters

nIndex	[in] Index of the first column to delete.
nNumColsToDelete	[in] Number of columns to delete.

Remarks: Method generates the eInvalidInput exception when the number of deleted columns is grater than the number of columns.

◆ deleteContent() [1/3]

virtual void OdDbLinkedTableData::deleteContent ( const OdCellRange & range )

virtual

Deletes content from cells.

Parameters

range [in] Range of cells.

◆ deleteContent() [2/3]

virtual void OdDbLinkedTableData::deleteContent	(	OdInt32	nRow,
		OdInt32	nCol
	)

virtual

Deletes content from a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[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 the content is not editable (!isContentEditable()).

◆ deleteContent() [3/3]

virtual void OdDbLinkedTableData::deleteContent	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent
	)

virtual

Deletes content from a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Index of the 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 the content is not editable (!isContentEditable()).

◆ deleteRow()

virtual void OdDbLinkedTableData::deleteRow	(	OdInt32	nIndex,
		OdInt32	nNumRowsToDelete
	)

virtual

Deletes the specified number of rows from this linked table object.

Parameters

nIndex	[in] Index of the first row to delete.
nNumRowsToDelete	[in] Number of rows to delete.

Remarks: Method generates the eInvalidInput exception when the number of rows to delete is grater than the number of rows in this linked table object.

◆ dwgInFields()

virtual OdResult OdDbLinkedTableData::dwgInFields ( OdDbDwgFiler * pFiler )

virtual

OdDbObject override.

Reimplemented from OdDbLinkedData.

Reimplemented in OdDbFormattedTableData, OdDbTableContent, and OdDbTableTemplate.

◆ dwgOutFields()

virtual void OdDbLinkedTableData::dwgOutFields ( OdDbDwgFiler * pFiler ) const

virtual

OdDbObject override.

Reimplemented from OdDbLinkedData.

Reimplemented in OdDbFormattedTableData, OdDbTableContent, and OdDbTableTemplate.

◆ dxfInFields()

virtual OdResult OdDbLinkedTableData::dxfInFields ( OdDbDxfFiler * pFiler )

virtual

OdDbObject override.

Reimplemented from OdDbLinkedData.

Reimplemented in OdDbFormattedTableData, OdDbTableContent, and OdDbTableTemplate.

◆ dxfOutFields()

virtual void OdDbLinkedTableData::dxfOutFields ( OdDbDxfFiler * pFiler ) const

virtual

OdDbObject override.

Reimplemented from OdDbLinkedData.

Reimplemented in OdDbFormattedTableData, OdDbTableContent, and OdDbTableTemplate.

◆ getBlockAttributeValue() [1/2]

virtual OdString OdDbLinkedTableData::getBlockAttributeValue	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdDbObjectId &	idAttDef
	)		const

virtual

Returns the attribute value of the block cell using the specified object ID key as an OdString value.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
idAttDef	[in] Object ID.

Returns: Attribute value of the block 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.

◆ getBlockAttributeValue() [2/2]

virtual OdString OdDbLinkedTableData::getBlockAttributeValue	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdDbObjectId &	idAttDef
	)		const

virtual

Returns the attribute value of the block cell using the specified object ID key as an OdString value.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
idAttDef	[in] Object id.

Returns: Attribute value of the block 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.

◆ getBlockTableRecordId() [1/2]

virtual OdDbObjectId OdDbLinkedTableData::getBlockTableRecordId	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the ID of the block table record of the zero content of a cell as an object of the OdDbObjectId class.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: ID of the block table record.

◆ getBlockTableRecordId() [2/2]

virtual OdDbObjectId OdDbLinkedTableData::getBlockTableRecordId	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent
	)		const

virtual

Returns the ID of the block table record of the specified content of a cell as an object of the OdDbObjectId class.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.

Returns: ID of the block table record.

◆ getColumnName()

virtual OdString OdDbLinkedTableData::getColumnName ( OdInt32 nIndex ) const

virtual

Returns the column name as an OdString value.

Parameters

nIndex [in] Column index.

Returns: Column name.

◆ getCustomData() [1/2]

virtual OdInt32 OdDbLinkedTableData::getCustomData	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the custom data value of a 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

nRow	[in] Row index.
nCol	[in] Column index.

Returns: Custom data value.

◆ getCustomData() [2/2]

virtual OdValue OdDbLinkedTableData::getCustomData	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdString &	sKey
	)		const

virtual

Returns the custom data value of a 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

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
sKey	[in] Key to use for the custom data.

◆ getDataLink() [1/3]

virtual OdInt32 OdDbLinkedTableData::getDataLink	(	const OdCellRange &	pRange,
		OdDbObjectIdArray &	dataLinkIds
	)		const

virtual

Returns the number of 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]

virtual OdDbObjectId OdDbLinkedTableData::getDataLink	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the data link object ID (OdDbDataLink) for the specified row and column.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: Data link object ID.

◆ getDataLink() [3/3]

virtual OdDbDataLinkPtr OdDbLinkedTableData::getDataLink	(	OdInt32	nRow,
		OdInt32	nCol,
		OdDb::OpenMode	mode
	)		const

virtual

Opens and returns the data link (OdDbDataLink) for the specified row and column.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
mode	[in] Open mode.

Remarks: Open mode should take one of the following values:

Value kNotOpen -1 kForRead 0 kForWrite 1 kForNotify 2

◆ getDataLinkRange()

virtual OdCellRange OdDbLinkedTableData::getDataLinkRange	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the data link cell range that includes the specified row and column.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: Cell range.

◆ getDataType() [1/2]

virtual void OdDbLinkedTableData::getDataType	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		OdValue::DataType &	nDataType,
		OdValue::UnitType &	nUnitType
	)		const

virtual

Gets the data type of the content at the specified index in a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Content index.
nDataType	[out] Reference to data type.
nUnitType	[out] Reference to 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/2]

virtual void OdDbLinkedTableData::getDataType	(	OdInt32	nRow,
		OdInt32	nCol,
		OdValue::DataType &	nDataType,
		OdValue::UnitType &	nUnitType
	)		const

virtual

Gets the data type of the first content of the specified cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nDataType	[out] Reference to data type.
nUnitType	[out] Reference to 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.

◆ getField()

virtual OdDbFieldPtr OdDbLinkedTableData::getField	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		OdDb::OpenMode	mode
	)		const

virtual

Returns the field of the specified content of a cell as an object pointer.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
mode	[in] Open mode.

Returns: Cell content field as an object pointer.

Remarks: Open mode must take one of the following values:

Value kNotOpen -1 kForRead 0 kForWrite 1 kForNotify 2

◆ getFieldId() [1/2]

virtual OdDbObjectId OdDbLinkedTableData::getFieldId	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the field ID of a cell as an object of the OdDbObjectId class.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: Field ID of the cell.

◆ getFieldId() [2/2]

virtual OdDbObjectId OdDbLinkedTableData::getFieldId	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent
	)		const

virtual

Returns the field ID of the specified content of a cell as an object of the OdDbObjectId class.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.

Returns: Field ID of the cell.

◆ getFormula()

virtual OdString OdDbLinkedTableData::getFormula	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent
	)		const

virtual

Returns the formula of the specified content of a cell as an object of the OdString class.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.

Returns: Formula string.

◆ getIterator() [1/2]

OdDbTableIteratorPtr OdDbLinkedTableData::getIterator	(	const OdCellRange *	pRange,
		OdDb::TableIteratorOption	nOption
	)		const

Returns the table iterator for the specified range.

Parameters

pRange	[in] Pointer to the input range for iteration.
nOption	[in] Iteration option.

Remarks: Option should take one of the following values:

Value kTableIteratorNone 0 kTableIteratorIterateSelection 0x1 kTableIteratorIterateRows 0x2 kTableIteratorIterateColumns 0x4 kTableIteratorIterateDataLinks 0x80 kTableIteratorReverseOrder 0x8 kTableIteratorSkipReadOnlyContent 0x10 kTableIteratorSkipReadOnlyFormat 0x20 kTableIteratorSkipMerged 0x40

◆ getIterator() [2/2]

OdDbTableIteratorPtr OdDbLinkedTableData::getIterator ( void ) const

Returns the table iterator.

◆ getText() [1/3]

virtual OdString OdDbLinkedTableData::getText	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the text string from the zero content of a cell as an OdString value.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: Content text string.

◆ getText() [2/3]

virtual OdString OdDbLinkedTableData::getText	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent
	)		const

virtual

Returns the text string from the specified content of a cell as an OdString value.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.

Returns: Content text string.

◆ getText() [3/3]

virtual OdString OdDbLinkedTableData::getText	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		OdValue::FormatOption	nOption
	)		const

virtual

Returns the text string from the specified content of a cell as an OdString value.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
nOption	[in] Format option of the value.

Returns: Content text string.

Remarks: Format option is an enumerator and takes one of the following values:

Value kFormatOptionNone 0x00 kForEditing 0x01 kForExpression 0x02 kUseMaximumPrecision 0x04 kIgnoreMtextFormat 0x08

◆ getToolTip()

virtual OdString OdDbLinkedTableData::getToolTip	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the tooltip of the cell as an OdString value.

Parameters

nRow	[in] Row index.
nCol	[in] Column index.

Returns: Tooltip of the cell.

◆ getValue() [1/2]

virtual OdValue OdDbLinkedTableData::getValue	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the value of the zero content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: Cell value.

◆ getValue() [2/2]

virtual OdValue OdDbLinkedTableData::getValue	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		OdValue::FormatOption	nOption
	)		const

virtual

Returns the value of the specified content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
nOption	[in] Format option of the value.

Remarks: Format option is an enumerator and takes one of the following values:

Value kFormatOptionNone 0x00 kForEditing 0x01 kForExpression 0x02 kUseMaximumPrecision 0x04 kIgnoreMtextFormat 0x08

◆ hasFormula()

virtual bool OdDbLinkedTableData::hasFormula	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent
	)		const

virtual

Checks if the cell has a formula in the specified content.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.

Returns: True if the cell has a formula in the specified content; false otherwise.

◆ insertColumn()

virtual OdInt32 OdDbLinkedTableData::insertColumn	(	OdInt32	nIndex,
		OdInt32	nNumCols
	)

virtual

Inserts the specified number of columns into this linked table object at the specified column index.

Parameters

nIndex	[in] Column index.
nNumCols	[in] Number of columns to insert.

Returns: Starting index of the inserted columns.

Remarks: Method generates the eInvalidInput exception when the column argument is grater than the number of columns or the width is zero.

◆ insertRow()

virtual OdInt32 OdDbLinkedTableData::insertRow	(	OdInt32	nIndex,
		OdInt32	nNumRows
	)

virtual

Inserts the specified number of rows into this linked table object at the specified row index.

Parameters

nIndex	[in] Row index.
nNumRows	[in] Number of rows to insert.

Returns: Starting index of the inserted rows.

Remarks: Method generates the eInvalidInput exception when the nNumRows argument is zero or negative.

◆ isContentEditable()

virtual bool OdDbLinkedTableData::isContentEditable	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the "editing content flag" cell property.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: True if the cell content can be edited or false if not.

◆ isLinked()

virtual bool OdDbLinkedTableData::isLinked	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Checks if a cell is linked to a data source.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.

Returns: True if the cell is linked to a data source; false otherwise.

◆ moveContent()

virtual void OdDbLinkedTableData::moveContent	(	OdInt32	nRow,
		OdInt32	nCol,
		OdInt32	nFromIndex,
		OdInt32	nToIndex
	)

virtual

Moves content in a cell from one position to another.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nFromIndex	[in] Index of the content to move.
nToIndex	[in] Target index of the content where it should be moved to.

Remarks: Method generates the eNotImplementedYet exception.

◆ numColumns()

virtual OdInt32 OdDbLinkedTableData::numColumns ( ) const

virtual

Returns the number of columns in this linked table object.

◆ numContents()

virtual OdUInt32 OdDbLinkedTableData::numContents	(	OdInt32	nRow,
		OdInt32	nCol
	)		const

virtual

Returns the number of contents in the cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[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 OdInt32 OdDbLinkedTableData::numRows ( ) const

virtual

Returns the number of rows in this linked table object.

Remarks: This includes title and header rows if any.

◆ ODDB_DECLARE_MEMBERS()

OdDbLinkedTableData::ODDB_DECLARE_MEMBERS ( OdDbLinkedTableData )

◆ removeDataLink() [1/2]

virtual void OdDbLinkedTableData::removeDataLink	(	OdInt32	nRow,
		OdInt32	nCol
	)

virtual

Removes the data link at the specified cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[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]

virtual void OdDbLinkedTableData::removeDataLink ( void )

virtual

Removes all data links.

◆ setBlockAttributeValue() [1/2]

virtual void OdDbLinkedTableData::setBlockAttributeValue	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdDbObjectId &	idAttDef,
		const OdString	sAttValue
	)

virtual

Sets the attribute value of the block cell using the specified object ID key.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
idAttDef	[in] Object ID.
sAttValue	[in] Attribute 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 void OdDbLinkedTableData::setBlockAttributeValue	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdDbObjectId &	idAttDef,
		const OdString	sAttValue
	)

virtual

Sets the attribute value of the block cell using the specified object ID key.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
idAttDef	[in] Object ID.
sAttValue	[in] Attribute 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()).

◆ setBlockTableRecordId() [1/2]

virtual void OdDbLinkedTableData::setBlockTableRecordId	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdDbObjectId &	idBTR
	)

virtual

Sets the ID of the block table record of the zero content of a cell as an object of the OdDbObjectId class.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
idBTR	[in] ID of the block table record.

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 void OdDbLinkedTableData::setBlockTableRecordId	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdDbObjectId &	idBTR
	)

virtual

Sets the ID of the block table record of the specified content of a cell as an object of the OdDbObjectId class.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
idBTR	[in] ID of the block table record.

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()).

◆ setCellState()

virtual void OdDbLinkedTableData::setCellState	(	OdInt32	nRow,
		OdInt32	nCol,
		OdDb::CellState	nCellState
	)

virtual

Sets the cell state.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nCellState	[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 the column number are less than 0 or greater than the table size.

◆ setColumnName()

virtual void OdDbLinkedTableData::setColumnName	(	OdInt32	nIndex,
		const OdString	name
	)

virtual

Sets the column name.

Parameters

nIndex	[in] Column index.
name	[in] Column name.

◆ setCustomData() [1/2]

virtual void OdDbLinkedTableData::setCustomData	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdString &	sKey,
		const OdValue *	pData
	)

virtual

Sets the custom data value of a 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

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
sKey	[in] Key to use for the custom data.
pData	[in] Custom data value.

◆ setCustomData() [2/2]

virtual void OdDbLinkedTableData::setCustomData	(	OdInt32	nRow,
		OdInt32	nCol,
		OdInt32	nData
	)

virtual

Sets the custom data value of a 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

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nData	[in] Custom data value.

◆ setDataFormat() [1/2]

virtual void OdDbLinkedTableData::setDataFormat	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdString	sFormat
	)

virtual

Sets the data format of the zero content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[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]

virtual void OdDbLinkedTableData::setDataFormat	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdString	sFormat
	)

virtual

Sets data format of the specified content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[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 the content is not editable (!isContentEditable()).

◆ setDataLink() [1/2]

virtual void OdDbLinkedTableData::setDataLink	(	const OdCellRange &	range,
		const OdDbObjectId &	idDataLink,
		bool	bUpdate
	)

virtual

Sets the data link object ID (OdDbDataLink) for the specified cell range.

Parameters

range	[in] Cell range.
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 in not an OdDbDataLink object ID.

◆ setDataLink() [2/2]

virtual void OdDbLinkedTableData::setDataLink	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdDbObjectId &	idDataLink,
		bool	bUpdate
	)

virtual

Sets the data link (OdDbDataLink) for the specified row and column.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
idDataLink	[in] Data lin 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 in not an OdDbDataLink object ID.

◆ setDataType() [1/2]

virtual void OdDbLinkedTableData::setDataType	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		OdValue::DataType	nDataType,
		OdValue::UnitType	nUnitType
	)

virtual

Sets the data type of the content at the specified index in a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[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 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. Method generates the eIsWriteProtected exception when the format is not editable (!isFormatEditable()).

◆ setDataType() [2/2]

virtual void OdDbLinkedTableData::setDataType	(	OdInt32	nRow,
		OdInt32	nCol,
		OdValue::DataType	nDataType,
		OdValue::UnitType	nUnitType
	)

virtual

Sets the data type of the first content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nDataType	[in] Data type.
nUnitType	[in] 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

Remarks: Unit type should take one of the following values:

Value kUnitless 0x00, kDistance 0x01, kAngle 0x02, kArea 0x04, kVolume 0x08, kCurrency 0x10, kPercentage 0x20

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 the format is not editable (!isFormatEditable()).

◆ setFieldId() [1/2]

virtual void OdDbLinkedTableData::setFieldId	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdDbObjectId &	idField
	)

virtual

Sets a field ID to the zero content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
idField	[in] Field 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 content is not editable (!isContentEditable()).

◆ setFieldId() [2/2]

virtual void OdDbLinkedTableData::setFieldId	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdDbObjectId &	idField
	)

virtual

Sets a field ID to the specified content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
idField	[in] Field 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 content is not editable (!isContentEditable()).

◆ setFormula()

virtual void OdDbLinkedTableData::setFormula	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdString	sFormula
	)

virtual

Sets the formula of the specified content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
sFormula	[in] Formula.

Remarks: Method generates the eNotImplementedYet exception.

◆ setSize()

virtual void OdDbLinkedTableData::setSize	(	OdInt32	nRows,
		OdInt32	nCols
	)

virtual

Sets the size for this linked table object.

Parameters

nRows	[in] Number of rows.
nCols	[in] Number of columns.

Remarks: Method generates the eInvalidInput exception when the number of rows or columns is zero.

◆ setText() [1/2]

virtual void OdDbLinkedTableData::setText	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdString &	sText
	)

virtual

Sets a text string to a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
sText	[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()).

◆ setText() [2/2]

virtual void OdDbLinkedTableData::setText	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdString &	sText
	)

virtual

Sets a text string to the specified content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
sText	[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()).

◆ setToolTip()

virtual void OdDbLinkedTableData::setToolTip	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdString &	sToolTip
	)

virtual

Sets the tooltip of the cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
sToolTip	[in] Tooltip.

◆ setValue() [1/3]

virtual void OdDbLinkedTableData::setValue	(	OdInt32	nRow,
		OdInt32	nCol,
		const OdValue &	value
	)

virtual

Sets a value to the zero content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
value	[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/3]

virtual void OdDbLinkedTableData::setValue	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdValue &	value
	)

virtual

Sets a value to the specified content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
value	[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() [3/3]

virtual void OdDbLinkedTableData::setValue	(	OdInt32	nRow,
		OdInt32	nCol,
		OdUInt32	nContent,
		const OdValue &	value,
		OdValue::ParseOption	nOption
	)

virtual

Sets a value to the specified content of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[in] Column index of the cell.
nContent	[in] Number of content.
value	[in] Value.
nOption	[in] Parse option of value.

Remarks: Parse option is an enumerator 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()).

◆ updateDataLink() [1/2]

virtual void OdDbLinkedTableData::updateDataLink	(	OdDb::UpdateDirection	nDir,
		OdDb::UpdateOption	nOption
	)

virtual

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]

virtual void OdDbLinkedTableData::updateDataLink	(	OdInt32	nRow,
		OdInt32	nCol,
		OdDb::UpdateDirection	nDir,
		OdDb::UpdateOption	nOption
	)

virtual

Updates the data link of a cell.

Parameters

nRow	[in] Row index of the cell.
nCol	[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.

The documentation for this class was generated from the following file:

DbLinkedTableData.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdDbLinkedTableData()

Member Function Documentation

◆ appendColumn()

◆ appendRow()

◆ canDelete()

◆ canInsert()

◆ cellState()

◆ clear()

◆ contentType() [1/2]

◆ contentType() [2/2]

◆ copyFrom() [1/3]

◆ copyFrom() [2/3]

◆ copyFrom() [3/3]

◆ createContent()

◆ dataFormat() [1/2]

◆ dataFormat() [2/2]

◆ deleteColumn()

◆ deleteContent() [1/3]

◆ deleteContent() [2/3]

◆ deleteContent() [3/3]

◆ deleteRow()

◆ dwgInFields()

◆ dwgOutFields()

◆ dxfInFields()

◆ dxfOutFields()

◆ getBlockAttributeValue() [1/2]

◆ getBlockAttributeValue() [2/2]

◆ getBlockTableRecordId() [1/2]

◆ getBlockTableRecordId() [2/2]

◆ getColumnName()

◆ getCustomData() [1/2]

◆ getCustomData() [2/2]

◆ getDataLink() [1/3]

◆ getDataLink() [2/3]

◆ getDataLink() [3/3]

◆ getDataLinkRange()

◆ getDataType() [1/2]

◆ getDataType() [2/2]

◆ getField()

◆ getFieldId() [1/2]

◆ getFieldId() [2/2]

◆ getFormula()

◆ getIterator() [1/2]

◆ getIterator() [2/2]

◆ getText() [1/3]

◆ getText() [2/3]

◆ getText() [3/3]

◆ getToolTip()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ hasFormula()

◆ insertColumn()

◆ insertRow()

◆ isContentEditable()

◆ isLinked()

◆ moveContent()

◆ numColumns()

◆ numContents()

◆ numRows()

◆ ODDB_DECLARE_MEMBERS()

◆ removeDataLink() [1/2]

◆ removeDataLink() [2/2]

◆ setBlockAttributeValue() [1/2]

◆ setBlockAttributeValue() [2/2]

◆ setBlockTableRecordId() [1/2]

◆ setBlockTableRecordId() [2/2]

◆ setCellState()

◆ setColumnName()

◆ setCustomData() [1/2]

◆ setCustomData() [2/2]

◆ setDataFormat() [1/2]

◆ setDataFormat() [2/2]

◆ setDataLink() [1/2]

◆ setDataLink() [2/2]

◆ setDataType() [1/2]

◆ setDataType() [2/2]