onOpenMenu メソッド

コンテキストメニューを開きます。

シンタックス

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.ContextMenu.ContextMenu();
var value; // Type: boolean
value = instance.onOpenMenu(menuData,
                            menuData.name,
                            menuData.text,
                            menuData.command,
                            menuData.disable,
                            menuData.iconClass,
                            menuData.group,
                            menuData.subMenu,
                            menuData.type,
                            menuData.workArea,
                            itemsDataForShown,
                            itemsDataForShown.name,
                            itemsDataForShown.text,
                            itemsDataForShown.command,
                            itemsDataForShown.disable,
                            itemsDataForShown.iconClass,
                            itemsDataForShown.group,
                            itemsDataForShown.subMenu,
                            itemsDataForShown.type,
                            itemsDataForShown.workArea,
                            hitInfo,
                            spread);

function onOpenMenu( 
   menuData : undefined,
   (optional) menuData.name : string,
   (optional) menuData.text : string,
   (optional) menuData.command : undefined,
   (optional) menuData.disable : boolean,
   (optional) menuData.iconClass : string,
   (optional) menuData.group : string,
   (optional) menuData.subMenu : undefined,
   (optional) menuData.type : string,
   (optional) menuData.workArea : string,
   itemsDataForShown : undefined,
   (optional) itemsDataForShown.name : string,
   (optional) itemsDataForShown.text : string,
   (optional) itemsDataForShown.command : undefined,
   (optional) itemsDataForShown.disable : boolean,
   (optional) itemsDataForShown.iconClass : string,
   (optional) itemsDataForShown.group : string,
   (optional) itemsDataForShown.subMenu : undefined,
   (optional) itemsDataForShown.type : string,
   (optional) itemsDataForShown.workArea : string,
   hitInfo : Object,
   spread : Object
) : boolean;

パラメータ

menuData
menuData.name: コンテキストメニュー項目のIDを表します。
menuData.text: このコンテキストメニュー項目がグループの場合、表示されるテキストを表します。テキストはDOM要素のタイトルとして表示されます。
menuData.command: コマンド名を表します。 commandManagerは、これをインデックスとして使用して、このコマンドを検索します。このコマンドが存在する場合は、実行してください。
menuData.disable: このコンテキストメニュー項目が現在の状態では無効になっていることを表します。デフォルト値はfalseです。
menuData.iconClass: このコンテキストメニュー項目のアイコンを表します。これはクラス名です。
menuData.group: このコンテキストメニュー項目はグループメニュー項目であることを表します。このパラメータの値は、グループヘッダーの名前である必要があります。
menuData.subMenu: このコンテキストメニュー項目にはサブメニューがあることを表します。
menuData.type: コンテキストメニューの種類を表します。
menuData.workArea: どの領域にコンテキストメニュー項目を表示する必要があるかを示します。値は、空白で区切られた条件のコレクションにすることができます。「sheetTab」、「outline」、「viewport」、「rowHeader」、「colHeader」、「comment」、「slicer」、「corner」を含めることができます。
itemsDataForShown
itemsDataForShown.name: コンテキストメニュー項目のIDを表します。
itemsDataForShown.text: このコンテキストメニュー項目がグループの場合、表示されるテキストを表します。テキストはDOM要素のタイトルとして表示されます。
itemsDataForShown.command: コマンド名を表します。 commandManagerは、これをインデックスとして使用して、このコマンドを検索します。このコマンドが存在する場合は、実行してください。
itemsDataForShown.disable: このコンテキストメニュー項目が現在の状態では無効になっていることを表します。デフォルト値はfalseです。
itemsDataForShown.iconClass: このコンテキストメニュー項目のアイコンを表します。これはクラス名です。
itemsDataForShown.group: このコンテキストメニュー項目はグループメニュー項目であることを表します。このパラメータの値は、グループヘッダーの名前である必要があります。
itemsDataForShown.subMenu: このコンテキストメニュー項目にはサブメニューがあることを表します。
itemsDataForShown.type: コンテキストメニューの種類を表します。
itemsDataForShown.workArea: どの領域にコンテキストメニュー項目を表示する必要があるかを示します。値は、空白で区切られた条件のコレクションにすることができます。「sheetTab」、「outline」、「viewport」、「rowHeader」、「colHeader」、「comment」、「slicer」、「corner」を含めることができます。
hitInfo
spread

使用例

Javascript

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
   spread.contextMenu.onOpenMenu = function (menuData, itemsDataForShown, hitInfo, spread) {
          console.log(menuData);
          console.log(itemsDataForShown);
          console.log(hitInfo);
          console.log(spread);
          // itemsDataForShownを変更して、フィルター結果を変更できます
          // フィルタ結果のみを変更したい場合は、falseを返すか、何も返さない
          // 独自のコンテキストメニューを開くこともできます。これを実行する場合は、trueを返します。
          // trueを返します
   };

参照

ContextMenu タイプ