Excel.ConditionalFormatCollection class
範囲に重なるすべての条件付き書式のコレクションを表します。
- Extends
注釈
[API セット: ExcelApi 1.6]
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(type) | コレクションの最上位/最上位の優先順位で新しい条件付き書式を追加します。 |
| add(type) | コレクションの最上位/最上位の優先順位で新しい条件付き書式を追加します。 |
| clear |
現在指定している範囲でアクティブなすべての条件付き書式をクリアする。 |
| get |
ブック内の条件付き書式の数を返します。 |
| get |
指定された ID に対応する条件付き書式を返します。 |
| get |
指定されたインデックスに条件付き書式を返します。 |
| get |
ID で識別される条件付き書式を返します。 条件付き書式オブジェクトが存在しない場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: Excel.ConditionalFormat[];プロパティ値
メソッドの詳細
add(type)
コレクションの最上位/最上位の優先順位で新しい条件付き書式を追加します。
add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat;パラメーター
追加される条件付き書式の種類。 詳細は「Excel.ConditionalFormatType」をご覧ください。
返品
注釈
[API セット: ExcelApi 1.6]
add(type)
コレクションの最上位/最上位の優先順位で新しい条件付き書式を追加します。
add(type: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"): Excel.ConditionalFormat;パラメーター
- type
-
"Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"
追加される条件付き書式の種類。 詳細は「Excel.ConditionalFormatType」をご覧ください。
返品
注釈
[API セット: ExcelApi 1.6]
clearAll()
現在指定している範囲でアクティブなすべての条件付き書式をクリアする。
clearAll(): void;返品
void
注釈
[API セット: ExcelApi 1.6]
getCount()
ブック内の条件付き書式の数を返します。
getCount(): OfficeExtension.ClientResult<number>;返品
OfficeExtension.ClientResult<number>
注釈
[API セット: ExcelApi 1.6]
getItem(id)
指定された ID に対応する条件付き書式を返します。
getItem(id: string): Excel.ConditionalFormat;パラメーター
- id
-
string
条件付き書式の ID。
返品
条件付き書式オブジェクト。
注釈
[API セット: ExcelApi 1.6]
getItemAt(index)
指定されたインデックスに条件付き書式を返します。
getItemAt(index: number): Excel.ConditionalFormat;パラメーター
- index
-
number
取得する条件付き書式のインデックス。
返品
注釈
[API セット: ExcelApi 1.6]
getItemOrNullObject(id)
ID で識別される条件付き書式を返します。 条件付き書式オブジェクトが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getItemOrNullObject(id: string): Excel.ConditionalFormat;パラメーター
- id
-
string
条件付き書式の ID。
返品
注釈
[API セット: ExcelApi 1.14]
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection;パラメーター
- options
-
Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ConditionalFormatCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ConditionalFormatCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ConditionalFormatCollectionData として型指定された) を返します。
toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;