IntelliPromptBase
Base class for IntelliPrompt implementations..
Definition
Namespace:Telerik.WinForms.Controls.SyntaxEditor.UI
Assembly:Telerik.WinControls.SyntaxEditor.dll
Syntax:
public class IntelliPromptBase : ShapedForm, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IContainerControl, IThemeChangeListener, IDisposable
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlFormShapedFormIntelliPromptBase...
Derived Classes:
Implements:
Inherited Members
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.
public IntelliPromptBase()
Initializes a new instance of the IntelliPromptBase class.
public IntelliPromptBase(RadSyntaxEditorElement syntaxEditor)
The code editor.
Properties
Gets a value indicating whether [close on lost focus].
public virtual bool CloseOnLostFocus { get; }
true if [close on lost focus]; otherwise, false.
Gets the editor.
public RadSyntaxEditorElement Editor { get; }
The editor.
Gets the end position.
public CaretPosition EndPosition { get; }
The end position.
Gets a value indicating whether this instance has called close.
protected bool HasCalledClose { get; }
true if this instance has called close; otherwise, false.
Gets or sets a value indicating whether this instance is automatic close.
public bool IsAutoClose { get; set; }
true if this instance is automatic close; otherwise, false.
Gets or sets the opacity when control pressed.
public double OpacityWhenCtrlPressed { get; set; }
The opacity when control pressed.
Gets a value indicating whether [reposition on caret position changed].
public virtual bool RepositionOnCaretPositionChanged { get; }
true if [reposition on caret position changed]; otherwise, false.
Gets the start position.
public CaretPosition StartPosition { get; }
The start position.
Methods
Attaches to editor.
protected virtual void AttachToEditor()
Automatics the close.
protected virtual void AutoClose()
Calculates the prompt location for a derived prompt type; the default implementation returns Empty.
protected virtual Point CalculatePopupLocation(RadSyntaxEditorElement editor)
The editor used to calculate the location.
Returns:The prompt location in editor-relative coordinates.
Closes this instance.
public void Close()
Detaches from editor.
protected virtual void DetachFromEditor()
Releases unmanaged and - optionally - managed resources.
protected virtual void Dispose(bool disposing)
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Resolves the theme from the application, the editor's owning control, or the control default, in that order.
protected virtual string GetThemeName()
The theme name selected by that precedence.
Handles the code editor key down.
protected virtual void HandleSyntaxEditorKeyDown(object sender, PreviewSyntaxEditorKeyEventArgs e)
The sender.
ePreviewSyntaxEditorKeyEventArgsThe PreviewSyntaxEditorKeyEventArgs instance containing the event data.
Handles the code editor key up.
protected virtual void HandleSyntaxEditorKeyUp(object sender, PreviewSyntaxEditorKeyEventArgs e)
The sender.
ePreviewSyntaxEditorKeyEventArgsThe PreviewSyntaxEditorKeyEventArgs instance containing the event data.
Applies the theme resolved for the owning editor to the prompt.
protected virtual void ReadOwnerProperties()
Resets this instance.
protected virtual void Reset()
Positions the prompt relative to the current caret and requests auto-close when that position leaves the editor viewport.
protected virtual void SetPositionInView()
Shows this instance.
public void Show()
Shows the specified start position.
public void Show(CaretPosition caretStartPosition, CaretPosition caretEndPositions)
The start position.
caretEndPositionsCaretPositionThe end position.
Converts an editor-relative location to screen coordinates and applies it to the prompt.
protected virtual void UpdatePopupLocation(Point location)
The prompt location relative to the editor.
Provides an extension point for derived prompts to size themselves before opening.
protected virtual void UpdatePopupSize()
Processes window messages and adjusts non-client hit testing for the prompt.
protected override void WndProc(ref Message m)
The message to process.
Overrides: