次の方法で共有


Excel.NamedItemCollection class

ブックまたはワークシートの一部であるすべての NamedItem オブジェクトのコレクション。到達方法に応じて異なります。

Extends

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

context

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

items

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

メソッド

add(name, reference, comment)

指定のスコープのコレクションに新しい名前を追加します。

addFormulaLocal(name, formula, comment)

ユーザーのロケールを数式に使用して、指定のスコープのコレクションに新しい名前を追加します。

getCount()

コレクションに含まれる名前付きアイテムの数を取得します。

getItem(name)

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

getItemOrNullObject(name)

名前を使用して NamedItem オブジェクトを取得します。 オブジェクトが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

items

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

readonly items: Excel.NamedItem[];

プロパティ値

メソッドの詳細

add(name, reference, comment)

指定のスコープのコレクションに新しい名前を追加します。

add(name: string, reference: Range | string, comment?: string): Excel.NamedItem;

パラメーター

name

string

名前付きの項目の名前。

reference

Excel.Range | string

名前が参照する数式または範囲。

comment

string

省略可能。 名前付き項目に関連付けられているコメント。

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const headerRange = sheet.getRange("A1:D1");

    sheet.names.add("ExpensesHeader", headerRange);
    const namedItems = sheet.names.load("name, type");

    await context.sync();
});

addFormulaLocal(name, formula, comment)

ユーザーのロケールを数式に使用して、指定のスコープのコレクションに新しい名前を追加します。

addFormulaLocal(name: string, formula: string, comment?: string): Excel.NamedItem;

パラメーター

name

string

名前付きの項目の名前。

formula

string

名前が参照するユーザーのロケールの数式。

comment

string

省略可能。 名前付き項目に関連付けられているコメント。

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

getCount()

コレクションに含まれる名前付きアイテムの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

getItem(name)

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

getItem(name: string): Excel.NamedItem;

パラメーター

name

string

名前付き項目名。

戻り値

注釈

[ 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);
});

getItemOrNullObject(name)

名前を使用して NamedItem オブジェクトを取得します。 オブジェクトが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemOrNullObject(name: string): Excel.NamedItem;

パラメーター

name

string

名前付き項目名。

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

load(options)

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

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

パラメーター

options

Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

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);
    }
});

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

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

戻り値

toJSON()

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

toJSON(): Excel.Interfaces.NamedItemCollectionData;

戻り値