Excel.NamedItem class

リファレンス

パッケージ:: excel

セルまたは値の範囲の定義済みの名前を表します。名前には、プリミティブの名前付きオブジェクト (以下の型に示すように)、範囲オブジェクト、または範囲への参照を指定できます。このオブジェクトを使用して、名前に関連付けられた範囲オブジェクトを取得することができます。

Extends: OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.1 ]

例

// 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) => {
    // Log all the named items in the active worksheet.
    const namedItems = context.workbook.worksheets.getActiveWorksheet().names.load();
    await context.sync();

    console.log("This worksheet contains " + namedItems.items.length + " named items.");

    for (let i = 0; i < namedItems.items.length; i++) {
        const namedItem : Excel.NamedItem = namedItems.items[i];
        console.log(JSON.stringify(namedItem)) + "\n";
    }

    await context.sync();
});

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
name	オブジェクトの名前。
type	名前の数式によって返される値の型を指定します。詳細は「`Excel.NamedItemType`」をご覧ください。
value	名前の数式で計算された値を表します。名前付き範囲の場合、範囲アドレスが返されます。この API は、#VALUE を返します。ユーザー定義関数を参照している場合は、Excel UI でエラーが発生します。
visible	オブジェクトが表示されるかどうかを指定します。

メソッド

getRange()	名前に関連付けられている範囲オブジェクトを返します。名前付きアイテムの型が範囲でない場合、エラーをスローします。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドを `JSON.stringify()`オーバーライドします。 (`JSON.stringify`さらに、渡されるオブジェクトのメソッドを呼び出 `toJSON` します)。元の Excel.NamedItem オブジェクトは API オブジェクトですが、メソッドは、元の `toJSON` オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として `Excel.Interfaces.NamedItemData`型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

name

オブジェクトの名前。

readonly name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

type

名前の数式によって返される値の型を指定します。詳細は「Excel.NamedItemType」をご覧ください。

readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";

プロパティ値

注釈

[ API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array ]

value

名前の数式で計算された値を表します。名前付き範囲の場合、範囲アドレスが返されます。この API は、#VALUE を返します。ユーザー定義関数を参照している場合は、Excel UI でエラーが発生します。

readonly value: any;

プロパティ値

any

注釈

[ API セット: ExcelApi 1.1 ]

visible

オブジェクトが表示されるかどうかを指定します。

visible: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

メソッドの詳細

getRange()

名前に関連付けられている範囲オブジェクトを返します。名前付きアイテムの型が範囲でない場合、エラーをスローします。

getRange(): Excel.Range;

戻り値

Excel.Range

注釈

[ API セット: ExcelApi 1.1 ]

例

// Returns the Range object that is associated with the name.
// Returns `null` if the name is not of type Range.
// Note: This API currently supports only the Workbook scoped items.
await Excel.run(async (context) => { 
    const names = context.workbook.names;
    const range = names.getItem('MyRange').getRange();
    range.load('address');
    await context.sync();

    console.log(range.address);
});

load(options)

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

load(options?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem;

パラメーター

options: Excel.Interfaces.NamedItemLoadOptions

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

戻り値

Excel.NamedItem

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

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

戻り値

Excel.NamedItem

例

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

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.NamedItem;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

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

戻り値

Excel.NamedItem

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.NamedItemUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Excel.Interfaces.NamedItemUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.NamedItem): void;

パラメーター

properties: Excel.NamedItem

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.NamedItemData;

戻り値

Excel.Interfaces.NamedItemData

Excel.NamedItem class

注釈

例

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

name

プロパティ値

注釈

type

プロパティ値

注釈

value

プロパティ値

注釈

visible

プロパティ値

注釈

メソッドの詳細

getRange()

戻り値

注釈

例

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

例

load(propertyNamesAndPaths)

パラメーター

戻り値

set(properties, options)

パラメーター

戻り値

set(properties)

パラメーター

戻り値

toJSON()

戻り値

フィードバック

その他のリソース