API Reference

Class

LegacyXlsPivotRuleFilter

Namespace OfficeIMO.Excel.LegacyXls.Model
Assembly OfficeIMO.Excel
Modifiers sealed

Describes one decoded SxFilt PivotTable rule-filter entry.

Inheritance

  • Object
  • LegacyXlsPivotRuleFilter

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

Constructors

public LegacyXlsPivotRuleFilter(UInt16 axisFlags, Int16 fieldPosition, Int16 fieldReferenceIndex, Boolean selected, UInt16 subtotalFlags, UInt16 itemIndexCount) #

Creates decoded PivotTable rule-filter metadata.

Parameters

axisFlags System.UInt16 requiredposition: 0
fieldPosition System.Int16 requiredposition: 1
fieldReferenceIndex System.Int16 requiredposition: 2
selected System.Boolean requiredposition: 3
subtotalFlags System.UInt16 requiredposition: 4
itemIndexCount System.UInt16 requiredposition: 5

Properties

public UInt16 AxisFlags { get; } #

Gets the raw SxFilt axis flag bits.

public String AxisName { get; } #

Gets the decoded PivotTable axis name.

public Int16 FieldPosition { get; } #

Gets the zero-based field position within the decoded axis.

public Int16 FieldReferenceIndex { get; } #

Gets the decoded pivot, cache, or data-field reference index.

public String FieldReferenceName { get; } #

Gets a stable field-reference name.

public Boolean Selected { get; } #

Gets whether this filter includes the referenced field header.

public UInt16 SubtotalFlags { get; } #

Gets raw subtotal-function flags from SxFilt.

public IReadOnlyList<String> SubtotalFunctionNames { get; } #

Gets decoded subtotal-function names from SxFilt.

public UInt16 ItemIndexCount { get; } #

Gets the number of SxItm indexes following this filter entry.