IMenuCommandService インターフェイスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

IMenuCommandService インターフェイス

グローバルデザイナ動詞とデザインモードで使用できるメニューコマンドを管理し、いくつかの種類のショートカットメニューを表示するためのメソッドを提供します。

名前空間: System.ComponentModel.Design
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
Public Interface IMenuCommandService

Visual Basic (使用法)

Dim instance As IMenuCommandService

[ComVisibleAttribute(true)] 
public interface IMenuCommandService

C++

[ComVisibleAttribute(true)] 
public interface class IMenuCommandService

/** @attribute ComVisibleAttribute(true) */ 
public interface IMenuCommandService

JScript

ComVisibleAttribute(true) 
public interface IMenuCommandService

解説

このインターフェイスは、以下の処理を行うメソッドを提供します。

グローバルデザイナ動詞コマンドの検索、呼び出し、追加、および削除。
標準メニューコマンドの検索、呼び出し、追加、および削除。
標準メニューコマンドに関連付けられているイベントハンドラの変更。
メニューの CommandID に関連付けられている標準コマンドのショートカットメニューの表示。

デザイナ動詞は、デザインモードでショートカットメニューに表示されるカスタム定義のコマンドを表します。デザイナ動詞は、指定したテキストラベルを提供できます。各デザイナ動詞には、一意の CommandID が自動的に割り当てられます。デザイナは、その Verbs プロパティを通じてデザイナ動詞を提供できますが、これらを使用できるのは、デザイナのコンポーネントが現在選択されているときだけです。グローバルデザイナ動詞は、選択されているコンポーネントに関係なく、デザインモードのショートカットメニューからアクセスできるデザイナ動詞コマンドです。このインターフェイスを使用すると、デザインモードで使用できるグローバルデザイナ動詞のセットを管理できます。

AddVerb メソッドを使用するとグローバルデザイナ動詞を追加でき、RemoveVerb メソッドを使用するとグローバルデザイナ動詞を削除できます。デザイナ動詞の CommandID がわかっていれば、GlobalInvoke メソッドを使用してその動詞を呼び出せます。このインターフェイスの Verbs プロパティには、ショートカットメニューに表示するデザイナ動詞コマンドの現在のセットが格納されています。このデザイナ動詞コマンドのセットは、すべてのグローバルデザイナ動詞と、現在選択されているコンポーネントのデザイナによって提供されるデザイナ動詞で構成されます。この動詞のセットは、デザイナ動詞コマンドを提供しているデザイナに対応するコンポーネントが選択されたり、選択が解除されたりするたびに更新されます。

メニューコマンドは、定義済み標準コマンドのセットに限定されます。定義済み標準コマンドのほとんどは、StandardCommands 列挙体と MenuCommands 列挙体で定義されています。各メニューコマンドは追加、削除、呼び出しが行えます。また、このインターフェイスのメソッドを使用して、メニューに追加されたメニューコマンドを検索できます。

AddCommand メソッドを使用すると標準メニューコマンドを追加でき、RemoveCommand メソッドを使用すると標準メニューコマンドを削除できます。AddCommand メソッドのドキュメントに記述されている手順に従うと、定義済みメニューコマンドにイベントハンドラを結び付けることができます。FindCommand メソッドを使用してメニューコマンドがメニューに追加されていた場合、CommandID により、そのメニューコマンドを検索できます。GlobalInvoke メソッドを使用して、CommandID でメニューコマンドやデザイナ動詞コマンドを呼び出せます。

メモ
既に存在している CommandID でメニューコマンドを追加しようとすると、InvalidOperationException がスローされます。メニューコマンドを追加するときは、FindCommand メソッドを使用して、そのコマンドがメニュー上に存在していないことを確認するか、例外処理を使用して適宜必要な処理を行ってください。

メモ

既に存在している CommandID でメニューコマンドを追加しようとすると、InvalidOperationException がスローされます。メニューコマンドを追加するときは、FindCommand メソッドを使用して、そのコマンドがメニュー上に存在していないことを確認するか、例外処理を使用して適宜必要な処理を行ってください。

メモ
メニューコマンドは、メニューに追加して、その Visible プロパティや Enabled プロパティを false に設定できます。メニューに追加したメニューコマンドが表示されない場合は、これらのプロパティのいずれかが false に設定されている可能性があります。

ShowContextMenu メソッドを使用して、メニューコマンドを格納している特定の標準ショートカットメニューを指定した位置に表示できます。このメソッドのドキュメントには、表示する有効なメニューを指定するコマンド ID の一覧表が記載されています。

使用例

IMenuCommandService を使用して、MenuCommand を追加する例を次に示します。

Visual Basic

<System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand,
 Name:="FullTrust")> _
Public Class CDesigner
    Inherits System.ComponentModel.Design.ComponentDesigner

    Public Overrides Sub
 Initialize(ByVal comp As IComponent)
        MyBase.Initialize(comp)

        Dim mcs As IMenuCommandService = CType(comp.Site.GetService(GetType(IMenuCommandService)),
 IMenuCommandService)
        Dim mc As New MenuCommand(New
 EventHandler(AddressOf OnF1Help), StandardCommands.F1Help)
        mc.Enabled = True
        mc.Visible = True
        mc.Supported = True
        mcs.AddCommand(mc)
        System.Windows.Forms.MessageBox.Show("Initialize() has
 been invoked.")
    End Sub

    Private Sub OnF1Help(ByVal
 sender As Object, ByVal
 e As EventArgs)
        System.Windows.Forms.MessageBox.Show("F1Help has been
 invoked.")
    End Sub
End Class

[System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand,
 Name = "FullTrust")] 
public class CDesigner : System.ComponentModel.Design.ComponentDesigner
 
{
    public override void Initialize(IComponent
 comp) 
    {
        base.Initialize(comp);

        IMenuCommandService mcs = (IMenuCommandService)comp.Site.
                    GetService(typeof(IMenuCommandService));
        MenuCommand mc = new MenuCommand(new
 EventHandler(OnF1Help), StandardCommands.F1Help);
        mc.Enabled = true;
        mc.Visible = true;
        mc.Supported = true;
        mcs.AddCommand(mc);
        System.Windows.Forms.MessageBox.Show("Initialize() has been invoked.");
    }

    private void OnF1Help(object sender, EventArgs
 e) 
    {
        System.Windows.Forms.MessageBox.Show("F1Help has been invoked.");
    }
}

C++

   public ref class CDesigner: public
 ComponentDesigner
   {
   public:
    [PermissionSetAttribute(SecurityAction::Demand, Name="FullTrust")]
      virtual void Initialize( IComponent^ comp ) override
      {
         ComponentDesigner::Initialize( comp );
         IMenuCommandService^ mcs = static_cast<IMenuCommandService^>(comp->Site->GetService(
 IMenuCommandService::typeid ));
         MenuCommand^ mc = gcnew MenuCommand( gcnew EventHandler( this,
 &CDesigner::OnF1Help ),StandardCommands::F1Help );
         mc->Enabled = true;
         mc->Visible = true;
         mc->Supported = true;
         mcs->AddCommand( mc );
         System::Windows::Forms::MessageBox::Show( "Initialize() has been invoked."
 );
      }

   private:
      void OnF1Help( Object^ /*sender*/, EventArgs^ /*e*/ )
      {
         System::Windows::Forms::MessageBox::Show( "F1Help has been invoked."
 );
      }
   };
}