Class
GridTableHeader

Represents the RadGrid for ASP.NET AJAX table header control wrapper.

Definition

Namespace:Telerik.WebAii.Controls.Html

Assembly:Telerik.WebAii.Controls.Html.dll

Syntax:

cs-api-definition
public class GridTableHeader : HtmlTableCell

Inheritance: objectControlHtmlControlHtmlContainerControlHtmlTableCellGridTableHeader

Inherited Members HtmlTableCell.AlignHtmlTableCell.CellIndexHtmlTableCell.ColSpanHtmlTableCell.RowSpanHtmlTableCell.HeightHtmlTableCell.VAlignHtmlTableCell.WidthHtmlContainerControl.TextContentHtmlContainerControl.InnerTextHtmlControl.FindParentContainer<TContainerControl>()HtmlControl.ValidateTag(string)HtmlControl.ValidateControl()HtmlControl.ParseResponseValue<T>(string, T)HtmlControl.GetAttributeAsString(string)HtmlControl.InitializeMappings(MappingsCollection)HtmlControl.GetRectangle()HtmlControl.IsVisible()HtmlControl.GetStyleValue(string)HtmlControl.GetStyle(string)HtmlControl.GetComputedStyleValue(string)HtmlControl.GetComputedStyle(string)HtmlControl.Parent<TContainerControl>()HtmlControl.Capture()HtmlControl.Capture(string, string)HtmlControl.Capture(string)HtmlControl.InvokeEvent(ScriptEventType)HtmlControl.InvokeEvent(ScriptEventType, bool)HtmlControl.InvokeEvent(ScriptEvent)HtmlControl.InvokeEvent(ScriptEvent, bool)HtmlControl.AddEventListener(string, EventHandler<JavascriptEventArgs>)HtmlControl.RemoveEventListener(string, EventHandler<JavascriptEventArgs>)HtmlControl.MouseClick()HtmlControl.MouseClick(MouseClickType)HtmlControl.MouseClick(MouseClickType, int, int)HtmlControl.MouseClick(MouseClickType, Point, OffsetReference)HtmlControl.MouseClick(MouseClickType, int, int, OffsetReference)HtmlControl.MouseHover()HtmlControl.MouseHover(Point)HtmlControl.MouseHover(int, int)HtmlControl.MouseHover(int, int, OffsetReference)HtmlControl.Click()HtmlControl.Click(bool)HtmlControl.ScrollToVisible()HtmlControl.ScrollToVisible(ScrollToVisibleType)HtmlControl.ScrollToVisible(ScrollToVisibleType, Rectangle)HtmlControl.Download(bool, DownloadOption, string, int)HtmlControl.CallMethod(string)HtmlControl.CallMethod<T>(string)HtmlControl.CallMethod<T>(string, T)HtmlControl.GetValue<T>(string)HtmlControl.GetValue<T>(string, T)HtmlControl.GetValue<T>(string, bool)HtmlControl.GetValue<T>(string, bool, T)HtmlControl.SetValue<T>(string, T)HtmlControl.SetValue<T>(string, T, bool)HtmlControl.Focus()HtmlControl.DragTo(OffsetReference, Point, int, int)HtmlControl.DragTo(OffsetReference, int, int, Rectangle, OffsetReference, int, int)HtmlControl.DragTo(Point)HtmlControl.DragTo(int, int)HtmlControl.DragTo(HtmlControl)HtmlControl.DragTo(HtmlControl, OffsetReference, Point)HtmlControl.DragTo(OffsetReference, Point, HtmlControl)HtmlControl.DragTo(OffsetReference, Point, HtmlControl, OffsetReference, Point)HtmlControl.DragTo(OffsetReference, int, int, bool, HtmlControl, OffsetReference, int, int, bool)HtmlControl.DragToWindowLocation(OffsetReference, int, int, bool, OffsetReference, int, int, bool)HtmlControl.ToString()HtmlControl.AsjQueryControl()HtmlControl.GetElementByTagNameClientSideLocatorHtmlControl.GetElementByIdClientSideLocatorHtmlControl.FindHtmlControl.ScrollTopHtmlControl.ScrollLeftHtmlControl.WaitHtmlControl.IDHtmlControl.CssClassHtmlControl.AttributesHtmlControl.MappingsHtmlControl.StylesHtmlControl.EventsHtmlControl.TagNameHtmlControl.ChildNodesHtmlControl.IsActiveElementHtmlControl.IsEnabledControl.Refresh()Control.AssignFailed(Exception)Control.SetTelerikComponentsVersion(TelerikComponentsVersion?)Control.MatchControl(Element, FindParam)Control.GetFamilyElement(int, Element)Control.ThrowOnInvalidAssignmentControl.TelerikComponentsVersionControl.IsRefreshControl.BaseElementControl.OwnerBrowserControl.Locator

