Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 573 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

ExcelPivotFilterInfo

Edit on GitHub
Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Source ExcelPivotFilterInfo.cs:22
Modifiers sealed

Describes a pivot filter found in an existing pivot table.

Inheritance

  • Object
  • ExcelPivotFilterInfo

Usage

Explore 2 API references to this type

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

Returned or exposed by 1

Accepted by parameters 1

Constructors

public ExcelPivotFilterInfo(String fieldName, ExcelPivotFilterType? type, String? value1, String? value2, String? dataFieldName, String? name, String? description, Boolean? isTop = null, Boolean? isPercent = null, String? filterValue = null) #
ExcelPivotFilterInfo.cs:22

Creates pivot filter readback information.

Parameters

fieldName System.String requiredposition: 0
type OfficeIMO.Excel.ExcelPivotFilterType? requiredposition: 1
value1 System.String? requiredposition: 2
value2 System.String? requiredposition: 3
dataFieldName System.String? requiredposition: 4
name System.String? requiredposition: 5
description System.String? requiredposition: 6
isTop System.Boolean? = null optionalposition: 7
isPercent System.Boolean? = null optionalposition: 8
filterValue System.String? = null optionalposition: 9

Properties

public String FieldName { get; } #
ExcelPivotFilterInfo.cs:43

Gets the source field name being filtered.

public ExcelPivotFilterType? Type { get; } #
ExcelPivotFilterInfo.cs:46

Gets the Open XML pivot filter type.

public String? Value1 { get; } #
ExcelPivotFilterInfo.cs:49

Gets the first filter value.

public String? Value2 { get; } #
ExcelPivotFilterInfo.cs:52

Gets the second filter value for between-style filters.

public String? DataFieldName { get; } #
ExcelPivotFilterInfo.cs:55

Gets the data field used by value filters.

public String? Name { get; } #
ExcelPivotFilterInfo.cs:58

Gets the filter display name.

public String? Description { get; } #
ExcelPivotFilterInfo.cs:61

Gets the filter description.

public Boolean? IsTop { get; } #
ExcelPivotFilterInfo.cs:64

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

public Boolean? IsPercent { get; } #
ExcelPivotFilterInfo.cs:67

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

public String? FilterValue { get; } #
ExcelPivotFilterInfo.cs:70

Gets the optional calculated top/bottom filter value threshold.

public Boolean WholeDay { get; } #
ExcelPivotFilterInfo.cs:73

Gets whether a fixed-date filter matches the entire calendar day.