OnBeforeDisplayCharacterPositionDialog Method

Raises the BeforeDisplayCharacterPositionDialog event before the character position dialog is displayed for an UltraStatusPanel whose Style is set to CharacterPosition and whose Control is a RichTextBox

Syntax

Visual Basic

'Declaration
 
Protected Overridable Sub OnBeforeDisplayCharacterPositionDialog( _
   ByVal e As CancelablePanelEventArgs _
) 

C#

protected virtual void OnBeforeDisplayCharacterPositionDialog( 
   CancelablePanelEventArgs e
)

Parameters

e

A CancelablePanelEventArgs that provides data for the event.

Remarks

Raising an event invokes the event handler through a delegate.

The OnBeforeDisplayCharacterPositionDialog method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnBeforeDisplayCharacterPositionDialog in a derived class, be sure to call the base class's OnBeforeDisplayCharacterPositionDialog method so that registered delegates receive the event.

Example

The following sample code illustrates what information is available in the BeforeDisplayCharacterPositionDialog event.

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 Infragistics.Win.UltraWinStatusBar
Imports System.Diagnostics

   Private Sub ultraStatusBar1_BeforeDisplayCharacterPositionDialog(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinStatusBar.CancelablePanelEventArgs) Handles ultraStatusBar1.BeforeDisplayCharacterPositionDialog

       Debug.WriteLine("Before display character position dialog for panel:")
       Debug.Indent()

       Debug.WriteLine("style:" + e.Panel.Style.ToString())
       Debug.WriteLine("index:" + e.Panel.Index.ToString())
       Debug.WriteLine("key:" + e.Panel.Key)
       Debug.WriteLine("text:" + e.Panel.DisplayText)

       Debug.IndentLevel = 0

       ' Note : This action can be canceled by the following line of code.
       'e.Cancel = True

   End Sub

C#

using System.Diagnostics;
using Infragistics.Win.UltraWinStatusBar;

private void ultraStatusBar1_BeforeDisplayCharacterPositionDialog(object sender, Infragistics.Win.UltraWinStatusBar.CancelablePanelEventArgs e)
{

	Debug.WriteLine("Before display character position dialog for panel:");
	Debug.Indent();

	Debug.WriteLine("style:" + e.Panel.Style.ToString());
	Debug.WriteLine("index:" + e.Panel.Index.ToString());
	Debug.WriteLine("key:" + e.Panel.Key);
	Debug.WriteLine("text:" + e.Panel.DisplayText);
	
	Debug.IndentLevel = 0;

	// Note : This action can be canceled by the following line of code.
	//e.Cancel = true;

}

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