New to Telerik UI for WinForms? Start a free 30-day trial

Base class for IntelliPrompt implementations..

Definition

Namespace:Telerik.WinForms.Controls.SyntaxEditor.UI

Assembly:Telerik.WinControls.SyntaxEditor.dll

Syntax:

C#
public class IntelliPromptBase : ShapedForm, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IContainerControl, IThemeChangeListener, IDisposable

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlFormShapedFormIntelliPromptBase...

Derived Classes: FindReplacePopupCompletionListPopupOverloadListPopupToolTipForm

Implements: IBindableComponentIComponentIContainerControlIDisposableIDropTargetISynchronizeInvokeIThemeChangeListenerIWin32Window...

Inherited Members ShapedForm.OnThemeChanged(ThemeChangedEventArgs)ShapedForm.SetBoundsCore(int, int, int, int, BoundsSpecified)ShapedForm.SetClientSizeCore(int, int)ShapedForm.OnLoad(EventArgs)ShapedForm.OnShown(EventArgs)ShapedForm.OnPaintBackground(PaintEventArgs)ShapedForm.OnSizeChanged(EventArgs)ShapedForm.ApplicationThemeChanged(object, ThemeChangedEventArgs)ShapedForm.ScaleControl(SizeF, BoundsSpecified)ShapedForm.OnResizeBegin(EventArgs)ShapedForm.OnResizeEnd(EventArgs)ShapedForm.OnMove(EventArgs)ShapedForm.PaintFrame(Graphics)ShapedForm.PaintBorder(Graphics)ShapedForm.GetHitTest(Point)ShapedForm.ApplyTheme(string)ShapedForm.ApplyShape()ShapedForm.IsRectangularShape(ref int)ShapedForm.CreateBorderPath()ShapedForm.LOWORD(int)ShapedForm.ShapedControlShapedForm.WindowsSettingsShapedForm.BackColorShapedForm.BorderColorShapedForm.BorderWidthShapedForm.ForeColorShapedForm.FontShapedForm.BorderAlignmentShapedForm.AllowResizeShapedForm.ShapeShapedForm.ThemeNameShapedForm.EnableCompositionOnVistaShapedForm.CreateParamsShapedForm.FormBorderStyleShapedForm.ControlThemeClassNameShapedForm.BorderPathShapedForm.OuterPathForm.SetVisibleCore(bool)Form.Activate()Form.ActivateMdiChild(Form)Form.AddOwnedForm(Form)Form.AdjustFormScrollbars(bool)Form.CreateControlsInstance()Form.CreateHandle()Form.DefWndProc(ref Message)Form.ProcessMnemonic(char)Form.CenterToParent()Form.CenterToScreen()Form.LayoutMdi(MdiLayout)Form.OnActivated(EventArgs)Form.OnBackgroundImageChanged(EventArgs)Form.OnBackgroundImageLayoutChanged(EventArgs)Form.OnClosing(CancelEventArgs)Form.OnClosed(EventArgs)Form.OnFormClosing(FormClosingEventArgs)Form.OnFormClosed(FormClosedEventArgs)Form.OnCreateControl()Form.OnDeactivate(EventArgs)Form.OnEnabledChanged(EventArgs)Form.OnEnter(EventArgs)Form.OnFontChanged(EventArgs)Form.OnHandleCreated(EventArgs)Form.OnHandleDestroyed(EventArgs)Form.OnHelpButtonClicked(CancelEventArgs)Form.OnLayout(LayoutEventArgs)Form.OnMaximizedBoundsChanged(EventArgs)Form.OnMaximumSizeChanged(EventArgs)Form.OnMinimumSizeChanged(EventArgs)Form.OnInputLanguageChanged(InputLanguageChangedEventArgs)Form.OnInputLanguageChanging(InputLanguageChangingEventArgs)Form.OnVisibleChanged(EventArgs)Form.OnMdiChildActivate(EventArgs)Form.OnMenuStart(EventArgs)Form.OnMenuComplete(EventArgs)Form.OnPaint(PaintEventArgs)Form.OnResize(EventArgs)Form.OnDpiChanged(DpiChangedEventArgs)Form.OnGetDpiScaledSize(int, int, ref Size)Form.OnRightToLeftLayoutChanged(EventArgs)Form.OnTextChanged(EventArgs)Form.ProcessCmdKey(ref Message, Keys)Form.ProcessDialogKey(Keys)Form.ProcessDialogChar(char)Form.ProcessKeyPreview(ref Message)Form.ProcessTabKey(bool)Form.RemoveOwnedForm(Form)Form.Select(bool, bool)Form.GetScaledBounds(Rectangle, SizeF, BoundsSpecified)Form.SetDesktopBounds(int, int, int, int)Form.SetDesktopLocation(int, int)Form.Show(IWin32Window)Form.ShowDialog()Form.ShowDialog(IWin32Window)Form.ToString()Form.UpdateDefaultButton()Form.OnStyleChanged(EventArgs)Form.ValidateChildren()Form.ValidateChildren(ValidationConstraints)Form.AcceptButtonForm.ActiveFormForm.ActiveMdiChildForm.AllowTransparencyForm.AutoScrollForm.AutoSizeForm.AutoSizeModeForm.AutoValidateForm.CancelButtonForm.ClientSizeForm.ControlBoxForm.DefaultImeModeForm.DefaultSizeForm.DesktopBoundsForm.DesktopLocationForm.DialogResultForm.HelpButtonForm.IconForm.IsMdiChildForm.IsMdiContainerForm.IsRestrictedWindowForm.KeyPreviewForm.LocationForm.MaximizedBoundsForm.MaximumSizeForm.MainMenuStripForm.MenuForm.MinimumSizeForm.MaximizeBoxForm.MdiChildrenForm.MdiParentForm.MergedMenuForm.MinimizeBoxForm.ModalForm.OpacityForm.OwnedFormsForm.OwnerForm.RestoreBoundsForm.RightToLeftLayoutForm.ShowInTaskbarForm.ShowIconForm.ShowWithoutActivationForm.SizeForm.SizeGripStyleForm.TextForm.TopLevelForm.TopMostForm.TransparencyKeyForm.WindowStateForm.AutoSizeChangedForm.AutoValidateChangedForm.HelpButtonClickedForm.MaximizedBoundsChangedForm.MaximumSizeChangedForm.MinimumSizeChangedForm.ActivatedForm.DeactivateForm.FormClosingForm.FormClosedForm.LoadForm.MdiChildActivateForm.MenuCompleteForm.MenuStartForm.InputLanguageChangedForm.InputLanguageChangingForm.RightToLeftLayoutChangedForm.ShownForm.DpiChangedForm.ResizeBeginForm.ResizeEnd...

