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
Initializes a new instance of the GridHeaderCellElement class.
public GridHeaderCellElement(GridViewColumn column, GridRowElement row)
Fields
public static RadProperty IsSortedAscendingProperty
public static RadProperty IsSortedDescendingProperty
Properties
Gets the ArrowPrimitive indicating the SortOrder of the cell.
public ArrowPrimitive Arrow { get; }
Gets or sets the arrow position.
protected GridHeaderCellElement.ArrowPositionEnum ArrowPosition { get; set; }
The arrow position.
Gets or sets the context RadDropDownMenu associated with the cell.
public override RadDropDownMenu ContextMenu { get; set; }
Overrides:
Gets the filter button for the cell.
public RadButtonElement FilterButton { get; }
Gets a value indicating whether the header cell is sorted ascending.
public bool IsSortedAscending { get; }
Gets a value indicating whether the header cell is sorted descending.
public bool IsSortedDescending { get; }
Gets or sets a value indicating the sort order of data in the column.
public RadSortOrder SortOrder { get; }
Gets the stack layout.
protected StackLayoutElement StackLayout { get; }
The stack layout.
Determines whether the header cell instance supports conditional formatting.
public override bool SupportsConditionalFormatting { get; }
Overrides:
Methods
Arranges the arrow.
protected void ArrangeArrow(SizeF finalSize, RadElement element)
The final size.
elementRadElementThe element.
Arranges the RadElement to its final location. The element must call the Arrange method of each of its children.
protected override SizeF ArrangeOverride(SizeF 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:
In this method call to the Arrange method of each child must be made.
Binds the column properties.
protected override void BindColumnProperties()
Overrides:
Determines whether this instance can hide the specified group.
protected bool CanHideGroup(GridViewColumnGroup group)
The group.
Returns:Creates the best fit menu items.
protected virtual void CreateBestFitMenuItems(RadDropDownMenu contextMenu)
The context menu.
Called by the element when constructed. Allows inheritors to build the element tree.
protected override void CreateChildElements()
Overrides:
Creates the column chooser menu items.
protected virtual void CreateColumnChooserMenuItems(RadDropDownMenu contextMenu)
The context menu.
Creates the column pinning menu items.
protected virtual void CreateColumnPinningMenuItems(RadDropDownMenu contextMenu)
The context menu.
Creates the composite filter form
protected virtual BaseCompositeFilterDialog CreateCompositeFilterForm()
An instance of CompositeFilterForm.
Creates the conditional formatting form.
protected virtual ConditionalFormattingForm CreateConditionalFormattingForm()
Creates the context menu items.
protected override void CreateContextMenuItems(RadDropDownMenu menu)
The menu.
Overrides:
Creates the filter popup.
Detaches the header cell element.
public override void Detach()
Overrides:
Dispose managed resources
protected override void DisposeManagedResources()
Overrides:
Drops in the column groups view.
protected virtual void DropInColumnGroupsView(ColumnGroupsViewDefinition view, GridViewColumn column, RadPosition dropPosition)
The view.
columnGridViewColumnThe column.
dropPositionRadPositionThe drop position.
Finds the group.
protected virtual GridViewColumnGroup FindGroup(ColumnGroupCollection groups, GridViewColumnGroupRow row)
The groups.
rowGridViewColumnGroupRowThe row.
Returns:Finds the row.
protected virtual GridViewColumnGroupRow FindRow(ColumnGroupCollection groups, GridViewColumn column)
The groups.
columnGridViewColumnThe column.
Returns:Gets the column sort order.
Gets the context, associated with a drag operation.
Gets the image to be used as a hint when this element is being dragged.
Gets the VisualStyleElement instance that describes the skin appearance for the element when the current OS is Windows Vista.
Gets the VisualStyleElement instance that describes the skin appearance for the element when the current OS is Windows XP.
Initializes the cell with specified column and row
public override void Initialize(GridViewColumn column, GridRowElement row)
An instance of GridViewColumn.
rowGridRowElementAn instance of GridRowElement.
Overrides:
Initializes the fields.
protected override void InitializeFields()
Overrides:
Performs initialization when the element is first-time painted using system skin.
protected override void InitializeSystemSkinPaint()
Overrides:
Determines whether element is compatible with the specified data.
public override bool IsCompatible(GridViewColumn data, object context)
The data.
contextobjectThe context.
Returns:true if the specified data is compatible; otherwise, false.
Overrides:
Measures the space required by the RadElement Used by the layout system.
protected override SizeF MeasureOverride(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:The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides:
In this method call to the Measure method of each child must be made.
Merges the context menu.
public override RadDropDownMenu MergeMenus(IContextMenuManager contextMenuManager, params object[] parameters)
The IContextMenuManager to merge with.
parametersobject[]merge parameters.
Returns:The merged context menu, if successful.
Overrides:
Occurs when some column property changes its value.
protected override void OnColumnPropertyChanged(RadPropertyChangedEventArgs e)
An instance of RadPropertyChangedEventArgs
Overrides:
Fires the PanGesture event.
protected override void OnPanGesture(PanGestureEventArgs args)
The arguments for the PanGesture event.
Overrides:
Fires the ZoomGesture event.
protected override void OnZoomGesture(ZoomGestureEventArgs args)
The arguments for the ZoomGesture event.
Overrides:
Provides a routine to paint element's content when system skin appearance is desired.
protected override void PaintElementSkin(IGraphics graphics)
Overrides:
Pins the column.
protected virtual void PinColumn(PinnedColumnPosition position)
The position.
Core logic when a drag-drop is performed over this element. Allows inheritors to provide their own implementations.
protected override void ProcessDragDrop(Point dropLocation, ISupportDrag dragObject)
Overrides:
Determines whether the element may be treated as a drop target during drag-and-drop operation.
protected override bool ProcessDragOver(Point currentMouseLocation, ISupportDrag dragObject)
Overrides:
Sets the arrow position.
protected GridHeaderCellElement.ArrowPositionEnum SetArrowPosition()
Sets the value of the cell.
public override void SetContent()
Overrides:
Returns whether the child element should be painted.
protected override bool ShouldPaintChild(RadElement element)
The element.
Returns:Overrides:
Shows the context menu.
protected override void ShowContextMenu()
Overrides:
Sorts with the specified sort order.
Toggles the column sort order.
protected void ToggleColumnSortOrder()
Unbinds the column properties.
protected override void UnbindColumnProperties()
Overrides:
Updates the state of the arrow.
public void UpdateArrowState()
Updates the buttons layout visibility.
protected virtual void UpdateButtonsLayoutVisibility()
Updates the filter button visibility.
protected virtual void UpdateFilterButtonVisibility()
Updates the visual state of the cell.
protected override void UpdateInfoCore()
Overrides: