Excel.RangeSort class

  • Referência
Pacote:
excel

Gere operações de ordenação em Range objetos.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Propriedades

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

Métodos

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

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

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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.RangeSort original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.RangeSortData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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 API: ExcelApi 1.2 ]

apply(fields, matchCase, hasHeaders, orientationString, methodString)

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

apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientationString?: "Rows" | "Columns", methodString?: "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.

orientationString

"Rows" | "Columns"

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

methodString

"PinYin" | "StrokeCount"

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

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.RangeSort original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.RangeSortData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

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

Retornos

{ [key: string]: string; }