Excel.Filter class

Référence

Paquet:: excel

Gère le filtrage de la colonne d’un tableau.

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
criteria	Le filtre actuellement appliqué à la colonne donnée.

Méthodes

apply(criteria)	Appliquer les critères de filtre donnés à la colonne indiquée.
applyBottomItemsFilter(count)	Appliquer un filtre « Élément inférieur » à la colonne pour le nombre d’éléments donné.
applyBottomPercentFilter(percent)	Appliquer un filtre « Pourcentage inférieur » à la colonne pour le pourcentage d’éléments donné.
applyCellColorFilter(color)	Appliquer un filtre « Couleur de cellule » à la colonne pour la couleur donnée.
applyCustomFilter(criteria1, criteria2, oper)	Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données.
applyCustomFilter(criteria1, criteria2, operString)	Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données.
applyDynamicFilter(criteria)	Appliquer un filtre « Dynamique » à la colonne.
applyDynamicFilter(criteriaString)	Appliquer un filtre « Dynamique » à la colonne.
applyFontColorFilter(color)	Appliquer un filtre « Couleur de police » à la colonne pour la couleur donnée.
applyIconFilter(icon)	Appliquez un filtre « Icône » à la colonne pour l’icône donnée.
applyTopItemsFilter(count)	Appliquer un filtre « Élément supérieur » à la colonne pour le nombre d’éléments donné.
applyTopPercentFilter(percent)	Appliquer un filtre « Pourcentage supérieur » à la colonne pour le pourcentage d’éléments donné.
applyValuesFilter(values)	Appliquer un filtre « Valeurs » à la colonne pour les valeurs données.
clear()	Effacer le filtre sur la colonne donnée.
load(options)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
load(propertyNames)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
load(propertyNamesAndPaths)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à son tour la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet Excel.Filter d’origine est un objet API, la `toJSON` méthode retourne un objet JavaScript brut (tapé en tant `Excel.Interfaces.FilterData`que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

criteria

Le filtre actuellement appliqué à la colonne donnée.

readonly criteria: Excel.FilterCriteria;

Valeur de propriété

Excel.FilterCriteria

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Détails de la méthode

apply(criteria)

Appliquer les critères de filtre donnés à la colonne indiquée.

apply(criteria: Excel.FilterCriteria): void;

Paramètres

criteria: Excel.FilterCriteria

Critères à appliquer.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyBottomItemsFilter(count)

Appliquer un filtre « Élément inférieur » à la colonne pour le nombre d’éléments donné.

applyBottomItemsFilter(count: number): void;

Paramètres

count: number

Nombre d’éléments à partir du bas à afficher.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyBottomPercentFilter(percent)

Appliquer un filtre « Pourcentage inférieur » à la colonne pour le pourcentage d’éléments donné.

applyBottomPercentFilter(percent: number): void;

Paramètres

percent: number

Pourcentage d’éléments à partir du bas à afficher.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyCellColorFilter(color)

Appliquer un filtre « Couleur de cellule » à la colonne pour la couleur donnée.

applyCellColorFilter(color: string): void;

Paramètres

color: string

Couleur d’arrière-plan des cellules à afficher.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, oper)

Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données.

applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator): void;

Paramètres

criteria1: string

Première chaîne de critères.

criteria2: string

Facultatif. Deuxième chaîne de critères.

oper: Excel.FilterOperator

Facultatif. Opérateur qui décrit comment les deux critères sont joints.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, operString)

Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données.

applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;

Paramètres

criteria1: string

Première chaîne de critères.

criteria2: string

Facultatif. Deuxième chaîne de critères.

operString: "And" | "Or"

Facultatif. Opérateur qui décrit comment les deux critères sont joints.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyDynamicFilter(criteria)

Appliquer un filtre « Dynamique » à la colonne.

applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;

Paramètres

criteria: Excel.DynamicFilterCriteria

Critères dynamiques à appliquer.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyDynamicFilter(criteriaString)

Appliquer un filtre « Dynamique » à la colonne.

applyDynamicFilter(criteriaString: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"): void;

Paramètres

criteriaString: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"

Critères dynamiques à appliquer.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyFontColorFilter(color)

Appliquer un filtre « Couleur de police » à la colonne pour la couleur donnée.

applyFontColorFilter(color: string): void;

Paramètres

color: string

Couleur de police des cellules à afficher.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyIconFilter(icon)

Appliquez un filtre « Icône » à la colonne pour l’icône donnée.

applyIconFilter(icon: Excel.Icon): void;

Paramètres

icon: Excel.Icon

Icônes des cellules à afficher.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyTopItemsFilter(count)

Appliquer un filtre « Élément supérieur » à la colonne pour le nombre d’éléments donné.

applyTopItemsFilter(count: number): void;

Paramètres

count: number

Nombre d’éléments à partir du haut à afficher.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyTopPercentFilter(percent)

Appliquer un filtre « Pourcentage supérieur » à la colonne pour le pourcentage d’éléments donné.

applyTopPercentFilter(percent: number): void;

Paramètres

percent: number

Pourcentage d’éléments à partir du haut à afficher.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

applyValuesFilter(values)

Appliquer un filtre « Valeurs » à la colonne pour les valeurs données.

applyValuesFilter(values: Array<string | FilterDatetime>): void;

Paramètres

values: Array<string | Excel.FilterDatetime>

Liste des valeurs à afficher. Il doit s’agir d’un tableau de chaînes ou d’un tableau d’objets Excel.FilterDateTime .

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

clear()

Effacer le filtre sur la colonne donnée.

clear(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;

Paramètres

options: Excel.Interfaces.FilterLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.Filter

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Filter;

Paramètres

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.Filter

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Filter;

Paramètres

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.Filter

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.Filter d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.FilterDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.FilterData;

Retours

Excel.Interfaces.FilterData

Excel.Filter class

Remarques

Propriétés

Méthodes

Détails de la propriété

context

Valeur de propriété

criteria

Valeur de propriété

Remarques

Détails de la méthode

apply(criteria)

Paramètres

Retours

Remarques

applyBottomItemsFilter(count)

Paramètres

Retours

Remarques

applyBottomPercentFilter(percent)

Paramètres

Retours

Remarques

applyCellColorFilter(color)

Paramètres

Retours

Remarques

applyCustomFilter(criteria1, criteria2, oper)

Paramètres

Retours

Remarques

applyCustomFilter(criteria1, criteria2, operString)

Paramètres

Retours

Remarques

applyDynamicFilter(criteria)

Paramètres

Retours

Remarques

applyDynamicFilter(criteriaString)

Paramètres

Retours

Remarques

applyFontColorFilter(color)

Paramètres

Retours

Remarques

applyIconFilter(icon)

Paramètres

Retours

Remarques

applyTopItemsFilter(count)

Paramètres

Retours

Remarques

applyTopPercentFilter(percent)

Paramètres

Retours

Remarques

applyValuesFilter(values)

Paramètres

Retours

Remarques

clear()

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Commentaires

Ressources supplémentaires