Interface Table
Description
This interface represents a drawing table in a Creo Parametric model.
See Also:
ModelItemOwner.ListItems(/*cipOptional*/ ModelItemType), ModelItemOwner.GetItemById(ModelItemType, int), TableOwner.CreateTable(TableCreateInstructions), TableOwner.RetrieveTable(TableRetrieveInstructions)
Direct Known Subclasses:
User Guide References:
Dimension Tolerances:Table, Drawings:Table, Annotation Features and Annotations:Table, Sheetmetal Part:Table, Sheetmetal Part:Table, Selection:Table, Accessing Selection Data:Table, Programmatic Selection:Table, User Interface Foundation Classes for Dialogs:Table, Getting a Model Object:Table, Custom Check Listeners:Table, Drawing Tables:Table, Creating Drawing Cells:Table, Selecting Drawing Tables and Cells:Table, Creating Drawing Tables:Table, Retrieving Drawing Tables:Table, Drawing Tables Information:Table, Drawing Tables Operations:Table, Drawing Table Segments:Table, Repeat Regions:Table, Solid Operations:Table, Accessing Material Properties:Table, Annotation Orientation:Table, Feature Information:Table, Setting the Family Table Instance Name:Table, Extracting Cross-Sectional Geometry:Table, Creating and Accessing Parameters:Table, Table Parameters:Table, Dimension Tolerances:Table, Family Tables:Table, Accessing Instances:Table, Accessing Columns:Table, Creating Family Table Instances:Table, Creating Family Table Columns:Table, Operations on Family Table Instances:Table, Family Table Utilities:Table, Export Instructions Table:Table, Printer Options:Table, Creo Object TOOLKIT Java Classes:Table
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Method Summary
boolean | CheckIfIsFromFormat (int SheetNumber) |
Identifies if the drawing table was created by the format. | |
void | DeleteColumn (int Column, /*cipOptional*/ Boolean Repaint) |
Deletes a column in the table. | |
void | DeleteRow (int Row, /*cipOptional*/ Boolean Repaint) |
Deletes a row in the table. | |
void | Display () |
Displays the table, if it has been erased. | |
void | Erase () |
Erases the table. | |
/*cipOptional*/ ComponentPath | |
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 functionsTable.GetCellTopModel(TableCell) (for Top level model) orTable.GetCellReferenceModel(TableCell). | |
/*cipOptional*/ ModelItem | |
Returns the detail note contained in the table cell. | |
/*cipOptional*/ Model | |
Returns the reference component referred to by this cell in a repeat region drawing table. Differs fromTable.GetCellComponentModel(TableCell) in that this function will return the reference object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL". | |
/*cipOptional*/ Assembly | |
Returns the top model referred to by this cell in a repeat region drawing table. Differs fromTable.GetCellComponentModel(TableCell) in that this function will return the object if the cell attribute is set to "NO DUPLICATE" or "NO DUPLICATE/LEVEL". | |
int | |
Returns the number of columns in the table. | |
double | GetColumnSize (int SegmentId, int Column) |
Returns the width of the drawing table column. | |
GetInfo (int SegmentId) | |
Returns information about the drawing table. | |
int | GetRowCount () |
Returns the number of rows in the table. | |
double | GetRowSize (int SegmentId, int Row) |
Returns the height of the row. | |
int | |
Returns the number of segments in the table. | |
int | GetSegmentSheet (int SegmentNumber) |
Returns the sheet where a particuar table segment lies. | |
Returns the text in a drawing table cell. | |
void | InsertColumn (double Width, /*cipOptional*/ Integer InsertAfterColumn, /*cipOptional*/ Boolean Repaint) |
Inserts a column in the drawing table. | |
void | InsertRow (double Height, /*cipOptional*/ Integer InsertAfterRow, /*cipOptional*/ Boolean Repaint) |
Inserts a new row into the table. | |
boolean | |
Determines if a table cell is a comment cell in a repeat region. | |
void | |
Merges a rectangular section of table cells. | |
void | |
Moves a segment of the table. | |
void | |
Rotates a table clockwise. | |
void | |
Sets the text in the table cell. | |
void | |
Removes all merges in the specified region of previously merged cells. |
Method Detail
GetRowCount | ||
int | GetRowCount | () |
Returns the number of rows in the table.
Exceptions thrown (but not limited to):
XToolkitNotExist - The specified table or drawing does not exist.
User Guide References:
Returns:
The number of rows.
GetColumnCount | ||
int | GetColumnCount | () |
Returns the number of columns in the table.
Exceptions thrown (but not limited to):
XToolkitNotExist - The specified table or drawing does not exist.
User Guide References:
Returns:
The number of columns.
Display | ||
void | Display | () |
Displays the table, if it has been erased.
See Also:
User Guide References:
Returns:
Erase | ||
void | Erase | () |
Erases the table.
See Also:
User Guide References:
Returns:
RotateClockwise | ||
void | RotateClockwise |
Rotates a table clockwise.
User Guide References:
Parameters:
Rotation
The amount of rotation.
Repaint
true to repaint the drawing with the changes, false or null to delay the repaint.
Returns:
CheckIfIsFromFormat | ||
boolean | CheckIfIsFromFormat | (int SheetNumber) |
Identifies if the drawing table was created by the format.
SheetNumber is ignored in this method.
User Guide References:
Parameters:
SheetNumber
The sheet number.
Returns:
true if the table was created by applying the drawing format.
GetInfo | ||
GetInfo | (int SegmentId) |
Returns information about the drawing table.
See Also:
User Guide References:
Parameters:
SegmentId
The segment identifier. Segment ids start at 0.
Returns:
The table information, including the rotation, column and row information, and outline.
InsertRow | ||
void | InsertRow | (double Height, /*cipOptional*/ Integer InsertAfterRow, /*cipOptional*/ Boolean Repaint) |
Inserts a new row into the table.
See Also:
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:
User Guide References:
InsertColumn | ||
void | InsertColumn | (double Width, /*cipOptional*/ Integer InsertAfterColumn, /*cipOptional*/ Boolean Repaint) |
Inserts a column in the drawing table.
See Also:
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:
User Guide References:
GetRowSize | ||
double | GetRowSize | (int SegmentId, int Row) |
Returns the height of the row.
See Also:
User Guide References:
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.
GetColumnSize | ||
double | GetColumnSize | (int SegmentId, int Column) |
Returns the width of the drawing table column.
See Also:
User Guide References:
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.
MergeRegion | ||
void | MergeRegion |
Merges a rectangular section of table cells.
User Guide References:
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:
SubdivideRegion | ||
void | SubdivideRegion |
Removes all merges in the specified region of previously merged cells.
User Guide References:
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:
DeleteRow | ||
void | DeleteRow | (int Row, /*cipOptional*/ Boolean Repaint) |
Deletes a row in the table.
User Guide References:
Parameters:
Row
Repaint
true to repaint the drawing with the changes, false or null to delay the repaint.
Returns:
DeleteColumn | ||
void | DeleteColumn | (int Column, /*cipOptional*/ Boolean Repaint) |
Deletes a column in the table.
User Guide References:
Parameters:
Column
Repaint
true to repaint the drawing with the changes, false or null to delay the repaint.
Returns:
GetSegmentCount | ||
int | GetSegmentCount | () |
Returns the number of segments in the table.
User Guide References:
Returns:
The number of segments.
GetSegmentSheet | ||
int | GetSegmentSheet | (int SegmentNumber) |
Returns the sheet where a particuar table segment lies.
Exceptions thrown (but not limited to):
XToolkitBadContext - A -1 segment ID was used for a multiple segment table.
See Also:
User Guide References:
Parameters:
SegmentNumber
The segement identifier. Segment ids start at 0.
Returns:
The sheet number.
MoveSegment | ||
void | MoveSegment |
Moves a segment of the table.
Exceptions thrown (but not limited to):
XToolkitBadContext - A -1 segment ID was used for a multiple segment table.
User Guide References:
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:
Sets the text in the table cell.
Exceptions thrown (but not limited to):
XToolkitBadContext - A -1 segment ID was used for a multiple segment table.
See Also:
User Guide References:
Parameters:
Cell
The table cell.
Lines
The text for the table cell.
Returns:
IsCommentCell | ||
boolean | IsCommentCell |
Determines if a table cell is a comment cell in a repeat region.
User Guide References:
Parameters:
Cell
The table cell.
Returns:
Whether or not the cell is a comment cell.
Returns the text in a drawing table cell.
If no text is found in the table cell, this method will throw a XToolkitGeneralError exception.
See Also:
User Guide References:
Parameters:
Cell
The table cell.
Mode
The mode used to retrieve the text.
Returns:
Sequence of text in the table cell.
GetCellComponentModel | ||
/*cipOptional*/ ComponentPath | GetCellComponentModel |
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 Table.GetCellTopModel(TableCell) (for Top level model) or Table.GetCellReferenceModel(TableCell).
Exceptions thrown (but not limited to):
XToolkitNotFound - The table cell does not contain a reference to a component model.
See Also:
User Guide References:
Parameters:
Cell
The table cell.
Returns:
The full path to the component referenced by the cell.
Returns the detail note contained in the table cell.
Exceptions thrown (but not limited to):
XToolkitEmpty - The cell is empty.
See Also:
User Guide References:
Parameters:
Cell
The table cell.
Returns:
The detail note item.
Returns the top model referred to by this cell in a repeat region drawing table. Differs from Table.GetCellComponentModel(TableCell) 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):
XToolkitNotFound - The cell does not have an associated model.
See Also:
User Guide References:
Parameters:
Cell
The table cell.
Returns:
The top model for the region.
Returns the reference component referred to by this cell in a repeat region drawing table. Differs from Table.GetCellComponentModel(TableCell) 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):
XToolkitNotFound - The cell does not have an associated model.
See Also:
User Guide References:
Parameters:
Cell
The table cell.
Returns:
The model of record for the cell.