CIP Visual Basic.NET documentation for interface "IpfcTable"

Interface IpfcTable

Description

This interface represents a drawing table in a Creo Parametric model.

See Also:: IpfcModelItemOwner.ListItems(), IpfcModelItemOwner.GetItemById(), IpfcTableOwner.CreateTable(), IpfcTableOwner.RetrieveTable()

Direct Parent Classes:: IpfcModelItem

Method Summary


`Function`	`CheckIfIsFromFormat (SheetNumber as Long) as Boolean`
	Identifies if the drawing table was created by the format.

`Sub`	`DeleteColumn (Column as Long, Repaint as Boolean [optional])`
	Deletes a column in the table.

`Sub`	`DeleteRow (Row as Long, Repaint as Boolean [optional])`
	Deletes a row in the table.

`Sub`	`Display ()`
	Displays the table, if it has been erased.

`Sub`	`Erase ()`
	Erases the table.

`Function`	`GetCellComponentModel (Cell as IpfcTableCell) as IpfcComponentPath [optional]`
	Returns the component model referred to by a cell in a repeat region of a table. This function will not return a valid result if the cell has the attribute "NO DUPLICATE" or "NO DUPLICATE/LEVEL" as there is no unique path available. In that case use the functions `IpfcTable.GetCellTopModel()` (for Top level model) or `IpfcTable.GetCellReferenceModel()`.

`Function`	`GetCellNote (Cell as IpfcTableCell) as IpfcModelItem [optional]`
	Returns the detail note contained in the table cell.

`Function`	`GetCellReferenceModel (Cell as IpfcTableCell) as IpfcModel [optional]`
	Returns the reference component referred to by this cell in a repeat region drawing table. Differs from `IpfcTable.GetCellComponentModel()` in that this function will return the reference object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL".

`Function`	`GetCellTopModel (Cell as IpfcTableCell) as IpfcAssembly [optional]`
	Returns the top model referred to by this cell in a repeat region drawing table. Differs from `IpfcTable.GetCellComponentModel()` in that this function will return the object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL".

`Function`	`GetColumnCount () as Long`
	Returns the number of columns in the table.

`Function`	`GetColumnSize (SegmentId as Long, Column as Long) as Double`
	Returns the width of the drawing table column.

`Function`	`GetInfo (SegmentId as Long) as IpfcTableInfo`
	Returns information about the drawing table.

`Function`	`GetRowCount () as Long`
	Returns the number of rows in the table.

`Function`	`GetRowSize (SegmentId as Long, Row as Long) as Double`
	Returns the height of the row.

`Function`	`GetSegmentCount () as Long`
	Returns the number of segments in the table.

`Function`	`GetSegmentSheet (SegmentNumber as Long) as Long`
	Returns the sheet where a particuar table segment lies.

`Function`	`GetText (Cell as IpfcTableCell, Mode as IpfcParamMode) as Istringseq`
	Returns the text in a drawing table cell.

`Sub`	`InsertColumn (Width as Double, InsertAfterColumn as Long [optional], Repaint as Boolean [optional])`
	Inserts a column in the drawing table.

`Sub`	`InsertRow (Height as Double, InsertAfterRow as Long [optional], Repaint as Boolean [optional])`
	Inserts a new row into the table.

`Function`	`IsCommentCell (Cell as IpfcTableCell) as Boolean`
	Determines if a table cell is a comment cell in a repeat region.

`Sub`	`MergeRegion (UpperLeft as IpfcTableCell, LowerRight as IpfcTableCell, Repaint as Boolean [optional])`
	Merges a rectangular section of table cells.

`Sub`	`MoveSegment (SegmentNumber as Long, NewPosition as IpfcPoint3D, Repaint as Boolean [optional])`
	Moves a segment of the table.

`Sub`	`RotateClockwise (Rotation as IpfcRotationDegree, Repaint as Boolean [optional])`
	Rotates a table clockwise.

`Sub`	`SetText (Cell as IpfcTableCell, Lines as Istringseq)`
	Sets the text in the table cell.

`Sub`	`SubdivideRegion (UpperLeft as IpfcTableCell, LowerRight as IpfcTableCell, Repaint as Boolean [optional])`
	Removes all merges in the specified region of previously merged cells.

Method Detail

Function CheckIfIsFromFormat (SheetNumber as Long) as Boolean

Identifies if the drawing table was created by the format.

SheetNumber is ignored in this method.

Parameters:

SheetNumber: The sheet number.

Returns:: true if the table was created by applying the drawing format.

Sub DeleteColumn (Column as Long, Repaint as Boolean [optional])

Deletes a column in the table.

Parameters:

Column
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Sub DeleteRow (Row as Long, Repaint as Boolean [optional])

Deletes a row in the table.

Parameters:

Row
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Sub Display ()

Displays the table, if it has been erased.

See Also:: IpfcTable.Erase()

Sub Erase ()

Erases the table.

See Also:: IpfcTable.Display()

Function GetCellComponentModel (Cell as IpfcTableCell) as IpfcComponentPath [optional]

Returns the component model referred to by a cell in a repeat region of a table. This function will not return a valid result if the cell has the attribute "NO DUPLICATE" or "NO DUPLICATE/LEVEL" as there is no unique path available. In that case use the functions IpfcTable.GetCellTopModel() (for Top level model) or IpfcTable.GetCellReferenceModel().

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The table cell does not contain a reference to a component model.

See Also:: IpfcTableCell.Create()

Parameters:

Cell: The table cell.

Returns:: The full path to the component referenced by the cell.

Function GetCellNote (Cell as IpfcTableCell) as IpfcModelItem [optional]

Returns the detail note contained in the table cell.

Exceptions thrown (but not limited to):

