Interface IInteractiveCustomColumn

Interface implemented by custom columns in the edit control that support user interaction.

Inherited Members
Namespace: SdlSdl.DesktopEditorEditorApi
Assembly: Sdl.DesktopEditor.EditorApi.dll
Syntax
public interface IInteractiveCustomColumn : ICustomColumn

Properties

EventFlags

The editor queries this property to determine which user interaction events this column is interested in. Only these types of events will generate calls on the OnCell... methods in this interface.

Declaration
InteractiveEventFlags EventFlags { get; }
Property Value
Type Description
InteractiveEventFlags

Methods

OnCellMouseDoubleClick(IRowInfo, Rectangle, MouseEventArgs)

Called when the user double-clicks inside the column.

Declaration
void OnCellMouseDoubleClick(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type Name Description
IRowInfo row
Rectangle cellBounds
MouseEventArgs e

OnCellMouseDown(IRowInfo, Rectangle, MouseEventArgs)

Called when the user presses the left mouse button inside the column.

Declaration
void OnCellMouseDown(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type Name Description
IRowInfo row
Rectangle cellBounds
MouseEventArgs e

OnCellMouseEntering(IRowInfo, Rectangle, IRowInfo, Rectangle)

Called when the mouse cursor is moved into a cell in the column.

Declaration
void OnCellMouseEntering(IRowInfo row, Rectangle cellBounds, IRowInfo leavingRow, Rectangle leavingCellBounds)
Parameters
Type Name Description
IRowInfo row

the row of the cell the mouse is entering
Rectangle cellBounds

window coordinates of the cell
IRowInfo leavingRow

the row of the cell the mouse was before entering this, or null if none.
Rectangle leavingCellBounds

the window coordinates of the cell the mouse was in before entering this, if any

OnCellMouseLeaving(IRowInfo, Rectangle, IRowInfo, Rectangle)

Called when the mouse cursor is moved out of a cell in the column.

Declaration
void OnCellMouseLeaving(IRowInfo row, Rectangle cellBounds, IRowInfo enteringRow, Rectangle enteringCellBounds)
Parameters
Type Name Description
IRowInfo row

the row of the cell the mouse is leaving
Rectangle cellBounds

window coordinates of the cell
IRowInfo enteringRow

the row of the cell the mouse will be entering, or null if none.
Rectangle enteringCellBounds

the window coordinates of the cell the mouse will be entering, if any

OnCellMouseMove(IRowInfo, Rectangle, MouseEventArgs)

Called when the mouse cursor is moved inside the column.

Declaration
void OnCellMouseMove(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type Name Description
IRowInfo row
Rectangle cellBounds
MouseEventArgs e

OnCellMouseRightDown(IRowInfo, Rectangle, MouseEventArgs)

Called when the right mouse button is pressed inside the column.

Declaration
void OnCellMouseRightDown(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type Name Description
IRowInfo row
Rectangle cellBounds
MouseEventArgs e

OnCellMouseRightUp(IRowInfo, Rectangle, MouseEventArgs)

Called when the right mouse button is released inside the column.

Declaration
void OnCellMouseRightUp(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type Name Description
IRowInfo row
Rectangle cellBounds
MouseEventArgs e

OnCellMouseUp(IRowInfo, Rectangle, MouseEventArgs)

Called when the user releases the left mouse button inside the column.

Declaration
void OnCellMouseUp(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type Name Description
IRowInfo row
Rectangle cellBounds
MouseEventArgs e

Events

ContentChanged

Fired by the custom column to indicate to the editor that content of one or more cells in the column has changed (and will need to be re-drawn).

Declaration
event EventHandler<CustomColumnContentChangedEventArgs> ContentChanged
Event Type
Type Description
EventHandlerCustomColumnContentChangedEventArgs
Remarks

This is only needed for content changes that do not originate directly from edit operations in the edit control. An example of when to use this event could be interactive highlighting of a cell when the user moves the mouse over it.

Extension Methods