Interface ITables

Gives access to tables in drafting documents.

Namespace: TopSolid.Cad.Drafting.Automating

Assembly: TopSolid.Cad.Drafting.Automating.dll

Syntax

[ServiceContract]
[AvailableSinceVersion(7, 16, 0, 0)]
public interface ITables

Remarks

This interface is available since v7.16.

Methods

ExportDraftTableCellValue(ElementId, Int32, Int32, Int32, String)

Exports the draft table cell value.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
string ExportDraftTableCellValue(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx, string inSeparator)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.
System.String	inSeparator	The separator.

Returns

Type	Description
System.String	The exported text value.

Remarks

This method is available since v7.17.

GetDraftTableCellElement(ElementId, Int32, Int32, Int32)

Gets the Element of a cell.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
ElementId GetDraftTableCellElement(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.

Returns

Type	Description
ElementId	Element of a cell.

Remarks

This method is available since v7.17.

GetDraftTableCellElementItem(ElementId, Int32, Int32, Int32)

Gets the Element Item of a cell.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 17, 0, 0)]
ElementItemId GetDraftTableCellElementItem(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.

Returns

Type	Description
ElementItemId	ElementItem of a cell.

Remarks

This method is available since v7.17.

GetDraftTableCellImage(ElementId, Int32, Int32, Int32)

Gets the image value of a cell.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
Bitmap GetDraftTableCellImage(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.

Returns

Type	Description
System.Drawing.Bitmap	Image of a cell.

Remarks

This method is available since v7.14.300.140.

GetDraftTableCellParameter(ElementId, Int32, Int32, Int32)

Gets the parameter of a cell.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
SmartText GetDraftTableCellParameter(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.

Returns

Type	Description
SmartText	SmartText parameter of a cell.

Remarks

This method is available since v7.14.300.140.

GetDraftTableCellText(ElementId, Int32, Int32, Int32)

Gets the text value of a cell.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
string GetDraftTableCellText(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.

Returns

Type	Description
System.String	Text value of a cell.

Remarks

This method is available since v7.14.300.140.

GetDraftTableCellType(ElementId, Int32, Int32)

Gets the draft table cell type at a specified column and row.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
CellType GetDraftTableCellType(ElementId inElementId, int inColumnIdx, int inRowIdx)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.

Returns

Type	Description
CellType	The cell type.

Remarks

This method is available since v7.14.300.140.

GetDraftTableCellValueType(ElementId, Int32, Int32, Int32)

Gets the value type of a cell.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
CellValueType GetDraftTableCellValueType(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdxIdx)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdxIdx	Index of the split column. 0 if default.

Returns

Type	Description
CellValueType	Cell value type.

Remarks

This method is available since v7.14.300.140.

GetDraftTableColumnCount(ElementId)

Gets the draft table column count.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
int GetDraftTableColumnCount(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.

Returns

Type	Description
System.Int32	Count of column.

Remarks

This method is available since v7.14.300.140.

GetDraftTableRowCount(ElementId)

Gets the draft table row count.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
int GetDraftTableRowCount(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.

Returns

Type	Description
System.Int32	Count of rows.

Remarks

This method is available since v7.14.300.140.

GetDraftTables(DocumentId)

Get draft tables of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
List<ElementId> GetDraftTables(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Document to analyze.

Returns

Type	Description
System.Collections.Generic.List<ElementId>	Draft tables of the document.

Remarks

This method is available since v7.14.300.140.

GetDraftTableSplitCellColumnCount(ElementId, Int32, Int32)

Gets the split cell column count.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
int GetDraftTableSplitCellColumnCount(ElementId inElementId, int inColumnIdx, int inRowIdx)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.

Returns

Type	Description
System.Int32	Count of cell of a split cell.

Remarks

This method is available since v7.14.300.140.

GetDraftTableType(ElementId)

Get the draft table type of an element.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
TableType GetDraftTableType(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to analyze.

Returns

Type	Description
TableType	Draft table type.

Remarks

This method is available since v7.14.300.140.

SetDraftTableCellImageFromBitmap(ElementId, Int32, Int32, Int32, Bitmap)

Sets the image of a cell from a bitmap.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
void SetDraftTableCellImageFromBitmap(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx, Bitmap inBitmap)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to modify.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.
System.Drawing.Bitmap	inBitmap	Image of the cell.

Remarks

This method is available since v7.14.300.140.

SetDraftTableCellImageFromPath(ElementId, Int32, Int32, Int32, String)

Sets the image of a cell from a path.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
void SetDraftTableCellImageFromPath(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx, string inPath)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to modify.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.
System.String	inPath	Path of the image.

Remarks

This method is available since v7.14.300.140.

SetDraftTableCellParameter(ElementId, Int32, Int32, Int32, SmartText)

Sets the parameter value of a cell.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
void SetDraftTableCellParameter(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx, SmartText inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to modify.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.
SmartText	inValue	Value of the cell.

Remarks

This method is available since v7.14.300.140.

SetDraftTableCellText(ElementId, Int32, Int32, Int32, String)

Sets the text value of a cell.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 300, 140)]
void SetDraftTableCellText(ElementId inElementId, int inColumnIdx, int inRowIdx, int inSplitColumnIdx, string inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the entity to modify.
System.Int32	inColumnIdx	Index of the column.
System.Int32	inRowIdx	Index of the row.
System.Int32	inSplitColumnIdx	Index of the split column. 0 if default.
System.String	inValue	Text value of the cell.

Remarks

This method is available since v7.14.300.140.