Loading...

Class GridHeaderCellElement

Represents the header cell in RadGridView

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
GridVisualElement
ConditionalFormattableGridVisualElement
GridCellElement
GridVirtualizedCellElement
GridHeaderCellElement
GridCheckBoxHeaderCellElement
GridColumnGroupCellElement
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 GridHeaderCellElement : GridVirtualizedCellElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IContextMenuProvider, IVirtualizedElement<GridViewColumn>

Constructors

GridHeaderCellElement(GridViewColumn, GridRowElement)

Initializes a new instance of the GridHeaderCellElement class.

Declaration
public GridHeaderCellElement(GridViewColumn column, GridRowElement row)
Parameters
GridViewColumn column

GridRowElement row

Fields

IsSortedAscendingProperty

Declaration
public static RadProperty IsSortedAscendingProperty
Field Value
RadProperty

IsSortedDescendingProperty

Declaration
public static RadProperty IsSortedDescendingProperty
Field Value
RadProperty

Properties

Arrow

Gets the ArrowPrimitive indicating the SortOrder of the cell.

Declaration
public ArrowPrimitive Arrow { get; }
Property Value
ArrowPrimitive

ArrowPosition

Gets or sets the arrow position.

Declaration
protected GridHeaderCellElement.ArrowPositionEnum ArrowPosition { get; set; }
Property Value
GridHeaderCellElement.ArrowPositionEnum

The arrow position.

FilterButton

Gets the filter button for the cell.

Declaration
public RadButtonElement FilterButton { get; }
Property Value
RadButtonElement

IsSortedAscending

Gets a value indicating whether the header cell is sorted ascending.

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

IsSortedDescending

Gets a value indicating whether the header cell is sorted descending.

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

SortOrder

Gets or sets a value indicating the sort order of data in the column.

Declaration
public RadSortOrder SortOrder { get; }
Property Value
RadSortOrder

StackLayout

Gets the stack layout.

Declaration
protected StackLayoutElement StackLayout { get; }
Property Value
StackLayoutElement

The stack layout.

SupportsConditionalFormatting

Determines whether the header cell instance supports conditional formatting.

Declaration
public override bool SupportsConditionalFormatting { get; }
Property Value
System.Boolean

Overrides

Value

Gets or sets the value represented by this cell.

Declaration
public override object Value { get; set; }
Property Value
System.Object

Overrides

Methods

ArrangeArrow(SizeF, RadElement)

Arranges the arrow.

Declaration
protected void ArrangeArrow(SizeF finalSize, RadElement element)
Parameters
System.Drawing.SizeF finalSize

The final size.
RadElement element

The element.

ArrangeOverride(SizeF)

Arranges the RadElement to its final location. The element must call the Arrange method of each of its children.

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

The size that is available for element.
Returns
System.Drawing.SizeF

The rectangle occupied by the element. Usually finalSize. Should you return different size, the Layout system will restart measuring and rearranging the items. That could lead to infinite recursion.
Overrides
Remarks

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

BindColumnProperties()

Binds the column properties.

Declaration
protected override void BindColumnProperties()
Overrides

CanDragCore(Point)

Determines whether the element may be dragged.

Declaration
protected override bool CanDragCore(Point dragStartPoint)
Parameters
System.Drawing.Point dragStartPoint

Returns
System.Boolean

Overrides

CanHideGroup(GridViewColumnGroup)

Determines whether this instance can hide the specified group.

Declaration
protected bool CanHideGroup(GridViewColumnGroup group)
Parameters
GridViewColumnGroup group

The group.
Returns
System.Boolean

CreateBestFitMenuItems(RadDropDownMenu)

Creates the best fit menu items.

Declaration
protected virtual void CreateBestFitMenuItems(RadDropDownMenu contextMenu)
Parameters
RadDropDownMenu contextMenu

The context menu.

CreateChildElements()

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

Declaration
protected override void CreateChildElements()
Overrides

CreateColumnChooserMenuItems(RadDropDownMenu)

Creates the column chooser menu items.

Declaration
protected virtual void CreateColumnChooserMenuItems(RadDropDownMenu contextMenu)
Parameters
RadDropDownMenu contextMenu

