CIP JavaScript documentation for class " pfcTable"

Class pfcTable

Description

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

See Also:: pfcModelItemOwner.ListItems(), pfcModelItemOwner.GetItemById(), pfcTableOwner.CreateTable(), pfcTableOwner.RetrieveTable()

Direct Parent Classes:: pfcModelItem

Method Summary


`boolean`	`CheckIfIsFromFormat (number SheetNumber)`
	Identifies if the drawing table was created by the format.

`void`	`DeleteColumn (number Column, /* optional */ boolean Repaint)`
	Deletes a column in the table.

`void`	`DeleteRow (number Row, /* optional */ boolean Repaint)`
	Deletes a row in the table.

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

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

`/* optional */ pfcComponentPath`	`GetCellComponentModel (pfcTableCell 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()` (for Top level model) or `pfcTable.GetCellReferenceModel()`.

`/* optional */ pfcModelItem`	`GetCellNote (pfcTableCell Cell)`
	Returns the detail note contained in the table cell.

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

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

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

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

`pfcTableInfo`	`GetInfo (number SegmentId)`
	Returns information about the drawing table.

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

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

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

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

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

`void`	`InsertColumn (number Width, /* optional / number InsertAfterColumn, / optional */ boolean Repaint)`
	Inserts a column in the drawing table.

`void`	`InsertRow (number Height, /* optional / number InsertAfterRow, / optional */ boolean Repaint)`
	Inserts a new row into the table.

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

`void`	`MergeRegion (pfcTableCell UpperLeft, pfcTableCell LowerRight, /* optional */ boolean Repaint)`
	Merges a rectangular section of table cells.

`void`	`MoveSegment (number SegmentNumber, pfcPoint3D NewPosition, /* optional */ boolean Repaint)`
	Moves a segment of the table.

`void`	`RotateClockwise (pfcRotationDegree Rotation, /* optional */ boolean Repaint)`
	Rotates a table clockwise.

`void`	`SetText (pfcTableCell Cell, stringseq Lines)`
	Sets the text in the table cell.

`void`	`SubdivideRegion (pfcTableCell UpperLeft, pfcTableCell LowerRight, /* optional */ boolean Repaint)`
	Removes all merges in the specified region of previously merged cells.

Method Detail

boolean CheckIfIsFromFormat (number SheetNumber)

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.

void DeleteColumn (number Column, /* optional */ boolean Repaint)

Deletes a column in the table.

Parameters:

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

void DeleteRow (number Row, /* optional */ boolean Repaint)

Deletes a row in the table.

Parameters:

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

void Display ()

Displays the table, if it has been erased.

See Also:: pfcTable.Erase()

void Erase ()

Erases the table.

See Also:: pfcTable.Display()

/* optional */ pfcComponentPath GetCellComponentModel (pfcTableCell 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() (for Top level model) or pfcTable.GetCellReferenceModel().

Exceptions thrown (but not limited to):

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

See Also:: pfcTableCell.Create()

Parameters:

Cell: The table cell.

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

/* optional */ pfcModelItem GetCellNote (pfcTableCell 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()

Parameters:

Cell: The table cell.

Returns:: The detail note item.

/* optional */ pfcModel GetCellReferenceModel (pfcTableCell Cell)

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

pfcXToolkitNotFound - The cell does not have an associated model.

See Also:: pfcTableCell.Create()

Parameters:

Cell: The table cell.

Returns:: The model of record for the cell.

/* optional */ pfcAssembly GetCellTopModel (pfcTableCell Cell)

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

pfcXToolkitNotFound - The cell does not have an associated model.

See Also:: pfcTableCell.Create()

Parameters:

Cell: The table cell.

Returns:: The top model for the region.

number GetColumnCount ()

Returns the number of columns in the table.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The specified table or drawing does not exist.

Returns:: The number of columns.

number GetColumnSize (number SegmentId, number Column)

Returns the width of the drawing table column.

See Also:: pfcTable.GetColumnCount(), pfcTable.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.

pfcTableInfo GetInfo (number SegmentId)

Returns information about the drawing table.

See Also:: pfcTable.GetSegmentCount()

Parameters:

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

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

number GetRowCount ()

Returns the number of rows in the table.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The specified table or drawing does not exist.

Returns:: The number of rows.

number GetRowSize (number SegmentId, number Row)

Returns the height of the row.

See Also:: pfcTable.GetRowCount(), pfcTable.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.

number GetSegmentCount ()

Returns the number of segments in the table.

Returns:: The number of segments.

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

Parameters:

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

Returns:: The sheet number.

stringseq GetText (pfcTableCell 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()

Parameters:

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

Returns:: Sequence of text in the table cell.

void InsertColumn (number Width, /* optional */ number InsertAfterColumn, /* optional */ boolean Repaint)

Inserts a column in the drawing table.

See Also:: pfcTable.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.

void InsertRow (number Height, /* optional */ number InsertAfterRow, /* optional */ boolean Repaint)

Inserts a new row into the table.

See Also:: pfcTable.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.

boolean IsCommentCell (pfcTableCell Cell)

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.

void MergeRegion (pfcTableCell UpperLeft, pfcTableCell LowerRight, /* optional */ boolean Repaint)

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.

void MoveSegment (number SegmentNumber, pfcPoint3D NewPosition, /* optional */ boolean 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.

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.

void RotateClockwise (pfcRotationDegree Rotation, /* optional */ boolean Repaint)

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.

void SetText (pfcTableCell Cell, stringseq 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()

Parameters:

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

void SubdivideRegion (pfcTableCell UpperLeft, pfcTableCell LowerRight, /* optional */ boolean Repaint)

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.