Class AutoFilter
Namespace: Aspose.Cells
Assembly: Aspose.Cells.dll (25.2.0)
Representa a filtragem automática para a planilha especificada.
public class AutoFilter
Herança
Membros Herdados
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Exemplos
//Criando um fluxo de arquivo contendo o arquivo Excel a ser aberto
//Instanciando um objeto Workbook
Workbook workbook = new Workbook("template.xlsx");
//Acessando a primeira planilha no arquivo Excel
Worksheet worksheet = workbook.Worksheets[0];
//Criando AutoFilter fornecendo o intervalo de células da linha de cabeçalho
worksheet.AutoFilter.Range = "A1:B1";
//Filtrando colunas com valores especificados
worksheet.AutoFilter.Filter(1, "Bananas");
//Salvando o arquivo Excel modificado.
workbook.Save("output.xls");
'Criando um fluxo de arquivo contendo o arquivo Excel a ser aberto
'Instanciando um objeto Workbook
Dim workbook As Workbook = New Workbook("template.xlsx")
'Acessando a primeira planilha no arquivo Excel
Dim worksheet As Worksheet = workbook.Worksheets(0)
'Criando AutoFilter fornecendo o intervalo de células da linha de cabeçalho
worksheet.AutoFilter.Range = "A1:B1"
'Filtrando colunas com valores especificados
Worksheet.AutoFilter.Filter(1, "Bananas")
'Salvando o arquivo Excel modificado
workbook.Save("output.xls")
Propriedades
FilterColumns
Obtém a coleção das colunas filtradas.
public FilterColumnCollection FilterColumns { get; }
Valor da Propriedade
Range
Representa o intervalo ao qual o AutoFilter especificado se aplica.
public string Range { get; set; }
Valor da Propriedade
ShowFilterButton
Indica se o botão de AutoFilter para esta coluna está visível.
public bool ShowFilterButton { get; set; }
Valor da Propriedade
Sorter
Obtém o classificador de dados.
public DataSorter Sorter { get; }
Valor da Propriedade
Métodos
AddDateFilter(int, DateTimeGroupingType, int, int, int, int, int, int)
Adiciona um filtro de data.
public void AddDateFilter(int fieldIndex, DateTimeGroupingType dateTimeGroupingType, int year, int month, int day, int hour, int minute, int second)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
dateTimeGroupingType
DateTimeGroupingType
O tipo de agrupamento
year
int
O ano.
month
int
O mês.
day
int
O dia.
hour
int
A hora.
minute
int
O minuto.
second
int
O segundo.
Observações
Se DateTimeGroupingType for Ano, apenas o parâmetro ano terá efeito. Se DateTimeGroupingType for Mês, apenas os parâmetros ano e mês terão efeito.
AddFillColorFilter(int, BackgroundType, CellsColor, CellsColor)
Adiciona um filtro de cor de preenchimento.
public void AddFillColorFilter(int fieldIndex, BackgroundType pattern, CellsColor foregroundColor, CellsColor backgroundColor)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
pattern
BackgroundType
O tipo de padrão de fundo.
foregroundColor
CellsColor
A cor de primeiro plano.
backgroundColor
CellsColor
A cor de fundo.
AddFilter(int, string)
Adiciona um filtro para uma coluna filtrada.
public void AddFilter(int fieldIndex, string criteria)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
criteria
string
Os critérios especificados (uma string; por exemplo, “101”). Pode ser nulo ou um dos valores das células nesta coluna.
Observações
O MS Excel 2007 suporta seleção múltipla em uma coluna filtrada.
AddFontColorFilter(int, CellsColor)
Adiciona um filtro de cor de fonte.
public void AddFontColorFilter(int fieldIndex, CellsColor color)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
color
CellsColor
O objeto Aspose.Cells.CellsColor.
AddIconFilter(int, IconSetType, int)
Adiciona um filtro de ícone.
public void AddIconFilter(int fieldIndex, IconSetType iconSetType, int iconId)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
iconSetType
IconSetType
O tipo de conjunto de ícones.
iconId
int
O id do ícone.
Observações
Apenas suporta a adição do filtro de ícone. Não suporta verificar qual linha está visível se o filtro for um filtro de ícone.
Custom(int, FilterOperatorType, object)
Filtra uma lista com critérios personalizados.
public void Custom(int fieldIndex, FilterOperatorType operatorType1, object criteria1)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
operatorType1
FilterOperatorType
O tipo de operador de filtro
criteria1
object
Os critérios personalizados
Custom(int, FilterOperatorType, object, bool, FilterOperatorType, object)
Filtra uma lista com critérios personalizados.
public void Custom(int fieldIndex, FilterOperatorType operatorType1, object criteria1, bool isAnd, FilterOperatorType operatorType2, object criteria2)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
operatorType1
FilterOperatorType
O tipo de operador de filtro
criteria1
object
Os critérios personalizados
isAnd
bool
operatorType2
FilterOperatorType
O tipo de operador de filtro
criteria2
object
Os critérios personalizados
DynamicFilter(int, DynamicFilterType)
Adiciona um filtro dinâmico.
public void DynamicFilter(int fieldIndex, DynamicFilterType dynamicFilterType)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
dynamicFilterType
DynamicFilterType
Tipo de filtro dinâmico.
Filter(int, string)
Filtra uma lista com critérios especificados.
public void Filter(int fieldIndex, string criteria)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
criteria
string
Os critérios especificados (uma string; por exemplo, “101”).
Observações
Aspose.Cells removerá todas as outras configurações de filtro neste campo, como o MS Excel 97-2003.
FilterTop10(int, bool, bool, int)
Filtra os 10 melhores itens na lista
public void FilterTop10(int fieldIndex, bool isTop, bool isPercent, int itemCount)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
isTop
bool
Indica se o filtro é do topo ou da parte inferior
isPercent
bool
Indica se os itens são percentuais ou contagem
itemCount
int
A contagem de itens
GetCellArea()
Obtém a Aspose.Cells.CellArea onde este AutoFilter se aplica.
public CellArea GetCellArea()
Retorna
a área à qual este filtro se aplica
GetCellArea(bool)
Obtém a Aspose.Cells.CellArea onde o AutoFilter especificado se aplica.
public CellArea GetCellArea(bool refreshAppliedRange)
Parâmetros
refreshAppliedRange
bool
Se deve atualizar o intervalo aplicado. Para o intervalo aplicado do filtro automático, a última linha pode mudar quando os dados das células mudam. Se esta flag for verdadeira, então a última linha do intervalo será recalculada de acordo com os dados atuais das células.
Retorna
a área à qual este filtro se aplica
MatchBlanks(int)
Combina todas as células em branco na lista.
public void MatchBlanks(int fieldIndex)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
MatchNonBlanks(int)
Combina todas as células não em branco na lista.
public void MatchNonBlanks(int fieldIndex)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
Refresh()
Atualiza os filtros automáticos para ocultar ou mostrar as linhas.
public int[] Refresh()
Retorna
int[]
Retorna todos os índices das linhas ocultas.
Refresh(bool)
Obtém todos os índices das linhas ocultas.
public int[] Refresh(bool hideRows)
Parâmetros
hideRows
bool
Se verdadeiro, oculta as linhas filtradas.
Retorna
int[]
Retorna todos os índices das linhas ocultas.
RemoveDateFilter(int, DateTimeGroupingType, int, int, int, int, int, int)
Remove um filtro de data.
public void RemoveDateFilter(int fieldIndex, DateTimeGroupingType dateTimeGroupingType, int year, int month, int day, int hour, int minute, int second)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
dateTimeGroupingType
DateTimeGroupingType
O tipo de agrupamento
year
int
O ano.
month
int
O mês.
day
int
O dia.
hour
int
A hora.
minute
int
O minuto.
second
int
O segundo.
Observações
Se DateTimeGroupingType for Ano, apenas o parâmetro ano terá efeito. Se DateTimeGroupingType for Mês, apenas os parâmetros ano e mês terão efeito.
RemoveFilter(int, string)
Remove um filtro para uma coluna filtrada.
public void RemoveFilter(int fieldIndex, string criteria)
Parâmetros
fieldIndex
int
O deslocamento inteiro do campo no qual você deseja basear o filtro (da esquerda para a lista; o campo mais à esquerda é o campo 0).
criteria
string
Os critérios especificados (uma string; por exemplo, “101”). Pode ser nulo ou um dos valores das células nesta coluna.
RemoveFilter(int)
Remove o filtro específico.
public void RemoveFilter(int fieldIndex)
Parâmetros
fieldIndex
int
O índice do filtro específico
SetRange(int, int, int)
Define o intervalo ao qual o AutoFilter especificado se aplica.
public void SetRange(int row, int startColumn, int endColumn)
Parâmetros
row
int
Índice da linha.
startColumn
int
Índice da coluna inicial.
endColumn
int
Índice da coluna final.
ShowAll()
Revela todas as linhas.
public void ShowAll()