DropDownItem Class

Represents an item in the HeaderDropDownList class.

Object Model

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Class DropDownItem 
   Implements INamedObject

Dim instance As DropDownItem

public class DropDownItem : INamedObject

Remarks

The DropDownItem class implements basic functionality required by classes that are displayed in the ColumnHeaderCell's ColumnHeaderCell.DropDownList.

A DropDownItem is an entry in HeaderDropDownList. It can have special Text, ToolTip, and Image values. The Click event fires when the user clicks the item with the mouse or keyboard. You can write code in the event handler to operate the related GcMultiRow.

Example

The following code example shows to use this drop-down item to sort or filter. This code example is part of a larger example provided for the ColumnHeaderCell.DropDownList property.

void setSecondColumnDropDownListButton_Click(object sender, EventArgs e)
        {
            // Create a header drop down list without default down down items.
            HeaderDropDownList headerDropDownList = new HeaderDropDownList();

            // If you do not indicate which cell to filter, the cell with the same index as the column header cell in the row             // section is filtered.
            headerDropDownList.CellName = "textBoxCell2";

            DropDownItemCollection dropDownItemCollection = headerDropDownList.Items;
            // Initialize drop down items manually.
            // Add sort item.
            dropDownItemCollection.Add(new DropDownSortItem(SortOrder.Ascending));
            dropDownItemCollection.Add(new DropDownSortItem(SortOrder.Descending));
            
            // Add a separator line.
            dropDownItemCollection.Add(new DropDownSeparatorItem());

            // Add show all, black and none black items.
            dropDownItemCollection.Add(new DropDownShowAllFilterItem());
            dropDownItemCollection.Add(new DropDownBlanksFilterItem());
            dropDownItemCollection.Add(new DropDownNonBlanksFilterItem());

            // Add auto filter items.
            dropDownItemCollection.Add(new DropDownAutoFilterItem());

            // Get second column header cell.
            ColumnHeaderCell columnHeaderCell = this.gcMultiRow1.ColumnHeaders[0][1] as ColumnHeaderCell;
            columnHeaderCell.DropDownList = headerDropDownList;
        }

VB.NET

Private Sub setSecondColumnDropDownListButton_Click(ByVal sender As Object, ByVal e As EventArgs) Handles 
setSecondColumnDropDownListButton.Click
        ' Create a header drop down list without default down down items.
        Dim headerDropDownList As New HeaderDropDownList()

        ' If you do not indicate which cell to filter, the cell with the same index as the column header cell in the row section 
        ' is filtered.
        headerDropDownList.CellName = "textBoxCell2"

        Dim dropDownItemCollection As DropDownItemCollection = headerDropDownList.Items
        ' Initialize drop down items manually.
        ' Add sort item.
        dropDownItemCollection.Add(New DropDownSortItem(SortOrder.Ascending))
        dropDownItemCollection.Add(New DropDownSortItem(SortOrder.Descending))

        ' Add a separator line.
        dropDownItemCollection.Add(New DropDownSeparatorItem())

        ' Add show all, black and none black items.
        dropDownItemCollection.Add(New DropDownShowAllFilterItem())
        dropDownItemCollection.Add(New DropDownBlanksFilterItem())
        dropDownItemCollection.Add(New DropDownNonBlanksFilterItem())

        ' Add auto filter items.
        dropDownItemCollection.Add(New DropDownAutoFilterItem())

        ' Get second column header cell.
        Dim columnHeaderCell As ColumnHeaderCell = TryCast(Me.gcMultiRow1.ColumnHeaders(0)(1), 
ColumnHeaderCell)
        columnHeaderCell.DropDownList = headerDropDownList
    End Sub

Inheritance Hierarchy

System.Object
   GrapeCity.Win.MultiRow.DropDownItem
      GrapeCity.Win.MultiRow.DropDownAutoFilterItem
      GrapeCity.Win.MultiRow.DropDownBlanksFilterItem
      GrapeCity.Win.MultiRow.DropDownCustomFilterItem
      GrapeCity.Win.MultiRow.DropDownNonBlanksFilterItem
      GrapeCity.Win.MultiRow.DropDownSeparatorItem
      GrapeCity.Win.MultiRow.DropDownShowAllFilterItem
      GrapeCity.Win.MultiRow.DropDownSortItem

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DropDownItem Members
GrapeCity.Win.MultiRow Namespace
HeaderDropDownList Class
DropDownItemCollection Class
DropDownSeparatorItem Class
DropDownShowAllFilterItem Class
DropDownBlanksFilterItem Class
DropDownNonBlanksFilterItem Class
DropDownAutoFilterItem Class
DropDownCustomFilterItem Class
DropDownSortItem Class
DropDownList Property