Excel.TableSort class
Gerencia operações de classificação em Table
objetos.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.2 ]
Propriedades
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
fields | Especifica as condições atuais usadas para classificar a tabela pela última vez. |
match |
Especifica se o invólucro afeta o último tipo da tabela. |
method | Representa o método de ordenação de caracteres chinês usado pela última vez para classificar a tabela. |
Métodos
apply(fields, match |
Executa uma operação de classificação. |
apply(fields, match |
Executa uma operação de classificação. |
clear() | Limpa a classificação que está na tabela. Essa ação não modifica a ordenação da tabela, mas limpa o estado dos botões do cabeçalho. |
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
reapply() | Reaplica os parâmetros de classificação atuais à tabela. |
toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;
Valor da propriedade
fields
Especifica as condições atuais usadas para classificar a tabela pela última vez.
readonly fields: Excel.SortField[];
Valor da propriedade
Comentários
matchCase
Especifica se o invólucro afeta o último tipo da tabela.
readonly matchCase: boolean;
Valor da propriedade
boolean
Comentários
method
Representa o método de ordenação de caracteres chinês usado pela última vez para classificar a tabela.
readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";
Valor da propriedade
Excel.SortMethod | "PinYin" | "StrokeCount"
Comentários
Detalhes do método
apply(fields, matchCase, method)
Executa uma operação de classificação.
apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;
Parâmetros
- fields
A lista de condições para a classificação.
- matchCase
-
boolean
Opcional. Define se o uso de maiúsculas ou minúsculas afeta a ordenação da cadeia de caracteres.
- method
- Excel.SortMethod
Opcional. O método de ordenação usado pelos caracteres chineses.
Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.2 ]
Exemplos
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)
Executa uma operação de classificação.
apply(fields: Excel.SortField[], matchCase?: boolean, methodString?: "PinYin" | "StrokeCount"): void;
Parâmetros
- fields
A lista de condições para a classificação.
- matchCase
-
boolean
Opcional. Define se o uso de maiúsculas ou minúsculas afeta a ordenação da cadeia de caracteres.
- methodString
-
"PinYin" | "StrokeCount"
Opcional. O método de ordenação usado pelos caracteres chineses.
Retornos
void
Comentários
clear()
Limpa a classificação que está na tabela. Essa ação não modifica a ordenação da tabela, mas limpa o estado dos botões do cabeçalho.
clear(): void;
Retornos
void
Comentários
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;
Parâmetros
Fornece opções para quais propriedades do objeto carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.TableSort;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableSort;
Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
reapply()
Reaplica os parâmetros de classificação atuais à tabela.
reapply(): void;
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON()
para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify()
. (JSON.stringify
por sua vez, chama o toJSON
método do objeto que é passado para ele.) Enquanto o objeto Excel.TableSort original é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TableSortData
) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.TableSortData;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de