IWbsFieldsRepository.IsColumnVisible Method

Namespace: Qdv.UserApi.Fields
Assembly: Qdv.UserApi (in Qdv.UserApi.dll)

Indicates whether a field's column is visible in the current context. All available settings and permissions are taken into account.

C++

JScript

Copy

Function IsColumnVisible( _ 
   ByVal field As IWbsField _ 
) As Boolean

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

C++

JScript

Copy

bool IsColumnVisible( 
   IWbsField field 
)

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

Parameters

field: IWbsField

The field for which the info is to be retrieved.

Return Value

bool

A value indicating whether the field's column is visible in the current context.

Remarks

The result of this method may be different than IColumnFormatting.HiddenByUser value of the field referenced by the field. It's because the IColumnFormatting.HiddenByUser property is not enough to determine, whether the field is visible in a particular context. It only indicates whether the column was explicitly hidden by a user or admin. If this property is set to false, it doesn't necessarily mean that the column is visible. Some other criteria may cause it to be invisible, such as hidden globally by admin, user profile permissions or visibility for progress statements or for estimate. For example, if we are in the 'Progress statement' mode and the IWbsField.VisibleInProgress is set to false, then the column is invisible regardless of a value of its IColumnFormatting.HiddenByUser and IColumnFormatting.HiddenByAdmin properties.

However, the method doesn't take into account whether the column is invisible because it is collapsed with the + and - icon in the header.

Version

Available since QDV 7.18.655.

Applies to

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

IWbsFieldsRepository.IsColumnVisible Method

Parameters

Return Value

.NET Framework

In this article