次の方法で共有


Word.TableStyle class

TableStyle オブジェクトを表します。

Extends

注釈

[ API セット: WordApi 1.6 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml

// Gets the table style properties and displays them in the form.
const styleName = $("#style-name")
  .val()
  .toString();
if (styleName == "") {
  console.warn("Please input a table style name.");
  return;
}

await Word.run(async (context) => {
  const tableStyle: Word.TableStyle = context.document.getStyles().getByName(styleName).tableStyle;
  tableStyle.load();
  await context.sync();

  if (tableStyle.isNullObject) {
    console.warn(`There's no existing table style with the name '${styleName}'.`);
    return;
  }

  console.log(tableStyle);
  $("#alignment").val(tableStyle.alignment);
  $("#allow-break-across-page").val(tableStyle.allowBreakAcrossPage.toString());
  $("#top-cell-margin").val(tableStyle.topCellMargin);
  $("#bottom-cell-margin").val(tableStyle.bottomCellMargin);
  $("#left-cell-margin").val(tableStyle.leftCellMargin);
  $("#right-cell-margin").val(tableStyle.rightCellMargin);
  $("#cell-spacing").val(tableStyle.cellSpacing);
});

プロパティ

alignment

ページ余白に対するテーブルの配置を指定します。

allowBreakAcrossPage

指定したスタイルで書式設定されたテーブル内の行をページ間で区切るかどうかを指定します。

bottomCellMargin

コンテンツとセルの下罫線の間に追加する領域の量を指定します。

cellSpacing

テーブル スタイルのセル間の間隔 (ポイント単位) を指定します。

context

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

leftCellMargin

内容とセルの左罫線の間に追加する領域の量を指定します。

rightCellMargin

内容とセルの右罫線の間に追加する領域の量を指定します。

topCellMargin

コンテンツとセルの上罫線の間に追加する領域の量を指定します。

メソッド

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

track()

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

untrack()

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

プロパティの詳細

alignment

ページ余白に対するテーブルの配置を指定します。

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

プロパティ値

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

注釈

[ API セット: WordApiDesktop 1.1 ]

allowBreakAcrossPage

指定したスタイルで書式設定されたテーブル内の行をページ間で区切るかどうかを指定します。

allowBreakAcrossPage: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApiDesktop 1.1 ]

bottomCellMargin

コンテンツとセルの下罫線の間に追加する領域の量を指定します。

bottomCellMargin: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.6 ]

cellSpacing

テーブル スタイルのセル間の間隔 (ポイント単位) を指定します。

cellSpacing: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.6 ]

context

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

context: RequestContext;

プロパティ値

leftCellMargin

内容とセルの左罫線の間に追加する領域の量を指定します。

leftCellMargin: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.6 ]

rightCellMargin

内容とセルの右罫線の間に追加する領域の量を指定します。

rightCellMargin: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.6 ]

topCellMargin

コンテンツとセルの上罫線の間に追加する領域の量を指定します。

topCellMargin: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.6 ]

メソッドの詳細

load(options)

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

load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;

パラメーター

options
Word.Interfaces.TableStyleLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

set(properties, options)

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

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

パラメーター

properties
Word.Interfaces.TableStyleUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

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

set(properties: Word.TableStyle): void;

パラメーター

properties
Word.TableStyle

戻り値

void

toJSON()

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

toJSON(): Word.Interfaces.TableStyleData;

戻り値

track()

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

track(): Word.TableStyle;

戻り値

untrack()

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

untrack(): Word.TableStyle;

戻り値