ClassGridHeaderCellElement
Represents the header cell in RadGridView
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class GridHeaderCellElement : GridVirtualizedCellElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IContextMenuProvider, IVirtualizedElement<GridViewColumn>
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementGridVisualElementConditionalFormattableGridVisualElementGridCellElementGridVirtualizedCellElementGridHeaderCellElement
Derived Classes:
Implements:
Inherited Members
Constructors
GridHeaderCellElement(GridViewColumn, GridRowElement)
Initializes a new instance of the GridHeaderCellElement class.
Declaration
public GridHeaderCellElement(GridViewColumn column, GridRowElement row)
Parameters
column
row
Fields
IsSortedAscendingProperty
Declaration
public static RadProperty IsSortedAscendingProperty
Field Value
IsSortedDescendingProperty
Declaration
public static RadProperty IsSortedDescendingProperty
Field Value
Properties
Arrow
Gets the ArrowPrimitive indicating the SortOrder of the cell.
ArrowPosition
Gets or sets the arrow position.
Declaration
protected GridHeaderCellElement.ArrowPositionEnum ArrowPosition { get; set; }
Property Value
GridHeaderCellElement.ArrowPositionEnum
The arrow position.
ContextMenu
Gets or sets the context RadDropDownMenu associated with the cell.
Declaration
public override RadDropDownMenu ContextMenu { get; set; }
Property Value
Overrides
FilterButton
Gets the filter button for the cell.
Declaration
public RadButtonElement FilterButton { get; }
Property Value
IsSortedAscending
Gets a value indicating whether the header cell is sorted ascending.
IsSortedDescending
Gets a value indicating whether the header cell is sorted descending.
SortOrder
Gets or sets a value indicating the sort order of data in the column.
StackLayout
Gets the stack layout.
Declaration
protected StackLayoutElement StackLayout { get; }
Property Value
The stack layout.
SupportsConditionalFormatting
Determines whether the header cell instance supports conditional formatting.
Declaration
public override bool SupportsConditionalFormatting { get; }
Property Value
Overrides
Methods
ArrangeArrow(SizeF, RadElement)
Arranges the arrow.
Declaration
protected void ArrangeArrow(SizeF finalSize, RadElement element)
Parameters
finalSize
The final size.
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
finalSize
The size that is available for element.
Returns
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.
CanHideGroup(GridViewColumnGroup)
Determines whether this instance can hide the specified group.
Declaration
protected bool CanHideGroup(GridViewColumnGroup group)
Parameters
group
The group.
Returns
CreateBestFitMenuItems(RadDropDownMenu)
Creates the best fit menu items.
Declaration
protected virtual void CreateBestFitMenuItems(RadDropDownMenu contextMenu)
Parameters
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
contextMenu
The context menu.
CreateColumnPinningMenuItems(RadDropDownMenu)
Creates the column pinning menu items.
Declaration
protected virtual void CreateColumnPinningMenuItems(RadDropDownMenu contextMenu)
Parameters
contextMenu
The context menu.
CreateCompositeFilterForm()
Creates the composite filter form
Declaration
protected virtual BaseCompositeFilterDialog CreateCompositeFilterForm()
Returns
An instance of CompositeFilterForm.
CreateConditionalFormattingForm()
Creates the conditional formatting form.
Declaration
protected virtual ConditionalFormattingForm CreateConditionalFormattingForm()
Returns
CreateContextMenuItems(RadDropDownMenu)
Creates the context menu items.
Declaration
protected override void CreateContextMenuItems(RadDropDownMenu menu)
Parameters
menu
The menu.
Overrides
CreateFilterPopup()
Creates the filter popup.
Declaration
protected virtual IGridFilterPopup CreateFilterPopup()
Returns
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
view
The view.
column
The column.
dropPosition
The drop position.
FindGroup(ColumnGroupCollection, GridViewColumnGroupRow)
Finds the group.
Declaration
protected virtual GridViewColumnGroup FindGroup(ColumnGroupCollection groups, GridViewColumnGroupRow row)
Parameters
groups
The groups.
row
The row.
Returns
FindRow(ColumnGroupCollection, GridViewColumn)
Finds the row.
Declaration
protected virtual GridViewColumnGroupRow FindRow(ColumnGroupCollection groups, GridViewColumn column)
Parameters
groups
The groups.
column
The column.
Returns
GetColumnSortOrder()
Gets the column sort order.
GetDragContextCore()
Gets the context, associated with a drag operation.
Declaration
protected override object GetDragContextCore()
Returns
Overrides
GetDragHintCore()
Gets the image to be used as a hint when this element is being dragged.
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
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
Overrides
Initialize(GridViewColumn, GridRowElement)
Initializes the cell with specified column and row
Declaration
public override void Initialize(GridViewColumn column, GridRowElement row)
Parameters
column
An instance of GridViewColumn.
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
data
The data.
context
The context.
Returns
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
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.
MergeMenus(IContextMenuManager, params object[])
Merges the context menu.
Declaration
public override RadDropDownMenu MergeMenus(IContextMenuManager contextMenuManager, params object[] parameters)
Parameters
contextMenuManager
The IContextMenuManager to merge with.
parameters
object[]
merge parameters.
Returns
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
e
An instance of RadPropertyChangedEventArgs
Overrides
OnPanGesture(PanGestureEventArgs)
Fires the PanGesture event.
Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
args
The arguments for the PanGesture event.
Overrides
OnZoomGesture(ZoomGestureEventArgs)
Fires the ZoomGesture event.
Declaration
protected override void OnZoomGesture(ZoomGestureEventArgs args)
Parameters
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
graphics
Overrides
PinColumn(PinnedColumnPosition)
Pins the column.
Declaration
protected virtual void PinColumn(PinnedColumnPosition position)
Parameters
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
dropLocation
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
currentMouseLocation
dragObject
Returns
Overrides
SetArrowPosition()
Sets the arrow position.
Declaration
protected GridHeaderCellElement.ArrowPositionEnum SetArrowPosition()
Returns
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
element
The element.
Returns
Overrides
ShowContextMenu()
Shows the context menu.
Declaration
protected override void ShowContextMenu()
Overrides
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
filterPopup_FilterConfirmed(object, EventArgs)
Handles the FilterConfirmed event of the filterPopup control.