GetSheetDisplayOptions Method

Gets the display options associated with the specified sheet.

Syntax

Visual Basic

'Declaration
 
Public Function GetSheetDisplayOptions( _
   ByVal sheet As Sheet, _
   Optional ByVal createIfNull As Boolean _
) As DisplayOptionsBase

C#

public DisplayOptionsBase GetSheetDisplayOptions( 
   Sheet sheet,
   bool createIfNull
)

Parameters

sheet

The sheet whose associated display options are to be retrieved.

createIfNull

True to create the display options if it has not yet been allocated. The options will be initialized based on the current state of the Sheet. Note the options should only have been null if there were no options for the Sheet when the Workbook was loaded.

Return Value

Null if the sheet does not belong to the workbook associated with this custom view; otherwise, the display options associated with the worksheet.

Exceptions

Exception	Description
System.ArgumentNullException	sheet is null.

Remarks

Setting properties on the returned DisplayOptionsBase instance will not change the actual display of the sheet. After setting properties, the Apply method of the CustomView will apply them to the sheet.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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