Class TemplateGroupsElement

Represents a hierarchy of template group elements that is associated with specified GridViewTemplate.

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

Constructors

TemplateGroupsElement(GroupPanelElement, GridViewTemplate)

Initializes a new instance of the TemplateGroupsElement class.

Declaration
public TemplateGroupsElement(GroupPanelElement groupPanelElement, GridViewTemplate template)
Parameters
GroupPanelElement groupPanelElement

An instance of GroupPanelElement.
GridViewTemplate template

An instance of GridViewTemplate.

Fields

ChildTemplateGroupsHorizontalOffsetProperty

Declaration
public static RadProperty ChildTemplateGroupsHorizontalOffsetProperty
Field Value
RadProperty

ItemsDistanceProperty

Declaration
public static RadProperty ItemsDistanceProperty
Field Value
RadProperty

LinkOffsetProperty

Declaration
public static RadProperty LinkOffsetProperty
Field Value
RadProperty

LinkPositionProperty

Declaration
public static RadProperty LinkPositionProperty
Field Value
RadProperty

LinkWidthProperty

Declaration
public static RadProperty LinkWidthProperty
Field Value
RadProperty

TemplateGroupsBottomDistanceProperty

Declaration
public static RadProperty TemplateGroupsBottomDistanceProperty
Field Value
RadProperty

Properties

ChildTemplateGroupsElements

Gets a read only collection of child elements of type TemplateGroupsElement

