Dialog Property

Returns a reference to the Navigation Pane Options dialog that is about to be displayed.

Syntax

Visual Basic

'Declaration
 
Public Property Dialog As NavigationPaneOptionsDialog

C#

public NavigationPaneOptionsDialog Dialog {get; set;}

Remarks

The dialog will be automatically displayed after the event returns if the Cancel parameter is set to false – you do not need to call the Show method off this reference to display the dialog.

This property is provided primarily to allow you to access the ResetButton property of the dialog so that you can make it visible and listen in to its Click event to provide reset processing.

Example

The following code shows how to process the NavigationOptionsDialogDisplaying event including how to cancel the display of the dialog and how to enable/disable the Dialog's Reset button.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Visual Basic

Imports System.Diagnostics
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinExplorerBar


	Dim WithEvents dialogResetButton As Button

	Private Sub UltraExplorerBar1_NavigationOptionsDialogDisplaying(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinExplorerBar.CancelableNavigationOptionsDialogDisplayingEventArgs) Handles UltraExplorerBar1.NavigationOptionsDialogDisplaying

		' To prevent the NavigationPaneOptionsDialog from displaying, uncomment the following line.
		'e.Cancel = true


		' If we haven't cancelled the dialog, enable the dialog's Reset button and listen to its Click event.
		If e.Cancel = False Then
			e.Dialog.ResetButton.Visible = True
			Me.dialogResetButton = e.Dialog.ResetButton
		Else
			' Since we have cancelled the display of the built-in NavigationPaneOptionsDialog, display our
			' own options dialog.
			Dim myNavigationOptionsDialog As MyNavigationOptionsDialog = New MyNavigationOptionsDialog()

			myNavigationOptionsDialog.ShowDialog(Me)
		End If

	End Sub


	Private Sub MyResetButtonEventHandler(ByVal sender As Object, ByVal e As EventArgs) Handles dialogResetButton.Click

		' Perform custom reset processing here.

	End Sub


Public Class MyNavigationOptionsDialog

	Inherits System.Windows.Forms.Form

End Class

C#

using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinExplorerBar;


		private void ultraExplorerBar1_NavigationOptionsDialogDisplaying(object sender, Infragistics.Win.UltraWinExplorerBar.CancelableNavigationOptionsDialogDisplayingEventArgs e)
		{
			// To prevent the NavigationPaneOptionsDialog from displaying, uncomment the following line.
			//e.Cancel = true;


			// If we haven't cancelled the dialog, enable the dialog's Reset button and listen to its Click event.
			if (e.Cancel == false)
			{
				e.Dialog.ResetButton.Visible	 = true;
				e.Dialog.ResetButton.Click		+= new EventHandler(this.MyResetButtonEventHandler);
			}
			else
			{
				// Since we have cancelled the display of the built-in NavigationPaneOptionsDialog, display our
				// own options dialog.
				MyNavigationOptionsDialog myNavigationOptionsDialog = new MyNavigationOptionsDialog();

				myNavigationOptionsDialog.ShowDialog(this);
			}
		}

		private void MyResetButtonEventHandler(object sender, EventArgs e)
		{
			// Perform custom reset processing here.
		}



	public class MyNavigationOptionsDialog : Form
	{

	}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2