GridColumn Class

GridColumn Class

A Column is the main logic unit that relates the content of the grid to properties of the objects in the DataSource.

The GridColumn defines the properties and methods that are common to all column types in KaxGrid. As it is an abstract class (MustInherit in VB.NET) GridColumn class can not be created directly. You should inherit it and use its children.

Inheritance Hierarchy

SystemObject
Kettic.AspNet.ControlsGridColumn
More...

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)

Syntax

C++

Copy

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public abstract class GridColumn : IStateManager, 
	IComparable

<TypeConverterAttribute(GetType(ExpandableObjectConverter))> 
Public MustInherit Class GridColumn
	Implements IStateManager, IComparable

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public ref class GridColumn abstract : IStateManager, 
	IComparable

[<AbstractClassAttribute>]
[<TypeConverterAttribute(typeof(ExpandableObjectConverter))>]
type GridColumn =  
    class
        interface IStateManager
        interface IComparable
    end

The GridColumn type exposes the following members.

Constructors

	Name	Description
	GridColumn	Creates and initializes a new column with its base properties.

Top

Methods

	Name	Description
	AddSubPropertyFieldInfo
	Clone	Creates a copy of the current column.
	EvaluateFilterExpression
	EvaluateFilterExpression(GridFilteringItem)	Gets a string representing a filter expression, based on the settings of all columns that support filtering, with a syntax ready to be used by a DataView object
	GetCustomPropertyDataFields	This method should be used in case you develop your own column. It returns the full list of DataFields used by the column. GridTableView uses this to decide which DataFields from the specified DataSource will be inlcuded in case of GridTableView.RetrieveAllDataFields is set to false.
	GetDefaultGroupByExpression	Calculate the default Group-by expression based on the settings of the DataField (if available)
	InheritanceSafeClone
	Initialize	The Initialize method is inherited by a derived GridColumn class. Is is used to reset a column of the derived type.
	InitializeCell	After a call to this method the column should add the corresponding controls (text, labels, input controls) into the cell given, regarding the inItem type and column index. Note: This method is called within KaxGrid and is not intended to be used directly from your code.
	IsBoundToFieldName	This method returns true if the column is bound to the specified field name.
	PrepareCell	Prepares the cell of the item given, when grid is rendered.
	RefreshCurrentFilterValue(GridFilteringItem)	Modifies the CurrentFilterValue property according to the corresponding selected item in the filter text-box control in the filtering item.
	RefreshCurrentFilterValue(GridFilteringItem, String)	Modifies the CurrentFilterFunction and CurrentFilterValue properties according to the function given and the corresponding filter text-box control in the filtering item.
	ResetCurrentFilterValue
	ResetCurrentFilterValue(GridFilteringItem)	Resets the values of the CurrentFilterFunction and CurrentFilterValue properties to their defaults.
	SupportsFiltering	This method should be used in case you develop your own column. It returns true if the column supports filtering.

Top

