Excel.ConditionalRangeBorderCollection class

範囲の境界線を構成する複数の境界線オブジェクトを表します。

Extends

プロパティ

bottom

下縁取りを取得します。

context

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

count

コレクションに含まれる境界線オブジェクトの数。

items

このコレクション内に読み込まれた子アイテムを取得します。

left

左の境界線を取得します。

right

右縁取りを取得します。

top

上枠を取得します。

メソッド

getItem(index)

オブジェクトの名前を使用して、境界線オブジェクトを取得します。

getItem(index)

オブジェクトの名前を使用して、境界線オブジェクトを取得します。

getItemAt(index)

オブジェクトのインデックスを使用して、境界線オブジェクトを取得します。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

プロパティの詳細

bottom

下縁取りを取得します。

readonly bottom: Excel.ConditionalRangeBorder;

プロパティ値

注釈

API セット: ExcelApi 1.6

context

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

context: RequestContext;

プロパティ値

count

コレクションに含まれる境界線オブジェクトの数。

readonly count: number;

プロパティ値

number

注釈

API セット: ExcelApi 1.6

items

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.ConditionalRangeBorder[];

プロパティ値

left

左の境界線を取得します。

readonly left: Excel.ConditionalRangeBorder;

プロパティ値

注釈

API セット: ExcelApi 1.6

right

右縁取りを取得します。

readonly right: Excel.ConditionalRangeBorder;

プロパティ値

注釈

API セット: ExcelApi 1.6

top

上枠を取得します。

readonly top: Excel.ConditionalRangeBorder;

プロパティ値

注釈

API セット: ExcelApi 1.6

メソッドの詳細

getItem(index)

オブジェクトの名前を使用して、境界線オブジェクトを取得します。

getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder;

パラメーター

index
Excel.ConditionalRangeBorderIndex

取得するボーダー オブジェクトのインデックス値。 詳細は「Excel.ConditionalRangeBorderIndex」をご覧ください。

返品

注釈

API セット: ExcelApi 1.6

getItem(index)

オブジェクトの名前を使用して、境界線オブジェクトを取得します。

getItem(index: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): Excel.ConditionalRangeBorder;

パラメーター

index

"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"

取得するボーダー オブジェクトのインデックス値。 詳細は「Excel.ConditionalRangeBorderIndex」をご覧ください。

返品

注釈

API セット: ExcelApi 1.6

getItemAt(index)

オブジェクトのインデックスを使用して、境界線オブジェクトを取得します。

getItemAt(index: number): Excel.ConditionalRangeBorder;

パラメーター

index

number

取得するオブジェクトのインデックス値。 0 を起点とする番号になります。

返品

注釈

API セット: ExcelApi 1.6

load(options)

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

load(options?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection;

パラメーター

options

Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返品

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalRangeBorderCollection;

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

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

返品

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData;

返品