API Reference

Class

ExcelPivotFilter

Edit on GitHub

Namespace OfficeIMO.Excel

Assembly OfficeIMO.Excel

Source OfficeIMO.Excel/ExcelPivotFilter.cs:65

Modifiers sealed

Describes a pivot table label or value filter to author.

Inheritance

Object
ExcelPivotFilter

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Method ExcelPivotFilter.BottomCount
Method ExcelPivotFilter.BottomPercent
Method ExcelPivotFilter.BottomSum
Method ExcelPivotFilter.Date
Method ExcelPivotFilter.DateBetween
Method ExcelPivotFilter.DateEquals
Method ExcelPivotFilter.DateLastMonth
Method ExcelPivotFilter.DateLastQuarter
Method ExcelPivotFilter.DateLastWeek
Method ExcelPivotFilter.DateLastYear
Method ExcelPivotFilter.DateMonth
Method ExcelPivotFilter.DateNewerThan
Method ExcelPivotFilter.DateNewerThanOrEqual
Method ExcelPivotFilter.DateNextMonth
Method ExcelPivotFilter.DateNextQuarter
Method ExcelPivotFilter.DateNextWeek
Method ExcelPivotFilter.DateNextYear
Method ExcelPivotFilter.DateNotBetween
Method ExcelPivotFilter.DateNotEquals
Method ExcelPivotFilter.DateOlderThan
Method ExcelPivotFilter.DateOlderThanOrEqual
Method ExcelPivotFilter.DateQuarter
Method ExcelPivotFilter.DateThisMonth
Method ExcelPivotFilter.DateThisQuarter
Method ExcelPivotFilter.DateThisWeek
Method ExcelPivotFilter.DateThisYear
Method ExcelPivotFilter.DateToday
Method ExcelPivotFilter.DateTomorrow
Method ExcelPivotFilter.DateYearToDate
Method ExcelPivotFilter.DateYesterday
Method ExcelPivotFilter.DynamicDate
Method ExcelPivotFilter.Label
Method ExcelPivotFilter.LabelBeginsWith
Method ExcelPivotFilter.LabelBetween
Method ExcelPivotFilter.LabelContains
Method ExcelPivotFilter.LabelEndsWith
Method ExcelPivotFilter.LabelEquals
Method ExcelPivotFilter.LabelGreaterThan
Method ExcelPivotFilter.LabelGreaterThanOrEqual
Method ExcelPivotFilter.LabelLessThan
Method ExcelPivotFilter.LabelLessThanOrEqual
Method ExcelPivotFilter.LabelNotBeginsWith
Method ExcelPivotFilter.LabelNotBetween
Method ExcelPivotFilter.LabelNotContains
Method ExcelPivotFilter.LabelNotEndsWith
Method ExcelPivotFilter.LabelNotEquals
Method ExcelPivotFilter.TopCount
Method ExcelPivotFilter.TopPercent
Method ExcelPivotFilter.TopSum
Method ExcelPivotFilter.Value
Method ExcelPivotFilter.ValueBetween
Method ExcelPivotFilter.ValueEquals
Method ExcelPivotFilter.ValueGreaterThan
Method ExcelPivotFilter.ValueGreaterThanOrEqual
Method ExcelPivotFilter.ValueLessThan
Method ExcelPivotFilter.ValueLessThanOrEqual
Method ExcelPivotFilter.ValueNotBetween
Method ExcelPivotFilter.ValueNotEquals

Accepted by parameters

Method ExcelSheet.AddPivotTable parameter pivotFilters
Method PivotTableBuilder.Filter parameter filters

Methods

