GridViewColumn Class
Click or drag to resize
GridViewColumn Class
This is a dependency object used to store column's specific data.
Inheritance Hierarchy

Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.GridView (in Telerik.Windows.Controls.GridView.dll) Version: 2018.2.620.40 (2018.2.620.40)
Syntax
public class GridViewColumn : FrameworkContentElement, 
	IFilterableColumn, IFieldDescriptor, INotifyPropertyChanged, IColumnElement

The GridViewColumn type exposes the following members.

Constructors
  NameDescription
Public methodGridViewColumn
Top
Methods
  NameDescription
Public methodCanEdit
Determines whether the data represented by the column can be edited.
Public methodCanFilter
Determines whether the data represented by the column can be filtered by the RadGridView control.
Public methodCanGroup
Determines whether the data represented by the column can be grouped.
Public methodCanSort
Determines whether the data represented by the column can be sorted.
Public methodClearFilters
Clears all filtering associated with this column.
Public methodCopyPropertiesFrom
Copy properties from source column.
Public methodCreateCellEditElement
Creates the element for the cell in edit mode.
Public methodCreateCellElement
Creates the element for the cell in view mode.
Public methodCreateColumnFilterDescriptor
Creates the column filter descriptor.
Public methodCreateField
Creates a field described by the descriptor.
Public methodCreateFieldFilterEditor
Creates the field filter editor.
Public methodGetAggregateResults
Gets aggregates results for specified group.
Public methodGetFilteringDisplayString
Gets the filtering display string for a distinct value.
Public methodStatic memberGetGridViewColumn
Gets the GridViewColumn object.
Protected methodOnAggregateFunctionsCollectionChanged
Called when the aggregate functions collection has changed.
Protected methodOnAggregateFunctionsItemChanged
Called when an item in the aggregate functions collection is changed.
Public methodOnCopyingCellClipboardContent
This method is called for each selected cell to retrieve the default cell content.
Protected methodOnInitialized
Raises the Initialized event. This method is invoked whenever IsInitialized is set to true.
(Overrides FrameworkContentElementOnInitialized(EventArgs).)
Public methodOnPastingCellClipboardContent
This method is called for each selected cell to replace the cell content with data from the clipboard.
Protected methodOnPropertyChanged(PropertyChangedEventArgs)
Raises the PropertyChanged event.
Protected methodOnPropertyChanged(String)
Raises the PropertyChanged event.
Protected methodPrepareCellForEdit
Prepares GridViewCell for edit.
Protected methodRefresh
Refresh this column cells.
Protected methodRefreshCellElement
Called when cell element needs refresh.
Protected methodSortDistinctValues
Sorts the distinct values.
Protected methodSortDistinctValuesByFilteringDisplay
Sorts the distinct values according to their display value.
Top
Extension Methods
  NameDescription
