Hide Table of Contents
SetColumnType3 Method (ITableAnnotation)

Sets the type and property data for the specified BOM table column.

.NET Syntax

Visual Basic (Declaration) 
Function SetColumnType3( _
   ByVal Index As System.Integer, _
   ByVal ColumnType As System.Integer, _
   ByVal IncludeHidden As System.Boolean, _
   ByVal PropertyData As System.Object _
) As System.Integer
Visual Basic (Usage) 
Dim instance As ITableAnnotation
Dim Index As System.Integer
Dim ColumnType As System.Integer
Dim IncludeHidden As System.Boolean
Dim PropertyData As System.Object
Dim value As System.Integer
 
value = instance.SetColumnType3(Index, ColumnType, IncludeHidden, PropertyData)
C# 
System.int SetColumnType3( 
   System.int Index,
   System.int ColumnType,
   System.bool IncludeHidden,
   System.object PropertyData
)
C++/CLI 
System.int SetColumnType3( 
&   System.int Index,
&   System.int ColumnType,
&   System.bool IncludeHidden,
&   System.Object^ PropertyData
) 

Parameters

Index
0-based index of the column whose type to set
ColumnType
Type of column as defined in swTableColumnTypes_e (see Remarks)
IncludeHidden
True to include hidden columns in Index, false to not
PropertyData
Property data specific to ColumnType (see Remarks)

Return Value

Return code as defined in swColumnTypeStatus_e

Example

Remarks

PropertyData specifies the column title and contents.

If ColumnType is set to swTableColumnTypes_e.... Then Set PropertyData with...
swBomTableColumnType_CustomProperty Valid property name*
swBomTableColumnType_UnitOfMeasure Valid property name*
swBomTableColumnType_Equation Equation string
swBomTableColumnType_ComponentReference Null or Nothing
swBomTableColumnType_ToolboxProperty Property as defined in swToolBoxPropertyName_e
swBomTableColumnType_CutListProperties (valid only for sheetmetal parts) Valid cutlist property name*
swBomTableColumnType_ItemNumber  Array of four values {Start_Item_Int, Increment_Int, Order_balloons_and_BOM_to_follow_assembly_order_Bool, Do_not_change_BOM_item_number_Bool}
swBomTableColumnType_PartNumber True to use title summary, false to not

* Note: To get the valid property names for a given column type, open a part in SOLIDWORKS and add a BOM table to it. Right-click a column and select Insert > Column Right. In the popup, select the column type of interest in the first dropdown. Inspect the contents of the second dropdown to see the valid property names for the column type.

When you set a column type, the title is automatically changed to match that column type. If you change the column type to custom property, you must set the column title using ITableAnnotation::SetColumnTitle2.

This method is consistent with the SOLIDWORKS user interface where you cannot add, delete, or replace the Quantity type column in a BOM table.

 

See Also

Availability

SOLIDWORKS 2019 FCS, Revision Number 27.0


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SetColumnType3 Method (ITableAnnotation)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2019 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.