Word.TableRowCollection class

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

context: RequestContext;

プロパティ値

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Word.TableRow[];

プロパティ値

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

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

パラメーター

返品

変換されたテキストを表す Range オブジェクト。

注釈

API セット: WordApiDesktop 1.4

テーブルの行を削除します。

delete(): void;

返品

注釈

API セット: WordApiDesktop 1.4

行が等しくなるように高さを調整します。

distributeHeight(): void;

返品

注釈

API セット: WordApiDesktop 1.4

このコレクション内の最初の行を取得します。 このコレクションが空の場合は、 ItemNotFound エラーをスローします。

getFirst(): Word.TableRow;

返品

注釈

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

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

getFirstOrNullObject(): Word.TableRow;

返品

注釈

API セット: WordApi 1.3

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

load(options?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection;

パラメーター

返品

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

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

パラメーター

返品

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection;

パラメーター

返品

テーブルの行を選択します。

select(): void;

返品

注釈

API セット: WordApiDesktop 1.4

表のセルの高さを設定します。

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.TableRowCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Word.Interfaces.TableRowCollectionData として型指定された) を返します。

toJSON(): Word.Interfaces.TableRowCollectionData;

返品

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

track(): Word.TableRowCollection;

返品

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

untrack(): Word.TableRowCollection;

返品