Excel.TableSort class
オブジェクトの並べ替え操作を Table 管理します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| fields | テーブルの最後の並べ替えに使用される現在の条件を指定します。 |
| match |
大文字と小文字がテーブルの最後の並べ替えに影響するかどうかを指定します。 |
| method | テーブルの並べ替えに最後に使用した中国語の文字順序付けメソッドを表します。 |
メソッド
| apply(fields, match |
並べ替え操作を実行します。 |
| apply(fields, match |
並べ替え操作を実行します。 |
| clear() | テーブルに現在設定されている並べ替えをクリアします。 これにより表の順序が変更されることはありませんが、ヘッダーのボタンの状態がクリアされます。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| reapply() | テーブルに、現在の並べ替えパラメーターを再適用します。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
fields
テーブルの最後の並べ替えに使用される現在の条件を指定します。
readonly fields: Excel.SortField[];プロパティ値
注釈
matchCase
大文字と小文字がテーブルの最後の並べ替えに影響するかどうかを指定します。
readonly matchCase: boolean;プロパティ値
boolean
注釈
method
テーブルの並べ替えに最後に使用した中国語の文字順序付けメソッドを表します。
readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";プロパティ値
Excel.SortMethod | "PinYin" | "StrokeCount"
注釈
メソッドの詳細
apply(fields, matchCase, method)
並べ替え操作を実行します。
apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;パラメーター
- fields
並べ替えに使用する条件の一覧。
- matchCase
-
boolean
オプション。 大文字小文字の区別が文字列の順序に影響を与えるかどうか。
- method
- Excel.SortMethod
オプション。 中国語文字に使用される順序付けの方法です。
戻り値
void
注釈
例
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
並べ替えに使用する条件の一覧。
- matchCase
-
boolean
オプション。 大文字小文字の区別が文字列の順序に影響を与えるかどうか。
- methodString
-
"PinYin" | "StrokeCount"
オプション。 中国語文字に使用される順序付けの方法です。
戻り値
void
注釈
clear()
テーブルに現在設定されている並べ替えをクリアします。 これにより表の順序が変更されることはありませんが、ヘッダーのボタンの状態がクリアされます。
clear(): void;戻り値
void
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
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()
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.TableSort オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.TableSortData型指定) を返します。
toJSON(): Excel.Interfaces.TableSortData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示