Class AbstractRowSelectionColumn
Base class for a column that is aware of row selections and the mouse operations that should be performed on them.
Inherited Members
Namespace: Sdl.DesktopEditor.EditorApi.Implementation
Assembly: Sdl.DesktopEditor.EditorApi.dll
Syntax
public abstract class AbstractRowSelectionColumn : AbstractCustomColumn, IInteractiveCustomColumn, ICustomColumn
Constructors
AbstractRowSelectionColumn()
Declaration
protected AbstractRowSelectionColumn()
Properties
EventFlags
Implementation handles all left mouse click events plus mouse entering and leaving a cell.
Declaration
public virtual InteractiveEventFlags EventFlags { get; }
Property Value
Type | Description |
---|---|
InteractiveEventFlags |
IsMinimized
If set then the width of the column will be reduced to a minimized state in the edit control. This should be used instead of removing or adding the segment id column because it is used for row activation as well.
Declaration
public bool IsMinimized { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
MinimizedWidth
The width that the column should be when minimized
Declaration
protected int MinimizedWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Methods
OnCellMouseDoubleClick(IRowInfo, Rectangle, MouseEventArgs)
Handled to avoid this being unintentionally processed by the edit control. The implementation does nothing.
Declaration
public virtual void OnCellMouseDoubleClick(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
IRowInfo | row | |
System.Drawing.Rectangle | cellBounds | |
System.Windows.Forms.MouseEventArgs | e |
OnCellMouseDown(IRowInfo, Rectangle, MouseEventArgs)
Handled to avoid this being unintentionally processed by the edit control. The implementation does nothing.
Declaration
public virtual void OnCellMouseDown(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
IRowInfo | row | |
System.Drawing.Rectangle | cellBounds | |
System.Windows.Forms.MouseEventArgs | e |
OnCellMouseEntering(IRowInfo, Rectangle, IRowInfo, Rectangle)
When the mouse enters the cell the cursor is set to a hand.
Declaration
public virtual void OnCellMouseEntering(IRowInfo row, Rectangle cellBounds, IRowInfo leavingRow, Rectangle leavingCellBounds)
Parameters
Type | Name | Description |
---|---|---|
IRowInfo | row | |
System.Drawing.Rectangle | cellBounds | |
IRowInfo | leavingRow | |
System.Drawing.Rectangle | leavingCellBounds |
OnCellMouseLeaving(IRowInfo, Rectangle, IRowInfo, Rectangle)
When the mouse leaves a cell the mouse cursor is restored and the tool tip is hidden.
Declaration
public virtual void OnCellMouseLeaving(IRowInfo row, Rectangle cellBounds, IRowInfo enteringRow, Rectangle enteringCellBounds)
Parameters
Type | Name | Description |
---|---|---|
IRowInfo | row | |
System.Drawing.Rectangle | cellBounds | |
IRowInfo | enteringRow | |
System.Drawing.Rectangle | enteringCellBounds |
OnCellMouseMove(IRowInfo, Rectangle, MouseEventArgs)
Not used.
Declaration
public virtual void OnCellMouseMove(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
IRowInfo | row | |
System.Drawing.Rectangle | cellBounds | |
System.Windows.Forms.MouseEventArgs | e |
OnCellMouseRightDown(IRowInfo, Rectangle, MouseEventArgs)
Not used.
Declaration
public virtual void OnCellMouseRightDown(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
IRowInfo | row | |
System.Drawing.Rectangle | cellBounds | |
System.Windows.Forms.MouseEventArgs | e |
OnCellMouseRightUp(IRowInfo, Rectangle, MouseEventArgs)
Not used.
Declaration
public virtual void OnCellMouseRightUp(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
IRowInfo | row | |
System.Drawing.Rectangle | cellBounds | |
System.Windows.Forms.MouseEventArgs | e |
OnCellMouseUp(IRowInfo, Rectangle, MouseEventArgs)
Performs the "click on" functionality - i.e. activates the current row.
Declaration
public virtual void OnCellMouseUp(IRowInfo row, Rectangle cellBounds, MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
IRowInfo | row | |
System.Drawing.Rectangle | cellBounds | |
System.Windows.Forms.MouseEventArgs | e |
OnContentChanged(Object, CustomColumnContentChangedEventArgs)
Fire the ContentChanged event.
Declaration
public virtual void OnContentChanged(object sender, CustomColumnContentChangedEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | |
CustomColumnContentChangedEventArgs | args |
Events
ContentChanged
Currently not used by this column.
Declaration
public event EventHandler<CustomColumnContentChangedEventArgs> ContentChanged
Event Type
Type | Description |
---|---|
System.EventHandler<CustomColumnContentChangedEventArgs> |