Class ColumnChooserElement

This is a form containing the hidden columns in RadGridView

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
GridVisualElement
ColumnChooserVisualElement
ColumnChooserElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class ColumnChooserElement : ColumnChooserVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IGridView, IGridViewEventListener

Constructors

ColumnChooserElement()

Initializes a new instance of the ColumnChooserElement class.

Declaration
public ColumnChooserElement()

Properties

Columns

Gets list of GridViewDataColumn objects contained in the ColumnChooserElement

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

ElementsHolder

Gets an instance of the StackLayoutElement class that represents the layout panel which holds the column chooser items.

Declaration
public StackLayoutElement ElementsHolder { get; }
Property Value
StackLayoutElement

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 element

Declaration
public RadTextBoxElement FilterTextBox { get; }
Property Value
RadTextBoxElement

GridViewElement

Gets or sets the GridVisualElement that owns this view.

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

Implements

ScrollViewer

Gets the scroll viewer.

Declaration
public RadScrollViewer ScrollViewer { get; }
Property Value
RadScrollViewer

The scroll viewer.

SortOrder

Gets or sets the sort order of the columns.

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

The sort order.

ViewInfo

Gets the GridViewInfo that this view represents.

Declaration
public GridViewInfo ViewInfo { get; }
Property Value
GridViewInfo

Implements

ViewTemplate

Gets or sets the GridViewTemplate associated with this column chooser

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

Methods

ArrangeOverride(SizeF)

Arranges the inner elements.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size.
Returns
System.Drawing.SizeF

Overrides

CompareColumns(GridViewColumn, GridViewColumn)

Compares the columns.

Declaration
protected virtual int CompareColumns(GridViewColumn x, GridViewColumn y)
Parameters
GridViewColumn x

The x column.
GridViewColumn y

The y column.
Returns
System.Int32

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected override void CreateChildElements()
Overrides

CreateFilterTextBox()

Creates the filter text box.

Declaration
protected virtual RadTextBoxElement CreateFilterTextBox()
Returns
RadTextBoxElement

Detach()

Uninitializes the associated instance of the GridViewTemplate in ColumnChooserElement.

Declaration
public void Detach()
Implements

DisposeManagedResources()

Disposes the managed resources.

Declaration
protected override void DisposeManagedResources()
Overrides

FilterTextBoxTextChanged(Object, EventArgs)

Fires when the filter text box's text is changed.

Declaration
protected virtual void FilterTextBoxTextChanged(object sender, EventArgs e)
Parameters
System.Object sender

The sender.
System.EventArgs e

The System.EventArgs instance containing the event data.

Initialize(RadGridViewElement, GridViewInfo)

Initializes ColumnChooserElement with new instance of the GridViewTemplate.

Declaration
public void Initialize(RadGridViewElement gridViewElement, GridViewInfo viewInfo)
Parameters
RadGridViewElement gridViewElement

An instance of the RadGridViewElement.
GridViewInfo viewInfo

Implements

InitializeFields()

Initializes the fields.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the space required by the RadElement Used by the layout system.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
System.Drawing.SizeF

The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides
Remarks

In this method call to the Measure method of each child must be made.

OnItemElementCreating(Object, ColumnChooserItemElementCreatingEventArgs)

Fires the ItemElementCreating event.

Declaration
protected virtual void OnItemElementCreating(object sender, ColumnChooserItemElementCreatingEventArgs e)
Parameters
System.Object sender

ColumnChooserItemElementCreatingEventArgs e

PassesFilter(ColumnChooserItem, String)

Passeses the filter.

Declaration
protected virtual bool PassesFilter(ColumnChooserItem item, string filter)
Parameters
ColumnChooserItem item

The item.
System.String filter

The filter.
Returns
System.Boolean

ProcessDragOver(Point, ISupportDrag)

Processes the drag over behavior.

Declaration
protected override bool ProcessDragOver(Point currentMouseLocation, ISupportDrag dragObject)
Parameters
System.Drawing.Point currentMouseLocation

The current mouse location.
ISupportDrag dragObject

The drag object.
Returns
System.Boolean

Overrides

UnwireEvents()

Declaration
protected virtual void UnwireEvents()

UpdateView()

Updates the child elements collection of the ColumnChooserElement.

Declaration
public void UpdateView()
Implements

WireEvents()

Declaration
protected virtual void WireEvents()

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

Explicit Interface Implementations

IGridViewEventListener.AnalyzeQueue(List<GridViewEvent>)

Declaration
bool IGridViewEventListener.AnalyzeQueue(List<GridViewEvent> events)
Parameters
System.Collections.Generic.List<GridViewEvent> events

Returns
System.Boolean

Implements

IGridViewEventListener.DesiredEvents

Declaration
GridEventType IGridViewEventListener.DesiredEvents { get; }
Returns
GridEventType

Implements

IGridViewEventListener.DesiredProcessMode

Declaration
GridEventProcessMode IGridViewEventListener.DesiredProcessMode { get; }
Returns
GridEventProcessMode

Implements

IGridViewEventListener.PostProcessEvent(GridViewEvent)

Declaration
GridViewEventResult IGridViewEventListener.PostProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

IGridViewEventListener.PreProcessEvent(GridViewEvent)

Declaration
GridViewEventResult IGridViewEventListener.PreProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

IGridViewEventListener.Priority

Declaration
EventListenerPriority IGridViewEventListener.Priority { get; }
Returns
EventListenerPriority

Implements

IGridViewEventListener.ProcessEvent(GridViewEvent)

Declaration
GridViewEventResult IGridViewEventListener.ProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

Extension Methods