ApplyDatePeriodFilter Method (WorksheetFilterSettings)

Applies an DatePeriodFilter to the column.

Syntax

Visual Basic

'Declaration
 
Public Function ApplyDatePeriodFilter( _
   ByVal relativeColumnIndex As Integer, _
   ByVal type As DatePeriodFilterType, _
   ByVal value As Integer _
) As DatePeriodFilter

C#

public DatePeriodFilter ApplyDatePeriodFilter( 
   int relativeColumnIndex,
   DatePeriodFilterType type,
   int value
)

Parameters

relativeColumnIndex

A zero based column index relative to the Region

type

The type of date period to filter in.

value

The 1-based value of the month or quarter to filter in.

Exceptions

Exception	Description
System.InvalidOperationException	If the Region was not set.
System.ArgumentOutOfRangeException	If the relativeColumnIndex is outside of the Region.
System.ComponentModel.InvalidEnumArgumentException	type is not defined in the DatePeriodFilterType enumeration.
System.ArgumentException	type is Quarter and value is less than 1 or greater than 4 or type is Month and value is less than 1 or greater than 12.

Remarks

If the type is Month, a value of 1 indicates January, 2 indicates February, and so on. If type is Quarter, a value of 1 indicates Quarter 1, and so on.

Requirements

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