OneNote.TableRow class
テーブル内の行を表します。
- Extends
注釈
プロパティ
| cell |
行のセルの数を取得します。 読み取り専用です。 |
| cells | 行のセルを取得します。 読み取り専用です。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| id | 行の ID を取得します。 読み取り専用です。 |
| parent |
親テーブルを取得します。 読み取り専用です。 |
| row |
親テーブル内の行のインデックスを取得します。 読み取り専用です。 |
メソッド
| clear() | 行の内容をクリアします。 |
| insert |
現在の行の前後に行を挿入します。 |
| insert |
現在の行の前後に行を挿入します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set |
行のすべてのセルの網かけの色を設定します。 セルに設定する色コード。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは の短縮形です |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは の |
プロパティの詳細
cellCount
cells
行のセルを取得します。 読み取り専用です。
readonly cells: OneNote.TableCellCollection;プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
id
parentTable
親テーブルを取得します。 読み取り専用です。
readonly parentTable: OneNote.Table;プロパティ値
注釈
rowIndex
親テーブル内の行のインデックスを取得します。 読み取り専用です。
readonly rowIndex: number;プロパティ値
number
注釈
メソッドの詳細
clear()
insertRowAsSibling(insertLocation, values)
現在の行の前後に行を挿入します。
insertRowAsSibling(insertLocation: OneNote.InsertLocation, values?: string[]): OneNote.TableRow;パラメーター
- insertLocation
- OneNote.InsertLocation
現在の行を基準にした新しい行を挿入する場所。
- values
-
string[]
配列として指定された、新しい行に挿入する文字列。 現在の行内のセルよりも多くのセル数にすることはできません。 オプション。
戻り値
注釈
例
await OneNote.run(async (context) => {
const app = context.application;
const outline = app.getActiveOutline();
// Queue a command to load outline.paragraphs and their types.
context.load(outline, "paragraphs, paragraphs/type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const paragraphs = outline.paragraphs;
// For each table, get table rows.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
// Queue a command to load table.rows.
context.load(table, "rows");
// Run the queued commands.
await context.sync();
const rows = table.rows;
rows.items[1].insertRowAsSibling("Before", ["cell0", "cell1"]);
await context.sync();
}
}
});
insertRowAsSibling(insertLocationString, values)
現在の行の前後に行を挿入します。
insertRowAsSibling(insertLocationString: "Before" | "After", values?: string[]): OneNote.TableRow;パラメーター
- insertLocationString
-
"Before" | "After"
現在の行を基準にした新しい行を挿入する場所。
- values
-
string[]
配列として指定された、新しい行に挿入する文字列。 現在の行内のセルよりも多くのセル数にすることはできません。 オプション。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: OneNote.Interfaces.TableRowLoadOptions): OneNote.TableRow;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): OneNote.TableRow;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
await OneNote.run(async (context) => {
const app = context.application;
const outline = app.getActiveOutline();
// Queue a command to load outline.paragraphs and their types.
context.load(outline, "paragraphs, paragraphs/type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const paragraphs = outline.paragraphs;
// For each table, get table rows.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
// Queue a command to load table.rows.
context.load(table, "rows");
await context.sync();
const rows = table.rows;
// For each table row, log cell count and row index.
for (let i = 0; i < rows.items.length; i++) {
console.log("Row " + i + " Id: " + rows.items[i].id);
console.log("Row " + i + " Cell Count: " + rows.items[i].cellCount);
console.log("Row " + i + " Row Index: " + rows.items[i].rowIndex);
}
await context.sync();
}
}
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.TableRow;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
setShadingColor(colorCode)
行のすべてのセルの網かけの色を設定します。 セルに設定する色コード。
setShadingColor(colorCode: string): void;パラメーター
- colorCode
-
string
戻り値
void
注釈
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の OneNote.TableRow オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として OneNote.Interfaces.TableRowData型指定) を返します。
toJSON(): OneNote.Interfaces.TableRowData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは の短縮形です context.trackedObjects.add(thisObject)。 このオブジェクトを呼び出しで .sync 使用し、".run" バッチのシーケンシャル実行の外部で使用していて、プロパティを設定するとき、またはオブジェクトのメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。
track(): OneNote.TableRow;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは の context.trackedObjects.remove(thisObject)短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に を呼び出す context.sync() 必要があります。
untrack(): OneNote.TableRow;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示