GetHiddenColumns Method

Gets the hidden columns associated with the specified worksheet.

Syntax

Visual Basic

'Declaration
 
Public Function GetHiddenColumns( _
   ByVal worksheet As Worksheet, _
   Optional ByVal createIfNull As Boolean _
) As HiddenColumnCollection

C#

public HiddenColumnCollection GetHiddenColumns( 
   Worksheet worksheet,
   bool createIfNull
)

Parameters

worksheet

The worksheet whose associated hidden columns are to be retrieved.

createIfNull

True to create the hidden column if it has not yet been allocated of the Worksheet. The options will be initialized based on the current state. Note the options should only have been null if there were no options for the Worksheet when the Workbook was loaded. Also this will not allocate the collection unless the SaveHiddenRowsAndColumns is true.

Return Value

Null if SaveHiddenRowsAndColumns is False or if the worksheet does not belong to the workbook associated with this custom view; otherwise, the collection of hidden columns associated with the worksheet.

Exceptions

Exception	Description
System.ArgumentNullException	worksheet is null.

Remarks

Adding columns on the returned HiddenColumnCollection instance will not actually hide columns in the worksheet. After modifying the hidden columns in this collection, the Apply method of the CustomView will hide or unhide the columns.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2