IWbs.GetColumnHeading Method

NOTE: This member is now obsolete. Use Qdv.UserApi.Fields.IWbsField.FieldName and Qdv.UserApi.Fields.IWbsField.SubHeader 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.

Returns the heading of a column in the WBS. Gets the displayed name and the parent name.
<Obsolete("Use Qdv.UserApi.Fields.IWbsField.FieldName and Qdv.UserApi.Fields.IWbsField.SubHeader 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.")> _ 
Function GetColumnHeading( _ 
ByVal FieldMnemonic As String
) As ColumnHeading
This language is not supported or no code example is available.
[Obsolete("Use Qdv.UserApi.Fields.IWbsField.FieldName and Qdv.UserApi.Fields.IWbsField.SubHeader 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.")] 
ColumnHeading GetColumnHeading( 
string FieldMnemonic 
)
This language is not supported or no code example is available.

Parameters

FieldMnemonic
string

The unique identifier to the WBS field (Mnemonic).

Return Value

ColumnHeading

A column heading info which contains the parent name, the displayed name of the column and the identifier (number) of the column. The latter is mostly used in the formulas of the BOQ.

The method returns null reference (Nothing in Visual Basic) if the name couldn't be retrieved, e.g. the column with FieldMnemonic wasn't found.

Remarks
 
ParentName and DisplayedName are returned 'as is', meaning that they have all characters including possible CR or LF. Those special characters are removed when reading the DisplayedName using the ColumnMappings property.
Version
 
Available since QDV 7.13.0001.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition