Class ColumnChooserControl

Displays a list with column chooser items, associated with columns.

Inheritance
System.Object
RadControl
ColumnChooserControl
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class ColumnChooserControl : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

ColumnChooserControl()

Initializes a new instance of the ColumnChooserControl class.

Declaration
public ColumnChooserControl()

ColumnChooserControl(RadGridViewElement)

Creates a new instance of the ColumnChooserForm class.

Declaration
public ColumnChooserControl(RadGridViewElement rootElement)
Parameters
RadGridViewElement rootElement

An instance of the RadGridViewElement.

Properties

ColumnChooserElement

Gets the column chooser element.

Declaration
public ColumnChooserElement ColumnChooserElement { get; }
Property Value
ColumnChooserElement

The column chooser element.

Columns

Gets a generic list containing all GridViewDataColumn objects available in the form.

Declaration
public IList<GridViewColumn> Columns { get; }
Property Value
System.Collections.Generic.IList<GridViewColumn>

EnableFiltering

Gets or sets a value indicating whether the filter text box is visible.

Declaration
public bool EnableFiltering { get; set; }
Property Value
System.Boolean

FilterTextBox

Gets the filter text box of this column chooser

Declaration
public RadTextBoxElement FilterTextBox { get; }
Property Value
RadTextBoxElement

GridViewElement

Gets or sets the grid view element.

Declaration
public RadGridViewElement GridViewElement { get; set; }
Property Value
RadGridViewElement

The grid view element.

SortOrder

Gets or sets the sort order of the columns.

Declaration
public RadSortOrder SortOrder { get; set; }
Property Value
RadSortOrder

The sort order.

ViewTemplate

Gets the GridViewTemplate used in the form.

Declaration
public GridViewTemplate ViewTemplate { get; set; }
Property Value
GridViewTemplate

Methods

ControlDefinesThemeForElement(RadElement)

Returns a boolean value indicating whether the control defines the theme for the element.

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

The element.
Returns
System.Boolean

Overrides

CreateChildItems(RadElement)

Creates a new instance of the ColumnChooserForm class.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

OnLoad(Size)

Notifies that the control is about to be visualized.

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnMouseWheel(MouseEventArgs)

Raises the MouseWheel event.

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

ScaleControl(SizeF, BoundsSpecified)

Scales the control with the specified factor.

Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
System.Drawing.SizeF factor

System.Windows.Forms.BoundsSpecified specified

Overrides

Events

ItemElementCreating

Occurs when a new item element is being created. The created item is then added to the Column chooser.

Declaration
public event ColumnChooserItemElementCreatingEventHandler ItemElementCreating
Event Type
ColumnChooserItemElementCreatingEventHandler

Extension Methods