CIP C++ documentation for class "pfcTable"

Class pfcTable

# include <pfcTable.h> class pfcTable : public virtual pfcModelItem { xaideclare(pfcTable) ... };

Description

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

See Also:: pfcModelItemOwner::ListItems(optional pfcModelItemType), pfcModelItemOwner::GetItemById(pfcModelItemType, xint), pfcTableOwner::CreateTable(pfcTableCreateInstructions_ptr), pfcTableOwner::RetrieveTable(pfcTableRetrieveInstructions_ptr)

Direct Known Subclasses:: wfcWTable

Method Summary


`xbool`	`CheckIfIsFromFormat (xint SheetNumber)`
	Identifies if the drawing table was created by the format.

`void`	`DeleteColumn (xint Column, optional xbool Repaint)`
	Deletes a column in the table.

`void`	`DeleteRow (xint Row, optional xbool Repaint)`
	Deletes a row in the table.

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

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

`optional pfcComponentPath_ptr`	`GetCellComponentModel (pfcTableCell_ptr Cell)`
	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 `pfcTable::GetCellTopModel(pfcTableCell_ptr)` (for Top level model) or `pfcTable::GetCellReferenceModel(pfcTableCell_ptr)`.

`optional pfcModelItem_ptr`	`GetCellNote (pfcTableCell_ptr Cell)`
	Returns the detail note contained in the table cell.

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

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

`xint`	`GetColumnCount ()`
	Returns the number of columns in the table.

`xreal`	`GetColumnSize (xint SegmentId, xint Column)`
	Returns the width of the drawing table column.

`pfcTableInfo_ptr`	`GetInfo (xint SegmentId)`
	Returns information about the drawing table.

`xint`	`GetRowCount ()`
	Returns the number of rows in the table.

`xreal`	`GetRowSize (xint SegmentId, xint Row)`
	Returns the height of the row.

`xint`	`GetSegmentCount ()`
	Returns the number of segments in the table.

`xint`	`GetSegmentSheet (xint SegmentNumber)`
	Returns the sheet where a particuar table segment lies.

`xstringsequence_ptr`	`GetText (pfcTableCell_ptr Cell, pfcParamMode Mode)`
	Returns the text in a drawing table cell.

`void`	`InsertColumn (xreal Width, optional xint InsertAfterColumn, optional xbool Repaint)`
	Inserts a column in the drawing table.

`void`	`InsertRow (xreal Height, optional xint InsertAfterRow, optional xbool Repaint)`
	Inserts a new row into the table.

`xbool`	`IsCommentCell (pfcTableCell_ptr Cell)`
	Determines if a table cell is a comment cell in a repeat region.

`void`	`MergeRegion (pfcTableCell_ptr UpperLeft, pfcTableCell_ptr LowerRight, optional xbool Repaint)`
	Merges a rectangular section of table cells.

`void`	`MoveSegment (xint SegmentNumber, pfcPoint3D_ptr NewPosition, optional xbool Repaint)`
	Moves a segment of the table.

`void`	`RotateClockwise (pfcRotationDegree Rotation, optional xbool Repaint)`
	Rotates a table clockwise.

`void`	`SetText (pfcTableCell_ptr Cell, xstringsequence_ptr Lines)`
	Sets the text in the table cell.

`void`	`SubdivideRegion (pfcTableCell_ptr UpperLeft, pfcTableCell_ptr LowerRight, optional xbool Repaint)`
	Removes all merges in the specified region of previously merged cells.

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Method Detail

xint GetRowCount ()

Returns the number of rows in the table.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The specified table or drawing does not exist.

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Returns:: The number of rows.

xint GetColumnCount ()

Returns the number of columns in the table.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The specified table or drawing does not exist.

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Returns:: The number of columns.

void Display ()

Displays the table, if it has been erased.

See Also:: pfcTable::Erase()

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Returns:

void Erase ()

Erases the table.

See Also:: pfcTable::Display()

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Returns:

void RotateClockwise (pfcRotationDegree Rotation, optional xbool Repaint)

Rotates a table clockwise.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

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

Returns:

xbool CheckIfIsFromFormat (xint SheetNumber)

Identifies if the drawing table was created by the format.

SheetNumber is ignored in this method.

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Parameters:

SheetNumber: The sheet number.

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

pfcTableInfo_ptr GetInfo (xint SegmentId)

Returns information about the drawing table.

See Also:: pfcTable::GetSegmentCount()

Manual References:: Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

Parameters:

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

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

void InsertRow (xreal Height, optional xint InsertAfterRow, optional xbool Repaint)

Inserts a new row into the table.

See Also:: pfcTable::GetRowCount()

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

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.

Returns:

void InsertColumn (xreal Width, optional xint InsertAfterColumn, optional xbool Repaint)

Inserts a column in the drawing table.

See Also:: pfcTable::GetColumnCount()

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

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.

Returns:

xreal GetRowSize (xint SegmentId, xint Row)

Returns the height of the row.

See Also:: pfcTable::GetRowCount(), pfcTable::GetSegmentCount()

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

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.

xreal GetColumnSize (xint SegmentId, xint Column)

Returns the width of the drawing table column.

See Also:: pfcTable::GetColumnCount(), pfcTable::GetSegmentCount()

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

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.

void MergeRegion (pfcTableCell_ptr UpperLeft, pfcTableCell_ptr LowerRight, optional xbool Repaint)

Merges a rectangular section of table cells.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

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.

Returns:

void SubdivideRegion (pfcTableCell_ptr UpperLeft, pfcTableCell_ptr LowerRight, optional xbool Repaint)

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

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

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.

Returns:

void DeleteRow (xint Row, optional xbool Repaint)

Deletes a row in the table.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

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

Returns:

void DeleteColumn (xint Column, optional xbool Repaint)

Deletes a column in the table.

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

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

Returns:

xint GetSegmentCount ()

Returns the number of segments in the table.

Manual References:: Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

Returns:: The number of segments.

xint GetSegmentSheet (xint SegmentNumber)

Returns the sheet where a particuar table segment lies.

Exceptions thrown (but not limited to):

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

See Also:: pfcTable::GetSegmentCount()

Manual References:: Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

Parameters:

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

Returns:: The sheet number.

void MoveSegment (xint SegmentNumber, pfcPoint3D_ptr NewPosition, optional xbool Repaint)

Moves a segment of the table.

Exceptions thrown (but not limited to):

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

Manual References:: Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

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.

Returns:

void SetText (pfcTableCell_ptr Cell, xstringsequence_ptr Lines)

Sets the text in the table cell.

Exceptions thrown (but not limited to):

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

See Also:: pfcTableCell::Create(xint, xint)

Manual References:: Drawings: Drawing Tables Operations, Drawings: Drawing Tables Operations

Parameters:

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

Returns:

xbool IsCommentCell (pfcTableCell_ptr Cell)

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

Manual References:: Drawings: Repeat Regions, Drawings: Repeat Regions

Parameters:

Cell: The table cell.

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

xstringsequence_ptr GetText (pfcTableCell_ptr Cell, pfcParamMode Mode)

Returns the text in a drawing table cell.

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

See Also:: pfcTableCell::Create(xint, xint)

Manual References:: Drawings: Drawing Tables Information, Drawings: Drawing Tables Information

Parameters:

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

Returns:: Sequence of text in the table cell.

optional pfcComponentPath_ptr GetCellComponentModel (pfcTableCell_ptr Cell)

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 pfcTable::GetCellTopModel(pfcTableCell_ptr) (for Top level model) or pfcTable::GetCellReferenceModel(pfcTableCell_ptr).

Exceptions thrown (but not limited to):

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

See Also:: pfcTableCell::Create(xint, xint)

Manual References:: Drawings: Repeat Regions, Drawings: Repeat Regions

Parameters:

Cell: The table cell.

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

optional pfcModelItem_ptr GetCellNote (pfcTableCell_ptr Cell)

Returns the detail note contained in the table cell.

Exceptions thrown (but not limited to):

pfcXToolkitEmpty - The cell is empty.

See Also:: pfcTableCell::Create(xint, xint)

Manual References:: Drawings: Drawing Tables Information

Parameters:

Cell: The table cell.

Returns:: The detail note item.

optional pfcAssembly_ptr GetCellTopModel (pfcTableCell_ptr Cell)

Returns the top model referred to by this cell in a repeat region drawing table. Differs from pfcTable::GetCellComponentModel(pfcTableCell_ptr) 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):

pfcXToolkitNotFound - The cell does not have an associated model.

See Also:: pfcTableCell::Create(xint, xint)

Manual References:: Drawings: Repeat Regions, Drawings: Repeat Regions

Parameters:

Cell: The table cell.

Returns:: The top model for the region.

optional pfcModel_ptr GetCellReferenceModel (pfcTableCell_ptr Cell)

Returns the reference component referred to by this cell in a repeat region drawing table. Differs from pfcTable::GetCellComponentModel(pfcTableCell_ptr) 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):

pfcXToolkitNotFound - The cell does not have an associated model.

See Also:: pfcTableCell::Create(xint, xint)

Manual References:: Drawings: Repeat Regions, Drawings: Repeat Regions

Parameters:

Cell: The table cell.

Returns:: The model of record for the cell.