ClassColumnChooserElement
This is a form containing the hidden columns in RadGridView
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class ColumnChooserElement : ColumnChooserVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IGridView, IGridViewEventListenerInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementGridVisualElementColumnChooserVisualElementColumnChooserElement
Implements:
Inherited Members
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
IList<GridViewColumn>
ColumnsDisplayMode
Declaration
public ColumnChooserColumnsDisplayMode ColumnsDisplayMode { get; set; }Property Value
ElementsHolder
Gets an instance of the StackLayoutElement class that represents the layout panel which holds the column chooser items.
Declaration
[Browsable(false)]
public StackLayoutElement ElementsHolder { get; }Property Value
EnableFiltering
Gets or sets a value indicating whether the filter text box is visible.
FilterTextBox
Gets the filter text box of this column chooser element
Declaration
public RadTextBoxElement FilterTextBox { get; }Property Value
GridViewElement
Gets or sets the GridVisualElement that owns this view.
Declaration
public RadGridViewElement GridViewElement { get; set; }Property Value
Implements
ScrollViewer
Gets the scroll viewer.
Declaration
public RadScrollViewer ScrollViewer { get; }Property Value
The scroll viewer.
SortOrder
Gets or sets the sort order of the columns.
Declaration
public RadSortOrder SortOrder { get; set; }Property Value
The sort order.
ViewInfo
Gets the GridViewInfo that this view represents.
Declaration
public GridViewInfo ViewInfo { get; }Property Value
Implements
ViewTemplate
Gets or sets the GridViewTemplate associated with this column chooser
Declaration
public GridViewTemplate ViewTemplate { get; set; }Property Value
Methods
ArrangeOverride(SizeF)
Arranges the inner elements.
CompareColumns(GridViewColumn, GridViewColumn)
Compares the columns.
Declaration
protected virtual int CompareColumns(GridViewColumn x, GridViewColumn y)Parameters
x
The x column.
y
The y column.
Returns
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
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.
Initialize(RadGridViewElement, GridViewInfo)
Initializes ColumnChooserElement with new instance of the GridViewTemplate.
Declaration
public void Initialize(RadGridViewElement gridViewElement, GridViewInfo viewInfo)Parameters
gridViewElement
An instance of the RadGridViewElement.
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
availableSize
The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
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 event.
Declaration
protected virtual void OnItemElementCreating(object sender, ColumnChooserItemElementCreatingEventArgs e)Parameters
sender
e
PassesFilter(ColumnChooserItem, string)
Passes the filter.
Declaration
protected virtual bool PassesFilter(ColumnChooserItem item, string filter)Parameters
item
The item.
filter
The filter.
Returns
PassesFilter(GridViewColumn, string)
Declaration
protected virtual bool PassesFilter(GridViewColumn column, string filter)Parameters
column
filter
Returns
ProcessDragOver(Point, ISupportDrag)
Processes the drag over behavior.
Declaration
protected override bool ProcessDragOver(Point currentMouseLocation, ISupportDrag dragObject)Parameters
currentMouseLocation
The current mouse location.
dragObject
The drag object.
Returns
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 ItemElementCreatingEvent Value