Represents a hierarchy of template group elements that is associated with specified GridViewTemplate.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class TemplateGroupsElement : GridVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementGridVisualElementTemplateGroupsElement...
Implements:
Inherited Members
Constructors
Initializes a new instance of the TemplateGroupsElement class.
public TemplateGroupsElement(GroupPanelElement groupPanelElement, GridViewTemplate template)
An instance of GroupPanelElement.
templateGridViewTemplateAn instance of GridViewTemplate.
Fields
Identifies the property that horizontally offsets child template groups from their parent groups.
public static RadProperty ChildTemplateGroupsHorizontalOffsetProperty
Identifies the property that controls horizontal and vertical spacing between group elements.
public static RadProperty ItemsDistanceProperty
Identifies the property that offsets connector endpoints from group-element edges.
public static RadProperty LinkOffsetProperty
Identifies the property that places descriptor connectors above or below group elements.
public static RadProperty LinkPositionProperty
Identifies the property that controls the width of a connector between group fields.
public static RadProperty LinkWidthProperty
Identifies the property that controls vertical spacing between child template groups.
public static RadProperty TemplateGroupsBottomDistanceProperty
Properties
Gets a read only collection of child elements of type TemplateGroupsElement
public ReadOnlyCollection<TemplateGroupsElement> ChildTemplateGroupsElements { get; }
Sets the horizontal offset of child template groups when their parent contains group elements.
public int ChildTemplateGroupsHorizontalOffset { get; set; }
Gets a read only collection of child elements of type GroupElement
public ReadOnlyCollection<GroupElement> GroupElements { get; }
Gets the group panel element.
public GroupPanelElement GroupPanelElement { get; }
The group panel element.
Sets the vertical and horizontal distance between two consecutive GroupElements
public virtual Size ItemsDistance { get; set; }
Sets the group links offset
public virtual int LinkOffset { get; set; }
Sets the group links position
public virtual TemplateGroupsElement.GroupLinkPosition LinkPosition { get; set; }
Sets the separator's width between two consecutive GridFieldElements
public virtual int LinkWidth { get; set; }
Sets the vertical and horizontal distance between two consecutive GroupElements
public virtual int TemplateGroupsBottomDistance { get; set; }
Gets the GridViewTemplate.
public GridViewTemplate ViewTemplate { get; }
The view template.
Methods
Arranges the group link.
protected virtual void ArrangeGroupLink(GroupLinkElement linkElement, PointF beginPoint, PointF endPoint)
The link element.
beginPointPointFThe begin point.
endPointPointFThe end point.
Calcs the final rect left to right bottom group link.
protected virtual void CalcFinalRectLeftToRightBottomGroupLink(GroupElement fromGroupElement, GroupElement toGroupElement, out PointF beingPoint, out PointF endPoint)
From group element.
toGroupElementGroupElementTo group element.
beingPointPointFThe being point.
endPointPointFThe end point.
Calcs the final rect right to left bottom group link.
protected virtual void CalcFinalRectRightToLeftBottomGroupLink(GroupElement fromGroupElement, GroupElement toGroupElement, out PointF beingPoint, out PointF endPoint)
From group element.
toGroupElementGroupElementTo group element.
beingPointPointFThe being point.
endPointPointFThe end point.
Determines whether the specified drag object [can be drag over] this instance.
public bool CanDragOver(ISupportDrag dragObject)
The drag object.
Returns:true if the specified drag object [can drag over]; otherwise, false.
Called by the element when constructed. Allows inheritors to build the element tree.
protected override void CreateChildElements()
Overrides:
Initializes the fields.
protected override void InitializeFields()
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.
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:
Adds a dragged data column as a new ascending group descriptor unless the change is canceled.
protected virtual void ProcessDragDropColumn(object dataContext)
The dragged grid column.
Reorders a single-field group descriptor or separates the dragged field into a new descriptor.
protected virtual void ProcessDragDropFieldContext(object dataContext)
The drag context containing the group descriptor and dragged sort descriptor.
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:
Recreates the child elements hierarchy depending on the associated GridViewTemplate.
public void UpdateHierarchy()