Declaration
public ReadOnlyCollection<TemplateGroupsElement> ChildTemplateGroupsElements { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyCollection<TemplateGroupsElement>

ChildTemplateGroupsHorizontalOffset

Sets the vertical offset between two consecutive child TemplateGroupsElements

Declaration
public int ChildTemplateGroupsHorizontalOffset { get; set; }
Property Value
System.Int32

GroupElements

Gets a read only collection of child elements of type GroupElement

Declaration
public ReadOnlyCollection<GroupElement> GroupElements { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyCollection<GroupElement>

GroupPanelElement

Gets the group panel element.

Declaration
public GroupPanelElement GroupPanelElement { get; }
Property Value
GroupPanelElement

The group panel element.

ItemsDistance

Sets the vertical and horizontal distance between two consecutive GroupElements

Declaration
[RadPropertyDefaultValue("ItemsDistance", typeof(RadElement))]
public virtual Size ItemsDistance { get; set; }
Property Value
System.Drawing.Size

LinkOffset

Sets the group links offset

Declaration
[RadPropertyDefaultValue("LinkOffset", typeof(RadElement))]
public virtual int LinkOffset { get; set; }
Property Value
System.Int32

LinkPosition

Sets the group links position

Declaration
[RadPropertyDefaultValue("LinkPosition", typeof(RadElement))]
public virtual TemplateGroupsElement.GroupLinkPosition LinkPosition { get; set; }
Property Value
TemplateGroupsElement.GroupLinkPosition

LinkWidth

Sets the separator's width between two consecutive GridFieldElements

Declaration
[RadPropertyDefaultValue("LinkWidth", typeof(RadElement))]
public virtual int LinkWidth { get; set; }
Property Value
System.Int32

TemplateGroupsBottomDistance

Sets the vertical and horizontal distance between two consecutive GroupElements

Declaration
[RadPropertyDefaultValue("TemplateGroupsBottomDistance", typeof(RadElement))]
public virtual int TemplateGroupsBottomDistance { get; set; }
Property Value
System.Int32

ViewTemplate

Gets the GridViewTemplate.

Declaration
public GridViewTemplate ViewTemplate { get; }
Property Value
GridViewTemplate

The view template.

Methods

ArrangeGroupLink(GroupLinkElement, PointF, PointF)

Arranges the group link.

Declaration
protected virtual void ArrangeGroupLink(GroupLinkElement linkElement, PointF beginPoint, PointF endPoint)
Parameters
GroupLinkElement linkElement

The link element.
System.Drawing.PointF beginPoint

The begin point.
System.Drawing.PointF endPoint

The end point.

ArrangeLeftToRight(SizeF)

Arranges the left to right.

Declaration
protected virtual SizeF ArrangeLeftToRight(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size.
Returns
System.Drawing.SizeF

ArrangeLeftToRightGroupElements(ref PointF, ref Single)

Arranges the left to right group elements.

Declaration
protected virtual void ArrangeLeftToRightGroupElements(ref PointF current, ref float currentBottom)
Parameters
System.Drawing.PointF current

The current.
System.Single currentBottom

The current bottom.

ArrangeOverride(SizeF)

Arranges the override.

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

The final size.
Returns
System.Drawing.SizeF

Overrides

ArrangeRightToLeft(SizeF)

Arranges the right to left.

Declaration
protected virtual SizeF ArrangeRightToLeft(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size.
Returns
System.Drawing.SizeF

ArrangeRightToLeftGroupElements(ref PointF, ref Single)

Arranges the right to left group elements.

Declaration
protected virtual void ArrangeRightToLeftGroupElements(ref PointF current, ref float currentBottom)
Parameters
System.Drawing.PointF current

The current.
System.Single currentBottom

The current bottom.

CalcFinalRectLeftToRightBottomGroupLink(GroupElement, GroupElement, out PointF, out PointF)

Calcs the final rect left to right bottom group link.

Declaration
protected virtual void CalcFinalRectLeftToRightBottomGroupLink(GroupElement fromGroupElement, GroupElement toGroupElement, out PointF beingPoint, out PointF endPoint)
Parameters
GroupElement fromGroupElement

From group element.
GroupElement toGroupElement

To group element.
System.Drawing.PointF beingPoint

The being point.
System.Drawing.PointF endPoint

The end point.

CalcFinalRectRightToLeftBottomGroupLink(GroupElement, GroupElement, out PointF, out PointF)

Calcs the final rect right to left bottom group link.

Declaration
protected virtual void CalcFinalRectRightToLeftBottomGroupLink(GroupElement fromGroupElement, GroupElement toGroupElement, out PointF beingPoint, out PointF endPoint)
Parameters
GroupElement fromGroupElement

From group element.
GroupElement toGroupElement

To group element.
System.Drawing.PointF beingPoint

The being point.
System.Drawing.PointF endPoint

The end point.

CanDragOver(ISupportDrag)

Determines whether the specified drag object [can be drag over] this instance.

Declaration
public bool CanDragOver(ISupportDrag dragObject)
Parameters
ISupportDrag dragObject

The drag object.
Returns
System.Boolean

true if the specified drag object [can drag over]; otherwise, false.

CreateChildElements()

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

Declaration
protected override void CreateChildElements()
Overrides

InitializeFields()

Initializes the fields.

Declaration
protected override void InitializeFields()
Overrides

MeasureGroupElements(SizeF, ref SizeF)

Measures the group elements.

Declaration
protected virtual void MeasureGroupElements(SizeF availableSize, ref SizeF sizeNeeded)
Parameters
System.Drawing.SizeF availableSize

Size of the available.
System.Drawing.SizeF sizeNeeded

The size needed.

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.

MeasureTemplateGroupElements(SizeF, ref SizeF)

Measures the template group elements.

Declaration
protected virtual void MeasureTemplateGroupElements(SizeF availableSize, ref SizeF sizeNeeded)
Parameters
System.Drawing.SizeF availableSize

Size of the available.
System.Drawing.SizeF sizeNeeded

The size needed.

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

ProcessDragDropColumn(Object)

Declaration
protected virtual void ProcessDragDropColumn(object dataContext)
Parameters
System.Object dataContext

ProcessDragDropFieldContext(Object)

Declaration
protected virtual void ProcessDragDropFieldContext(object dataContext)
Parameters
System.Object dataContext

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

UpdateHierarchy()

Recreates the child elements hierarchy depending on the associated GridViewTemplate.

Declaration
public void UpdateHierarchy()

Extension Methods