Excel.ConditionalRangeFormat class

パッケージ:

excel

条件付き書式範囲のフォント、塗りつぶし、罫線、およびその他のプロパティをカプセル化する format オブジェクト。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.6 ]

プロパティ

borders	条件付き書式の範囲全体に適用される罫線オブジェクトのコレクション。
context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
fill	条件付き書式の範囲全体で定義されている塗りつぶしオブジェクトを返します。
font	条件付き書式範囲全体で定義されているフォント オブジェクトを返します。
numberFormat	指定した範囲の Excel の数値書式コードを表します。 Excel の数値書式の詳細については、「数値書式 コード」を参照してください。 nullが渡された場合はクリアされます。

メソッド

clearFormat()	条件付き書式ルールから書式プロパティを削除します。 これにより、書式設定のないルールが作成されます。
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 メソッドを呼び出します)。元の Excel.ConditionalRangeFormat オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ConditionalRangeFormatData として型指定) を返します。

プロパティの詳細

borders

条件付き書式の範囲全体に適用される罫線オブジェクトのコレクション。

readonly borders: Excel.ConditionalRangeBorderCollection;

プロパティ値

Excel.ConditionalRangeBorderCollection

注釈

[ API セット: ExcelApi 1.6 ]

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

fill

条件付き書式の範囲全体で定義されている塗りつぶしオブジェクトを返します。

readonly fill: Excel.ConditionalRangeFill;

プロパティ値

Excel.ConditionalRangeFill

注釈

[ API セット: ExcelApi 1.6 ]

font

条件付き書式範囲全体で定義されているフォント オブジェクトを返します。

readonly font: Excel.ConditionalRangeFont;

プロパティ値

Excel.ConditionalRangeFont

注釈

[ API セット: ExcelApi 1.6 ]

numberFormat

指定した範囲の Excel の数値書式コードを表します。 Excel の数値書式の詳細については、「数値書式 コード」を参照してください。 nullが渡された場合はクリアされます。

numberFormat: any;

プロパティ値

any

注釈

[ API セット: ExcelApi 1.6 ]

メソッドの詳細

clearFormat()

条件付き書式ルールから書式プロパティを削除します。 これにより、書式設定のないルールが作成されます。

clearFormat(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

load(options)

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

load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;

パラメーター

options

Excel.Interfaces.ConditionalRangeFormatLoadOptions

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

戻り値

Excel.ConditionalRangeFormat

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.ConditionalRangeFormat;

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.ConditionalRangeFormat

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ConditionalRangeFormat;

パラメーター

propertyNamesAndPaths

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

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

戻り値

Excel.ConditionalRangeFormat

set(properties, options)

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

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

パラメーター

properties

Excel.Interfaces.ConditionalRangeFormatUpdateData

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

options

OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.ConditionalRangeFormat): void;

パラメーター

properties

Excel.ConditionalRangeFormat

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalRangeFormatData;

戻り値

Excel.Interfaces.ConditionalRangeFormatData