The context menu.

CreateColumnPinningMenuItems(RadDropDownMenu)

Creates the column pinning menu items.

Declaration
protected virtual void CreateColumnPinningMenuItems(RadDropDownMenu contextMenu)
Parameters
RadDropDownMenu contextMenu

The context menu.

CreateCompositeFilterForm()

Creates the composite filter form

Declaration
protected virtual BaseCompositeFilterDialog CreateCompositeFilterForm()
Returns
BaseCompositeFilterDialog

An instance of CompositeFilterForm.

CreateConditionalFormattingForm()

Creates the conditional formatting form.

Declaration
protected virtual ConditionalFormattingForm CreateConditionalFormattingForm()
Returns
ConditionalFormattingForm

CreateContextMenuItems(RadDropDownMenu)

Creates the context menu items.

Declaration
protected override void CreateContextMenuItems(RadDropDownMenu menu)
Parameters
RadDropDownMenu menu

The menu.
Overrides

CreateFilterPopup()

Creates the filter popup.

Declaration
protected virtual IGridFilterPopup CreateFilterPopup()
Returns
IGridFilterPopup

Detach()

Detaches the header cell element.

Declaration
public override void Detach()
Overrides

DisposeManagedResources()

Dispose managed resources

Declaration
protected override void DisposeManagedResources()
Overrides

DropInColumnGroupsView(ColumnGroupsViewDefinition, GridViewColumn, RadPosition)

Drops in the column groups view.

Declaration
protected virtual void DropInColumnGroupsView(ColumnGroupsViewDefinition view, GridViewColumn column, RadPosition dropPosition)
Parameters
ColumnGroupsViewDefinition view

The view.
GridViewColumn column

The column.
RadPosition dropPosition

The drop position.

filterPopup_FilterConfirmed(Object, EventArgs)

Handles the FilterConfirmed event of the filterPopup control.

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

The source of the event.
System.EventArgs e

The System.EventArgs instance containing the event data.

FindGroup(ColumnGroupCollection, GridViewColumnGroupRow)

Finds the group.

Declaration
protected virtual GridViewColumnGroup FindGroup(ColumnGroupCollection groups, GridViewColumnGroupRow row)
Parameters
ColumnGroupCollection groups

The groups.
GridViewColumnGroupRow row

The row.
Returns
GridViewColumnGroup

FindRow(ColumnGroupCollection, GridViewColumn)

Finds the row.

Declaration
protected virtual GridViewColumnGroupRow FindRow(ColumnGroupCollection groups, GridViewColumn column)
Parameters
ColumnGroupCollection groups

The groups.
GridViewColumn column

The column.
Returns
GridViewColumnGroupRow

GetColumnSortOrder()

Gets the column sort order.

Declaration
protected RadSortOrder GetColumnSortOrder()
Returns
RadSortOrder

GetDragContextCore()

Gets the context, associated with a drag operation.

Declaration
protected override object GetDragContextCore()
Returns
System.Object

Overrides

GetDragHintCore()

Gets the image to be used as a hint when this element is being dragged.

Declaration
protected override Image GetDragHintCore()
Returns
System.Drawing.Image

Overrides

GetVistaVisualStyle()

Gets the VisualStyleElement instance that describes the skin appearance for the element when the current OS is Windows Vista.

Declaration
public override VisualStyleElement GetVistaVisualStyle()
Returns
System.Windows.Forms.VisualStyles.VisualStyleElement

Overrides

GetXPVisualStyle()

Gets the VisualStyleElement instance that describes the skin appearance for the element when the current OS is Windows XP.

Declaration
public override VisualStyleElement GetXPVisualStyle()
Returns
System.Windows.Forms.VisualStyles.VisualStyleElement

Overrides

Initialize(GridViewColumn, GridRowElement)

Initializes the cell with specified column and row

Declaration
public override void Initialize(GridViewColumn column, GridRowElement row)
Parameters
GridViewColumn column

An instance of GridViewColumn.
GridRowElement row

An instance of GridRowElement.
Overrides

InitializeFields()

Initializes the fields.

