CIP JAVA documentation for class "com.ptc.wfc.wfcTable.WTable"

Interface WTable

package com.ptc.wfc.wfcTable; public interface WTable extends com.ptc.wfc.wfcModelItem.WModelItem, com.ptc.wfc.wfcLayerState.LayerItem, com.ptc.pfc.pfcTable.Table

Description

Extends the functionality of Table

This is the actual type of Table Items in Object Toolkit.

Method Summary
`TableGrowthDirType`	`GetGrowthDirection ()` Gets the growth direction for the drawing table.
`TableRowheightAutoadjustType`	`GetRowHeightAutoAdjustType (int Row)` Get the automatic row height adjustment property for a row of a drawing table.
`SegmentExtents`	`GetSegmentExtents (int SegmentId)` Returns the start/end rows and columns of a particular table segment.
`void`	`Save (String TargetPath, TableFormatType FormatType, /optional/ Integer SegmentId)` Save table in different format.
`void`	`SetColumnWidth (double Width, int ColumnId, TableSizeType Type)` Set the column width of a drawing table.
`void`	`SetGrowthDirection (TableGrowthDirType Type)` Sets the growth direction for the drawing table.
`void`	`SetRowHeight (double Height, int RowId, TableSizeType Type)` Set the row height of a drawing table.
`void`	`SetRowHeightAutoAdjustType (int Row, TableRowheightAutoadjustType Type)` Set the automatic row height adjustment property for a row of a drawing table.
`void`	`SetSegmentOrigin (int SegmentId, Point3D Origin)` Set table segment origin.
`void`	`WrapCelltext (int RowId, int ColumnId)` Wrap text in cell

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Methods Inherited from Interface `com.ptc.wfc.wfcLayerState.LayerItem`
`IsLayerItemVisible`, `RemoveNoUpdate`, `GetLayers`, `AddNoUpdate`

Methods Inherited from Interface `com.ptc.pfc.pfcTable.Table`
`GetRowCount`, `GetColumnCount`, `Display`, `Erase`, `RotateClockwise`, `CheckIfIsFromFormat`, `GetInfo`, `InsertRow`, `InsertColumn`, `GetRowSize`, `GetColumnSize`, `MergeRegion`, `SubdivideRegion`, `DeleteRow`, `DeleteColumn`, `GetSegmentCount`, `GetSegmentSheet`, `MoveSegment`, `SetText`, `IsCommentCell`, `GetText`, `GetCellComponentModel`, `GetCellNote`, `GetCellTopModel`, `GetCellReferenceModel`

Methods Inherited from Interface com.ptc.pfc.pfcTable.Table

GetRowCount, GetColumnCount, Display, Erase, RotateClockwise, CheckIfIsFromFormat, GetInfo, InsertRow, InsertColumn, GetRowSize, GetColumnSize, MergeRegion, SubdivideRegion, DeleteRow, DeleteColumn, GetSegmentCount, GetSegmentSheet, MoveSegment, SetText, IsCommentCell, GetText, GetCellComponentModel, GetCellNote, GetCellTopModel, GetCellReferenceModel

Method Detail

SetColumnWidth

void SetColumnWidth (double Width, int ColumnId, TableSizeType Type)

Set the column width of a drawing table.

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

Parameters:

Width: Column width
ColumnId: The column index. Column indices start at 1.
Type: Size type. If pfcTABLESIZE_BY_NUM_CHARS, then row_height column_width will be rounded down.

Returns:

GetSegmentExtents

SegmentExtents GetSegmentExtents (int SegmentId)

Returns the start/end rows and columns of a particular table segment.

Exceptions thrown (but not limited to):

XToolkitBadContext - -1 was used for multiple-segment table.

Manual References:: Drawings: Drawing Table Segments

Parameters:

SegmentId: The table segment id. Pass -1 for a single segment table.

Returns:: The segment extents.

SetRowHeight

void SetRowHeight (double Height, int RowId, TableSizeType Type)

Set the row height of a drawing table.

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

Parameters:

Height: Row height.
RowId: The row index.
Type: Size type. If pfcTABLESIZE_BY_NUM_CHARS, then row_height will be rounded down.

Returns:

WrapCelltext

void WrapCelltext (int RowId, int ColumnId)

Wrap text in cell

Manual References:: Drawings: Drawing Tables Operations

Parameters:

RowId: The row index
ColumnId: The column index

Returns:

SetSegmentOrigin

void SetSegmentOrigin (int SegmentId, Point3D Origin)

Set table segment origin.

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

Parameters:

SegmentId: The segment identifier.
Origin: Point location of the segment.

Returns:

Save

void Save (String TargetPath, TableFormatType FormatType, /*optional*/ Integer SegmentId)

Save table in different format.

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

Parameters:

TargetPath: Full path of the saved location.
FormatType: Save format of the drawing table.
SegmentId: segment of the table to save if table_format is wfcTABLEFORMAT_CSV.

Returns:

SetGrowthDirection

void SetGrowthDirection (TableGrowthDirType Type)

Sets the growth direction for the drawing table.

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

Parameters:

Type: The growth direction type.

Returns:

GetGrowthDirection

TableGrowthDirType GetGrowthDirection ()

Gets the growth direction for the drawing table.

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

Returns:: The growth direction type.

SetRowHeightAutoAdjustType

void SetRowHeightAutoAdjustType (int Row, TableRowheightAutoadjustType Type)

Set the automatic row height adjustment property for a row of a drawing table.

Height changes (if any) will be visible only after next regeneration or a call to pfcModel2D::UpdateTables().

Exceptions thrown (but not limited to):

XToolkitCantModify - The row is a non-template repeat region row.

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

Parameters:

Row: Row number for which the property is to be set. Row numbers start with 1.
Type: The auto-adjust property. wfcTBLROWHEIGHT_AUTOADJUST_TRUE to activate auto adjust. wfcTBLROWHEIGHT_AUTOADJUST_FALSE to deactivate auto adjust.

Returns:

GetRowHeightAutoAdjustType

TableRowheightAutoadjustType GetRowHeightAutoAdjustType (int Row)

Get the automatic row height adjustment property for a row of a drawing table.

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

Parameters:

Row: Row number for which the property is to be retrieved. Row numbers start with 1.

Returns:: Retrieved value for auto-adjust property.