Ewa.NamedItemCollection オブジェクト

**適用対象:**apps for SharePoint | Excel Services | SharePoint Server 2013

ブックの名前付きアイテムのコレクションを表します。

Ewa.NamedItemCollection

注釈

NamedItemCollectionでは、ブック内のすべての名前付きアイテムを表します。名前付きアイテムのコレクションへの参照を取得するには、 Workbook.getNamedItemsメソッドを使います。

注意

名前付きアイテム ビューモードでは、 Workbook.getNamedItemsメソッドは、公開されたアイテムのみを返します。シートの表示モードでは、 Workbook.getNamedItemsはブック内のすべての発行可能なアイテムを返します。

さらに、 Workbook.getNamedItemsには、ブックの読み込み時に発表アイテムのみが返されます。たとえば場合は、テーブルの追加や削除を動的に、 Workbook.getNamedItemsではこのそれらの変更内容が反映されません。

例

次の例では、ページにボタンを追加する方法について説明し、[ブック内のすべての名前付きアイテムをループし、名前付きアイテムの種類が表示されている各名前付きアイテムの警告メッセージが表示されるボタンonClickイベントのイベント ハンドラーを追加します。コードの例では、 Excel Web Access Web パーツでSharePoint Server 2013で作業していることを前提としています。

<script type="text/javascript">
     
var ewa = null;
     
// Add event handler for onload event.
if (window.attachEvent) 
{ 
    window.attachEvent("onload", ewaOnPageLoad);    
} 
else 
{ 
    window.addEventListener("DOMContentLoaded", ewaOnPageLoad, false); 
}

// Add event handler for applicationReady event.
function ewaOnPageLoad() 
{         
    Ewa.EwaControl.add_applicationReady(onApplicationReady); 
} 

function onApplicationReady()
{            
    // Get a reference to the Excel Services Web Part.
    ewa = Ewa.EwaControl.getInstances().getItem(0);                                   
}              

// Get NamedItemType as string.
function getNamedItemTypeAsString(type)
{
    var myType = null;
    
    switch(type)
    {
        case Ewa.NamedItemType.NamedRange:
            myType = "NamedRange";
            break;
        case Ewa.NamedItemType.Parameter:
            myType = "Parameter";
            break;
        case Ewa.NamedItemType.Table:
            myType = "Table";
            break;
        case Ewa.NamedItemType.PivotTable:
            myType = "PivotTable";
            break;
        case Ewa.NamedItemType.Chart:  
            myType = "Chart";
            break;
        default:
            myType = "undefined";
    }        
    
    return myType;    
}

        
function getTypeButton()
{    
    // Get the specified workbook.
    var wkBook = ewa.getActiveWorkbook();    
    // Get the NamedItems collection
    var items = wkBook.getNamedItems();
    var type = null;
    
    if (items)
    {
        for (i=0;i<items.getCount();i++)
        {
            type = items.getItem(i).getNamedItemType();
            alert("Named item #" + (i + 1) + " is of type " + getNamedItemTypeAsString(type) + ".");
        }
    }
    else
    {
        alert("There are no named items.");
    }
}


</script>
<input type="button" id="GetType" value="Get Named Item Type" onclick="getTypeButton()" />

関連項目

概念

Ewa.NamedItemCollection 方法