Declaration
protected override void InitializeFields()
Overrides

InitializeSystemSkinPaint()

Performs initialization when the element is first-time painted using system skin.

Declaration
protected override void InitializeSystemSkinPaint()
Overrides

IsCompatible(GridViewColumn, Object)

Determines whether element is compatible with the specified data.

Declaration
public override bool IsCompatible(GridViewColumn data, object context)
Parameters
GridViewColumn data

The data.
System.Object context

The context.
Returns
System.Boolean

true if the specified data is compatible; otherwise, false.
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.

MergeMenus(IContextMenuManager, Object[])

Merges the context menu.

Declaration
public override RadDropDownMenu MergeMenus(IContextMenuManager contextMenuManager, params object[] parameters)
Parameters
IContextMenuManager contextMenuManager

The IContextMenuManager to merge with.
System.Object[] parameters

merge parameters.
Returns
RadDropDownMenu

The merged context menu, if successful.
Overrides

OnColumnPropertyChanged(RadPropertyChangedEventArgs)

Occurs when some column property changes its value.

Declaration
protected override void OnColumnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

An instance of RadPropertyChangedEventArgs
Overrides

OnPanGesture(PanGestureEventArgs)

Fires the PanGesture event.

Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
PanGestureEventArgs args

The arguments for the PanGesture event.
Overrides

OnZoomGesture(ZoomGestureEventArgs)

Fires the ZoomGesture event.

Declaration
protected override void OnZoomGesture(ZoomGestureEventArgs args)
Parameters
ZoomGestureEventArgs args

The arguments for the ZoomGesture event.
Overrides

PaintElementSkin(IGraphics)

Provides a routine to paint element's content when system skin appearance is desired.

Declaration
protected override void PaintElementSkin(IGraphics graphics)
Parameters
IGraphics graphics

Overrides

PinColumn(PinnedColumnPosition)

Pins the column.

Declaration
protected virtual void PinColumn(PinnedColumnPosition position)
Parameters
PinnedColumnPosition position

The position.

ProcessDragDrop(Point, ISupportDrag)

Core logic when a drag-drop is performed over this element. Allows inheritors to provide their own implementations.

Declaration
protected override void ProcessDragDrop(Point dropLocation, ISupportDrag dragObject)
Parameters
System.Drawing.Point dropLocation

ISupportDrag dragObject

Overrides

ProcessDragOver(Point, ISupportDrag)

Determines whether the element may be treated as a drop target during drag-and-drop operation.

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

ISupportDrag dragObject

Returns
System.Boolean

Overrides

SetArrowPosition()

Sets the arrow position.

Declaration
protected GridHeaderCellElement.ArrowPositionEnum SetArrowPosition()
Returns
GridHeaderCellElement.ArrowPositionEnum

SetContent()

Sets the value of the cell.

Declaration
public override void SetContent()
Overrides

ShouldPaintChild(RadElement)

Returns whether the child element should be painted.

Declaration
protected override bool ShouldPaintChild(RadElement element)
Parameters
RadElement element

The element.
Returns
System.Boolean

Overrides

ShowContextMenu()

Shows the context menu.

Declaration
protected override void ShowContextMenu()
Overrides

Sort(RadSortOrder)

Sorts with the specified sort order.

Declaration
public virtual void Sort(RadSortOrder sortOrder)
Parameters
RadSortOrder sortOrder

The sort order.

ToggleColumnSortOrder()

Toggles the column sort order.

Declaration
protected void ToggleColumnSortOrder()

UnbindColumnProperties()

Unbinds the column properties.

Declaration
protected override void UnbindColumnProperties()
Overrides

UpdateArrowState()

Updates the state of the arrow.

Declaration
public void UpdateArrowState()

UpdateButtonsLayoutVisibility()

Updates the buttons layout visibility.

Declaration
protected virtual void UpdateButtonsLayoutVisibility()

UpdateFilterButtonVisibility()

Updates the filter button visibility.

Declaration
protected virtual void UpdateFilterButtonVisibility()

UpdateInfoCore()

Updates the visual state of the cell.

Declaration
protected override void UpdateInfoCore()
Overrides

Extension Methods