Excel.TableSort class
Gère les opérations de tri sur Table les objets.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.2 ]
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. |
| fields | Spécifie les conditions actuelles utilisées pour le dernier tri de la table. |
| match |
Spécifie si la casse a un impact sur le dernier type de la table. |
| method | Représente la dernière méthode de classement des caractères chinois utilisée pour trier la table. |
Méthodes
| apply(fields, match |
Effectue une opération de tri. |
| apply(fields, match |
Effectue une opération de tri. |
| clear() | Efface le tri actuellement appliqué au tableau. Même si le classement du tableau n’est pas modifié, l’état des boutons d’en-tête est rétabli. |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| reapply() | Applique à nouveau les paramètres actuels de tri au tableau. |
| toJSON() | Remplace la méthode JavaScript |
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é
fields
Spécifie les conditions actuelles utilisées pour le dernier tri de la table.
readonly fields: Excel.SortField[];Valeur de propriété
Remarques
matchCase
Spécifie si la casse a un impact sur le dernier type de la table.
readonly matchCase: boolean;Valeur de propriété
boolean
Remarques
method
Représente la dernière méthode de classement des caractères chinois utilisée pour trier la table.
readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";Valeur de propriété
Excel.SortMethod | "PinYin" | "StrokeCount"
Remarques
Détails de la méthode
apply(fields, matchCase, method)
Effectue une opération de tri.
apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;Paramètres
- fields
Liste des conditions de tri.
- matchCase
-
boolean
Optional. Indique si la casse influe sur le classement des chaînes.
- method
- Excel.SortMethod
Optional. Méthode de classement utilisée pour les caractères chinois.
Retours
void
Remarques
[ Ensemble d’API : ExcelApi 1.2 ]
Exemples
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.sort.apply([
{
key: 2,
ascending: true
},
], true);
await context.sync();
});
apply(fields, matchCase, methodString)
Effectue une opération de tri.
apply(fields: Excel.SortField[], matchCase?: boolean, methodString?: "PinYin" | "StrokeCount"): void;Paramètres
- fields
Liste des conditions de tri.
- matchCase
-
boolean
Optional. Indique si la casse influe sur le classement des chaînes.
- methodString
-
"PinYin" | "StrokeCount"
Optional. Méthode de classement utilisée pour les caractères chinois.
Retours
void
Remarques
clear()
Efface le tri actuellement appliqué au tableau. Même si le classement du tableau n’est pas modifié, l’état des boutons d’en-tête est rétabli.
clear(): void;Retours
void
Remarques
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.TableSortLoadOptions): Excel.TableSort;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
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.TableSort;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
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.TableSort;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
reapply()
Applique à nouveau les paramètres actuels de tri au tableau.
reapply(): void;Retours
void
Remarques
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 d’origine Excel.TableSort est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TableSortDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.TableSortData;