Properties

	Name	Description
	AndCurrentFilterFunction	Gets or sets the current second filter condition function.
	AndCurrentFilterValue	Gets or sets a value of the currently applied second filter condition value.
	AutoPostBackOnFilter	Gets or sets a value indicating whether the grid should automatically postback, when the value in the filter text-box changes, and the the focus moves to another element.
	ColumnType	Gets the string representation of the type-name of this instance. The value is used by KaxGrid to determine the type of the columns persisted into the ViewState, when recreating the grid after postback. The value is also used by the grid client-side object. This property is read only.
	CurrentFilterFunction	Gets or sets the current function used for filtering.
	CurrentFilterValue	Gets or sets a value of the currently applied filter.
	DataType	Gets or sets (see the Remarks) the type of the data from the DataField as it was set in the DataSource.
	DataTypeName	Gets the string representation of the DataType property of the column, needed for the client-side grid instance.
	Display	Gets or sets a value indicating whether the cells corresponding to a column would be rendered with a 'display:none' style attribute (end-user-not-visible). To completely prevent cells from rendering, set the Visible property to false, instead of the Display property.
	EditFormColumnIndex	Specifies the vertical collumn number where this column will appear when using EditForms editing mode and the form is autogenerated. See the remarks for details.
	EditFormHeaderTextFormat	String that formats the HeaderText when the column is displayed in an edit form
	FilterControlAltText	Gets or Sets the text value which should be added to alt attribute of the filter control
	FilterControlWidth	Use this property to set width to the filtering control (depending on the column type, this may be a normal textbox, KaxNumericTextBox, KaxDatePicker, etc.)
	FilterDelay
	FilterImageToolTip
	FilterImageUrl	Gets or sets a string representing the URL to the image used in the filtering box.
	FilterListOptions	Gets or sets the value indincating which of the filter functions should be available for that column. For more information see GridFilterListOptions enumaration.
	FilterTemplate	Gets or sets the template, which will be rendered in the filter item cell of the column.
	FooterStyle	Style of the cell in the footer item of the grid, corresponding to the column.
	FooterText	Use the FooterText property to specify your own or determine the current text for the footer section of the column.
	Groupable	Gets or sets a value indicating whether you will be able to group Kettic KaxGrid by that column. By default this property is true.
	GroupByExpression	The group-expression that should be used when grid is grouping-by this column. If not set explicitly, KaxGrid will generate a group expression based on the DataField of the column (if available), using the GetDefaultGroupByExpression method. The grouping can be turned on/off for columns like GridBoundColumn using Groupable property. For more information about the Group-By expressions and their syntax, see GridGroupByExpression class.
	HeaderAbbr
	HeaderAxis
	HeaderButtonType	Gets or sets the button type of the button rendered in the header item, used for sorting. The possible values that this property accepts are: Kettic.AspNet.Controls.GridHeaderButtonType.LinkButton Kettic.AspNet.Controls.GridHeaderButtonType.PushButton Kettic.AspNet.Controls.GridHeaderButtonType.TextButton
	HeaderImageUrl	Gets or sets the URL of an image in the cell in the header item of the grid current column. You can use a relative or an absolute URL.
	HeaderStyle	Style of the cell in the header item of the grid, corresponding to the column.
	HeaderText	Use the HeaderText property to specify your own or determine the current text for the header section of the column.
	HeaderTooltip
	IsEditable	This property is supposed for developers of new grid columns. It gets whether a column is currently ReadOnly. The ReadOnly property determines whether a column will be editable in edit mode. A column for which the ReadOnly property is true will not be present in the automatically generated edit form.
	ItemStyle	Style of the cells, corresponding to the column.
	OrderIndex	Gets or sets the order index of column in the collection of RenderColumns. Use SwapColumns(String, String) method for reordering the columns.
	Owner	Gets the instance of the GridTableVeiw wich owns this column instance.
	OwnerGridID	Gets the value of the ClientID property of the KaxGrid instance that owns this column. This property value is used by grid's client object
	OwnerID	Gets the value of the ClientID property of the GridTableView that owns this column. This property value is used by grid's client object
	Reorderable	Gets or sets a value indicating whether the column can be reordered client-side.
	Resizable	Gets or sets a value indicating whether the column can be resized client-side. You can use this property, by setting it to false, to disable resizing for a particular column, while preserving this functionality for all the other columns.
	ShowFilterIcon
	ShowSortIcon	Get or Sets a value indicating whether a sort icon should appear next to the header button, when a column is sorted.
	SortAscImageUrl	Gets or sets a string representing the URL to the image used for sorting in ascending mode.
	SortDescImageUrl	Gets or sets a string representing the URL to the image used for sorting in descending mode.
	SortedBackColor
	SortExpression	The string representing a filed-name from the DataSource that should be used when grid sorts by this column. For example: 'EmployeeName'
	UniqueName	Each column in Kettic KaxGrid has an UniqueName property (string). This property is assigned automatically by the designer (or the first time you want to access the columns if they are built dynamically).
	Visible	Gets or sets a value indicating if the column and all corresponding cells would be rendered.

Top

Reference

Kettic.AspNet.Controls Namespace

Inheritance Hierarchy