IWbs.InsertColumnIntoWorkbook Method

NOTE: This member is now obsolete. Use Qdv.UserApi.Fields.IWbsFieldsRepository.AddField instead. This is a newer and more flexible API that was introduced in QDV 7.18.655. Access the WBS fields via Qdv.UserApi.IEstimate.WbsFieldsRepository property.

Inserts a new user/free/special column in WBS.
<Obsolete("Use Qdv.UserApi.Fields.IWbsFieldsRepository.AddField instead.
This is a newer and more flexible API that was introduced in QDV 7.18.655. Access the WBS fields via Qdv.UserApi.IEstimate.WbsFieldsRepository property.")> _ 
Sub InsertColumnIntoWorkbook( _ 
ByVal ColumnID As String, _ 
Optional ByVal BeforeColumn As Integer = 0 _ 
)
This language is not supported or no code example is available.
[Obsolete("Use Qdv.UserApi.Fields.IWbsFieldsRepository.AddField instead.
This is a newer and more flexible API that was introduced in QDV 7.18.655. Access the WBS fields via Qdv.UserApi.IEstimate.WbsFieldsRepository property.")] 
void InsertColumnIntoWorkbook( 
string ColumnID
int BeforeColumn = 0 
)
This language is not supported or no code example is available.

Parameters

ColumnID
string

The column ID (usually a mnemonic) of the field to be inserted. See remarks for details.

BeforeColumn
int

Optional. The column before which the new column must be inserted. The leftmost  column is column 0.

Exception type Condition

QdvApiException

A problem occurred.

Remarks
 

In order to have such changes taken into account, you must call the IEstimate.CheckAndRepaint method.

Syntax of the column ID

Free fields

If the ColumnID is an empty string, then a new free field will be inserted and a new mnemonic will be automatically generated in the form 'Col_XYZ'.

If the ColumnID is a simple mnemonic, then a new free field will be inserted with this mnemonic.

Special fields

If the ColumnID starts with an underscore character or it is some known special field mnemonic, then a new special field will be inserted with this mnemonic.

Progress fields

If the field is a progress field pointing to a breakdown field, the ColumnID consists of multiple breakdown parts delimited by '|' character. The progress field reference contains also the progress level number, as a suffix starting with $ and an underscore character instead of the minus sign. The format of such column ID is:

%MainBreakdownField%|%BreakdownByField%|%BreakdownValue%|Field|%VHWQUEPZ_flags%

The meaning of the flags is as follows:

H: Hidden by admin. This is editable only by admin. For other users, the user-specific info is used. 
V: Visible (by admin), may be omitted 
U: Use Unit instead of Total field in WBS +Details reports; for breakdown value 
W: Show totals (using WBS quantity); for breakdown value 
E: Hide in Estimate (doesn't apply to admin in edit mode) 
P: Hide in Progress statement (doesn't apply to admin in edit mode) 
Q: Return value to Quantity column (Progress) 
Z: Return value to Quantity column (Estimate) 

A sample column ID for a breakdown field from progress statement -2 may look like:

MAT_TotalCost$_2|MAT_Currency$_2|EUR,GBP|Field|UEV

Version
 
Available since QDV 7.13.0001.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition