Excel.ConditionalRangeFormat class
条件付き書式範囲のフォント、塗りつぶし、罫線、およびその他のプロパティをカプセル化する書式オブジェクト。
- Extends
注釈
使用元
プロパティ
| borders | 条件付き書式全体の範囲に適用される罫線オブジェクトのコレクション。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| fill | 全体の条件付き書式範囲で定義された塗りつぶしオブジェクトを返します。 |
| font | 全体の条件付き書式範囲で定義されているフォント オブジェクトを返します。 |
| number |
指定された範囲に対する Excel の数値書式コードを表します。 Excel の数値の書式設定の詳細については、「 数値の書式コード」を参照してください。
|
メソッド
| clear |
条件付き書式ルールから書式プロパティを削除します。 これにより、書式設定のないルールが作成されます。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
borders
条件付き書式全体の範囲に適用される罫線オブジェクトのコレクション。
readonly borders: Excel.ConditionalRangeBorderCollection;プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
fill
全体の条件付き書式範囲で定義された塗りつぶしオブジェクトを返します。
readonly fill: Excel.ConditionalRangeFill;プロパティ値
注釈
font
全体の条件付き書式範囲で定義されているフォント オブジェクトを返します。
readonly font: Excel.ConditionalRangeFont;プロパティ値
注釈
numberFormat
指定された範囲に対する Excel の数値書式コードを表します。 Excel の数値の書式設定の詳細については、「 数値の書式コード」を参照してください。
null が渡された場合はクリアされます。
numberFormat: any;プロパティ値
any
注釈
メソッドの詳細
clearFormat()
条件付き書式ルールから書式プロパティを削除します。 これにより、書式設定のないルールが作成されます。
clearFormat(): void;返品
void
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ConditionalRangeFormat;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ConditionalRangeFormat;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ConditionalRangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
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;