Excel.RangeSort class

Range オブジェクトに対する並べ替え操作を管理します。

Extends

注釈

[ API セット: ExcelApi 1.2 ]

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

メソッド

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

並べ替え操作を実行します。

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

並べ替え操作を実行します。

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RangeSort オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RangeSortData として型指定) を返します。

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: 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()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RangeSort オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RangeSortData として型指定) を返します。

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

戻り値

{ [key: string]: string; }