Public Extension MethodChildrenOfTypeT
Gets all child elements recursively from the visual tree by given type.
(Defined by ChildrenOfTypeExtensions.)
Public Extension MethodClearIfNoBindingAndSet
Clears if set.
(Defined by CommonExtensions.)
Public Extension MethodClearIfSet
Clears the property if a value has been set.
(Defined by CommonExtensions.)
Public Extension MethodFindChildByTypeT
Finds child element of the specified type. Uses breadth-first search.
(Defined by ChildrenOfTypeExtensions.)
Public Extension MethodGetParents
Enumerates through element's parents in the visual tree.
(Defined by ParentOfTypeExtensions.)
Public Extension MethodGetVisualParentT
Searches up in the visual tree for parent element of the specified type.
(Defined by ParentOfTypeExtensions.)
Public Extension MethodIsAncestorOf
Determines whether the element is an ancestor of the descendant.
(Defined by ParentOfTypeExtensions.)
Public Extension MethodIsLocalValueSet(DependencyProperty)Overloaded.
Determines whether the specified dependency property local value is set.
(Defined by DependencyObjectExtensions.)
Public Extension MethodIsLocalValueSet(DependencyProperty)Overloaded.
Determines whether the specified dependency property local value is set.
(Defined by CommonExtensions.)
Public Extension MethodParentOfTypeT
Gets the parent element from the visual tree by given type.
(Defined by ParentOfTypeExtensions.)
Public Extension MethodSetIfDifferent
Sets the value of the dependencyProperty property if it's hasn't that value currently.
(Defined by CommonExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberBackgroundProperty
Identifies the Background dependency property.
Public fieldStatic memberCellEditTemplateProperty
Identifies the CellEditTemplateProperty property.
Public fieldStatic memberCellEditTemplateSelectorProperty
Identifies the CellEditTemplateSelector dependency property.
Public fieldStatic memberCellStyleProperty
Identifies the CellStyle dependency property.
Public fieldStatic memberCellStyleSelectorProperty
Identifies the CellStyleSelector dependency property.
Public fieldStatic memberCellTemplateProperty
Identifies the CellTemplate property.
Public fieldStatic memberCellTemplateSelectorProperty
Identifies the CellTemplateSelector dependency property.
Public fieldStatic memberDisplayIndexProperty
Identifies the DisplayIndex dependency property.
Public fieldStatic memberEditTriggersProperty
Identifies the EditTriggers dependency property.
Public fieldStatic memberFilteringControlStyleProperty
Identifies the FilteringControlStyle dependency property.
Public fieldStatic memberFilterMemberTypeProperty
Identifies the FilterMemberType dependency property.
Public fieldStatic memberFooterCellStyleProperty
Identifies the FooterCellStyle dependency property.
Public fieldStatic memberFooterProperty
Identifies the Footer dependency property.
Public fieldStatic memberFooterTextAlignmentProperty
Gets or sets a value that indicates the horizontal alignment of header text content Affects all the header cell in the column.
Public fieldStatic memberGroupFooterCellStyleProperty
Identifies the GroupFooterCellStyle dependency property.
Public fieldStatic memberGroupFooterCellStyleSelectorProperty
Identifies the GroupFooterCellStyleSelector dependency property.
Public fieldStatic memberGroupFooterTemplateProperty
Identifies the GroupFooterTemplate property.
Public fieldStatic memberGroupFooterTemplateSelectorProperty
Identifies the GroupFooterTemplateSelector dependency property.
Public fieldStatic memberGroupHeaderTemplateProperty
Identifies the GroupFooterTemplateProperty property.
Public fieldStatic memberGroupHeaderTemplateSelectorProperty
Identifies the GroupHeaderTemplateSelector dependency property.
Public fieldStatic memberHeaderCellStyleProperty
Identifies the HeaderCellStyle dependency property.
Public fieldStatic memberHeaderProperty
Identifies the Header dependency property.
Public fieldStatic memberHeaderTextAlignmentProperty
Gets or sets a value that indicates the horizontal alignment of header text content Affects all the header cell in the column.
Public fieldStatic memberHeaderTextDecorationsProperty
Identifies the HeaderTextDecorations dependency property.
Public fieldStatic memberHeaderTextTrimmingProperty
Identifies the HeaderTextTrimming property.
Public fieldStatic memberHeaderTextWrappingProperty
Identifies the HeaderTextWrapping property.
Public fieldStatic memberIsCustomSortingEnabledProperty
Identifies the IsCustomSortingEnabled dependency property.
Public fieldStatic memberIsFilterableProperty
Identifies the IsFilterable dependency property.
Public fieldStatic memberIsFilteringDeferredProperty
Identifies the IsFilteringDeferred dependency property.
Public fieldStatic memberIsFrozenProperty
Identifies the IsFrozen readonly dependency property.
Public fieldStatic memberIsGroupableProperty
Identifies the IsGroupable dependency property.
Public fieldStatic memberIsReadOnlyProperty
Identifies the IsReadOnly dependency property.
Public fieldStatic memberIsReorderableProperty
Identifies the IsReorderable dependency property.
Public fieldStatic memberIsResizableProperty
Identifies the IsResizable dependency property.
Public fieldStatic memberIsSelectedProperty
Identifies the IsSelected dependency property.
Public fieldStatic memberIsSortableProperty
Identifies the IsSortable dependency property.
Public fieldStatic memberIsVisibleProperty
Identifies the IsVisible dependency property.
Public fieldStatic memberMaxWidthProperty
The DependencyProperty that represents the MaxWidth property.
Public fieldStatic memberMinWidthProperty
The DependencyProperty that represents the MinWidth property.
Public fieldStatic memberOptimizeDistinctFilterQueryProperty
Identifies the OptimizeDistinctFilterQuery dependency property.
Public fieldStatic memberShouldGenerateFieldFilterEditorsProperty
Identifies the ShouldGenerateFieldFilterEditors dependency property.
Public fieldStatic memberShowColumnWhenGroupedProperty
Identifies the ShowColumnWhenGrouped dependency property.
Public fieldStatic memberShowDistinctFiltersProperty
Identifies the ShowDistinctFilters dependency property.
Public fieldStatic memberShowFieldFiltersProperty
Identifies the ShowFieldFilters dependency property.
Public fieldStatic memberShowFilterButtonProperty
Identifies the ShowFilterButton dependency property.
Public fieldStatic memberShowToolTipOnTrimmedTextProperty
Identifies the ShowToolTipOnTrimmedText dependency property.
Public fieldStatic memberSortingIndexProperty
Identifies the SortingIndex readonly dependency property.
Public fieldStatic memberSortingStateChangedEvent
Identifies the SortingStateChanged routed event.
Public fieldStatic memberSortingStateProperty
Identifies the SortingState dependency property.
Public fieldStatic memberTabStopModeProperty
Identifies the TabStopMode dependency property.
Public fieldStatic memberTextAlignmentProperty
Gets or sets a value that indicates the horizontal alignment of text content Affects all the cells in the column.
Public fieldStatic memberTextDecorationsProperty
Identifies the TextDecorations dependency property.
Public fieldStatic memberTextTrimmingProperty
Identifies the TextTrimming property.
Public fieldStatic memberTextWrappingProperty
Identifies the TextWrapping property.
Public fieldStatic memberToolTipTemplateProperty
Identifies the ToolTipTemplateProperty property.
Public fieldStatic memberToolTipTemplateSelectorProperty
Identifies the ToolTipTemplateSelector dependency property.
Public fieldStatic memberWidthProperty
The DependencyProperty that represents the Width property.
Top
Properties
  NameDescription
Public propertyActualWidth
Gets the current width of the column in pixels.
Public propertyAggregateFunctions
Gets an observable collection of the aggregate functions defined for the column.
Public propertyBackground
Gets or sets the color behind the content of the column.
Public propertyCellEditTemplate
Gets or sets the data template for the cell in edit mode.
Public propertyCellEditTemplateSelector
Gets or sets the data template selector for the cell in edit mode.
Public propertyCellStyle
Gets or sets the style to be applied for the cells in that column.
Public propertyCellStyleSelector
Gets or sets the style selector for the cell.
Public propertyCellTemplate
Gets or sets the data template for the cell in view mode.
Public propertyCellTemplateSelector
Gets or sets the data template selector for the cell in view mode.
Public propertyColumnFilterDescriptor
Gets the column filter descriptor.
Public propertyColumnGroupName
Gets or sets the name of the group this column belongs to.
Public propertyDataControl
Gets the owning grid.
Public propertyDisplayIndex
Gets or sets the display position of the column relative to the other columns in the RadGridView.
Public propertyEditTriggers
Gets or sets the edit triggers.
Public propertyFilteringControl
Gets or sets the control used for filtering.
Public propertyFilteringControlStyle
Gets or sets the style which will be applied on the filtering control.
Protected propertyFilteringDisplayFunc
Gets the filtering display function.
Public propertyFilterMemberPath
Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to filter by.
Public propertyFilterMemberType
Gets or sets the filter member type of the column. Set this property when the type cannot be automatically discovered from the FilterMemberPath.
Public propertyFooter
Gets or sets the object used for Column footer.
Public propertyFooterCellStyle
Gets or sets the style to be applied for the footer cell in that column.
Public propertyFooterTextAlignment
Gets or sets the text alignment for GridViewColumn footer cell content.
Public propertyGroupFooterCellStyle
Gets or sets the style to be applied for the group footer cell in that column.
Public propertyGroupFooterCellStyleSelector
Gets or sets the style selector for group footer cells.
Public propertyGroupFooterTemplate
Gets or sets the data template for the group footer cell.
Public propertyGroupFooterTemplateSelector
Gets or sets the data template selector for the group footer cell.
Public propertyGroupHeaderFormatString
Gets or sets the header format string. Used with string.Format statement.
Public propertyGroupHeaderTemplate
Gets or sets the template for the group header.
Public propertyGroupHeaderTemplateSelector
Gets or sets the data template selector for the group header cell.
Public propertyGroupMemberPath
Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to group by.
Public propertyHeader
Gets or sets the content of the column header.
Public propertyHeaderCellStyle
Gets or sets the style to be applied for the header cell in that column.
Public propertyHeaderTextAlignment
Gets or sets the text alignment for GridViewColumn header cell content.
Public propertyHeaderTextDecorations
Gets or sets the text decoration. Affects the header cell of the column. This is a dependency property.
Public propertyHeaderTextTrimming
Gets or sets TextTrimming that will be used to trim the text in this column header cell. This is a dependency property.
Public propertyHeaderTextWrapping
Gets or sets HeaderTextWrapping that will be used to wrap the text in this column header cell. This is a dependency property.
Public propertyIsAutoGenerated
Gets a value that indicates whether the column is auto-generated.
Public propertyIsCustomSortingEnabled
Gets or sets a value indicating whether custom sorting is enabled for this instance.
Public propertyIsFilterable
Gets or sets a value indicating whether this column can be filtered through the UI.
Public propertyIsFilteringDeferred
Gets or sets a value indicating whether this column will have deferred filtering when FilteringMode is Popup.
Public propertyIsFrozen
Gets a value that indicates whether the column is prevented from scrolling horizontally.
Public propertyIsGroupable
Gets or sets a value indicating whether this instance can be grouped.
Public propertyIsLeftSideFrozen
Gets a value that indicates whether the column frozen to the left side.
Public propertyIsReadOnly
Gets or sets a value indicating whether the cells in the column can be edited.
Public propertyIsReorderable
Gets or sets a value that indicates whether the user can change the column display position by dragging the column header.
Public propertyIsResizable
Gets or sets a value that indicates whether the user can adjust the column width using the mouse.
Public propertyIsRightSideFrozen
Gets a value that indicates whether the column frozen to the right side.
Public propertyIsSelected
Gets or sets a value indicating whether this column is selected.
Public propertyIsSortable
Gets or sets a value that indicates whether the user can sort the column by clicking the column header.
Public propertyIsVisible
Gets or sets a value indicating whether this instance is visible.
Public propertyItemType
Gets the type of the item that the field belongs to.
Public propertyMaxWidth
Gets or sets the maximum column width in pixels.
Public propertyMinWidth
Gets or sets the minimum column width in pixels.
Public propertyOptimizeDistinctFilterQuery
Gets or sets a value indicating whether to optimize distinct filter query.
Public propertyShouldGenerateFieldFilterEditors
Gets or sets a value indicating whether field filter editors should be generated.
Public propertyShowColumnWhenGrouped
Indicates whether the column should be visible when grid is grouped by this column.
Public propertyShowDistinctFilters
Gets or sets a value indicating whether this column will show distinct filters.
Public propertyShowFieldFilters
Gets or sets a value indicating whether this column will show field filters.
Public propertyShowFilterButton
Gets or sets a value indicating whether this column will show the filter button.
Public propertyShowToolTipOnTrimmedText
Gets or sets a value that indicates whether a ToolTip will be visualized if the text in the cells is trimmed.
Public propertySortingIndex
Gets the sorting index of the column when there is multiple column sorting.
Public propertySortingState
Gets or sets a Column sorting state depending on executed sorted command, it can take 3 possible values: Ascending, Descending and None.
Public propertySortMemberPath
Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by.
Public propertyTabStopMode
Gets or sets the tab stop mode which denotes if cell could gain focus via TAB key.
Protected propertyTargetFilters
Gets the FilterDescriptorCollection where this column will add its ColumnFilterDescriptor. By default these are the RadGridView.FilterDescriptors since the column is filtering RadGridView.
Public propertyTextAlignment
Gets or sets the text alignment for GridViewColumn cells content.
Public propertyTextDecorations
Gets or sets the text decoration. Affects all the cells in the column. This is a dependency property.
Public propertyTextTrimming
Gets or sets TextTrimming that will be used to trim the text in this column cells. This is a dependency property.
Public propertyTextWrapping
Gets or sets TextWrapping that will be used to wrap the text in this column cells. This is a dependency property.
Public propertyToolTipTemplate
Gets or sets the template for the cell tooltip.
Public propertyToolTipTemplateSelector
Gets or sets the data template selector for the cell tooltip.
Public propertyUniqueName
Gets or sets the unique name of the Column used for identifier.
Public propertyWidth
Gets or sets the column width or an automatic sizing mode.
Top
Events
  NameDescription
Public eventPropertyChanged
Occurs when a property value changes.
Public eventSortingStateChanged
Occurs after when the sorting state of a column changes.
Top
See Also