Excel.TableSort class

Paquete:

excel

Administra las operaciones de ordenación en Table objetos.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
fields	Especifica las condiciones actuales usadas para ordenar por última vez la tabla.
matchCase	Especifica si el uso de mayúsculas y minúsculas afecta al último tipo de tabla.
method	Representa el método de ordenación de caracteres chino que se usó por última vez para ordenar la tabla.

Métodos

apply(fields, matchCase, method)	Realizar una operación de ordenación.
apply(fields, matchCase, methodString)	Realizar una operación de ordenación.
clear()	Borra la ordenación que se aplica actualmente en la tabla. Aunque esto no modifica la ordenación de la tabla, borra el estado de los botones de encabezado.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
reapply()	Vuelve a aplicar los parámetros de ordenación actuales a la tabla.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.TableSort original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableSortData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

fields

Especifica las condiciones actuales usadas para ordenar por última vez la tabla.

readonly fields: Excel.SortField[];

Valor de propiedad

Excel.SortField[]

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

matchCase

Especifica si el uso de mayúsculas y minúsculas afecta al último tipo de tabla.

readonly matchCase: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

method

Representa el método de ordenación de caracteres chino que se usó por última vez para ordenar la tabla.

readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";

Valor de propiedad

Excel.SortMethod | "PinYin" | "StrokeCount"

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Detalles del método

apply(fields, matchCase, method)

Realizar una operación de ordenación.

apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;

Parámetros

fields

Excel.SortField[]

La lista de condiciones por las que realizar la ordenación.

matchCase

boolean

Opcional. Indica si la ordenación de cadenas distingue mayúsculas de minúsculas.

method

Excel.SortMethod

Opcional. Método de ordenación que se usa para los caracteres chinos.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Ejemplos

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)

Realizar una operación de ordenación.

apply(fields: Excel.SortField[], matchCase?: boolean, methodString?: "PinYin" | "StrokeCount"): void;

Parámetros

fields

Excel.SortField[]

La lista de condiciones por las que realizar la ordenación.

matchCase

boolean

Opcional. Indica si la ordenación de cadenas distingue mayúsculas de minúsculas.

methodString

"PinYin" | "StrokeCount"

Opcional. Método de ordenación que se usa para los caracteres chinos.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

clear()

Borra la ordenación que se aplica actualmente en la tabla. Aunque esto no modifica la ordenación de la tabla, borra el estado de los botones de encabezado.

clear(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;

Parámetros

options

Excel.Interfaces.TableSortLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.TableSort

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.TableSort

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.TableSort

reapply()

Vuelve a aplicar los parámetros de ordenación actuales a la tabla.

reapply(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.TableSort original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableSortData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.TableSortData;

Devoluciones

Excel.Interfaces.TableSortData