Class GridDropDownColorUICellRenderer
Implements the renderer part of a drop-down color selection cell that lets users drop-down a color selection panel from a cell just like a combo box.
Inheritance
System.Object
GridDropDownColorUICellRenderer
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridDropDownColorUICellRenderer : GridDropDownCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposableRemarks
A renderer is created for each GridCellModelBase and GridControlBase. There can be several renderers associated with one GridDropDownColorUICellModel if several views display the same GridModel.
The following table lists some characteristics about the DropDownColorUI cell type:
| Item | Description |
|---|---|
| CellType | ColorEdit |
| Renderer | GridDropDownColorUICellRenderer |
| Model | GridDropDownColorUICellModel |
| XP Themes Support | Yes |
| Cell Button | GridCellComboBoxButton |
| Interactive | Edit with Text Input or DropDown |
| Control | GridDropDownEditPartControl |
| DropDown Control | ColorUIControl |
| Floating Support | No |
| Base Type | GridDropDownCellRenderer |
The cell's behavior and appearance can be customized with the following properties of the GridStyleInfo class:
| PropertyName | Description |
|---|---|
| AllowEnter (System.Boolean) | Gets / sets if pressing the <Enter>-Key should insert a new line into the edited text. (Default: False) |
| BaseStyle (System.String) | The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty) |
| Borders (GridBordersInfo) | Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default) |
| CellAppearance (GridCellAppearance) | Specifies if cell edges shall be drawn raised, sunken, or flat (default). (Default: GridCellAppearance.Flat) |
| CellTipText (System.String) | ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty) |
| CellType (System.String) | ColorEdit (Default: TextBox) |
| CellValue (System.Object) | This property holds the cell value. Although the cell value is typically a string, it can also be any other primitive type such as int, byte, enum, or any custom type that is derived from System.Object. (Default: String.Empty) |
| CellValueType (System.Type) | Specifies the preferred System.Type for cell values. When you assign a value to the GridStyleInfo object, the value will be converted to this type. If the value cannot be converted, Error will contain error information. Recommended types for a DropDownColorUI are either System.Drawing.Color, System.String or none. (Note: System.Drawing.Color can not be set from property grid at the moment). (Default: NULL) |
| Clickable (System.Boolean) | Specifies if drop-down button can be clicked. If set to False, the button will be drawn grayed out. See Enabled how to disable activating the drop-down cell. (Default: True) |
| CultureInfo (System.Globalization.CultureInfo) | The culture information holds rules for parsing and formatting the cell's value. (Default: null) |
| Enabled (System.Boolean) | Specifies if the cell can be activated as current cell or if cell should be skipped when moving the current cell. When disabled, the drop-down button can still be clicked. You should also disable Clickable if you do not want the user to click the drop-down button. (Default: True) |
| Error (System.String) | Holds error information if a value could not be converted to the System.Type specified with CellValueType. (Default: String.Empty) |
| Font (GridFontInfo) | The font for drawing text. (Default: GridFontInfo.Default) |
| HorizontalAlignment (GridHorizontalAlignment) | Specifies horizontal alignment of text in the cell. This does not affect the position of the drop-down button. (Default: GridHorizontalAlignment.Left) |
| ImageIndex (System.Int32) | Specifies an index for an image in the ImageList of a GridStyleInfo instance. The image is only shown in the text field, not in the drop-down list. (Default: -1) |
| ImageList (System.Windows.Forms.ImageList) | The ImageList that holds a collection of images. Cells can choose images with the ImageIndex property in a GridStyleInfo instance. (Default: NULL) |
| Interior (BrushInfo) | Lets you specify a solid back color, gradient, or pattern style with both back and fore color for a cell's background. (Default: SystemColors.Window) |
| MaxLength (System.Int32) | Limits the number of characters the user can type into the cell. Note: When selecting a text from a choice list or when pasting text, the text can be longer. Additional validation is necessary on your side. (Default: 0) |
| ReadOnly (System.Boolean) | Specifies if cell contents can be modified by the user. The user can still drop-down the color panel but changes will not be saved back into the text field. (Default: False) |
| ShowButtons (GridShowButtons) | Specifies when to show or display the drop-down button. Possible choices are: show the button only for the current cell, always show buttons, or never show buttons. (Default: GridShowButtons.Show) |
| Text (System.String) | Gets / sets the value as a string. If a CellValueType is specified, the text will be parsed and converted to the type specified with CellValueType using any CultureInfo information. (Default: String.Empty) |
| TextAlign (GridTextAlign) | Align text left of button elements (which is typical for combo boxes). Or align text right of button elements. (Default: GridTextAlign.Default) |
| TextColor (System.Drawing.Color) | Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText) |
| TextMargins (GridMarginsInfo) | Holds text margins in pixels. When drawing a cell, this specifies the empty area between the text rectangle and the borders of the client rectangle of the cell. The client rectangle is the cell rectangle without buttons and borders. (Default: GridMarginsInfo.Default) |
| Themed (System.Boolean) | Specifies if cell should be drawn using Windows XP themes when ThemesEnabled has been set. (Default: True) |
| Trimming (System.Drawing.StringTrimming) | Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character) |
| ValidateValue (GridCellValidateValueInfo) | Holds validation rules for the cell value that are being checked before any user changes are committed to the grid cell's style object. (Default: null) |
| VerticalAlignment (GridVerticalAlignment) | Specifies vertical alignment of text and the drop-down button in the cell. (Default: GridVerticalAlignment.Top) |
| WrapText (System.Boolean) | Specifies if text should be wrapped when it does not fit into a single line. (Default: True) |
Constructors
GridDropDownColorUICellRenderer(GridControlBase, GridCellModelBase)
Initializes a new GridDropDownColorUICellRenderer object for the given GridControlBase and GridCellModelBase.
Declaration
public GridDropDownColorUICellRenderer(GridControlBase grid, GridCellModelBase cellModel)Parameters
| Type | Name | Description |
|---|---|---|
| GridControlBase | grid | The GridControlBase that displays this cell renderer. |
| GridCellModelBase | cellModel | The GridCellModelBase that holds data for this cell renderer that should be shared among views. |
Remarks
References to GridControlBase, and GridCellModelBase will be saved.
Methods
ChildClosing(IPopupChild, PopupCloseType)
Called to indicate that the popup child was closed in the specified mode.
Declaration
public override void ChildClosing(IPopupChild childUI, PopupCloseType popupCloseType)Parameters
| Type | Name | Description |
|---|---|---|
| IPopupChild | childUI | Popup child. |
| PopupCloseType | popupCloseType | Specifies the way in which the popup child was closed. |
Overrides
DropDownContainerShowedDropDown(Object, EventArgs)
Occurs after the popup container was dropped down and made visible.
Declaration
public override void DropDownContainerShowedDropDown(object sender, EventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The source of the event. |
| System.EventArgs | e | Event data. |
Overrides
DropDownContainerShowingDropDown(Object, CancelEventArgs)
Occurs when the drop down container is about to be shown.
Declaration
public override void DropDownContainerShowingDropDown(object sender, CancelEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The source of the event. |
| System.ComponentModel.CancelEventArgs | e | Event data. |
Overrides
InitializeDropDownContainer()
Called to initialize contents of the drop-down container for the first time.
Declaration
protected override void InitializeDropDownContainer()Overrides
OnDeactivating()
Closes the DropDown if the CurrentCell is deactivated along with BrowseOnly property
Declaration
protected override bool OnDeactivating()Returns
| Type |
|---|
| System.Boolean |
Overrides
OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)
Allows custom formatting of a cell by changing its style object.
Declaration
public override void OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| GridPrepareViewStyleInfoEventArgs | e | Event data. |
Overrides
TextBoxChanged(Object, EventArgs)
This event fired when textBox changed.
Declaration
protected override void TextBoxChanged(object sender, EventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The source control |
| System.EventArgs | e | The System.EventArgsthat contains event data. |
Overrides
Implements
System.IDisposable