public static ExcelPivotFilter BottomCount(String fieldName, String dataFieldName, Int32 count, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:157

Returns: ExcelPivotFilter

Creates a bottom-count pivot filter for the specified data field.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
count System.Int32 requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter BottomPercent(String fieldName, String dataFieldName, Int32 percent, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:165

Returns: ExcelPivotFilter

Creates a bottom-percent pivot filter for the specified data field.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
percent System.Int32 requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter BottomSum(String fieldName, String dataFieldName, Double value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:173

Returns: ExcelPivotFilter

Creates a bottom-sum pivot filter for the specified data field.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
value System.Double requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter Date(String fieldName, PivotFilterValues type, DateTime value1, Nullable<DateTime> value2 = null, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:315

Returns: ExcelPivotFilter

Creates a fixed date pivot filter using a supported Open XML pivot filter type.

Parameters

fieldName System.String requiredposition: 0
type DocumentFormat.OpenXml.Spreadsheet.PivotFilterValues requiredposition: 1
value1 System.DateTime requiredposition: 2
value2 System.Nullable{System.DateTime} = null optionalposition: 3
name System.String = null optionalposition: 4
description System.String = null optionalposition: 5

public static ExcelPivotFilter DateBetween(String fieldName, DateTime from, DateTime to, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:201

Returns: ExcelPivotFilter

Creates a date-between pivot filter.

Parameters

fieldName System.String requiredposition: 0
from System.DateTime requiredposition: 1
to System.DateTime requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter DateEquals(String fieldName, DateTime value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:177

Returns: ExcelPivotFilter

Creates a date-equals pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.DateTime requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter DateLastMonth(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:237

Returns: ExcelPivotFilter

Creates a dynamic date filter for last month.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateLastQuarter(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:249

Returns: ExcelPivotFilter

Creates a dynamic date filter for last quarter.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateLastWeek(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:225

Returns: ExcelPivotFilter

Creates a dynamic date filter for last week.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateLastYear(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:261

Returns: ExcelPivotFilter

Creates a dynamic date filter for last year.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateMonth(String fieldName, Int32 month, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:274

Returns: ExcelPivotFilter

Creates a dynamic date filter for a calendar month.

Parameters

fieldName System.String requiredposition: 0
month System.Int32 requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter DateNewerThan(String fieldName, DateTime value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:185

Returns: ExcelPivotFilter

Creates a date-newer-than pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.DateTime requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter DateNewerThanOrEqual(String fieldName, DateTime value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:189

Returns: ExcelPivotFilter

Creates a date-newer-than-or-equal pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.DateTime requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter DateNextMonth(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:241

Returns: ExcelPivotFilter

Creates a dynamic date filter for next month.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateNextQuarter(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:253

Returns: ExcelPivotFilter

Creates a dynamic date filter for next quarter.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateNextWeek(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:229

Returns: ExcelPivotFilter

Creates a dynamic date filter for next week.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateNextYear(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:265

Returns: ExcelPivotFilter

Creates a dynamic date filter for next year.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateNotBetween(String fieldName, DateTime from, DateTime to, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:205

Returns: ExcelPivotFilter

Creates a date-not-between pivot filter.

Parameters

fieldName System.String requiredposition: 0
from System.DateTime requiredposition: 1
to System.DateTime requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter DateNotEquals(String fieldName, DateTime value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:181

Returns: ExcelPivotFilter

Creates a date-not-equals pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.DateTime requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter DateOlderThan(String fieldName, DateTime value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:193

Returns: ExcelPivotFilter

Creates a date-older-than pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.DateTime requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter DateOlderThanOrEqual(String fieldName, DateTime value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:197

Returns: ExcelPivotFilter

Creates a date-older-than-or-equal pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.DateTime requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter DateQuarter(String fieldName, Int32 quarter, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:293

Returns: ExcelPivotFilter

Creates a dynamic date filter for a calendar quarter.

Parameters

fieldName System.String requiredposition: 0
quarter System.Int32 requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter DateThisMonth(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:233

Returns: ExcelPivotFilter

Creates a dynamic date filter for this month.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateThisQuarter(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:245

Returns: ExcelPivotFilter

Creates a dynamic date filter for this quarter.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateThisWeek(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:221

Returns: ExcelPivotFilter

Creates a dynamic date filter for this week.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateThisYear(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:257

Returns: ExcelPivotFilter

Creates a dynamic date filter for this year.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateToday(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:209

Returns: ExcelPivotFilter

Creates a dynamic date filter for today.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateTomorrow(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:217

Returns: ExcelPivotFilter

Creates a dynamic date filter for tomorrow.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateYearToDate(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:269

Returns: ExcelPivotFilter

Creates a dynamic date filter for year-to-date.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DateYesterday(String fieldName, String name = null, String description = null) #

OfficeIMO.Excel/ExcelPivotFilter.cs:213

Returns: ExcelPivotFilter

Creates a dynamic date filter for yesterday.

Parameters

fieldName System.String requiredposition: 0
name System.String = null optionalposition: 1
description System.String = null optionalposition: 2

public static ExcelPivotFilter DynamicDate(String fieldName, PivotFilterValues type, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:326

Returns: ExcelPivotFilter

Creates a dynamic date pivot filter using a supported Open XML pivot filter type.

Parameters

fieldName System.String requiredposition: 0
type DocumentFormat.OpenXml.Spreadsheet.PivotFilterValues requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter Label(String fieldName, PivotFilterValues type, String value1, String value2 = null, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:303

Returns: ExcelPivotFilter

Creates a label pivot filter using a specific Open XML pivot filter type.

Parameters

fieldName System.String requiredposition: 0
type DocumentFormat.OpenXml.Spreadsheet.PivotFilterValues requiredposition: 1
value1 System.String requiredposition: 2
value2 System.String = null optionalposition: 3
name System.String = null optionalposition: 4
description System.String = null optionalposition: 5

public static ExcelPivotFilter LabelBeginsWith(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:81

Returns: ExcelPivotFilter

Creates a label-begins-with pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelBetween(String fieldName, String from, String to, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:113

Returns: ExcelPivotFilter

Creates a label-between pivot filter.

Parameters

fieldName System.String requiredposition: 0
from System.String requiredposition: 1
to System.String requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter LabelContains(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:73

Returns: ExcelPivotFilter

Creates a label-contains pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelEndsWith(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:89

Returns: ExcelPivotFilter

Creates a label-ends-with pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelEquals(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:65

Returns: ExcelPivotFilter

Creates a label-equals pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelGreaterThan(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:97

Returns: ExcelPivotFilter

Creates a label-greater-than pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelGreaterThanOrEqual(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:101

Returns: ExcelPivotFilter

Creates a label-greater-than-or-equal pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelLessThan(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:105

Returns: ExcelPivotFilter

Creates a label-less-than pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelLessThanOrEqual(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:109

Returns: ExcelPivotFilter

Creates a label-less-than-or-equal pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelNotBeginsWith(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:85

Returns: ExcelPivotFilter

Creates a label-not-begins-with pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelNotBetween(String fieldName, String from, String to, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:117

Returns: ExcelPivotFilter

Creates a label-not-between pivot filter.

Parameters

fieldName System.String requiredposition: 0
from System.String requiredposition: 1
to System.String requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter LabelNotContains(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:77

Returns: ExcelPivotFilter

Creates a label-not-contains pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelNotEndsWith(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:93

Returns: ExcelPivotFilter

Creates a label-not-ends-with pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter LabelNotEquals(String fieldName, String value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:69

Returns: ExcelPivotFilter

Creates a label-not-equals pivot filter.

Parameters

fieldName System.String requiredposition: 0
value System.String requiredposition: 1
name System.String = null optionalposition: 2
description System.String = null optionalposition: 3

public static ExcelPivotFilter TopCount(String fieldName, String dataFieldName, Int32 count, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:153

Returns: ExcelPivotFilter

Creates a top-count pivot filter for the specified data field.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
count System.Int32 requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter TopPercent(String fieldName, String dataFieldName, Int32 percent, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:161

Returns: ExcelPivotFilter

Creates a top-percent pivot filter for the specified data field.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
percent System.Int32 requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter TopSum(String fieldName, String dataFieldName, Double value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:169

Returns: ExcelPivotFilter

Creates a top-sum pivot filter for the specified data field.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
value System.Double requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter Value(String fieldName, String dataFieldName, PivotFilterValues type, Double value1, Nullable<Double> value2 = null, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:308

Returns: ExcelPivotFilter

Creates a value pivot filter using a specific Open XML pivot filter type.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
type DocumentFormat.OpenXml.Spreadsheet.PivotFilterValues requiredposition: 2
value1 System.Double requiredposition: 3
value2 System.Nullable{System.Double} = null optionalposition: 4
name System.String = null optionalposition: 5
description System.String = null optionalposition: 6

public static ExcelPivotFilter ValueBetween(String fieldName, String dataFieldName, Double from, Double to, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:145

Returns: ExcelPivotFilter

Creates a value-between pivot filter.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
from System.Double requiredposition: 2
to System.Double requiredposition: 3
name System.String = null optionalposition: 4
description System.String = null optionalposition: 5

public static ExcelPivotFilter ValueEquals(String fieldName, String dataFieldName, Double value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:121

Returns: ExcelPivotFilter

Creates a value-equals pivot filter.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
value System.Double requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter ValueGreaterThan(String fieldName, String dataFieldName, Double value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:129

Returns: ExcelPivotFilter

Creates a value-greater-than pivot filter.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
value System.Double requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter ValueGreaterThanOrEqual(String fieldName, String dataFieldName, Double value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:133

Returns: ExcelPivotFilter

Creates a value-greater-than-or-equal pivot filter.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
value System.Double requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter ValueLessThan(String fieldName, String dataFieldName, Double value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:137

Returns: ExcelPivotFilter

Creates a value-less-than pivot filter.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
value System.Double requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter ValueLessThanOrEqual(String fieldName, String dataFieldName, Double value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:141

Returns: ExcelPivotFilter

Creates a value-less-than-or-equal pivot filter.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
value System.Double requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

public static ExcelPivotFilter ValueNotBetween(String fieldName, String dataFieldName, Double from, Double to, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:149

Returns: ExcelPivotFilter

Creates a value-not-between pivot filter.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
from System.Double requiredposition: 2
to System.Double requiredposition: 3
name System.String = null optionalposition: 4
description System.String = null optionalposition: 5

public static ExcelPivotFilter ValueNotEquals(String fieldName, String dataFieldName, Double value, String name = null, String description = null)

OfficeIMO.Excel/ExcelPivotFilter.cs:125

Returns: ExcelPivotFilter

Creates a value-not-equals pivot filter.

Parameters

fieldName System.String requiredposition: 0
dataFieldName System.String requiredposition: 1
value System.Double requiredposition: 2
name System.String = null optionalposition: 3
description System.String = null optionalposition: 4

Inherited Methods

Properties

public String FieldName { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:34

Gets the source field name to filter.

public PivotFilterValues Type { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:37

Gets the Open XML pivot filter type.

public String Value1 { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:40

Gets the first filter value.

public String Value2 { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:43

Gets the second filter value for between-style filters.

public String DataFieldName { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:46

Gets the data field used by value filters.

public String Name { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:49

Gets the optional filter display name.

public String Description { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:52

Gets the optional filter description.

public Nullable<Boolean> IsTop { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:55

Gets whether a top/bottom filter keeps top values. False means bottom values.

public Nullable<Boolean> IsPercent { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:58

Gets whether a top/bottom filter uses a percentage threshold.

public String FilterValue { get; } #

OfficeIMO.Excel/ExcelPivotFilter.cs:61

Gets the optional calculated top/bottom filter value threshold.