Word.ConditionalStyle class

選択した表が、指定された表のスタイルで書式設定されている場合に、表の指定領域に適用する特殊な書式設定を表します。

Extends

プロパティ

borders

条件付きスタイルのすべての罫線を表す BorderUniversalCollection オブジェクトを返します。

bottomPadding

テーブル内の 1 つのセルまたはすべてのセルの内容の下に追加するスペースの量をポイント単位で指定します。

context

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

font

条件付きスタイルのフォント書式を表す Font オブジェクトを返します。

leftPadding

テーブル内の 1 つのセルまたはすべてのセルの内容の左側に追加する領域の量 (ポイント単位) を指定します。

paragraphFormat

条件付きスタイルの段落書式を表す ParagraphFormat オブジェクトを返します。

rightPadding

テーブル内の 1 つのセルまたはすべてのセルの内容の右側に追加するスペースの量 (ポイント単位) を指定します。

shading

条件付きスタイルの網掛けを表す ShadingUniversal オブジェクトを返します。

topPadding

テーブル内の 1 つのセルまたはすべてのセルの内容の上に追加する領域の量 (ポイント単位) を指定します。

メソッド

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

track()

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

untrack()

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

プロパティの詳細

borders

条件付きスタイルのすべての罫線を表す BorderUniversalCollection オブジェクトを返します。

readonly borders: Word.BorderUniversalCollection;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

bottomPadding

テーブル内の 1 つのセルまたはすべてのセルの内容の下に追加するスペースの量をポイント単位で指定します。

bottomPadding: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.4

context

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

context: RequestContext;

プロパティ値

font

条件付きスタイルのフォント書式を表す Font オブジェクトを返します。

readonly font: Word.Font;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

leftPadding

テーブル内の 1 つのセルまたはすべてのセルの内容の左側に追加する領域の量 (ポイント単位) を指定します。

leftPadding: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.4

paragraphFormat

条件付きスタイルの段落書式を表す ParagraphFormat オブジェクトを返します。

readonly paragraphFormat: Word.ParagraphFormat;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

rightPadding

テーブル内の 1 つのセルまたはすべてのセルの内容の右側に追加するスペースの量 (ポイント単位) を指定します。

rightPadding: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.4

shading

条件付きスタイルの網掛けを表す ShadingUniversal オブジェクトを返します。

readonly shading: Word.ShadingUniversal;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

topPadding

テーブル内の 1 つのセルまたはすべてのセルの内容の上に追加する領域の量 (ポイント単位) を指定します。

topPadding: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.4

メソッドの詳細

load(options)

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

load(options?: Word.Interfaces.ConditionalStyleLoadOptions): Word.ConditionalStyle;

パラメーター

options
Word.Interfaces.ConditionalStyleLoadOptions

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

返品

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

返品

toJSON()

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

toJSON(): Word.Interfaces.ConditionalStyleData;

返品

track()

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

track(): Word.ConditionalStyle;

返品

untrack()

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

untrack(): Word.ConditionalStyle;

返品