Excel.RangeSort class

Pacote:
excel

Gerencia operações de classificação em Range objetos.

Extends
OfficeExtension.ClientObject

Comentários

Conjunto de APIs: ExcelApi 1.2

Usada por

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

Métodos

apply(fields, matchCase, hasHeaders, orientation, method)

Executa uma operação de classificação.
apply(fields, matchCase, hasHeaders, orientation, method)

Executa uma operação de classificação.
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 original Excel.RangeSort é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeSortData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

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

Excel.RequestContext

Detalhes do método

apply(fields, matchCase, hasHeaders, orientation, method)

Executa uma operação de classificação.

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

Parâmetros

fields

Excel.SortField[]

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.

hasHeaders

boolean

Opcional. Se o intervalo tem um cabeçalho.

orientation
Excel.SortOrientation

Opcional. Se a operação classifica linhas ou colunas.

method
Excel.SortMethod

Opcional. O método de ordenação usado pelos caracteres chineses.

Retornos

void

Comentários

Conjunto de APIs: ExcelApi 1.2

apply(fields, matchCase, hasHeaders, orientation, method)

Executa uma operação de classificação.

apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: "Rows" | "Columns", method?: "PinYin" | "StrokeCount"): void;

Parâmetros

fields

Excel.SortField[]

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.

hasHeaders

boolean

Opcional. Se o intervalo tem um cabeçalho.

orientation

"Rows" | "Columns"

Opcional. Se a operação classifica linhas ou colunas.

method

"PinYin" | "StrokeCount"

Opcional. O método de ordenação usado pelos caracteres chineses.

Retornos

void

Comentários

Conjunto de APIs: ExcelApi 1.2

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 original Excel.RangeSort é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeSortData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): {
            [key: string]: string;
        };

Retornos

{ [key: string]: string; }