IWbsField.SubHeader Property

Property SubHeader() As String

This language is not supported or no code example is available.

string SubHeader {get; set;}

This language is not supported or no code example is available.

Property Value

The sub-header text which is to be shown in the row below the field name.

Only some kinds of fields have sub-headers:

• Breakdown field. By default the sub-header contains breakdown discrete value(s). If IWbsFieldMasterBreakdownInfo.ShowMultipleFields property of the field is set to true, there are multiple columns shown. In this case, each column is represented by a separate IWbsField and has it's own sub-header.
• Progress field reference.  By default the sub-header contains referenced progress field name.

This value may be also an Excel formula which returns localized column names. So instead of hard-coded "Per unit", the following formula can be used: "=BoQXLS_PerUnit". In this case, you most likely don't need to set a text in other languages, because the formula will automatically display the localized string.

You need to call the IWbsFieldsRepository.EvaluateLocalizedFormula method if you want to get the evaluated result of the formula that is displayed to the user.

The SubHeader and SubHeaderMultilingual properties are connected. Any change in the SubHeader will modify also the SubHeaderMultilingual property. And vice-versa, a change in the SubHeaderMultilingual may modify also the SubHeader property.

.NET Framework