ApplyDatePeriodFilter Method (WorksheetFilterSettings)

Applies an DatePeriodFilter to the column.

Syntax

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: Android 4.4+, iOS 8+

Development Environments: Visual Studio 2015+, Visual Studio for Mac Preview, Xamarin for Visual Studio 4.2+