Constructors

Creates an instance without initializing its editor-dependent prompt state. Use the constructor that accepts a RadSyntaxEditorElement for prompts that will be shown or closed.

C#
public IntelliPromptBase()

Initializes a new instance of the IntelliPromptBase class.

C#
public IntelliPromptBase(RadSyntaxEditorElement syntaxEditor)
Parameters:syntaxEditorRadSyntaxEditorElement

The code editor.

Properties

Gets a value indicating whether [close on lost focus].

C#
public virtual bool CloseOnLostFocus { get; }
Property Value:

true if [close on lost focus]; otherwise, false.

Gets the editor.

C#
public RadSyntaxEditorElement Editor { get; }
Property Value:

The editor.

Gets the end position.

C#
public CaretPosition EndPosition { get; }
Property Value:

The end position.

Gets a value indicating whether this instance has called close.

C#
protected bool HasCalledClose { get; }
Property Value:

true if this instance has called close; otherwise, false.

Gets or sets a value indicating whether this instance is automatic close.

C#
public bool IsAutoClose { get; set; }
Property Value:

true if this instance is automatic close; otherwise, false.

Gets or sets the opacity when control pressed.

C#
public double OpacityWhenCtrlPressed { get; set; }
Property Value:

The opacity when control pressed.

Gets a value indicating whether [reposition on caret position changed].

C#
public virtual bool RepositionOnCaretPositionChanged { get; }
Property Value:

true if [reposition on caret position changed]; otherwise, false.

Gets the start position.

C#
public CaretPosition StartPosition { get; }
Property Value:

The start position.

Methods

Attaches to editor.

C#
protected virtual void AttachToEditor()

Automatics the close.

C#
protected virtual void AutoClose()

Calculates the prompt location for a derived prompt type; the default implementation returns Empty.

C#
protected virtual Point CalculatePopupLocation(RadSyntaxEditorElement editor)
Parameters:editorRadSyntaxEditorElement

The editor used to calculate the location.

Returns:

Point

The prompt location in editor-relative coordinates.

Closes this instance.

C#
public void Close()

Detaches from editor.

C#
protected virtual void DetachFromEditor()

Releases unmanaged and - optionally - managed resources.

C#
protected virtual void Dispose(bool disposing)
Parameters:disposingbool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Provides a hook for derived prompts to respond when the owning form changes location.

C#
protected virtual void EditorLocationChanged(object sender, EventArgs e)
Parameters:senderobject

The owning form.

eEventArgs

The event data.

Maps resize-edge hit tests to caption hit tests so the prompt can be moved without resizing.

C#
protected virtual int GetDesiredNCHitResult(int actualHitPoint)
Parameters:actualHitPointint

The hit-test result received from the window.

Returns:

int

The hit-test result used for non-client processing.

Converts an editor-relative prompt location to screen coordinates.

C#
protected virtual Point GetScreenPopupLocation(Point location)
Parameters:locationPoint

The prompt location relative to the editor.

Returns:

Point

The screen location, or Empty when the editor or its element tree is unavailable.

Resolves the theme from the application, the editor's owning control, or the control default, in that order.

C#
protected virtual string GetThemeName()
Returns:

string

The theme name selected by that precedence.

Handles the code editor key down.

C#
protected virtual void HandleSyntaxEditorKeyDown(object sender, PreviewSyntaxEditorKeyEventArgs e)
Parameters:senderobject

The sender.

ePreviewSyntaxEditorKeyEventArgs

The PreviewSyntaxEditorKeyEventArgs instance containing the event data.

Handles the code editor key up.

C#
protected virtual void HandleSyntaxEditorKeyUp(object sender, PreviewSyntaxEditorKeyEventArgs e)
Parameters:senderobject

The sender.

ePreviewSyntaxEditorKeyEventArgs

The PreviewSyntaxEditorKeyEventArgs instance containing the event data.

Applies the theme resolved for the owning editor to the prompt.

C#
protected virtual void ReadOwnerProperties()

Resets this instance.

C#
protected virtual void Reset()

Positions the prompt relative to the current caret and requests auto-close when that position leaves the editor viewport.

C#
protected virtual void SetPositionInView()

Shows this instance.

C#
public void Show()

Shows the specified start position.

C#
public void Show(CaretPosition caretStartPosition, CaretPosition caretEndPositions)
Parameters:caretStartPositionCaretPosition

The start position.

caretEndPositionsCaretPosition

The end position.

Converts an editor-relative location to screen coordinates and applies it to the prompt.

C#
protected virtual void UpdatePopupLocation(Point location)
Parameters:locationPoint

The prompt location relative to the editor.

Provides an extension point for derived prompts to size themselves before opening.

C#
protected virtual void UpdatePopupSize()

Processes window messages and adjusts non-client hit testing for the prompt.

C#
protected override void WndProc(ref Message m)
Parameters:mMessage

The message to process.

Overrides: ShapedForm.WndProc(ref Message)