IpfcXToolkitEmpty - The cell is empty.

See Also:: IpfcTableCell.Create()

Parameters:

Cell: The table cell.

Returns:: The detail note item.

Function GetCellReferenceModel (Cell as IpfcTableCell) as IpfcModel [optional]

Returns the reference component referred to by this cell in a repeat region drawing table. Differs from IpfcTable.GetCellComponentModel() in that this function will return the reference object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL".

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The cell does not have an associated model.

See Also:: IpfcTableCell.Create()

Parameters:

Cell: The table cell.

Returns:: The model of record for the cell.

Function GetCellTopModel (Cell as IpfcTableCell) as IpfcAssembly [optional]

Returns the top model referred to by this cell in a repeat region drawing table. Differs from IpfcTable.GetCellComponentModel() in that this function will return the object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL".

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The cell does not have an associated model.

See Also:: IpfcTableCell.Create()

Parameters:

Cell: The table cell.

Returns:: The top model for the region.

Function GetColumnCount () as Long

Returns the number of columns in the table.

Exceptions thrown (but not limited to):

IpfcXToolkitNotExist - The specified table or drawing does not exist.

Returns:: The number of columns.

Function GetColumnSize (SegmentId as Long, Column as Long) as Double

Returns the width of the drawing table column.

See Also:: IpfcTable.GetColumnCount(), IpfcTable.GetSegmentCount()

Parameters:

SegmentId: The segment identifier. Segment identifiers start at 0.
Column: The column number. Column numbers range from 1 to the number of columns.

Returns:: The column size.

Function GetInfo (SegmentId as Long) as IpfcTableInfo

Returns information about the drawing table.

See Also:: IpfcTable.GetSegmentCount()

Parameters:

SegmentId: The segment identifier. Segment ids start at 0.

Returns:: The table information, including the rotation, column and row information, and outline.

Function GetRowCount () as Long

Returns the number of rows in the table.

Exceptions thrown (but not limited to):

IpfcXToolkitNotExist - The specified table or drawing does not exist.

Returns:: The number of rows.

Function GetRowSize (SegmentId as Long, Row as Long) as Double

Returns the height of the row.

See Also:: IpfcTable.GetRowCount(), IpfcTable.GetSegmentCount()

Parameters:

SegmentId: The segment identifier. Segment ids range start at 0.
Row: The row number. Row numbers range from 1 to the number of rows.

Returns:: The row height.

Function GetSegmentCount () as Long

Returns the number of segments in the table.

Returns:: The number of segments.

Function GetSegmentSheet (SegmentNumber as Long) as Long

Returns the sheet where a particuar table segment lies.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - A -1 segment ID was used for a multiple segment table.

See Also:: IpfcTable.GetSegmentCount()

Parameters:

SegmentNumber: The segement identifier. Segment ids start at 0.

Returns:: The sheet number.

Function GetText (Cell as IpfcTableCell, Mode as IpfcParamMode) as Istringseq

Returns the text in a drawing table cell.

If no text is found in the table cell, this method will throw a IpfcXToolkitGeneralError exception.

See Also:: IpfcTableCell.Create()

Parameters:

Cell: The table cell.
Mode: The mode used to retrieve the text.

Returns:: Sequence of text in the table cell.

Sub InsertColumn (Width as Double, InsertAfterColumn as Long [optional], Repaint as Boolean [optional])

Inserts a column in the drawing table.

See Also:: IpfcTable.GetColumnCount()

Parameters:

Width: The width of the inserted column.
InsertAfterColumn: The column number to insert after. Pass 0 to insert as the first column. Column numbers range from 1 to the number of columns.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Sub InsertRow (Height as Double, InsertAfterRow as Long [optional], Repaint as Boolean [optional])

Inserts a new row into the table.

See Also:: IpfcTable.GetRowCount()

Parameters:

Height: The row height. This argument should be in number of characters, even if the table was created using a height type of TABLESIZE_BY_LENGTH.
InsertAfterRow: The row number. Enter 0 to insert a new first row. Row numbers range from 1 to the number of rows.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Function IsCommentCell (Cell as IpfcTableCell) as Boolean

Determines if a table cell is a comment cell in a repeat region.

Parameters:

Cell: The table cell.

Returns:: Whether or not the cell is a comment cell.

Sub MergeRegion (UpperLeft as IpfcTableCell, LowerRight as IpfcTableCell, Repaint as Boolean [optional])

Merges a rectangular section of table cells.

Parameters:

UpperLeft: The table cell on the upper left of the region.
LowerRight: The table cell on the lower right of the region.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Sub MoveSegment (SegmentNumber as Long, NewPosition as IpfcPoint3D, Repaint as Boolean [optional])

Moves a segment of the table.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - A -1 segment ID was used for a multiple segment table.

Parameters:

SegmentNumber: The segment identifier. Segment ids start from 0.
NewPosition: The new location for the drawing table segment.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Sub RotateClockwise (Rotation as IpfcRotationDegree, Repaint as Boolean [optional])

Rotates a table clockwise.

Parameters:

Rotation: The amount of rotation.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.

Sub SetText (Cell as IpfcTableCell, Lines as Istringseq)

Sets the text in the table cell.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - A -1 segment ID was used for a multiple segment table.

See Also:: IpfcTableCell.Create()

Parameters:

Cell: The table cell.
Lines: The text for the table cell.

Sub SubdivideRegion (UpperLeft as IpfcTableCell, LowerRight as IpfcTableCell, Repaint as Boolean [optional])

Removes all merges in the specified region of previously merged cells.

Parameters:

UpperLeft: The upper left table cell to remesh.
LowerRight: The lower right table cell to remesh.
Repaint: true to repaint the drawing with the changes, false or null to delay the repaint.