Excel.NamedItemCollection class

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

context: RequestContext;

プロパティ値

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

readonly items: Excel.NamedItem[];

プロパティ値

名前を使用して NamedItem オブジェクトを取得します。

getItem(name: string): Excel.NamedItem;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => { 
    const sheetName = 'Sheet1';
    const nameditem = context.workbook.names.getItem(sheetName);
    nameditem.load('type');
    await context.sync();
    
    console.log(nameditem.type);
});

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

load(options?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection;

パラメーター

返品

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

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

パラメーター

返品

例

await Excel.run(async (context) => { 
    const nameditems = context.workbook.names;
    nameditems.load('items');
    await context.sync();

    for (let i = 0; i < nameditems.items.length; i++) {
        console.log(nameditems.items[i].name);
    }
});

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

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

パラメーター

返品

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

toJSON(): Excel.Interfaces.NamedItemCollectionData;

返品