次の方法で共有


Excel.TableSort class

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

Extends

注釈

[ API セット: ExcelApi 1.2 ]

プロパティ

context

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

fields

テーブルの最後の並べ替えに使用される現在の条件を指定します。

matchCase

大文字と小文字がテーブルの最後の並べ替えに影響するかどうかを指定します。

method

テーブルの並べ替えに最後に使用した中国語の文字順序付けメソッドを表します。

メソッド

apply(fields, matchCase, method)

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

apply(fields, matchCase, methodString)

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

clear()

テーブルに現在設定されている並べ替えをクリアします。 これにより表の順序が変更されることはありませんが、ヘッダーのボタンの状態がクリアされます。

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

reapply()

テーブルに、現在の並べ替えパラメーターを再適用します。

toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

fields

テーブルの最後の並べ替えに使用される現在の条件を指定します。

readonly fields: Excel.SortField[];

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

matchCase

大文字と小文字がテーブルの最後の並べ替えに影響するかどうかを指定します。

readonly matchCase: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.2 ]

method

テーブルの並べ替えに最後に使用した中国語の文字順序付けメソッドを表します。

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

プロパティ値

Excel.SortMethod | "PinYin" | "StrokeCount"

注釈

[ API セット: ExcelApi 1.2 ]

メソッドの詳細

apply(fields, matchCase, method)

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

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

パラメーター

fields

Excel.SortField[]

並べ替えに使用する条件の一覧。

matchCase

boolean

省略可能。 大文字小文字の区別が文字列の順序に影響を与えるかどうか。

method
Excel.SortMethod

省略可能。 中国語文字に使用される順序付けの方法です。

戻り値

void

注釈

[ API セット: ExcelApi 1.2 ]

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)

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

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

パラメーター

fields

Excel.SortField[]

並べ替えに使用する条件の一覧。

matchCase

boolean

省略可能。 大文字小文字の区別が文字列の順序に影響を与えるかどうか。

methodString

"PinYin" | "StrokeCount"

省略可能。 中国語文字に使用される順序付けの方法です。

戻り値

void

注釈

[ API セット: ExcelApi 1.2 ]

clear()

テーブルに現在設定されている並べ替えをクリアします。 これにより表の順序が変更されることはありませんが、ヘッダーのボタンの状態がクリアされます。

clear(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.2 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

options
Excel.Interfaces.TableSortLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNamesAndPaths

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

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

reapply()

テーブルに、現在の並べ替えパラメーターを再適用します。

reapply(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.2 ]

toJSON()

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

toJSON(): Excel.Interfaces.TableSortData;

戻り値