Excel.CustomPropertyCollection class

customproperty オブジェクトのコレクションが含まれています。Contains the collection of customProperty objects.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

メソッド

add(key, value)

新しいカスタム プロパティを作成、または既存のカスタム プロパティを設定します。Creates a new or sets an existing custom property.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

deleteAll()

このコレクション内のすべてのカスタム プロパティを削除します。Deletes all custom properties in this collection.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getCount()

カスタム プロパティの数を取得します。Gets the count of custom properties.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getItem(key)

キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。Gets a custom property object by its key, which is case-insensitive. カスタムプロパティが存在しない場合にスローされます。Throws if the custom property does not exist.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getItemOrNullObject(key)

キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。Gets a custom property object by its key, which is case-insensitive. カスタムプロパティが存在しない場合は、null オブジェクトを返します。Returns a null object if the custom property does not exist.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(option)
toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元Excel.CustomPropertyCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.CustomPropertyCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.CustomPropertyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomPropertyCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

readonly items: Excel.CustomProperty[];

プロパティ値

Excel.CustomProperty[]

メソッドの詳細

add(key, value)

新しいカスタム プロパティを作成、または既存のカスタム プロパティを設定します。Creates a new or sets an existing custom property.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

add(key: string, value: any): Excel.CustomProperty;

パラメーター

key
string

必須です。Required. カスタムプロパティのキー。大文字と小文字は区別されません。The custom property's key, which is case-insensitive.

value
any

必須です。Required. カスタムプロパティの値。The custom property's value.

戻り値

deleteAll()

このコレクション内のすべてのカスタム プロパティを削除します。Deletes all custom properties in this collection.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

deleteAll(): void;

戻り値

void

getCount()

カスタム プロパティの数を取得します。Gets the count of custom properties.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

getItem(key)

キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。Gets a custom property object by its key, which is case-insensitive. カスタムプロパティが存在しない場合にスローされます。Throws if the custom property does not exist.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getItem(key: string): Excel.CustomProperty;

パラメーター

key
string

カスタムプロパティオブジェクトを識別するキー。The key that identifies the custom property object.

戻り値

getItemOrNullObject(key)

キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。Gets a custom property object by its key, which is case-insensitive. カスタムプロパティが存在しない場合は、null オブジェクトを返します。Returns a null object if the custom property does not exist.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

getItemOrNullObject(key: string): Excel.CustomProperty;

パラメーター

key
string

必須です。Required. カスタムプロパティオブジェクトを識別するキー。The key that identifies the custom property object.

戻り値

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection;

パラメーター

option
Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.CustomPropertyCollection-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.CustomPropertyCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.CustomPropertyCollection-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.CustomPropertyCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomPropertyCollection-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CustomPropertyCollection - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(option)

load(option?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection;

パラメーター

戻り値

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元Excel.CustomPropertyCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.CustomPropertyCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.CustomPropertyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomPropertyCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.CustomPropertyCollectionData;

戻り値