API Reference

Class

LegacyXlsAutoFilterCriteria

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

Represents parsed legacy AutoFilter criteria for one filtered column.

Inheritance

  • Object
  • LegacyXlsAutoFilterCriteria

Usage

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

Constructors

public LegacyXlsAutoFilterCriteria(UInt32 columnId, Boolean matchAll, IReadOnlyList<LegacyXlsAutoFilterCondition> conditions, LegacyXlsAutoFilterKind kind = Custom, Nullable<UInt16> top10Value = null, Boolean top10IsTop = true, Boolean top10IsPercent = false) #

Creates parsed legacy AutoFilter criteria.

Parameters

columnId System.UInt32 requiredposition: 0
matchAll System.Boolean requiredposition: 1
conditions System.Collections.Generic.IReadOnlyList{OfficeIMO.Excel.LegacyXls.Model.LegacyXlsAutoFilterCondition} requiredposition: 2
kind OfficeIMO.Excel.LegacyXls.Model.LegacyXlsAutoFilterKind = Custom optionalposition: 3
top10Value System.Nullable{System.UInt16} = null optionalposition: 4
top10IsTop System.Boolean = true optionalposition: 5
top10IsPercent System.Boolean = false optionalposition: 6

Methods

public static LegacyXlsAutoFilterCriteria CreateBlanks(UInt32 columnId) #
Returns: LegacyXlsAutoFilterCriteria

Creates parsed legacy blank AutoFilter criteria.

Parameters

columnId System.UInt32 requiredposition: 0
public static LegacyXlsAutoFilterCriteria CreateNonBlanks(UInt32 columnId) #
Returns: LegacyXlsAutoFilterCriteria

Creates parsed legacy nonblank AutoFilter criteria.

Parameters

columnId System.UInt32 requiredposition: 0
public static LegacyXlsAutoFilterCriteria CreateTop10(UInt32 columnId, UInt16 value, Boolean isTop, Boolean isPercent) #
Returns: LegacyXlsAutoFilterCriteria

Creates parsed legacy Top/Bottom AutoFilter criteria.

Parameters

columnId System.UInt32 requiredposition: 0
value System.UInt16 requiredposition: 1
isTop System.Boolean requiredposition: 2
isPercent System.Boolean requiredposition: 3

Properties

public UInt32 ColumnId { get; } #

Gets the zero-based column index within the AutoFilter range.

public Boolean MatchAll { get; } #

Gets whether multiple conditions must all match.

public LegacyXlsAutoFilterJoinOperator JoinOperator { get; } #

Gets the logical join used when this criteria has comparison conditions.

public IReadOnlyList<LegacyXlsAutoFilterCondition> Conditions { get; } #

Gets the parsed filter conditions.

public LegacyXlsAutoFilterKind Kind { get; } #

Gets the kind of AutoFilter criteria represented by this record.

public Boolean IsTop10 { get; } #

Gets whether this criteria represents a Top/Bottom AutoFilter.

public Nullable<UInt16> Top10Value { get; } #

Gets the Top/Bottom count or percentage value.

public Boolean Top10IsTop { get; } #

Gets whether the Top/Bottom criteria keeps top values rather than bottom values.

public Boolean Top10IsPercent { get; } #

Gets whether the Top/Bottom criteria value is a percentage rather than an item count.