Class GridOriginalTextBoxControl

Implements the text box that is shown in a GridTextBoxCellRenderer when the user starts editing the cell.

Inheritance

System.Object

GridOriginalTextBoxControl

Implements

IGridTextBoxControl

ISupportsPopupControlContainer

Namespace: Syncfusion.Windows.Forms.Grid

Assembly: Syncfusion.Grid.Windows.dll

Syntax

public class GridOriginalTextBoxControl : TextBox, IGridTextBoxControl, ISupportsPopupControlContainer

Constructors

GridOriginalTextBoxControl(GridTextBoxCellRenderer)

Initializes a new GridTextBoxControl and attaches it to a GridTextBoxCellRenderer

Declaration

public GridOriginalTextBoxControl(GridTextBoxCellRenderer parent)

Parameters

Type	Name	Description
GridTextBoxCellRenderer	parent	The GridTextBoxCellRenderer that the cell belongs to.

Properties

CreateParams

Gets the required creation parameters when the control handle is created.

Declaration

protected override CreateParams CreateParams { get; }

Property Value

Type
System.Windows.Forms.CreateParams

DroppedDown

Gets or sets a value indicating whether the dropped-down state or shows or hides the drop-down window.

Declaration

public bool DroppedDown { get; set; }

Property Value

Type
System.Boolean

Floatable

Gets or sets a value indicating whether if the cell supports floating over another cell.

Declaration

public virtual bool Floatable { get; set; }

Property Value

Type
System.Boolean

FloatDone

Gets or sets a value indicating whether if the cell was floated over another cell after the user inserted text. Will be reset when the cell is redrawn.

Declaration

public bool FloatDone { get; set; }

Property Value

Type
System.Boolean

Initializing

Gets a value indicating whether BeginInit() was called.

Declaration

public bool Initializing { get; }

Property Value

Type
System.Boolean

IsSuspendEvents

Gets a value indicating whether the raising events is temporarily disabled.

Declaration

public bool IsSuspendEvents { get; }

Property Value

Type
System.Boolean

ParentCell

Gets the associated cell renderer for the text box.

Declaration

public GridCellRendererBase ParentCell { get; }

Property Value

Type
GridCellRendererBase

PopupControlContainer

Gets or sets the container this child control is associated with.

Declaration

protected virtual IGridDropDownContainer PopupControlContainer { get; set; }

Property Value

Type
IGridDropDownContainer

Methods

BeginInit()

Suspends raising Modified events until EndInit is called and set Initializing property to true. You should check Initializing your cell renderer's implementation to see if changes in the text box are done because of initialization or user interaction.

Declaration

public void BeginInit()

Exceptions

Type	Condition
System.Exception	if BeginInit called twice.

EndInit()

Resume raising modified events and resets the Initializing property.

Declaration

public void EndInit()

IsInputKey(Keys)

Determines whether the specified key is an input key or a special key that requires preprocessing.

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Type	Name	Description
System.Windows.Forms.Keys	keyData	One of the key's values.

Returns

Type	Description
System.Boolean	A value indicating whether the key data can be allowed

LineScroll(Int32)

Scroll the specified number of lines.

Declaration

public void LineScroll(int count)

Parameters

Type	Name	Description
System.Int32	count	The number of lines to scroll.

Remarks

Sends an EM_LINESCROLL message to the control.

OnEnter(EventArgs)

Raises the System.Windows.Forms.Control.Enter event.

Declaration

protected override void OnEnter(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgsthat contains event data.

OnGotFocus(EventArgs)

Raises the System.Windows.Forms.Control.GotFocus event.

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgsthat contains event data.

OnHandleDestroyed(EventArgs)

Raises the System.Windows.Forms.Control.OnHandleDestroyed event.

Declaration

protected override void OnHandleDestroyed(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgsthat contains event data.

OnKeyDown(KeyEventArgs)

Raises the System.Windows.Forms.Control.KeyDown event.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.KeyEventArgs	e	An System.Windows.Forms.KeyEventArgsthat contains event data.

OnKeyPress(KeyPressEventArgs)

Raises the System.Windows.Forms.Control.KeyPress event.

Declaration

protected override void OnKeyPress(KeyPressEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.KeyPressEventArgs	e	An System.Windows.Forms.KeyEventArgsthat contains event data.

OnKeyUp(KeyEventArgs)

Raises the System.Windows.Forms.Control.KeyUp event.

Declaration

protected override void OnKeyUp(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.KeyEventArgs	e	An System.Windows.Forms.KeyEventArgsthat contains event data.

OnLeave(EventArgs)

Raises the System.Windows.Forms.Control.Leave event.

Declaration

protected override void OnLeave(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgsthat contains event data.

OnLostFocus(EventArgs)

Raises the System.Windows.Forms.Control.LostFocus event.

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgsthat contains event data.

OnMouseWheel(MouseEventArgs)

Overridden to raise the System.Windows.Forms.Control.MouseWheel event.

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	e	An System.Windows.Forms.MouseEventArgsthat contains event data.

OnPaintBackground(PaintEventArgs)

Paints the background of the control.

Declaration

protected override void OnPaintBackground(PaintEventArgs pevent)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	pevent	An System.Windows.Forms.PaintEventArgsthat contains event data.

OnTextChanged(EventArgs)

Raises the System.Windows.Forms.Control.TextChanged event.

Declaration

protected override void OnTextChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgsthat contains event data.

PreProcessMessage(ref Message)

Pre-processes the keyboard or input messages within the message loop before they are dispatched.

Declaration

public override bool PreProcessMessage(ref Message msg)

Parameters

Type	Name	Description
System.Windows.Forms.Message	msg	Message that has to be dispatched.

Returns

Type	Description
System.Boolean	True if the messages can be preprocessed.

ProcessKeyMessage(ref Message)

Processes a keyboard message.

Declaration

protected override bool ProcessKeyMessage(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m	A System.Windows.Forms.Message passed by reference, that represents the window message to process.

Returns

Type	Description
System.Boolean	Returns the message of the processed key.

ResumeEvents()

Resumes raising events.

Declaration

public void ResumeEvents()

SuspendEvents()

Suspends raising events.

Declaration

public void SuspendEvents()

WndProc(ref Message)

Processes Windows messages.

Declaration

protected override void WndProc(ref Message msg)

Parameters

Type	Name	Description
System.Windows.Forms.Message	msg	A Windows Message object.

Explicit Interface Implementations

IGridTextBoxControl.TextBoxMargins

Gets the default text box margins.

Declaration

GridMargins IGridTextBoxControl.TextBoxMargins { get; }

Returns

Type
GridMargins

ISupportsPopupControlContainer.PopupControlContainer

Gets or sets the container this child control is associated with.

Declaration

IGridDropDownContainer ISupportsPopupControlContainer.PopupControlContainer { get; set; }

Returns

Type
IGridDropDownContainer

Implements

IGridTextBoxControl

ISupportsPopupControlContainer