InProgress(ToolbarEventIds) メソッド

イベントが実行中の場合 (実行中カウンタが 0 より大きいの場合) 、True を返します。

シンタックス

Visual Basic

'宣言
 
Public Overloads Function InProgress( _
   ByVal eventid As ToolbarEventIds _
) As Boolean

C#

public bool InProgress( 
   ToolbarEventIds eventid
)

パラメータ

eventid

チェックするイベントを示す値。

戻り値の型

指定したイベントが現在発生中の場合は True。そうでない場合は False。

解説

このメソッドを使用して、イベントのコードが現在実行されているかどうかを判断します。イベントを無効にする前に発生するかどうかを確認したい場合があります。

「進行中」のカウントは、イベントに対する再帰的な呼び出しを考慮します。イベントに対するネストされた呼び出しの数とどの再帰レベルが実行されているかを判断するために使用できます。

使用例

Visual Basic

Imports Infragistics.Win.UltraWinToolbars

Private Sub button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles button1.Click

    ' Get the toolbar manager's event manager.
    ' The event manager is used to temporarily disable events
    ' to prevent them from being raised. This can be very
    ' convenient in a situation where one or more properties
    ' are being set in code and the events they would normally 
    ' raise would cause unnecessary or counter-productive
    ' code to be executed.
    '
    ' Note: All events are enabled by default.
    Dim eventManager As ToolbarsEventManager

    eventManager = Me.ultraToolbarsManager1.EventManager

    ' Disable the ToolClick event
    eventManager.SetEnabled(ToolbarEventIds.ToolClick, False)

    ' Toggle the 'Checked' property of a state button tool.
    ' Note: This would normally cause the ToolClick event to 
    ' be raised. However, since the above code disabled the event
    ' it won't be raised.
    Dim tool As StateButtonTool

    tool = Me.ultraToolbarsManager1.Tools("StateButtonTool1")
    tool.Checked = Not tool.Checked

    ' Re-enable the ToolClick event
    eventManager.SetEnabled(ToolbarEventIds.ToolClick, True)

    ' The 'AllEventsEnabled' property lets you enable/disable
    ' all events will a single line of code. If any event is 
    ' disabled the 'AllEventsEnabled' property returns false.
    If Not eventManager.AllEventsEnabled Then
        eventManager.AllEventsEnabled = True
    End If

    ' The event manager also exposes an 'IsEnabled' method
    ' to see if an event is enabled or disbled.
    If Not eventManager.IsEnabled(ToolbarEventIds.ToolClick) Then
        eventManager.SetEnabled(ToolbarEventIds.ToolClick, True)
    End If

    ' The status bar event manager also exposes overloaded 
    ' 'IsEnabled' and 'SetEnabled' methods that take an  
    ' event group so that, for example all 'Before' or all
    ' 'After' events can be enabled/disabled. If any event
    ' in the group is disabled the 'IsEnabled' method returns
    ' false.
    If Not eventManager.IsEnabled(EventGroups.BeforeEvents) Then
        eventManager.SetEnabled(EventGroups.BeforeEvents, True)
    End If

    eventManager.SetEnabled(EventGroups.AfterEvents, True)

    ' The 'InProgress' method will return true if the 
    ' specified event is currently being raised. This
    ' is often helpful in methods that can be called
    ' from various points in an application to determine
    ' what is triggering the call.
    If eventManager.InProgress(ToolbarEventIds.ToolClick) Then
        ' ... 
    End If

End Sub

C#

using System.Diagnostics;
using Infragistics.Win.UltraWinToolbars;

private void button1_Click(object sender, System.EventArgs e)
{

	// Get the toolbar manager's event manager.
	// The event manager is used to temporarily disable events
	// to prevent them from being raised. This can be very
	// convenient in a situation where one or more properties
	// are being set in code and the events they would normally 
	// raise would cause unnecessary or counter-productive
	// code to be executed.
	//
	// Note: All events are enabled by default.
	ToolbarsEventManager eventManager = this.ultraToolbarsManager1.EventManager;

	// Disable the ToolClick event
	eventManager.SetEnabled( ToolbarEventIds.ToolClick, false );

	// Toggle the 'Checked' property of a state button tool.
	// Note: This would normally cause the ToolClick event to 
	// be raised. However, since the above code disabled the event
	// it won't be raised.
	StateButtonTool tool;

	tool = this.ultraToolbarsManager1.Tools["StateButtonTool1"] as StateButtonTool;
	tool.Checked = !tool.Checked;

	// Re-enable the ToolClick event
	eventManager.SetEnabled( ToolbarEventIds.ToolClick, true );

	// The 'AllEventsEnabled' property lets you enable/disable
	// all events will a single line of code. If any event is 
	// disabled the 'AllEventsEnabled' property returns false.
	if ( !eventManager.AllEventsEnabled )
		eventManager.AllEventsEnabled = true;

	// The event manager also exposes an 'IsEnabled' method
	// to see if an event is enabled or disbled.
	if ( !eventManager.IsEnabled(ToolbarEventIds.ToolClick ) )
		eventManager.SetEnabled(ToolbarEventIds.ToolClick, true );

	// The status bar event manager also exposes overloaded 
	// 'IsEnabled' and 'SetEnabled' methods that take an  
	// event group so that, for example all 'Before' or all
	// 'After' events can be enabled/disabled. If any event
	// in the group is disabled the 'IsEnabled' method returns
	// false.
	if ( !eventManager.IsEnabled(EventGroups.BeforeEvents ) )
		eventManager.SetEnabled(EventGroups.BeforeEvents, true );

	eventManager.SetEnabled(EventGroups.AfterEvents, true );

	// The 'InProgress' method will return true if the 
	// specified event is currently being raised. This
	// is often helpful in methods that can be called
	// from various points in an application to determine
	// what is triggering the call.
	if ( eventManager.InProgress( ToolbarEventIds.ToolClick ) )
	{
		// ... 
	}
	
}