Word.TableStyle class
TableStyle オブジェクトを表します。
- Extends
注釈
使用元
例
// 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 = (document.getElementById("style-name") as HTMLInputElement).value;
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);
(document.getElementById("alignment") as HTMLInputElement).value = tableStyle.alignment;
(document.getElementById("allow-break-across-page") as HTMLInputElement).value = tableStyle.allowBreakAcrossPage.toString();
(document.getElementById("top-cell-margin") as HTMLInputElement).value = `${tableStyle.topCellMargin}`;
(document.getElementById("bottom-cell-margin") as HTMLInputElement).value = `${tableStyle.bottomCellMargin}`;
(document.getElementById("left-cell-margin") as HTMLInputElement).value = `${tableStyle.leftCellMargin}`;
(document.getElementById("right-cell-margin") as HTMLInputElement).value = `${tableStyle.rightCellMargin}`;
(document.getElementById("cell-spacing") as HTMLInputElement).value = `${tableStyle.cellSpacing}`;
});
プロパティ
| alignment | ページ余白に対する表の配置を指定します。 |
| allow |
スタイルで書式設定された表の行をページ間で改ページするかどうかを指定します。 |
| borders | テーブルのすべての境界線を表す |
| bottom |
セルの内容と下側の境界線の間に追加するスペースの量を指定します。 |
| cell |
表スタイルのセル間の間隔 (ポイント単位) を指定します。 |
| column |
スタイルで奇数列または偶数列のバンディングが指定されている場合に、バンディング内の列数を指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| is |
Microsoft Word で指定された表をページ間で分割できるかどうかを指定します。 |
| left |
セルの内容と左罫線の間に追加するスペースの量を指定します。 |
| left |
表スタイルの行の左インデント値 (ポイント単位) を指定します。 |
| right |
セルの内容と右罫線の間に追加するスペースの量を指定します。 |
| row |
スタイルで奇数行または偶数行のバンディングが指定されている場合に、バンディングに含める行数を指定します。 |
| shading | 表スタイルの網かけ書式を参照する |
| table |
Microsoft Word が表スタイルのセルを並べ替える方向を指定します。 |
| top |
セルの内容と上枠の間に追加するスペースの量を指定します。 |
メソッド
| condition(condition |
テーブルの一部に特別なスタイルの書式を設定する |
| condition(condition |
テーブルの一部に特別なスタイルの書式を設定する |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
alignment
ページ余白に対する表の配置を指定します。
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";プロパティ値
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
注釈
allowBreakAcrossPage
スタイルで書式設定された表の行をページ間で改ページするかどうかを指定します。
allowBreakAcrossPage: boolean;プロパティ値
boolean
注釈
borders
テーブルのすべての境界線を表す BorderUniversalCollection を返します。
readonly borders: Word.BorderUniversalCollection;プロパティ値
注釈
bottomCellMargin
cellSpacing
columnStripe
スタイルで奇数列または偶数列のバンディングが指定されている場合に、バンディング内の列数を指定します。
columnStripe: number;プロパティ値
number
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
isBreakAcrossPagesAllowed
Microsoft Word で指定された表をページ間で分割できるかどうかを指定します。
isBreakAcrossPagesAllowed: boolean;プロパティ値
boolean
注釈
leftCellMargin
leftIndent
rightCellMargin
rowStripe
スタイルで奇数行または偶数行のバンディングが指定されている場合に、バンディングに含める行数を指定します。
rowStripe: number;プロパティ値
number
注釈
shading
表スタイルの網かけ書式を参照する ShadingUniversal オブジェクトを返します。
readonly shading: Word.Shading;プロパティ値
注釈
tableDirection
Microsoft Word が表スタイルのセルを並べ替える方向を指定します。
tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight";プロパティ値
Word.TableDirection | "RightToLeft" | "LeftToRight"
注釈
topCellMargin
メソッドの詳細
condition(conditionCode)
テーブルの一部に特別なスタイルの書式を設定する ConditionalStyle オブジェクトを返します。
condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle;パラメーター
- conditionCode
- Word.ConditionCode
書式設定を適用するテーブルの領域。
返品
注釈
condition(conditionCode)
テーブルの一部に特別なスタイルの書式を設定する ConditionalStyle オブジェクトを返します。
condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle;パラメーター
- conditionCode
-
"FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"
書式設定を適用するテーブルの領域。
返品
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
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
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
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;