WindowsFormsApplicationBase.StartupNextInstance イベントとは何？わかりやすく解説 Weblio辞書

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

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

WindowsFormsApplicationBase.StartupNextInstance イベント

メモ : このイベントは、.NET Framework version 2.0 で新しく追加されたものです。

単一インスタンスのアプリケーションを起動しようとしたとき、そのアプリケーションが既にアクティブになっている場合に発生します。

名前空間: Microsoft.VisualBasic.ApplicationServices
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Event StartupNextInstance As
 StartupNextInstanceEventHandler

Visual Basic (使用法)

Dim instance As WindowsFormsApplicationBase
Dim handler As StartupNextInstanceEventHandler

AddHandler instance.StartupNextInstance, handler

public event StartupNextInstanceEventHandler StartupNextInstance

C++

public:
event StartupNextInstanceEventHandler^ StartupNextInstance {
    void add (StartupNextInstanceEventHandler^ obj);
    void remove (StartupNextInstanceEventHandler^ obj);
}

/** @event */
public void add_StartupNextInstance (StartupNextInstanceEventHandler
 obj)

/** @event */
public void remove_StartupNextInstance (StartupNextInstanceEventHandler
 obj)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

詳細については、Visual Basic のトピック「My.Application.StartupNextInstance イベント」を参照してください。

単一インスタンスのアプリケーションでは、既にアクティブになっているアプリケーションを再起動させようとすると、StartupNextInstance イベントが生成されます。単一インスタンスのアプリケーションは、初回起動時に Startup イベントを生成します。詳細については、My.Application.Startup イベント、方法 : アプリケーションのインスタンス化の動作を指定するの各トピックを参照してください。

このイベントは、Visual Basic アプリケーションモデルに属する機能です。詳細については、「Visual Basic アプリケーションモデルの概要」を参照してください。

このイベントは、他のユーザーインターフェイスイベントと共に、アプリケーションのメインスレッドで発生します。これを利用すると、イベントハンドラを通じて、アプリケーションのユーザーインターフェイスに直接アクセスできます。ただし、このイベントの発生時に、アプリケーションが別のユーザーインターフェイスのイベントを処理していてビジー状態にあった場合、他のイベントハンドラの処理が完了するか、My.Application.DoEvents メソッドが呼び出されるまで、このイベントは処理されません。

メモ
StartupNextInstance イベントは、単一インスタンスのアプリケーションでのみ生成されます。アプリケーションに単一インスタンスの動作を実装するには、プロジェクトデザイナで [単一インスタンスのアプリケーションを作成する] チェックボックスをオンにする必要があります。

アプリケーションを単一インスタンスにするには

ソリューションエクスプローラでプロジェクトを選択し、[プロジェクト] メニューの [プロパティ] をクリックします。

[アプリケーション] タブをクリックします。

[単一インスタンスのアプリケーションを作成する] チェックボックスをオンにします。

詳細については、「方法 : アプリケーションのインスタンス化の動作を指定する」を参照してください。

単一インスタンスのアプリケーションを複数回起動した場合、2 つ目以降のインスタンスの引数にアクセスするには、e パラメータの CommandLine プロパティを使用する必要があります。My.Application.CommandLineArgs プロパティを使用すると、単一インスタンスのアプリケーションの 1 つ目のインスタンスを起動するときに渡された引数を取得できます。

StartupNextInstance イベントハンドラのコードは、ApplicationEvents.vb ファイル (既定では隠しファイル) に格納されています。

アプリケーションイベントのコードエディタウィンドウにアクセスするには

ソリューションエクスプローラでプロジェクトを選択し、[プロジェクト] メニューの [プロパティ] をクリックします。

[アプリケーション] タブをクリックします。

[アプリケーションイベントの表示] をクリックして、コードエディタを開きます。

詳細については、「方法 : アプリケーションイベントを処理する (Visual Basic)」を参照してください。

My.Application.StartupNextInstance イベントを使ったタスクの例を次の表に示します。

目的	参照項目
Visual Basic アプリケーションモデルのイベントを利用してコードを実行する。	方法 : アプリケーションの起動時または終了時にコードを実行する
1 つ目のアプリケーションインスタンスのコマンドライン引数をチェックする。	My.Application.CommandLineArgs プロパティ

使用例

この例では、StartupNextInstance イベントハンドラの e パラメータを使用して、アプリケーションのコマンドライン引数を調べています。/input= で始まる引数が見つかった場合は、その引数の残りの部分が表示されます。

Visual Basic

Private Sub MyApplication_StartupNextInstance(
 _
    ByVal sender As Object,
 _
    ByVal e As Microsoft.VisualBasic.ApplicationServices.StartupNextInstanceEventArgs
 _
) Handles Me.StartupNextInstance
    Dim inputArgument As String
 = "/input="
    Dim inputName As String
 = ""

    For Each s As String
 In e.CommandLine
        If s.ToLower.StartsWith(inputArgument) Then
            inputName = s.Remove(0, inputArgument.Length)
        End If
    Next

    If inputName = "" Then
        MsgBox("No input name")
    Else
        MsgBox("Input name: " & inputName)
    End If
End Sub