Excel.RangeSort class

  • Ссылка
Пакет:
excel

Управляет операциями сортировки объектов Range .

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.2 ]

Свойства

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

Методы

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

Выполняет сортировку.
apply(fields, matchCase, hasHeaders, orientationString, methodString)

Выполняет сортировку.
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.RangeSort является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.RangeSortData), который содержит мелкие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

Сведения о методе

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

Выполняет сортировку.

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

Параметры

fields

Excel.SortField[]

Список условий для сортировки.

matchCase

boolean

Необязательный параметр. Указывает, необходимо ли учитывать регистр при сортировке строк.

hasHeaders

boolean

Необязательный параметр. Указывает, есть ли у диапазона заголовок.

orientation
Excel.SortOrientation

Необязательный параметр. Указывает направление сортировки: по строкам или по столбцам.

method
Excel.SortMethod

Необязательный параметр. Метод сортировки, используемый для китайских символов.

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

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

Выполняет сортировку.

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

Параметры

fields

Excel.SortField[]

Список условий для сортировки.

matchCase

boolean

Необязательный параметр. Указывает, необходимо ли учитывать регистр при сортировке строк.

hasHeaders

boolean

Необязательный параметр. Указывает, есть ли у диапазона заголовок.

orientationString

"Rows" | "Columns"

Необязательный параметр. Указывает направление сортировки: по строкам или по столбцам.

methodString

"PinYin" | "StrokeCount"

Необязательный параметр. Метод сортировки, используемый для китайских символов.

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.RangeSort является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.RangeSortData), который содержит мелкие копии всех загруженных дочерних свойств из исходного объекта.

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

Возвращаемое значение

{ [key: string]: string; }