Constructors

GridTableHeader()

Initializes a new instance of the GridTableHeader class.

Declaration

cs-api-definition
public GridTableHeader()

GridTableHeader(Element)

Initializes a new instance of the GridTableHeader class.

Declaration

cs-api-definition
public GridTableHeader(Element element)

Parameters

element

Element

Properties

ClientSideLocator

The client-side locator of the TableHeader control.

Declaration

cs-api-definition
public override string ClientSideLocator { get; }

Property Value

string

Overrides HtmlControl.ClientSideLocator

ColumnIndex

The index of the column.

Declaration

cs-api-definition
public int ColumnIndex { get; }

Property Value

int

Filtered

Get whether the column is filtered.

Declaration

cs-api-definition
public bool Filtered { get; }

Property Value

bool

GroupName

The group name of this column when multi column headers are enabeld.

Declaration

cs-api-definition
public string GroupName { get; }

Property Value

string

LocatorExpression

Get the locator FindParam.

Declaration

cs-api-definition
public override IFindExpression LocatorExpression { get; }

Property Value

IFindExpression

Overrides Control.LocatorExpression

MultiHeadersEnabled

Gets whether the multi column headers are enabled

Declaration

cs-api-definition
public bool MultiHeadersEnabled { get; }

Property Value

bool

Reorderable

Get whether the column is reorderable.

Declaration

cs-api-definition
public bool Reorderable { get; }

Property Value

bool

Resizable

Get whether the columns is resizable.

Declaration

cs-api-definition
public bool Resizable { get; }

Property Value

bool

RowIndex

Gets the row index

Declaration

cs-api-definition
public int RowIndex { get; }

Property Value

int

Selected

Get whether the column is selected.

Declaration

cs-api-definition
public bool Selected { get; }

Property Value

bool

SortOrder

The sort order of this column.

Declaration

cs-api-definition
public GridColumnSortOrderType SortOrder { get; }

Property Value

GridColumnSortOrderType

TableID

Gets the parent table ID.

Declaration

cs-api-definition
public string TableID { get; }

Property Value

string

UniqueName

The unique name of this column.

Declaration

cs-api-definition
public string UniqueName { get; }

Property Value

string

Visible

Get whether the column is visible on the client.

Declaration

cs-api-definition
public bool Visible { get; }

Property Value

bool

Methods

AssignElement(Element)

Assign element and initialize this control.

Declaration

cs-api-definition
public override void AssignElement(Element e)

Parameters

e

Element

The element.

Overrides HtmlTableCell.AssignElement(Element)

ClientSelectCheckBoxClick()

Click the client select check box in the header to select/unselect all the items. Throws InvalidOperationException if the client select column check box is not available.

Declaration

cs-api-definition
public void ClientSelectCheckBoxClick()

ControlAssert()

Get RadControlAssert instance initialized for this control.

Declaration

cs-api-definition
public RadControlAssert ControlAssert()

Returns

RadControlAssert

RadControlAssert instance initialized for this control.

DragToGroup()

Drag the current header cell/column into the RadGrid Grouping Panel to group the data by the corresponging field.

Declaration

cs-api-definition
public void DragToGroup()

Reorder(HtmlControl)

Simulates drag and drop of the current table header to reorder it with the target one.

Declaration

cs-api-definition
public void Reorder(HtmlControl targetHeader)

Parameters

targetHeader

HtmlControl

The target table header to reorder with.

Remarks

The column reordering in RadGrid may interfere with the column resizing feature. This method might not be working if the column resizing is enabled as well.

Reorder(string)

Simulates drag and drop of the current table header to reorder it with the target one.

Declaration

cs-api-definition
public void Reorder(string headerName)

Parameters

headerName

string

The name of the target table header to reorder with.

Exceptions

ArgumentException

Thrown in case of invalid column unique name.

ShowContextMenu()

Shows the header context menu.

Declaration

cs-api-definition
public void ShowContextMenu()

Sort()

Initiates a 'sort' action of the column.

Declaration

cs-api-definition
public void Sort()