ShowCaretPositionDialog Method

Used to display the CaretPositionDialog

Syntax

Visual Basic

'Declaration
 
Public Function ShowCaretPositionDialog() As Boolean

C#

public bool ShowCaretPositionDialog()

Return Value

False if the Control property is not a RichTextBox or if the panel is not a CharacterPosition style pane. Otherwise true if the dialog was displayed.

Remarks

The CaretPositionDialog may be displayed for a CharacterPosition style panel whose Control is a System.Windows.Forms.RichTextBox. The dialog is similar to the one displayed by Visual Studio .Net when you double click on the character position status panel.

Example

The following sample code illustrates how to display the caret position dialog.

Visual Basic

Private Sub button2_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles button2.Click

    ' Call the panel's ShowCaretPositionDialog method
    ' to bring up the dialog.
    Me.ultraStatusBar1.Panels("P3").ShowCaretPositionDialog()

    ' Note: This panel must have a style of 'CharacterPosition'
    ' for this method to work. If the panel's 'Style' property
    ' is set to any other style nothing happens.

End Sub

C#

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

	// Call the panel's ShowCaretPositionDialog method
	// to bring up the dialog.
	this.ultraStatusBar1.Panels["P3"].ShowCaretPositionDialog();

	// Note: This panel must have a style of 'CharacterPosition'
	// for this method to work. If the panel's 'Style' property
	// is set to any other style nothing happens.

}

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