Word.TableRow class
Word ドキュメント内の行を表します。
- Extends
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
プロパティ
| cell |
行のセルの数を取得します。 |
| cells | セルを取得します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| endnotes | テーブル行の文末脚注のコレクションを取得します。 |
| fields | テーブル行のフィールド オブジェクトのコレクションを取得します。 |
| font | フォントを取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。 |
| footnotes | テーブル行の脚注のコレクションを取得します。 |
| horizontal |
行内のすべてのセルの水平方向の配置を指定します。 値には、'Left'、'Centered'、'Right'、または 'Justified' を指定できます。 |
| is |
行がヘッダー行であるかどうかを確認します。 ヘッダー行の数を設定するには、Table オブジェクトで |
| parent |
親テーブルを取得します。 |
| preferred |
行の高さをポイント単位で指定します。 |
| row |
親テーブル内の行のインデックスを取得します。 |
| shading |
網かけの色を指定します。 色は、"#RRGGBB" 形式で指定するか、色の名前を使用して指定します。 |
| values | 行内のテキスト値を 2D JavaScript 配列として指定します。 |
| vertical |
行内のセルの垂直方向の配置を指定します。 値には、'Top'、'Center'、または 'Bottom' を指定できます。 |
メソッド
| clear() | 行の内容をクリアします。 |
| delete() | 行全体を削除します。 |
| get |
行のセルの罫線スタイルを取得します。 |
| get |
行のセルの罫線スタイルを取得します。 |
| get |
セル内のスペースをポイント単位で取得します。 |
| get |
セル内のスペースをポイント単位で取得します。 |
| get |
次の行を取得します。 この行が最後の行である場合は、 |
| get |
次の行を取得します。 この行が最後の行の場合、このメソッドは |
| insert |
この行をテンプレートとして使用して、行を挿入します。 値を指定すると、新しい行に値を挿入します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| merge() | 行を 1 つのセルにマージします。 |
| search(search |
行のスコープに対して、指定した SearchOptions を使用して検索を実行します。 検索結果は、範囲オブジェクトのコレクションです。 |
| select(selection |
行を選択し、その行に Word の UI を移動します。 |
| select(selection |
行を選択し、その行に Word の UI を移動します。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
セル内のスペースをポイント単位で設定します。 |
| set |
セル内のスペースをポイント単位で設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
cellCount
cells
セルを取得します。
readonly cells: Word.TableCellCollection;プロパティ値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
endnotes
テーブル行の文末脚注のコレクションを取得します。
readonly endnotes: Word.NoteItemCollection;プロパティ値
注釈
fields
テーブル行のフィールド オブジェクトのコレクションを取得します。
readonly fields: Word.FieldCollection;プロパティ値
注釈
font
フォントを取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。
readonly font: Word.Font;プロパティ値
注釈
footnotes
テーブル行の脚注のコレクションを取得します。
readonly footnotes: Word.NoteItemCollection;プロパティ値
注釈
horizontalAlignment
行内のすべてのセルの水平方向の配置を指定します。 値には、'Left'、'Centered'、'Right'、または 'Justified' を指定できます。
horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";プロパティ値
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
注釈
isHeader
行がヘッダー行であるかどうかを確認します。 ヘッダー行の数を設定するには、Table オブジェクトで headerRowCount を使用します。
readonly isHeader: boolean;プロパティ値
boolean
注釈
parentTable
preferredHeight
rowIndex
shadingColor
網かけの色を指定します。 色は、"#RRGGBB" 形式で指定するか、色の名前を使用して指定します。
shadingColor: string;プロパティ値
string
注釈
values
行内のテキスト値を 2D JavaScript 配列として指定します。
values: string[][];プロパティ値
string[][]
注釈
verticalAlignment
行内のセルの垂直方向の配置を指定します。 値には、'Top'、'Center'、または 'Bottom' を指定できます。
verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";プロパティ値
Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"
注釈
メソッドの詳細
clear()
delete()
getBorder(borderLocation)
行のセルの罫線スタイルを取得します。
getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;パラメーター
- borderLocation
- Word.BorderLocation
必須です。 罫線の場所。
戻り値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets border details about the first row of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
const borderLocation = Word.BorderLocation.bottom;
const border: Word.TableBorder = firstTableRow.getBorder(borderLocation);
border.load(["type", "color", "width"]);
await context.sync();
console.log(`Details about the ${borderLocation} border of the first table's first row:`, `- Color: ${border.color}`, `- Type: ${border.type}`, `- Width: ${border.width} points`);
});
getBorder(borderLocationString)
行のセルの罫線スタイルを取得します。
getBorder(borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;パラメーター
- borderLocationString
-
"Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"
必須です。 罫線の場所。
戻り値
注釈
getCellPadding(cellPaddingLocation)
セル内のスペースをポイント単位で取得します。
getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;パラメーター
- cellPaddingLocation
- Word.CellPaddingLocation
必須です。 セルのパディングの場所は、'Top'、'Left'、'Bottom'、または 'Right' である必要があります。
戻り値
OfficeExtension.ClientResult<number>
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets cell padding details about the first row of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
const cellPaddingLocation = Word.CellPaddingLocation.bottom;
const cellPadding = firstTableRow.getCellPadding(cellPaddingLocation);
await context.sync();
console.log(
`Cell padding details about the ${cellPaddingLocation} border of the first table's first row: ${cellPadding.value} points`
);
});
getCellPadding(cellPaddingLocationString)
セル内のスペースをポイント単位で取得します。
getCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;パラメーター
- cellPaddingLocationString
-
"Top" | "Left" | "Bottom" | "Right"
必須です。 セルのパディングの場所は、'Top'、'Left'、'Bottom'、または 'Right' である必要があります。
戻り値
OfficeExtension.ClientResult<number>
注釈
getNext()
次の行を取得します。 この行が最後の行である場合は、 ItemNotFound エラーをスローします。
getNext(): Word.TableRow;戻り値
注釈
getNextOrNullObject()
次の行を取得します。 この行が最後の行の場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getNextOrNullObject(): Word.TableRow;戻り値
注釈
insertRows(insertLocation, rowCount, values)
この行をテンプレートとして使用して、行を挿入します。 値を指定すると、新しい行に値を挿入します。
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;パラメーター
必須です。 現在の行を基準にして、新しい行を挿入する必要があります。 'Before' または 'After' である必要があります。
- rowCount
-
number
必須。 追加する行数
- values
-
string[][]
省略可能。 2D 配列として指定された新しい行に挿入する文字列。 各行のセルの数は、既存の行のセル数を超えてはなりません。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.TableRowLoadOptions): Word.TableRow;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.TableRow;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableRow;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
merge()
search(searchText, searchOptions)
行のスコープに対して、指定した SearchOptions を使用して検索を実行します。 検索結果は、範囲オブジェクトのコレクションです。
search(searchText: string, searchOptions?: Word.SearchOptions | {
ignorePunct?: boolean;
ignoreSpace?: boolean;
matchCase?: boolean;
matchPrefix?: boolean;
matchSuffix?: boolean;
matchWholeWord?: boolean;
matchWildcards?: boolean;
}): Word.RangeCollection;パラメーター
- searchText
-
string
必須です。 検索テキスト。
- searchOptions
-
Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }
省略可能。 検索のオプション。
戻り値
注釈
select(selectionMode)
行を選択し、その行に Word の UI を移動します。
select(selectionMode?: Word.SelectionMode): void;パラメーター
- selectionMode
- Word.SelectionMode
省略可能。 選択モードは、'Select'、'Start'、または 'End' である必要があります。 'Select' が既定値です。
戻り値
void
注釈
select(selectionModeString)
行を選択し、その行に Word の UI を移動します。
select(selectionModeString?: "Select" | "Start" | "End"): void;パラメーター
- selectionModeString
-
"Select" | "Start" | "End"
省略可能。 選択モードは、'Select'、'Start'、または 'End' である必要があります。 'Select' が既定値です。
戻り値
void
注釈
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.TableRowUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.TableRow): void;パラメーター
- properties
- Word.TableRow
戻り値
void
setCellPadding(cellPaddingLocation, cellPadding)
セル内のスペースをポイント単位で設定します。
setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;パラメーター
- cellPaddingLocation
- Word.CellPaddingLocation
必須です。 セルのパディングの場所は、'Top'、'Left'、'Bottom'、または 'Right' である必要があります。
- cellPadding
-
number
必須です。 セルのパディング。
戻り値
void
注釈
setCellPadding(cellPaddingLocationString, cellPadding)
セル内のスペースをポイント単位で設定します。
setCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;パラメーター
- cellPaddingLocationString
-
"Top" | "Left" | "Bottom" | "Right"
必須。 セルのパディングの場所は、'Top'、'Left'、'Bottom'、または 'Right' である必要があります。
- cellPadding
-
number
必須です。 セルのパディング。
戻り値
void
注釈
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.TableRow オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.TableRowData として型指定) を返します。
toJSON(): Word.Interfaces.TableRowData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.TableRow;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): Word.TableRow;戻り値
Office Add-ins