#include <DbFormattedTableData.h>
Public Member Functions inherited from Detailed Description
This class represents FormattedTableData objects in an OdDbDatabase instance.
- Remarks
- Work in progress!
<group OdDb_Classes>
Definition at line 43 of file DbFormattedTableData.h.
Constructor & Destructor Documentation
◆ OdDbFormattedTableData()
| OdDbFormattedTableData::OdDbFormattedTableData | ( | ) |
Default constructor. Creates an object of the OdDbFormattedTableData class.
Member Function Documentation
◆ alignment()
|
virtual |
Returns the cell alignment for the specified cell in this table object.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- Cell alignment for the specified cell.
- Remarks
- 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
◆ backgroundColor()
|
virtual |
Returns the background color for the specified cell in this table object.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- Background color value.
◆ contentColor() [1/2]
Returns the color of the cell content as an object of the OdCmColor class.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ contentColor() [2/2]
|
virtual |
Returns the color of the specified content of a cell as an object of the OdCmColor class.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index.
- Returns
- Color of the specified content of the cell.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ contentLayout()
|
virtual |
Returns the content layout of the specified cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- Content layout of the specified cell.
- Remarks
- Returning value should be one of following values:
Value kCellContentLayoutFlow 0x1 kCellContentLayoutStackedHorizontal 0x2 kCellContentLayoutStackedVertical 0x4
◆ dwgInFields()
|
virtual |
OdDbObject override.
Reimplemented from OdDbLinkedTableData.
Reimplemented in OdDbTableContent, and OdDbTableTemplate.
◆ dwgOutFields()
|
virtual |
OdDbObject override.
Reimplemented from OdDbLinkedTableData.
Reimplemented in OdDbTableContent, and OdDbTableTemplate.
◆ dxfInFields()
|
virtual |
OdDbObject override.
Reimplemented from OdDbLinkedTableData.
Reimplemented in OdDbTableContent, and OdDbTableTemplate.
◆ dxfOutFields()
|
virtual |
OdDbObject override.
Reimplemented from OdDbLinkedTableData.
Reimplemented in OdDbTableContent, and OdDbTableTemplate.
◆ enableMergeAll()
|
virtual |
Sets the merge-all flag for the cell, row, or column.
- Parameters
-
nRow [in] Row index. nCol [in] Column index. bEnable [in] Merge-all flag value.
- Remarks
- Method generates the eNotImplementedYet exception.
◆ flowDirection()
|
virtual |
Returns the direction that this table entity flows from its first row to the last.
- Returns
- Flow direction value.
- Remarks
- flowDirection() returns one of the following:
Value Description OdDb::kTtoB 0 Top to Bottom OdDb::kBtoT 1 Bottom to Top
◆ getGridProperty()
|
virtual |
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 grid property of the row. Use a valid column index and pass the row index '-1' to get the grid property of the column.
- Parameters
-
nRow [in] Row index. nCol [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
◆ getMergeRange()
|
virtual |
Returns merge range of the cell as an object of the OdCellRange class.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- Merge range of the specified cell.
- Remarks
- Returns invalid merge range if the cell is not part of the merge range.
◆ getOverride() [1/2]
|
virtual |
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 overrides. Use a valid column index and pass the row index '-1' to get the column property overrides.
- Parameters
-
nRow [in] Row index. nCol [in] Column index. nGridLineType [in] Grid linetype.
- 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]
|
virtual |
Returns the override of the cell, row or column. Use a valid row index and pass the column index '-1' to get the row property overrides. Use a valid column index and pass the row index '-1' to get the column property overrides.
- Parameters
-
nRow [in] Row index. nCol [in] Column index. nContent [in] Content index.
- Returns
- Override of the cell, row or column.
- 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)
◆ gridColor()
|
virtual |
Returns the grid line 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
-
nRow [in] Row index. nCol [in] Column index. nGridLineType [in] Grid linetype.
- Returns
- Grid line 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
◆ gridDoubleLineSpacing()
|
virtual |
Returns the grid double line spacing of the cell, row or column as a double value. Use a valid row index and pass column index -1 to get row grid double line spacing. Use a valid column index and pass row index -1 to get column grid double line spacing.
- Parameters
-
nRow [in] Row index. nCol [in] Column index. nGridLineType [in] Grid linetype.
- Returns
- Grid double line spacing value.
- 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()
|
virtual |
Returns the grid linestyle of the cell, row or column. Use a valid row index and pass the column index '-1' to get the grid linestyle of the row. Use a valid column index and pass the row index '-1' to get the grid linestyle of the column.
- Parameters
-
nRow [in] Row index. nCol [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()
|
virtual |
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
-
nRow [in] Row index. nCol [in] Column index. nGridLineType [in] Grid linetypes.
- Returns
- Grid linetype object ID.
- 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
◆ gridLineWeight()
|
virtual |
Returns the grid lineweight of the 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
-
nRow [in] Row index. nCol [in] Column index. nGridLineType [in] Grid linetype.
- Returns
- Lineweight value.
- 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
◆ gridVisibility()
|
virtual |
Returns the grid visibility of the cell, row or column. Use a valid row index and pass the column index '-1' to get the grid visibility of the row. Use a valid column index and pass the row index '-1' to get the grid visibility of the column.
- Parameters
-
nRow [in] Row index. nCol [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
Grid visibility should take one of the following values:
Value kInvisible 1 kVisible 0
◆ insertColumnAndInherit()
|
virtual |
Inserts columns at the specified index and inherits the column properties for the inserted columns from the reference column.
- Parameters
-
nIndex [in] Index. nInheritFrom [in] Index of the reference column to inherit the format from. nNumCols [in] Number of inserted columns.
- Returns
- Starting index of the inserted columns.
- Remarks
- Method generates the eInvalidInput exception when the number of rows or columns is zero.
◆ insertRowAndInherit()
|
virtual |
Inserts rows at the specified index and inherits the row properties for the inserted rows from the reference row.
- Parameters
-
nIndex [in] Index to insert rows at. nInheritFrom [in] Index of the reference row to inherit the format from. nNumRows [in] Number of inserted rows.
- Returns
- Starting index of the inserted rows.
◆ isAutoScale() [1/2]
Indicates whether the data in the zero content of a cell is auto-scaled or not.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- True if the data in the zero content of the cell is auto-scaled; false otherwise.
◆ isAutoScale() [2/2]
|
virtual |
Indicates whether the data in the specified content of a cell is auto-scaled or not. Returns the auto-scaled flag as a boolean value.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index.
- Returns
- True if the data in the specified content of the cell is auto-scaled; false otherwise.
◆ isFormatEditable()
Returns "editing format flag" cell property.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- True if cell format can be edited or false if not.
◆ isMergeAllEnabled()
Checks whether the merge-all flag is enabled for the cell, row, or column.
- Parameters
-
nRow [in] Row index. nCol [in] Column index.
- Returns
- True if the merge-all flag is enabled or false if it is not.
- Remarks
- Method generates the eNotImplementedYet exception.
◆ isMerged()
Returns true if and only if the specified cell has been merged.
- Parameters
-
nRow [in] Row index. nCol [in] Column index.
- Returns
- True if the specified cell has been merged; false otherwise.
- 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.
◆ margin()
|
virtual |
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 of the row. Use a valid column index and pass the row index '-1' to get the margin of the column.
- Parameters
-
nRow [in] Row index. nCol [in] Column index. nMargin [in] Margin type.
- Returns
- Margin value.
- Remarks
- Margin type should be one of following values:
Value kCellMarginTop 0x01 kCellMarginLeft 0x02 kCellMarginBottom 0x04 kCellMarginRight 0x08 kCellMarginHorzSpacing 0x10 kCellMarginVertSpacing 0x20
◆ merge()
|
virtual |
Merges a rectangular range of cells in this table object.
- Parameters
-
range [in] Input range to merge.
- 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.
◆ ODDB_DECLARE_MEMBERS()
| OdDbFormattedTableData::ODDB_DECLARE_MEMBERS | ( | OdDbFormattedTableData | ) |
◆ removeAllOverrides()
Removes all overrides in the 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
-
nRow [in] Row index. nCol [in] Column index.
◆ rotation() [1/2]
Returns the zero content rotation angle.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- Zero content rotation angle value in radians.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ rotation() [2/2]
|
virtual |
Returns the specified content rotation angle.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index.
- Returns
- Specified content rotation angle value in radians.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ scale() [1/2]
Returns the scale value of the zero content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- Zero content scale value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ scale() [2/2]
|
virtual |
Returns the scale 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] Content index.
- Returns
- Specified content scale value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ setAlignment()
|
virtual |
Sets the cell alignment for the specified cell in this table entity.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nAlignment [in] Alignment.
- Remarks
- 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 grater than the number of rows, or when the column argument is grater than the number of columns.
◆ setAutoScale() [1/2]
|
virtual |
Sets the auto-scaled flag to the zero content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. bAutoScale [in] Auto-scaled flag value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setAutoScale() [2/2]
|
virtual |
Sets the auto-scaled flag to the specified content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index. bAutoScale [in] Auto-scaled flag value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setBackgroundColor()
|
virtual |
Sets the background color for the specified cell in this table object.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. color [in] Background color value.
- Remarks
- Method generates the eInvalidInput exception when the row type mask is more than 7, the row argument is grater than the number of rows, or the column argument is grater than the number of columns.
◆ setContentColor() [1/2]
|
virtual |
Sets the color of the zero content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. color [in] Color of the content.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setContentColor() [2/2]
|
virtual |
Sets the color of the specified content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index. color [in] Color of the content.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setContentLayout()
|
virtual |
Sets the content layout for the specified cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [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 input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setFieldId() [1/2]
|
virtual |
Sets a field ID to the zero cell content.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. idField [in] Field ID. nFlag [in] Cell option.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when content is not editable (!isContentEditable()).
◆ setFieldId() [2/2]
|
virtual |
Sets a field ID to the specified cell content.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Number of content. idField [in] Field ID. nFlag [in] Cell option.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when content is not editable (!isContentEditable()).
◆ setFlowDirection()
|
virtual |
Sets the direction that this table entity flows from its first row to the last.
- Parameters
-
nDir [in] Flow direction value.
- 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.
◆ setGridColor()
|
virtual |
Sets the grid line color of the cell, row or column. Use a valid row index and pass the column index '-1' to set the grid line color for the row. Use a valid column index and pass the row index '-1' to set the grid line color for the column.
- Parameters
-
nRow [in] Row index. nCol [in] Column index. nGridlineTypes [in] Grid linetypes. color [in] Grid line 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
◆ setGridDoubleLineSpacing()
|
virtual |
Sets the grid double line spacing for the cell, row or column. Use a valid row index and pass the column index '-1' to set the grid double line spacing for the row. Use a valid column index and pass the row index '-1' to set the grid double line spacing for the column.
- Parameters
-
nRow [in] Row index. nCol [in] Column index. nGridLineTypes [in] Grid linetypes. fSpacing [in] Grid double line spacing value.
- 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()
|
virtual |
Sets the grid line style for the cell, row or column. Use a valid row index and pass the column index '-1' to set the row grid linestyle. Use a valid column index and pass the row index '-1' to set the column grid linestyle.
- Parameters
-
nRow [in] Row index. nCol [in] Column index. nGridLineTypes [in] Grid linetype. nLineStyle [in] 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 linestyle should take one of the following values:
Value kGridLineStyleSingle 1 kGridLineStyleDouble 2
◆ setGridLinetype()
|
virtual |
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
-
nRow [in] Row index. nCol [in] Column index. nGridLineTypes [in] Grid linetypes. idLinetype [in] Object ID of the 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()
|
virtual |
Sets the grid lineweight of the 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
-
nRow [in] Row index. nCol [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
◆ setGridProperty() [1/2]
|
virtual |
Sets the grid line property for the cell, row or column.
- Parameters
-
range [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]
|
virtual |
Sets the grid line property for the cell, row or column. Use a valid row index and pass the column index '-1' to set the grid property for the row. Use a valid column index and pass the row index '-1' to set the grid property for the column.
- Parameters
-
nRow [in] Row index. nCol [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()
|
virtual |
Sets the grid visibility for the cell, row or column. Use a valid row index and pass the column index '-1' to set the grid visibility for the row. Use a valid column index and pass the row index '-1' to set the grid visibility for the column.
- Parameters
-
nRow [in] Row index. nCol [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
◆ setMargin()
|
virtual |
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
-
nRow [in] Row index. nCol [in] Column index. nMargins [in] Margin type. fMargin [in] Margin value.
- Remarks
- Margin type should be a combination of the following values:
Value kCellMarginTop 0x01 kCellMarginLeft 0x02 kCellMarginBottom 0x04 kCellMarginRight 0x08 kCellMarginHorzSpacing 0x10 kCellMarginVertSpacing 0x20
◆ setOverride() [1/2]
|
virtual |
Sets the override in the cell, row, column, content or grid line in the 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
-
nRow [in] Row index. nCol [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]
|
virtual |
Sets the override in the cell, row, column, content or grid line in the 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
-
nRow [in] Row index. nCol [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 zero cell content rotation angle.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. fRotation [in] Rotation angle value in radians.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setRotation() [2/2]
|
virtual |
Sets the specified cell content rotation angle.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index. fRotation [in] Rotation angle value in radians.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setScale() [1/2]
Sets the scale value for the zero content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. fScale [in] Scale value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ setScale() [2/2]
|
virtual |
Sets the scale value for the specified content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index. fScale [in] Scale value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ setTextHeight() [1/2]
|
virtual |
Sets the text height of the zero content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. fTextHeight [in] Text height value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setTextHeight() [2/2]
|
virtual |
Sets the text height of the specified content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index. fTextHeight [in] Text height value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setTextStyle() [1/2]
|
virtual |
Sets the text style for the zero content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. idTextStyle [in] Text style object ID.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ setTextStyle() [2/2]
|
virtual |
Sets the text style for the specified content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index. idTextStyle [in] Text style object ID.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size. Method generates the eIsWriteProtected when format is not editable (!isFormatEditable()).
◆ textHeight() [1/2]
Returns the text height for the zero content of a cell in this table object.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- Text height value.
◆ textHeight() [2/2]
|
virtual |
Returns the text height of the specified content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index.
- Returns
- Text height value.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ textStyle() [1/2]
|
virtual |
Returns the text style of the zero content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell.
- Returns
- Text style object ID.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ textStyle() [2/2]
|
virtual |
Returns the text style of the specified content of a cell.
- Parameters
-
nRow [in] Row index of the cell. nCol [in] Column index of the cell. nContent [in] Content index.
- Returns
- Text style object ID.
- Remarks
- Method generates the eInvalidInput exception when input row number and column number are less than 0 or greater than table size.
◆ unmerge()
|
virtual |
Unmerges a rectangular range of cells in this table object.
- Parameters
-
range [in] Input range to unmerge.
- 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.
The documentation for this class was generated from the following file: