Syncfusion.Grid.Windows
Members 


Syncfusion.Windows.Forms.Grid Namespace : GridDropDownGridListControlCellRenderer Class

GridDropDownGridListControlCellRenderer Class

Defines the renderer part of a drop-down ListControl-like grid that lets users drop-down a grid that can be bound to a GridStyleInfo.DataSource of a GridStyleInfo instance and supports auto-complete. Display and value members can be specified with GridStyleInfo.ValueMember and GridStyleInfo.DisplayMember.
Object Model
GridDropDownGridListControlCellRenderer ClassGridCurrentCell ClassGridStyleInfo ClassGridCellButton ClassGridDropDownContainer ClassIGridDropDownCellImp InterfaceIGridDropDownCellImp InterfaceGridControlBase ClassGridListControl ClassGridDropDownGridListControlCellModel ClassPopupControlContainer ClassGridStyleInfo Class
Syntax
Remarks
The GridDropDownGridListControlCellRenderer supports an auto complete feature that will fill the text with possible matches from the drop-down list while the user is entering text.

A renderer is created for each GridCellModelBase and GridControlBase. There can be several renderers associated with one GridDropDownGridListControlCellModel if several views display the same GridModel.

The following table lists some characteristics about the DropDownGridListControl cell type.

Item Description
CellType GridListControl
Renderer GridDropDownGridListControlCellRenderer
Model GridDropDownGridListControlCellModel
XP Themes Support Yes
Cell Button GridCellComboBoxButton
Interactive Edit with Text Input or DropDown
Control GridDropDownEditPartControl
DropDown Control GridListControl
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
GridStyleInfo.AllowEnter (System.Boolean) Gets / sets if pressing the <Enter>-Key should insert a new line into the edited text. (Default: False)
GridStyleInfo.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)
GridStyleInfo.Borders (GridBordersInfo) Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
GridStyleInfo.CellAppearance (GridCellAppearance) Specifies if cell edges shall be drawn raised, sunken, or flat (default). (Default: GridCellAppearance.Flat)
GridStyleInfo.CellTipText (System.String) ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
GridStyleInfo.CellType (System.String) GridListControl (Default: Text Box)
GridStyleInfo.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)
GridStyleInfo.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, GridStyleInfo.Error will contain error information. (Default: NULL)
GridStyleInfo.Clickable (System.Boolean) Specifies if the drop-down button can be clicked. If set to False, the button will be drawn grayed out. See GridStyleInfo.Enabled how to disable activating the drop-down cell. (Default: True)
GridStyleInfo.CultureInfo (System.Globalization.CultureInfo) The culture information holds rules for parsing and formatting the cell's value. (Default: NULL)
GridStyleInfo.DataSource (System.Object) Specifies a data source that holds items to be displayed in a drop-down list. A datasource can be specified instead of manually filling the choicelist with string entries. (Default: NULL)
GridStyleInfo.DisplayMember (System.String) Names the property in the GridStyleInfo.DataSource that holds the text to be displayed in a cell that depends on a GridStyleInfo.ValueMember. (Default: String.Empty)
GridStyleInfo.DropDownStyle (GridDropDownStyle) Specifies if user input is restricted to items from the GridStyleInfo.ChoiceList or GridStyleInfo.DataSource. (Default: GridDropDownStyle.Editable)
GridStyleInfo.Enabled (System.Boolean) Specifies if the cell can be activated as current cell or if the cell should be skipped when moving the current cell. When disabled, the drop-down button can still be clicked. You should also disable GridStyleInfo.Clickable if you do not want the user to click the drop-down button. (Default: True)
GridStyleInfo.Error (System.String) Holds error information if a value could not be converted to the System.Type specified with GridStyleInfo.CellValueType. (Default: String.Empty)
GridStyleInfo.ExclusiveChoiceList (System.Boolean) Specifies if user input is restricted to items from the GridStyleInfo.ChoiceList or GridStyleInfo.DataSource. (Default: False)
GridStyleInfo.Font (GridFontInfo) The font for drawing text. (Default: GridFontInfo.Default)
GridStyleInfo.HorizontalAlignment (GridHorizontalAlignment) Specifies horizontal alignment of text in the cell. This does not affect the position of the drop-down button. (Default: GridHorizontalAlignment.Left)
GridStyleInfo.HotkeyPrefix (System.Drawing.Text.HotkeyPrefix) Specifies how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable the hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show)
GridStyleInfo.ImageIndex (System.Int32) Specifies an index for an image in the GridStyleInfo.ImageList of a GridStyleInfo instance. The image is only shown in the text field, not in the drop-down list. You have to add custom programming logic in order to set the ImageIndex based on a selection in the drop-down list. (Default: -1)
GridStyleInfo.ImageList (System.Windows.Forms.ImageList) The GridStyleInfo.ImageList that holds a collection of images. Cells can choose images with the GridStyleInfo.ImageIndex property in a GridStyleInfo instance. (Default: NULL)
GridStyleInfo.Interior (Syncfusion.Drawing.BrushInfo) Lets you specify a solid backColor, gradient, or pattern style with both back and foreColor for a cell's background. (Default: SystemColors.Window)
GridStyleInfo.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)
GridStyleInfo.ReadOnly (System.Boolean) Specifies if cell contents can be modified by the user. The user can still drop-down the grid panel but changes will not be saved back into the text field. (Default: False)
GridStyleInfo.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)
GridStyleInfo.Text (System.String) Gets / sets the value as a string. If a GridStyleInfo.CellValueType is specified, the text will be parsed and converted to the type specified with GridStyleInfo.CellValueType using any GridStyleInfo.CultureInfo information. (Default: String.Empty)
GridStyleInfo.TextAlign (GridTextAlign) Align text left of button elements (which is typical for combo boxes). Or align text right of button elements. (Default: GridTextAlign.Default)
GridStyleInfo.TextColor (System.Drawing.Color) Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText)
GridStyleInfo.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)
GridStyleInfo.Themed (System.Boolean) Specifies if cell should be drawn using Windows XP themes when GridControlBase.ThemesEnabled has been set. (Default: True)
GridStyleInfo.Trimming (System.Drawing.StringTrimming) Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character)
GridStyleInfo.ValidateValue (GridCellValidateValueInfo) Holds validation rules for the cell value that are being checked before any user changes are committed to the grid cells style object. (Default: NULL)
GridStyleInfo.ValueMember (System.String) Names the property in the dataSource that holds the key to be saved in a cell. (Default: String.Empty)
GridStyleInfo.VerticalAlignment (GridVerticalAlignment) Specifies the vertical alignment of text and the drop-down button in the cell. (Default: GridVerticalAlignment.Top)
GridStyleInfo.WrapText (System.Boolean) Specifies if text should be wrapped when it does not fit into a single line. (Default: True)

Inheritance Hierarchy

System.Object
   Syncfusion.ComponentModel.NonFinalizeDisposable
      Syncfusion.Windows.Forms.Grid.GridCellRendererBase
         Syncfusion.Windows.Forms.Grid.GridStaticCellRenderer
            Syncfusion.Windows.Forms.Grid.GridTextBoxCellRenderer
               Syncfusion.Windows.Forms.Grid.GridDropDownCellRenderer
                  Syncfusion.Windows.Forms.Grid.GridDropDownGridListControlCellRenderer
                     Syncfusion.GridHelperClasses.GridListFilterBarCellRenderer
                     Syncfusion.Windows.Forms.Grid.GridDropDownStandardValuesCellRenderer
                     Syncfusion.Windows.Forms.Grid.Grouping.GridTableDropDownListCellRenderer
                     Syncfusion.Windows.Forms.Grid.Grouping.GridTableFilterBarGridListCellRenderer

AssemblyVersion

Syncfusion.Grid.Windows: 17.2460.0.46

See Also