Excel.ConditionalRangeBorderCollection class
範囲の境界線を構成する複数の境界線オブジェクトを表します。
- Extends
注釈
プロパティ
bottom | 下の罫線を取得します。 |
context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
count | コレクションに含まれる境界線オブジェクトの数。 |
items | このコレクション内に読み込まれた子アイテムを取得します。 |
left | 左罫線を取得します。 |
right | 右罫線を取得します。 |
top | 上部の罫線を取得します。 |
メソッド
get |
オブジェクトの名前を使用して、境界線オブジェクトを取得します。 |
get |
オブジェクトの名前を使用して、境界線オブジェクトを取得します。 |
get |
オブジェクトのインデックスを使用して、境界線オブジェクトを取得します。 |
load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
toJSON() | API オブジェクトが |
プロパティの詳細
bottom
下の罫線を取得します。
readonly bottom: Excel.ConditionalRangeBorder;
プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
count
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: Excel.ConditionalRangeBorder[];
プロパティ値
left
左罫線を取得します。
readonly left: Excel.ConditionalRangeBorder;
プロパティ値
注釈
right
右罫線を取得します。
readonly right: Excel.ConditionalRangeBorder;
プロパティ値
注釈
top
上部の罫線を取得します。
readonly top: Excel.ConditionalRangeBorder;
プロパティ値
注釈
メソッドの詳細
getItem(index)
オブジェクトの名前を使用して、境界線オブジェクトを取得します。
getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder;
パラメーター
取得する border オブジェクトのインデックス値。 詳細は「Excel.ConditionalRangeBorderIndex
」をご覧ください。
戻り値
注釈
getItem(indexString)
オブジェクトの名前を使用して、境界線オブジェクトを取得します。
getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): Excel.ConditionalRangeBorder;
パラメーター
- indexString
-
"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"
取得する border オブジェクトのインデックス値。 詳細は「Excel.ConditionalRangeBorderIndex
」をご覧ください。
戻り値
注釈
getItemAt(index)
オブジェクトのインデックスを使用して、境界線オブジェクトを取得します。
getItemAt(index: number): Excel.ConditionalRangeBorder;
パラメーター
- index
-
number
取得するオブジェクトのインデックス値。 0 を起点とする番号になります。
戻り値
注釈
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;
戻り値
Office Add-ins