Word.TableRow class

行のセルの数を取得します。

readonly cellCount: number;

プロパティ値

注釈

API セット: WordApi 1.3

セルを取得します。

readonly cells: Word.TableCellCollection;

プロパティ値

注釈

API セット: WordApi 1.3

例

// 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}`,
  );
});

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

context: RequestContext;

プロパティ値

テーブル行の文末脚注のコレクションを取得します。

readonly endnotes: Word.NoteItemCollection;

プロパティ値

注釈

API セット: WordAPI 1.5

テーブル行の Field オブジェクトのコレクションを取得します。

readonly fields: Word.FieldCollection;

プロパティ値

注釈

API セット: WordApi 1.4

フォントを取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。

readonly font: Word.Font;

プロパティ値

注釈

API セット: WordApi 1.3

テーブル行の脚注のコレクションを取得します。

readonly footnotes: Word.NoteItemCollection;

プロパティ値

注釈

API セット: WordAPI 1.5

行のすべてのセルの水平方向の配置を指定します。 値には、 left、 centered、 right、または justified を指定できます。

horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

プロパティ値

注釈

API セット: WordApi 1.3

行がヘッダー行であるかどうかを確認します。 ヘッダー行数を設定するには、Table オブジェクトで headerRowCount を使用します。

readonly isHeader: boolean;

プロパティ値

注釈

API セット: WordApi 1.3

親テーブルを取得します。

readonly parentTable: Word.Table;

プロパティ値

注釈

API セット: WordApi 1.3

行の優先高さをポイント単位で指定します。

preferredHeight: number;

プロパティ値

注釈

API セット: WordApi 1.3

テーブルの行を表す Range オブジェクトを返します。

readonly range: Word.Range;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

親テーブル内の行のインデックスを取得します。

readonly rowIndex: number;

プロパティ値

注釈

API セット: WordApi 1.3

テーブル行の網掛けを表す ShadingUniversal オブジェクトを返します。

readonly shading: Word.ShadingUniversal;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

網かけの色を指定します。 色は、"#RRGGBB" 形式で指定するか、色の名前を使用して指定します。

shadingColor: string;

プロパティ値

注釈

API セット: WordApi 1.3

行のテキスト値を 2D JavaScript 配列として指定します。

values: string[][];

プロパティ値

注釈

API セット: WordApi 1.3

行のセルの垂直方向の配置を指定します。 値には、 top、 center、または bottom を指定できます。

verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";

プロパティ値

注釈

API セット: WordApi 1.3

行の内容をクリアします。

clear(): void;

返品

注釈

API セット: WordApi 1.3

表の行をテキストに変換します。

convertToText(options?: Word.TableConvertToTextOptions): Word.Range;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

行全体を削除します。

delete(): void;

返品

注釈

API セット: WordApi 1.3

行のセルの罫線スタイルを取得します。

getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;

パラメーター

返品

注釈

API セット: WordApi 1.3

例

// 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(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;

パラメーター

返品

注釈

API セット: WordApi 1.3

セル内のスペースをポイント単位で取得します。

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;

パラメーター

返品

注釈

API セット: WordApi 1.3

例

// 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(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

パラメーター

返品

注釈

API セット: WordApi 1.3

次の行を取得します。 この行が最後の行である場合は、 ItemNotFound エラーをスローします。

getNext(): Word.TableRow;

返品

注釈

API セット: WordApi 1.3

次の行を取得します。 この行が最後の行である場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getNextOrNullObject(): Word.TableRow;

返品

注釈

API セット: WordApi 1.3

行にコンテンツ コントロールを挿入します。

insertContentControl(): Word.ContentControl;

返品

注釈

API セット: WordApiDesktop 1.1

この行をテンプレートとして使用して、行を挿入します。 値を指定すると、新しい行に値を挿入します。

insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;

パラメーター

返品

注釈

API セット: WordApi 1.3

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

load(options?: Word.Interfaces.TableRowLoadOptions): Word.TableRow;

パラメーター

返品

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

load(propertyNames?: string | string[]): Word.TableRow;

パラメーター

返品

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableRow;

パラメーター

返品

行を 1 つのセルに結合します。

merge(): Word.TableCell;

返品

注釈

API セット: WordApi 1.4

行の範囲に対して、指定された検索オプションを使用して検索を実行します。 検索結果は、 Range オブジェクトのコレクションです。

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

パラメーター

返品

注釈

API セット: WordApi 1.3

行を選択し、その行に Word の UI を移動します。

select(selectionMode?: Word.SelectionMode): void;

パラメーター

返品

注釈

API セット: WordApi 1.3

行を選択し、その行に Word の UI を移動します。

select(selectionMode?: "Select" | "Start" | "End"): void;

パラメーター

返品

注釈

API セット: WordApi 1.3

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.TableRow): void;

パラメーター

返品

セル内のスペースをポイント単位で設定します。

setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;

パラメーター

返品

注釈

API セット: WordApi 1.3

セル内のスペースをポイント単位で設定します。

setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;

パラメーター

返品

注釈

API セット: WordApi 1.3

行の高さを設定します。

setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

行の高さを設定します。

setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

テーブル行の左インデントを設定します。

setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

テーブル行の左インデントを設定します。

setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

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

toJSON(): Word.Interfaces.TableRowData;

返品

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.TableRow;

返品

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.TableRow;

返品