menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface IGridDropDownCellImp - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Interface IGridDropDownCellImp

    Provides functionality for drop-down cell.The GridDropDownCellImp class implements this interface.

    Inherited Members
    IPopupItem.GetPopupParentControl()
    IPopupItem.IsRelatedControl(Control, Boolean)
    IPopupParent.ChildClosing(IPopupChild, PopupCloseType)
    IPopupParent.GetBorderOverlapCue(PopupRelativeAlignment)
    IPopupParent.GetLocationForPopupAlignment(PopupRelativeAlignment, PopupRelativeAlignment)
    IPopupParent.IsRightToLeft
    IQueryFocusInside.QueryFocusInside()
    System.IDisposable.Dispose()
    Namespace: Syncfusion.Windows.Forms.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public interface IGridDropDownCellImp : IDisposable, IQueryFocusInside, IPopupParent, IPopupItem

    Properties

    CurrentCell

    Gets a reference to GridCurrentCell implementation of the GridControlBase this cell renderer is associated with.

    Declaration
    GridCurrentCell CurrentCell { get; }
    Property Value
    Type
    GridCurrentCell

    DropDownButton

    Gets or sets the drop-down button.

    Declaration
    GridCellButton DropDownButton { get; set; }
    Property Value
    Type
    GridCellButton

    DropDownContainer

    Gets the container same as PopupControlContainer, for convenience only.

    Declaration
    IGridDropDownContainer DropDownContainer { get; }
    Property Value
    Type
    IGridDropDownContainer

    EditPart

    Gets the text box that is displayed in the user input field for a combo box.

    Declaration
    Control EditPart { get; }
    Property Value
    Type
    System.Windows.Forms.Control

    Grid

    Gets a reference to the parent grid.

    Declaration
    GridControlBase Grid { get; }
    Property Value
    Type
    GridControlBase

    IgnoreDoubleClickTicks

    Gets or sets a value indicating whether the Environment.TickCount value until a second click should be considered a double click.

    Declaration
    int IgnoreDoubleClickTicks { get; set; }
    Property Value
    Type
    System.Int32

    IgnoreFocus

    Gets or sets a value indicating whether grid focus notification should be temporarily ignored.

    Declaration
    bool IgnoreFocus { get; set; }
    Property Value
    Type
    System.Boolean

    InitFocusEditPart

    Gets or sets a value indicating whether the focus should remain with the grid or active text box when dropped-down. True if focus should remain with grid; False if drop-down should get focus.

    Declaration
    bool InitFocusEditPart { get; set; }
    Property Value
    Type
    System.Boolean

    IsDroppedDown

    Gets a value indicating whether the drop-down is currently dropped-down and visible.

    Declaration
    bool IsDroppedDown { get; }
    Property Value
    Type
    System.Boolean

    PopupControlContainer

    Gets the container where you can insert child controls to be displayed as drop-down part for your cell.

    Declaration
    IGridDropDownContainer PopupControlContainer { get; }
    Property Value
    Type
    IGridDropDownContainer

    Methods

    CreateDropDownContainer()

    Creates a IGridDropDownContainer and associates it with the cells parent grid.

    Declaration
    IGridDropDownContainer CreateDropDownContainer()
    Returns
    Type Description
    IGridDropDownContainer

    The container where you can insert child controls to be displayed as a drop-down part for your cell.

    DropDownContainerCloseDropDown(Object, PopupClosedEventArgs)

    Will be called to indicate that the popup child was closed.

    Declaration
    void DropDownContainerCloseDropDown(object sender, PopupClosedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The child that was closed.

    PopupClosedEventArgs e

    The event data with a PopupCloseType value.

    DropDownContainerShowedDropDown(Object, EventArgs)

    Occurs after the popup has been dropped-down and made visible.

    Declaration
    void DropDownContainerShowedDropDown(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    System.EventArgs e

    Event data.

    DropDownContainerShowingDropDown(Object, CancelEventArgs)

    Occurs when the drop-down container is about to be shown.

    Declaration
    void DropDownContainerShowingDropDown(object sender, CancelEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    System.ComponentModel.CancelEventArgs e

    Event data.

    EnsureDropDownContainer()

    Ensures the container is valid and initialized.

    Declaration
    void EnsureDropDownContainer()

    FixTopMostWindow()

    Ensures that the drop-down part is the top-most window.

    Declaration
    void FixTopMostWindow()

    InitializeDropDownContainer()

    Called to initialize contents of the drop-down container for the first time.

    Declaration
    void InitializeDropDownContainer()

    NotifyShowedDropDown()

    Raises the OnCurrentCellShowedDropDown(EventArgs) for the parent grid.

    Declaration
    void NotifyShowedDropDown()

    NotifyShowingDropDown(ref Size)

    Raises the OnCurrentCellShowingDropDown(GridCurrentCellShowingDropDownEventArgs) for the parent grid.

    Declaration
    bool NotifyShowingDropDown(ref Size size)
    Parameters
    Type Name Description
    System.Drawing.Size size

    The suggested size of the drop-down

    Returns
    Type Description
    System.Boolean

    True if drop-down should be shown; False if operation should be canceled.

    OnButtonClicked(Int32, Int32, Int32)

    This method is called when the user clicks a cell button inside a cell.

    Declaration
    void OnButtonClicked(int rowIndex, int colIndex, int button)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    System.Int32 button

    The button control

    Remarks

    In your overridden version of this method, you can activate the current cell for the given row and column index and then drop-down a list.

    OnCloseDropDown(PopupCloseType)

    This is called from GridCurrentCell.CloseDropDown.

    Declaration
    void OnCloseDropDown(PopupCloseType reason)
    Parameters
    Type Name Description
    PopupCloseType reason
    Remarks

    If your renderer supports dropped-down state, the drop-down window should be closed at this time.

    OnHasFocusControlChanged()

    Override this method if your cell renderer supports in-place editing and you want to do any custom initialization at this point before cell gets redrawn.

    Declaration
    void OnHasFocusControlChanged()

    OnInitialize(Int32, Int32)

    This method gets called from the cell renderer's initialize method. Override this method if you need to do any initialization for the current cell.

    Declaration
    void OnInitialize(int rowIndex, int colIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    OnKeyDown(KeyEventArgs)

    User pressed key down. (similar to Control.OnKeyDown)

    Declaration
    void OnKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.KeyEventArgs e

    The event args of Key down

    OnShowDropDown()

    This is called from GridCurrentCell.ShowDropDown after BeginEdit has been called.

    Declaration
    void OnShowDropDown()
    Remarks

    If your renderer supports dropped-down state, the drop-down window should be made visible at this time.

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved