Class ContextPrompt

Represents a form which is used for performing context prompt functionality.

Inheritance
System.Object
BasePopupForm
ContextPrompt
Inherited Members
Namespace: Syncfusion.Windows.Forms.Edit.Forms.Popup
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public class ContextPrompt : BasePopupForm

Constructors

ContextPrompt(Control)

Initializes a new instance of the ContextPrompt class.

Declaration
public ContextPrompt(Control parent)
Parameters
Type Name Description
System.Windows.Forms.Control parent

Editor, prompt belongs to.

Properties

CurrentPrompt

Gets or sets the index of currently selected prompt.

Declaration
public int CurrentPrompt { get; set; }
Property Value
Type
System.Int32

DownArrow

Gets the down arrow image for the ContextPrompt form.

Declaration
public static Image DownArrow { get; }
Property Value
Type
System.Drawing.Image

Dropper

Gets or sets the lexem that causes the context prompt to drop.

Declaration
public IRenderedLexem Dropper { get; set; }
Property Value
Type
IRenderedLexem

Info

Gets measuring info of the current context prompt.

Declaration
protected ContextPrompt.MeasuredInfo Info { get; }
Property Value
Type
ContextPrompt.MeasuredInfo

LexemBeforeDropper

Gets or sets the lexem situated before dropper.

Declaration
public IRenderedLexem LexemBeforeDropper { get; set; }
Property Value
Type
IRenderedLexem

List

Gets the collection of context prompt list item.

Declaration
public ContextPromptCollection List { get; }
Property Value
Type
ContextPromptCollection

SelectedPrompt

Gets the currently selected item in context prompt popup window.

Declaration
public ContextPromptItem SelectedPrompt { get; }
Property Value
Type
ContextPromptItem

UpArrow

Gets the upper arrow image for the ContextPrompt form.

Declaration
public static Image UpArrow { get; }
Property Value
Type
System.Drawing.Image

UseCustomSize

Gets or sets a value indicating whether the custom context prompt size should be used or not.

Declaration
public bool UseCustomSize { get; set; }
Property Value
Type
System.Boolean

UseXPStyle

Gets or sets a value indicating whether the XP style should be used in form or not.

Declaration
public bool UseXPStyle { get; set; }
Property Value
Type
System.Boolean

Methods

Close()

Helps to cancels selection and closes the form.

Declaration
public void Close()

CreateAccessibilityInstance()

New instance for ContextPromptAccessibility accessible object

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type Description
System.Windows.Forms.AccessibleObject

ContextPromptAccessibility

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

True to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

OnCurrentPromptChanged()

Raises SelectedPromptChanged event.

Declaration
protected void OnCurrentPromptChanged()

OnDataChanged()

Updates form.

Declaration
protected void OnDataChanged()

OnPaint(PaintEventArgs)

Draws the whole popup prompt object.

Declaration
protected override void OnPaint(PaintEventArgs pe)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs pe

A PaintEventArgs that contains the event data.

ProcessDialogKey(Keys)

Processes arrow keys.

Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
Type Name Description
System.Windows.Forms.Keys keyData

One of the Keys values that represents the key to process.
Returns
Type Description
System.Boolean

True if the keystroke was processed and consumed by the control; otherwise, false to allow further processing.

ProcessKey(Keys)

Processes the key combination.

Declaration
public bool ProcessKey(Keys keyData)
Parameters
Type Name Description
System.Windows.Forms.Keys keyData

Key combination.
Returns
Type Description
System.Boolean

True, if combination can be processed, otherwise false.

ShowContextPrompt(Point, Size)

Displays the context prompt window that helps to easily add the contents to the EditControl.

Declaration
public void ShowContextPrompt(Point location, Size size)
Parameters
Type Name Description
System.Drawing.Point location

Location of window to show.
System.Drawing.Size size

Size of window to show.

Events

SelectedPromptChanged

Occurs after selected context prompt has changed.

Declaration
public event ContextPromptSelectionChangedEventHandler SelectedPromptChanged
Event Type
Type
ContextPromptSelectionChangedEventHandler