Class AutoFilter
Namespace: Aspose.Cells
Assembly: Aspose.Cells.dll (25.2.0)
Представляет автофильтр для указанного листа.
public class AutoFilter
Наследование
Унаследованные члены
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Примеры
//Создание потока файла, содержащего Excel файл для открытия
//Создание объекта Workbook
Workbook workbook = new Workbook("template.xlsx");
//Доступ к первому листу в Excel файле
Worksheet worksheet = workbook.Worksheets[0];
//Создание AutoFilter, задав диапазон ячеек заголовка
worksheet.AutoFilter.Range = "A1:B1";
//Фильтрация столбцов с указанными значениями
worksheet.AutoFilter.Filter(1, "Bananas");
//Сохранение измененного Excel файла.
workbook.Save("output.xls");
'Создание потока файла, содержащего Excel файл для открытия
'Создание объекта Workbook
Dim workbook As Workbook = New Workbook("template.xlsx")
'Доступ к первому листу в Excel файле
Dim worksheet As Worksheet = workbook.Worksheets(0)
'Создание AutoFilter, задав диапазон ячеек заголовка
worksheet.AutoFilter.Range = "A1:B1"
'Фильтрация столбцов с указанными значениями
Worksheet.AutoFilter.Filter(1, "Bananas")
'Сохранение измененного Excel файла
workbook.Save("output.xls")
Свойства
FilterColumns
Получает коллекцию фильтруемых столбцов.
public FilterColumnCollection FilterColumns { get; }
Значение свойства
Range
Представляет диапазон, к которому применяется указанный AutoFilter.
public string Range { get; set; }
Значение свойства
ShowFilterButton
Указывает, видима ли кнопка AutoFilter для этого столбца.
public bool ShowFilterButton { get; set; }
Значение свойства
Sorter
Получает сортировщик данных.
public DataSorter Sorter { get; }
Значение свойства
Методы
AddDateFilter(int, DateTimeGroupingType, int, int, int, int, int, int)
Добавляет фильтр по дате.
public void AddDateFilter(int fieldIndex, DateTimeGroupingType dateTimeGroupingType, int year, int month, int day, int hour, int minute, int second)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
dateTimeGroupingType
DateTimeGroupingType
Тип группировки
year
int
Год.
month
int
Месяц.
day
int
День.
hour
int
Час.
minute
int
Минута.
second
int
Секунда.
Примечания
Если DateTimeGroupingType - Год, только параметр год влияет. Если DateTimeGroupingType - Месяц, только параметры год и месяц влияют.
AddFillColorFilter(int, BackgroundType, CellsColor, CellsColor)
Добавляет фильтр по цвету заливки.
public void AddFillColorFilter(int fieldIndex, BackgroundType pattern, CellsColor foregroundColor, CellsColor backgroundColor)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
pattern
BackgroundType
Тип фона.
foregroundColor
CellsColor
Цвет переднего плана.
backgroundColor
CellsColor
Цвет фона.
AddFilter(int, string)
Добавляет фильтр для столбца фильтра.
public void AddFilter(int fieldIndex, string criteria)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
criteria
string
Указанные критерии (строка; например, “101”). Он может быть только null или одним из значений ячеек в этом столбце.
Примечания
MS Excel 2007 поддерживает множественный выбор в столбце фильтра.
AddFontColorFilter(int, CellsColor)
Добавляет фильтр по цвету шрифта.
public void AddFontColorFilter(int fieldIndex, CellsColor color)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
color
CellsColor
Объект Aspose.Cells.CellsColor.
AddIconFilter(int, IconSetType, int)
Добавляет фильтр по значку.
public void AddIconFilter(int fieldIndex, IconSetType iconSetType, int iconId)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
iconSetType
IconSetType
Тип набора значков.
iconId
int
Идентификатор значка.
Примечания
Поддерживает только добавление фильтра по значку. Не поддерживает проверку, какая строка видима, если фильтр является фильтром значка.
Custom(int, FilterOperatorType, object)
Фильтрует список по пользовательским критериям.
public void Custom(int fieldIndex, FilterOperatorType operatorType1, object criteria1)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
operatorType1
FilterOperatorType
Тип оператора фильтра
criteria1
object
Пользовательские критерии
Custom(int, FilterOperatorType, object, bool, FilterOperatorType, object)
Фильтрует список по пользовательским критериям.
public void Custom(int fieldIndex, FilterOperatorType operatorType1, object criteria1, bool isAnd, FilterOperatorType operatorType2, object criteria2)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
operatorType1
FilterOperatorType
Тип оператора фильтра
criteria1
object
Пользовательские критерии
isAnd
bool
operatorType2
FilterOperatorType
Тип оператора фильтра
criteria2
object
Пользовательские критерии
DynamicFilter(int, DynamicFilterType)
Добавляет динамический фильтр.
public void DynamicFilter(int fieldIndex, DynamicFilterType dynamicFilterType)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
dynamicFilterType
DynamicFilterType
Тип динамического фильтра.
Filter(int, string)
Фильтрует список по указанным критериям.
public void Filter(int fieldIndex, string criteria)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
criteria
string
Указанные критерии (строка; например, “101”).
Примечания
Aspose.Cells удалит все другие настройки фильтра на этом поле, как и Ms Excel 97-2003.
FilterTop10(int, bool, bool, int)
Фильтрует 10 лучших элементов в списке
public void FilterTop10(int fieldIndex, bool isTop, bool isPercent, int itemCount)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
isTop
bool
Указывает, фильтровать сверху или снизу
isPercent
bool
Указывает, являются ли элементы процентами или количеством
itemCount
int
Количество элементов
GetCellArea()
Получает Aspose.Cells.CellArea, к которому применяется этот AutoFilter.
public CellArea GetCellArea()
Возвращает
область, к которой применяется этот фильтр
GetCellArea(bool)
Получает Aspose.Cells.CellArea, к которому применяется указанный AutoFilter.
public CellArea GetCellArea(bool refreshAppliedRange)
Параметры
refreshAppliedRange
bool
Обновить ли примененный диапазон. Для примененного диапазона автофильтра последняя строка может измениться, когда меняются данные ячеек. Если этот флаг установлен в true, то последняя строка диапазона будет пересчитана в соответствии с текущими данными ячеек.
Возвращает
область, к которой применяется этот фильтр
MatchBlanks(int)
Совпадает со всеми пустыми ячейками в списке.
public void MatchBlanks(int fieldIndex)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
MatchNonBlanks(int)
Совпадает со всеми непустыми ячейками в списке.
public void MatchNonBlanks(int fieldIndex)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
Refresh()
Обновляет автофильтры, чтобы скрыть или показать строки.
public int[] Refresh()
Возвращает
int[]
Возвращает индексы всех скрытых строк.
Refresh(bool)
Получает индексы всех скрытых строк.
public int[] Refresh(bool hideRows)
Параметры
hideRows
bool
Если true, скрыть отфильтрованные строки.
Возвращает
int[]
Возвращает индексы всех скрытых строк.
RemoveDateFilter(int, DateTimeGroupingType, int, int, int, int, int, int)
Удаляет фильтр по дате.
public void RemoveDateFilter(int fieldIndex, DateTimeGroupingType dateTimeGroupingType, int year, int month, int day, int hour, int minute, int second)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
dateTimeGroupingType
DateTimeGroupingType
Тип группировки
year
int
Год.
month
int
Месяц.
day
int
День.
hour
int
Час.
minute
int
Минута.
second
int
Секунда.
Примечания
Если DateTimeGroupingType - Год, только параметр год влияет. Если DateTimeGroupingType - Месяц, только параметры год и месяц влияют.
RemoveFilter(int, string)
Удаляет фильтр для столбца фильтра.
public void RemoveFilter(int fieldIndex, string criteria)
Параметры
fieldIndex
int
Целочисленный смещение поля, на основе которого вы хотите установить фильтр (слева от списка; самое левое поле - поле 0).
criteria
string
Указанные критерии (строка; например, “101”). Он может быть только null или одним из значений ячеек в этом столбце.
RemoveFilter(int)
Удаляет конкретный фильтр.
public void RemoveFilter(int fieldIndex)
Параметры
fieldIndex
int
Индекс конкретного фильтра
SetRange(int, int, int)
Устанавливает диапазон, к которому применяется указанный AutoFilter.
public void SetRange(int row, int startColumn, int endColumn)
Параметры
row
int
Индекс строки.
startColumn
int
Индекс начального столбца.
endColumn
int
Индекс конечного столбца.
ShowAll()
Показывает все строки.
public void ShowAll()