CIP C++ documentation for class "wfcWTable"

Class wfcWTable

# include <wfcTable.h> class wfcWTable : public virtual wfcWModelItem, : public virtual wfcLayerItem, : public virtual pfcTable { xaideclare(wfcWTable) ... };

Description

Extends the functionality of pfcTable

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

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`wfcTableGrowthDirType`	`GetGrowthDirection ()`
	Gets the growth direction for the drawing table.

`wfcTableRowheightAutoadjustType`	`GetRowHeightAutoAdjustType (xint Row)`
	Get the automatic row height adjustment property for a row of a drawing table.

`wfcSegmentExtents_ptr`	`GetSegmentExtents (xint SegmentId)`
	Returns the start/end rows and columns of a particular table segment.

`void`	`Save (xrstring TargetPath, wfcTableFormatType FormatType, optional xint SegmentId)`
	Save table in different format.

`void`	`SetColumnWidth (xreal Width, xint ColumnId, pfcTableSizeType Type)`
	Set the column width of a drawing table.

`void`	`SetGrowthDirection (wfcTableGrowthDirType Type)`
	Sets the growth direction for the drawing table.

`void`	`SetRowHeight (xreal Height, xint RowId, pfcTableSizeType Type)`
	Set the row height of a drawing table.

`void`	`SetRowHeightAutoAdjustType (xint Row, wfcTableRowheightAutoadjustType Type)`
	Set the automatic row height adjustment property for a row of a drawing table.

`void`	`SetSegmentOrigin (xint SegmentId, pfcPoint3D_ptr Origin)`
	Set table segment origin.

`void`	`WrapCelltext (xint RowId, xint ColumnId)`
	Wrap text in cell

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

Methods Inherited from Class pfcParent:: GetChild

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

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

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

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

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

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Methods Inherited from Class wfcLayerItem:: IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Class pfcTable:: 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

void SetColumnWidth (xreal Width, xint ColumnId, pfcTableSizeType 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:

wfcSegmentExtents_ptr GetSegmentExtents (xint SegmentId)

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

Exceptions thrown (but not limited to):

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

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

Parameters:

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

Returns:: The segment extents.

void SetRowHeight (xreal Height, xint RowId, pfcTableSizeType 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:

void WrapCelltext (xint RowId, xint ColumnId)

Wrap text in cell

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

Parameters:

RowId: The row index
ColumnId: The column index

Returns:

void SetSegmentOrigin (xint SegmentId, pfcPoint3D_ptr 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:

void Save (xrstring TargetPath, wfcTableFormatType FormatType, optional xint 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:

void SetGrowthDirection (wfcTableGrowthDirType 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:

wfcTableGrowthDirType GetGrowthDirection ()

Gets the growth direction for the drawing table.

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

Returns:: The growth direction type.

void SetRowHeightAutoAdjustType (xint Row, wfcTableRowheightAutoadjustType 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):

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

Manual References:: 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:

wfcTableRowheightAutoadjustType GetRowHeightAutoAdjustType (xint 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.