alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Search Results for

    Show / Hide Table of Contents

    Class AutoFiltersCollection

    Represents an AutoFilter collections

    Inheritance
    object
    CollectionBase<object>
    CollectionBaseEx<object>
    AutoFiltersCollection
    Implements
    IList<object>
    ICollection<object>
    IEnumerable<object>
    IEnumerable
    ICloneParent
    IAutoFilters
    IParentApplication
    Inherited Members
    CollectionBase<object>.Add(object)
    CollectionBase<object>.Capacity
    CollectionBase<object>.Clear()
    CollectionBase<object>.Contains(object)
    CollectionBase<object>.CopyTo(object[], int)
    CollectionBase<object>.Count
    CollectionBase<object>.GetEnumerator()
    CollectionBase<object>.IndexOf(object)
    CollectionBase<object>.InnerList
    CollectionBase<object>.Insert(int, object)
    CollectionBase<object>.IsReadOnly
    CollectionBase<object>.List
    CollectionBase<object>.Remove(object)
    CollectionBase<object>.RemoveAt(int)
    CollectionBaseEx<object>.AppImplementation
    CollectionBaseEx<object>.Application
    CollectionBaseEx<object>.Changed
    CollectionBaseEx<object>.ChangeName(IDictionary, ValueChangedEventArgs)
    CollectionBaseEx<object>.Cleared
    CollectionBaseEx<object>.Clearing
    CollectionBaseEx<object>.ClearMaxValues()
    CollectionBaseEx<object>.Clone(object)
    CollectionBaseEx<object>.EnsureCapacity(int)
    CollectionBaseEx<object>.FindParent(Type)
    CollectionBaseEx<object>.FindParent(Type, bool)
    CollectionBaseEx<object>.GenerateDefaultName(ICollection<object>, string)
    CollectionBaseEx<object>.GenerateDefaultName(ICollection, string)
    CollectionBaseEx<object>.GenerateDefaultName(string, params ICollection[])
    CollectionBaseEx<object>.Inserted
    CollectionBaseEx<object>.Inserting
    CollectionBaseEx<object>.OnClear()
    CollectionBaseEx<object>.OnClearComplete()
    CollectionBaseEx<object>.OnInsert(int, object)
    CollectionBaseEx<object>.OnInsertComplete(int, object)
    CollectionBaseEx<object>.OnRemove(int, object)
    CollectionBaseEx<object>.OnRemoveComplete(int, object)
    CollectionBaseEx<object>.OnSet(int, object, object)
    CollectionBaseEx<object>.OnSetComplete(int, object, object)
    CollectionBaseEx<object>.Parent
    CollectionBaseEx<object>.QuietMode
    CollectionBaseEx<object>.Removed
    CollectionBaseEx<object>.Removing
    CollectionBaseEx<object>.Set
    CollectionBaseEx<object>.SetParent(object)
    CollectionBaseEx<object>.Setting
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Implementation.Collections
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    public class AutoFiltersCollection : CollectionBaseEx<object>, IList<object>, ICollection<object>, IEnumerable<object>, IEnumerable, ICloneParent, IAutoFilters, IParentApplication

    Constructors

    AutoFiltersCollection(IApplication, object)

    Creates a new instance for AutoFilter collection.

    Declaration
    public AutoFiltersCollection(IApplication application, object parent)
    Parameters
    Type Name Description
    IApplication application

    Excelengine application.

    object parent

    Parent object.

    Fields

    DEF_AUTOFILTER_NAMEDRANGE

    Name of the named range for autofilter range.

    Declaration
    public const string DEF_AUTOFILTER_NAMEDRANGE = "_FilterDatabase"
    Field Value
    Type
    string

    DEF_EXCEL07_AUTOFILTER_NAMEDRANGE

    Name of the named range for autofilter range in MS Excel 2007.

    Declaration
    public const string DEF_EXCEL07_AUTOFILTER_NAMEDRANGE = "_xlnm._FilterDatabase"
    Field Value
    Type
    string

    Properties

    AddressR1C1

    Gets address of filtered range in R1C1 style. Read-only.

    Declaration
    public string AddressR1C1 { get; }
    Property Value
    Type
    string

    DataSorter

    Gets the DataSorter.

    Declaration
    public IDataSort DataSorter { get; }
    Property Value
    Type Description
    IDataSort

    The DataSorter.

    Examples

    The following code illustrates how to get the DataSorter from AutoFilters.

             <pre><code class="lang-csharp">ExcelEngine excelEngine = new ExcelEngine();
    

    IApplication application = excelEngine.Excel; application.DefaultVersion = ExcelVersion.Excel2013; IWorkbook workbook = application.Workbooks.Open("Sorting.xlsx");

    workbook.Worksheets[0].AutoFilters.FilterRange = workbook.Worksheets[0].UsedRange;

    //Create DataSorter for AutoFilters. IDataSort filterSort = workbook.Worksheets[0].AutoFilters.DataSorter;;

    //Adding Sorting fields for DataSorter. filterSort.SortFields.Add(1, SortOn.Values, OrderBy.Ascending);

    //Perform Sorting for AutoFilters. filterSort.Sort();

    workbook.SaveAs("SortedExcel.xlsx"); workbook.Close(); excelEngine.Dispose();

    DefaultNamedRangeName

    Gets default autofilter named range name.

    Declaration
    public string DefaultNamedRangeName { get; }
    Property Value
    Type
    string

    FilterRange

    Range to be filtered.

    Declaration
    public IRange FilterRange { get; set; }
    Property Value
    Type
    IRange

    IsFiltered

    Indicates whether sheet contains filtered range.

    Declaration
    public bool IsFiltered { get; }
    Property Value
    Type
    bool

    this[int]

    Returns single autofilter object by column index. Read-only.

    Declaration
    public IAutoFilter this[int columnIndex] { get; }
    Parameters
    Type Name Description
    int columnIndex
    Property Value
    Type
    IAutoFilter

    Worksheet

    Returns parent worksheet. Read-only.

    Declaration
    public WorksheetImpl Worksheet { get; }
    Property Value
    Type
    WorksheetImpl

    Methods

    ChangeVersions(int, int, ExcelVersion)

    Changes Excel versions based on AutoFilter collection.

    Declaration
    public void ChangeVersions(int iLastRow, int iLastColumn, ExcelVersion version)
    Parameters
    Type Name Description
    int iLastRow

    Max last row.

    int iLastColumn

    Max last column.

    ExcelVersion version

    Excel version to make conversion into.

    Clone(WorksheetImpl)

    Clones AutoFilter collection.

    Declaration
    public AutoFiltersCollection Clone(WorksheetImpl parent)
    Parameters
    Type Name Description
    WorksheetImpl parent

    Parent object.

    Returns
    Type Description
    AutoFiltersCollection

    Returns cloned object.

    Parse(List<BiffRecordRaw>)

    Parses filter records. Must be called after parsing of all names.

    Declaration
    public void Parse(List<BiffRecordRaw> records)
    Parameters
    Type Name Description
    List<BiffRecordRaw> records

    Records to parse

    Serialize(OffsetArrayList)

    Serializes AutoFilter collection into set of records.

    Declaration
    [CLSCompliant(false)]
    public void Serialize(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    Place where serialized records will be placed.

    UpdateFilterRange()

    Updates internal range object that stores filtered range.

    Declaration
    public void UpdateFilterRange()

    Implements

    IList<T>
    ICollection<T>
    IEnumerable<T>
    IEnumerable
    ICloneParent
    IAutoFilters
    IParentApplication

    Extension Methods

    CalcEngineHelper.ToArray<T>(IEnumerable<T>)
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved