Class GridViewColumn
This is a dependency object used to store column's specific data.
Inheritance
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.GridView.dll
Syntax
public class GridViewColumn : FrameworkContentElement, IFilterableColumn, IFieldDescriptor, INotifyPropertyChanged, IColumnElement
Constructors
GridViewColumn()
Declaration
public GridViewColumn()
Fields
BackgroundProperty
Identifies the Background dependency property.
Declaration
public static readonly DependencyProperty BackgroundProperty
Field Value
System.Windows.DependencyProperty
|
CellEditTemplateProperty
Identifies the CellEditTemplateProperty property.
Declaration
public static readonly DependencyProperty CellEditTemplateProperty
Field Value
System.Windows.DependencyProperty
|
CellEditTemplateSelectorProperty
Identifies the CellEditTemplateSelector dependency property.
Declaration
public static readonly DependencyProperty CellEditTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty
|
CellStyleProperty
Identifies the CellStyle dependency property.
Declaration
public static readonly DependencyProperty CellStyleProperty
Field Value
System.Windows.DependencyProperty
|
CellStyleSelectorProperty
Identifies the CellStyleSelector dependency property.
Declaration
public static readonly DependencyProperty CellStyleSelectorProperty
Field Value
System.Windows.DependencyProperty
|
CellTemplateProperty
Identifies the CellTemplate property.
Declaration
public static readonly DependencyProperty CellTemplateProperty
Field Value
System.Windows.DependencyProperty
|
CellTemplateSelectorProperty
Identifies the CellTemplateSelector dependency property.
Declaration
public static readonly DependencyProperty CellTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty
|
DisplayIndexProperty
Identifies the DisplayIndex dependency property.
Declaration
public static readonly DependencyProperty DisplayIndexProperty
Field Value
System.Windows.DependencyProperty
|
DistinctValuesDisplayModeProperty
Identifies the DistinctValuesDisplayMode dependency property.
Declaration
public static readonly DependencyProperty DistinctValuesDisplayModeProperty
Field Value
System.Windows.DependencyProperty
|
DistinctValuesSearchModeProperty
Identifies the DistinctValuesSearchMode dependency property.
Declaration
public static readonly DependencyProperty DistinctValuesSearchModeProperty
Field Value
System.Windows.DependencyProperty
|
EditTriggersProperty
Identifies the EditTriggers dependency property.
Declaration
public static readonly DependencyProperty EditTriggersProperty
Field Value
System.Windows.DependencyProperty
|
EnableDistinctValuesFilteringProperty
Identifies the EnableDistinctValuesFiltering dependency property.
Declaration
public static readonly DependencyProperty EnableDistinctValuesFilteringProperty
Field Value
System.Windows.DependencyProperty
|
FilteringControlStyleProperty
Identifies the FilteringControlStyle dependency property.
Declaration
public static readonly DependencyProperty FilteringControlStyleProperty
Field Value
System.Windows.DependencyProperty
|
FilterMemberTypeProperty
Identifies the FilterMemberType dependency property.
Declaration
public static readonly DependencyProperty FilterMemberTypeProperty
Field Value
System.Windows.DependencyProperty
|
FooterCellStyleProperty
FooterProperty
FooterTextAlignmentProperty
GroupFooterCellStyleProperty
GroupFooterCellStyleSelectorProperty
GroupFooterTemplateProperty
GroupFooterTemplateSelectorProperty
GroupHeaderTemplateProperty
Identifies the GroupFooterTemplateProperty property.
Declaration
public static readonly DependencyProperty GroupHeaderTemplateProperty
Field Value
System.Windows.DependencyProperty
|
GroupHeaderTemplateSelectorProperty
Identifies the GroupHeaderTemplateSelector dependency property.
Declaration
public static readonly DependencyProperty GroupHeaderTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty
|
HeaderCellStyleProperty
Identifies the HeaderCellStyle dependency property.
Declaration
public static readonly DependencyProperty HeaderCellStyleProperty
Field Value
System.Windows.DependencyProperty
|
HeaderProperty
Identifies the Header dependency property.
Declaration
public static readonly DependencyProperty HeaderProperty
Field Value
System.Windows.DependencyProperty
|
HeaderTextAlignmentProperty
Gets or sets a value that indicates the horizontal alignment of header text content Affects all the header cell in the column.
Declaration
public static readonly DependencyProperty HeaderTextAlignmentProperty
Field Value
System.Windows.DependencyProperty
|
HeaderTextDecorationsProperty
Identifies the HeaderTextDecorations dependency property.
Declaration
public static readonly DependencyProperty HeaderTextDecorationsProperty
Field Value
System.Windows.DependencyProperty
|
HeaderTextTrimmingProperty
Identifies the HeaderTextTrimming property.
Declaration
public static readonly DependencyProperty HeaderTextTrimmingProperty
Field Value
System.Windows.DependencyProperty
The identifier for the HeaderTextTrimming property. |
HeaderTextWrappingProperty
Identifies the HeaderTextWrapping property.
Declaration
public static readonly DependencyProperty HeaderTextWrappingProperty
Field Value
System.Windows.DependencyProperty
The identifier for the HeaderTextWrapping property. |
IsCustomSortingEnabledProperty
Identifies the IsCustomSortingEnabled dependency property.
Declaration
public static readonly DependencyProperty IsCustomSortingEnabledProperty
Field Value
System.Windows.DependencyProperty
|
IsFilterableProperty
Identifies the IsFilterable dependency property.
Declaration
public static readonly DependencyProperty IsFilterableProperty
Field Value
System.Windows.DependencyProperty
|
IsFilteringDeferredProperty
Identifies the IsFilteringDeferred dependency property.
Declaration
public static readonly DependencyProperty IsFilteringDeferredProperty
Field Value
System.Windows.DependencyProperty
|
IsFrozenProperty
Identifies the IsFrozen readonly dependency property.
Declaration
public static readonly DependencyProperty IsFrozenProperty
Field Value
System.Windows.DependencyProperty
|
IsGroupableProperty
Identifies the IsGroupable dependency property.
Declaration
public static readonly DependencyProperty IsGroupableProperty
Field Value
System.Windows.DependencyProperty
|
IsReadOnlyProperty
Identifies the IsReadOnly dependency property.
Declaration
public static readonly DependencyProperty IsReadOnlyProperty
Field Value
System.Windows.DependencyProperty
|
IsReorderableProperty
Identifies the IsReorderable dependency property.
Declaration
public static readonly DependencyProperty IsReorderableProperty
Field Value
System.Windows.DependencyProperty
|
IsResizableProperty
Identifies the IsResizable dependency property.
Declaration
public static readonly DependencyProperty IsResizableProperty
Field Value
System.Windows.DependencyProperty
|
IsSelectedProperty
Identifies the IsSelected dependency property.
Declaration
public static readonly DependencyProperty IsSelectedProperty
Field Value
System.Windows.DependencyProperty
|
IsSortableProperty
Identifies the IsSortable dependency property.
Declaration
public static readonly DependencyProperty IsSortableProperty
Field Value
System.Windows.DependencyProperty
|
IsVisibleProperty
Identifies the IsVisible dependency property.
Declaration
public static readonly DependencyProperty IsVisibleProperty
Field Value
System.Windows.DependencyProperty
|
MaxWidthProperty
The DependencyProperty that represents the MaxWidth property.
Declaration
public static readonly DependencyProperty MaxWidthProperty
Field Value
System.Windows.DependencyProperty
|
MinWidthProperty
The DependencyProperty that represents the MinWidth property.
Declaration
public static readonly DependencyProperty MinWidthProperty
Field Value
System.Windows.DependencyProperty
|
OptimizeDistinctFilterQueryProperty
Identifies the OptimizeDistinctFilterQuery dependency property.
Declaration
public static readonly DependencyProperty OptimizeDistinctFilterQueryProperty
Field Value
System.Windows.DependencyProperty
|
ShouldGenerateFieldFilterEditorsProperty
Identifies the ShouldGenerateFieldFilterEditors dependency property.
Declaration
public static readonly DependencyProperty ShouldGenerateFieldFilterEditorsProperty
Field Value
System.Windows.DependencyProperty
|
ShowColumnWhenGroupedProperty
Identifies the ShowColumnWhenGrouped dependency property.
Declaration
public static readonly DependencyProperty ShowColumnWhenGroupedProperty
Field Value
System.Windows.DependencyProperty
|
ShowDistinctFiltersProperty
Identifies the ShowDistinctFilters dependency property.
Declaration
public static readonly DependencyProperty ShowDistinctFiltersProperty
Field Value
System.Windows.DependencyProperty
|
ShowFieldFiltersProperty
Identifies the ShowFieldFilters dependency property.
Declaration
public static readonly DependencyProperty ShowFieldFiltersProperty
Field Value
System.Windows.DependencyProperty
|
ShowFilterButtonProperty
Identifies the ShowFilterButton dependency property.
Declaration
public static readonly DependencyProperty ShowFilterButtonProperty
Field Value
System.Windows.DependencyProperty
|
ShowToolTipOnTrimmedTextProperty
Identifies the ShowToolTipOnTrimmedText dependency property.
Declaration
public static readonly DependencyProperty ShowToolTipOnTrimmedTextProperty
Field Value
System.Windows.DependencyProperty
|
SortingIndexProperty
Identifies the SortingIndex readonly dependency property.
Declaration
public static readonly DependencyProperty SortingIndexProperty
Field Value
System.Windows.DependencyProperty
|
SortingStateChangedEvent
Identifies the SortingStateChanged routed event.
Declaration
public static readonly RoutedEvent SortingStateChangedEvent
Field Value
System.Windows.RoutedEvent
|
SortingStateProperty
Identifies the SortingState dependency property.
Declaration
public static readonly DependencyProperty SortingStateProperty
Field Value
System.Windows.DependencyProperty
|
TabStopModeProperty
Identifies the TabStopMode dependency property.
Declaration
public static readonly DependencyProperty TabStopModeProperty
Field Value
System.Windows.DependencyProperty
|
TextAlignmentProperty
Gets or sets a value that indicates the horizontal alignment of text content Affects all the cells in the column.
Declaration
public static readonly DependencyProperty TextAlignmentProperty
Field Value
System.Windows.DependencyProperty
|
TextDecorationsProperty
Identifies the TextDecorations dependency property.
Declaration
public static readonly DependencyProperty TextDecorationsProperty
Field Value
System.Windows.DependencyProperty
|
TextTrimmingProperty
Identifies the TextTrimming property.
Declaration
public static readonly DependencyProperty TextTrimmingProperty
Field Value
System.Windows.DependencyProperty
The identifier for the TextTrimming property. |
TextWrappingProperty
Identifies the TextWrapping property.
Declaration
public static readonly DependencyProperty TextWrappingProperty
Field Value
System.Windows.DependencyProperty
The identifier for the TextWrapping property. |
ToolTipShowDurationProperty
Identifies the ToolTipShowDurationProperty property.
Declaration
public static readonly DependencyProperty ToolTipShowDurationProperty
Field Value
System.Windows.DependencyProperty
|
ToolTipTemplateProperty
Identifies the ToolTipTemplateProperty property.
Declaration
public static readonly DependencyProperty ToolTipTemplateProperty
Field Value
System.Windows.DependencyProperty
|
ToolTipTemplateSelectorProperty
Identifies the ToolTipTemplateSelector dependency property.
Declaration
public static readonly DependencyProperty ToolTipTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty
|
WidthProperty
The DependencyProperty that represents the Width property.
Declaration
public static readonly DependencyProperty WidthProperty
Field Value
System.Windows.DependencyProperty
|
Properties
ActualWidth
Gets the current width of the column in pixels.
Declaration
public double ActualWidth { get; }
Property Value
System.Double
The width of the column in pixels. Returns 0 if the column has not been added to a RadGridView. |
AggregateFunctions
Gets an observable collection of the aggregate functions defined for the column.
Declaration
public AggregateFunctionCollection AggregateFunctions { get; }
Property Value
AggregateFunctionCollection
The aggregate functions. |
Background
Gets or sets the color behind the content of the column.
Declaration
public Brush Background { get; set; }
Property Value
System.Windows.Media.Brush
The column background. |
CellEditTemplate
Gets or sets the data template for the cell in edit mode.
Declaration
public DataTemplate CellEditTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
Remarks
Please refer to CellEditTemplate for more information on the property.
CellEditTemplateSelector
Gets or sets the data template selector for the cell in edit mode.
Declaration
public DataTemplateSelector CellEditTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector
|
CellStyle
Gets or sets the style to be applied for the cells in that column.
Declaration
public Style CellStyle { get; set; }
Property Value
System.Windows.Style
The cell style. |
CellStyleSelector
Gets or sets the style selector for the cell.
Declaration
public StyleSelector CellStyleSelector { get; set; }
Property Value
System.Windows.Controls.StyleSelector
|
CellTemplate
Gets or sets the data template for the cell in view mode.
Declaration
public DataTemplate CellTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
Remarks
Please refer to CellTemplate for more information on the property.
CellTemplateSelector
Gets or sets the data template selector for the cell in view mode.
Declaration
public DataTemplateSelector CellTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector
|
ColumnFilterDescriptor
Gets the column filter descriptor.
Declaration
public IColumnFilterDescriptor ColumnFilterDescriptor { get; }
Property Value
IColumnFilterDescriptor
The column filter descriptor. |
ColumnGroupName
Gets or sets the name of the group this column belongs to.
Declaration
public string ColumnGroupName { get; set; }
Property Value
System.String
|
DataControl
Gets the owning grid.
Declaration
public GridViewDataControl DataControl { get; }
Property Value
GridViewDataControl
|
DisplayIndex
Gets or sets the display position of the column relative to the other columns in the RadGridView.
Declaration
public int DisplayIndex { get; set; }
Property Value
System.Int32
The zero-based position of the column as it is displayed in the associated RadGridView. The default is the index of the corresponding Item in the RadGridView.Columns collection. |
DistinctValuesDisplayMode
Gets or sets the search mode for the distinct values. Setting this property is set to Tree makes the filtering deferred and disregards the value of the IsFilteringDeferred property.
Declaration
public DistinctValuesDisplayMode DistinctValuesDisplayMode { get; set; }
Property Value
DistinctValuesDisplayMode
|
DistinctValuesSearchMode
Gets or sets the search mode for the distinct values.
Declaration
public TextSearchMode DistinctValuesSearchMode { get; set; }
Property Value
TextSearchMode
|
EditTriggers
Gets or sets the edit triggers.
Declaration
public GridViewEditTriggers EditTriggers { get; set; }
Property Value
GridViewEditTriggers
The edit triggers. |
EnableDistinctValuesFiltering
Gets or sets a value indicating whether this column will show the distinct values search text box.
Declaration
public bool EnableDistinctValuesFiltering { get; set; }
Property Value
System.Boolean
|
FilteringControl
Gets or sets the control used for filtering.
Declaration
public IFilteringControl FilteringControl { get; set; }
Property Value
IFilteringControl
|
FilteringControlStyle
Gets or sets the style which will be applied on the filtering control.
Declaration
public Style FilteringControlStyle { get; set; }
Property Value
System.Windows.Style
The editor style. |
FilteringDisplayFunc
Gets the filtering display function.
Declaration
protected virtual Func<object, object> FilteringDisplayFunc { get; }
Property Value
System.Func<System.Object, System.Object>
The filtering display function. |
Remarks
This function is used by the filtering control distinct values list. It accepts a raw data value and returns what will become the content of the distinct value checkbox.
FilterMemberPath
Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to filter by.
Declaration
public string FilterMemberPath { get; set; }
Property Value
System.String
|
FilterMemberType
Gets or sets the filter member type of the column. Set this property when the type cannot be automatically discovered from the FilterMemberPath.
Declaration
public Type FilterMemberType { get; set; }
Property Value
System.Type
The filter member data type of the column. |
Footer
FooterCellStyle
FooterTextAlignment
GroupFooterCellStyle
GroupFooterCellStyleSelector
GroupFooterTemplate
GroupFooterTemplateSelector
GroupHeaderFormatString
Gets or sets the header format string. Used with string.Format statement.
Declaration
public string GroupHeaderFormatString { get; set; }
Property Value
System.String
The header format string. |
GroupHeaderTemplate
Gets or sets the template for the group header.
Declaration
public DataTemplate GroupHeaderTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
Remarks
Please refer to GroupHeaderTemplate for more information on the property.
GroupHeaderTemplateSelector
Gets or sets the data template selector for the group header cell.
Declaration
public DataTemplateSelector GroupHeaderTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector
|
GroupMemberPath
Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to group by.
Declaration
public virtual string GroupMemberPath { get; set; }
Property Value
System.String
|
Header
Gets or sets the content of the column header.
Declaration
public virtual object Header { get; set; }
Property Value
System.Object
|
Remarks
The ElementName binding does not work when used in column Header or CellTemplate. The problem comes from the fact that binding engine uses FindName method on FrameworkElement to find the target just once. So when element is loaded with LoadContent() – the element is not yet in the visual tree and FindName fails. As a solution, you can apply a Style to set the ContentTemplate.
HeaderCellStyle
Gets or sets the style to be applied for the header cell in that column.
Declaration
public Style HeaderCellStyle { get; set; }
Property Value
System.Windows.Style
The cell style. |
HeaderTextAlignment
Gets or sets the text alignment for GridViewColumn header cell content.
Declaration
public TextAlignment HeaderTextAlignment { get; set; }
Property Value
System.Windows.TextAlignment
The text alignment. |
HeaderTextDecorations
Gets or sets the text decoration. Affects the header cell of the column. This is a dependency property.
Declaration
public TextDecorationCollection HeaderTextDecorations { get; set; }
Property Value
System.Windows.TextDecorationCollection
|
HeaderTextTrimming
Gets or sets TextTrimming that will be used to trim the text in this column header cell. This is a dependency property.
Declaration
public TextTrimming HeaderTextTrimming { get; set; }
Property Value
System.Windows.TextTrimming
TextTrimming that will be used to trim the inner text in the header cell for this column. The default value is System.Windows.TextTrimming.None |
HeaderTextWrapping
Gets or sets HeaderTextWrapping that will be used to wrap the text in this column header cell. This is a dependency property.
Declaration
public TextWrapping HeaderTextWrapping { get; set; }
Property Value
System.Windows.TextWrapping
HeaderTextWrapping that will be used to wrap the inner text in the header cell for this column. The default value is System.Windows.TextWrapping.NoWrap |
IsAutoGenerated
Gets a value that indicates whether the column is auto-generated.
Declaration
public bool IsAutoGenerated { get; set; }
Property Value
System.Boolean
|
IsCustomSortingEnabled
Gets or sets a value indicating whether custom sorting is enabled for this instance.
Declaration
public bool IsCustomSortingEnabled { get; set; }
Property Value
System.Boolean
|
IsFilterable
Gets or sets a value indicating whether this column can be filtered through the UI.
Declaration
public bool IsFilterable { get; set; }
Property Value
System.Boolean
|
IsFilteringDeferred
Gets or sets a value indicating whether this column will have deferred filtering when FilteringMode is Popup.
Declaration
public bool IsFilteringDeferred { get; set; }
Property Value
System.Boolean
|
Remarks
This property only makes sense and is used for the Popup FilteringMode of RadGridView.
IsFrozen
Gets a value that indicates whether the column is prevented from scrolling horizontally.
Declaration
public bool IsFrozen { get; }
Property Value
System.Boolean
|
IsGroupable
Gets or sets a value indicating whether this instance can be grouped.
Declaration
public bool IsGroupable { get; set; }
Property Value
System.Boolean
|
IsLeftSideFrozen
Gets a value that indicates whether the column frozen to the left side.
Declaration
public bool IsLeftSideFrozen { get; }
Property Value
System.Boolean
|
IsReadOnly
Gets or sets a value indicating whether the cells in the column can be edited.
Declaration
public virtual bool IsReadOnly { get; set; }
Property Value
System.Boolean
|
Implements
IsReorderable
Gets or sets a value that indicates whether the user can change the column display position by dragging the column header.
Declaration
public bool IsReorderable { get; set; }
Property Value
System.Boolean
|
IsResizable
Gets or sets a value that indicates whether the user can adjust the column width using the mouse.
Declaration
public bool IsResizable { get; set; }
Property Value
System.Boolean
|
IsRightSideFrozen
Gets a value that indicates whether the column frozen to the right side.
Declaration
public bool IsRightSideFrozen { get; }
Property Value
System.Boolean
|
IsSelected
Gets or sets a value indicating whether this column is selected.
Declaration
public bool IsSelected { get; set; }
Property Value
System.Boolean
|
IsSortable
Gets or sets a value that indicates whether the user can sort the column by clicking the column header.
Declaration
public bool IsSortable { get; set; }
Property Value
System.Boolean
|
IsVisible
Gets or sets a value indicating whether this instance is visible.
Declaration
public bool IsVisible { get; set; }
Property Value
System.Boolean
|
ItemType
Gets the type of the item that the field belongs to.
Declaration
public virtual Type ItemType { get; }
Property Value
System.Type
The type of the item. |
MaxWidth
Gets or sets the maximum column width in pixels.
Declaration
public double MaxWidth { get; set; }
Property Value
System.Double
The maximum column width in pixels. The default is PositiveInfinity. |
MinWidth
Gets or sets the minimum column width in pixels.
Declaration
public double MinWidth { get; set; }
Property Value
System.Double
The minimum column width in pixels, or 20 if the value is not set. The default is 20. |
OptimizeDistinctFilterQuery
Gets or sets a value indicating whether to optimize distinct filter query.
Declaration
public bool OptimizeDistinctFilterQuery { get; set; }
Property Value
System.Boolean
A value indicating whether to optimize distinct filter query. |
Remarks
By default, a condition of the form 'Member IsEqualTo Value' is generated for each distinct value selected and then all such conditions are combined with the OR operator. When the amount of distinct values checked grows, the query might become very slow. Setting OptimizeDistinctFilterQuery to true, will check the amount of distinct values checked. If this amount is less than or equal to half of all distinct values the original query will be generated. If, however, the amount of distinct values checked is more than half of all distinct values, an inverted statement like this be generated: (Member IsNotEqualTo uncheckedDistinctValue_0) ... AND ... (Member IsNotEqualTo uncheckedDistinctValue_N) If absolutely all distinct values are checked then no statement will be generated at all because this effectively means that there is no filter applied. Setting this property to true will try to generate the shortest possible LINQ Where clause.
ShouldGenerateFieldFilterEditors
Gets or sets a value indicating whether field filter editors should be generated.
Declaration
public bool? ShouldGenerateFieldFilterEditors { get; set; }
Property Value
System.Nullable<System.Boolean>
|
ShowColumnWhenGrouped
Indicates whether the column should be visible when grid is grouped by this column.
Declaration
public bool ShowColumnWhenGrouped { get; set; }
Property Value
System.Boolean
|
ShowDistinctFilters
Gets or sets a value indicating whether this column will show distinct filters.
Declaration
public bool ShowDistinctFilters { get; set; }
Property Value
System.Boolean
|
ShowFieldFilters
Gets or sets a value indicating whether this column will show field filters.
Declaration
public bool ShowFieldFilters { get; set; }
Property Value
System.Boolean
|
ShowFilterButton
Gets or sets a value indicating whether this column will show the filter button.
Declaration
public bool ShowFilterButton { get; set; }
Property Value
System.Boolean
|
ShowToolTipOnTrimmedText
Gets or sets a value that indicates whether a ToolTip will be visualized if the text in the cells is trimmed.
Declaration
public bool? ShowToolTipOnTrimmedText { get; set; }
Property Value
System.Nullable<System.Boolean>
|
SortingIndex
Gets the sorting index of the column when there is multiple column sorting.
Declaration
public int SortingIndex { get; }
Property Value
System.Int32
The sorting index of the column when there is multiple column sorting. |
SortingState
Gets or sets a Column sorting state depending on executed sorted command, it can take 3 possible values: Ascending, Descending and None.
Declaration
public SortingState SortingState { get; set; }
Property Value
SortingState
|
SortMemberPath
Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by.
Declaration
public virtual string SortMemberPath { get; set; }
Property Value
System.String
|
TabStopMode
Gets or sets the tab stop mode which denotes if cell could gain focus via TAB key.
Declaration
public GridViewTabStop TabStopMode { get; set; }
Property Value
GridViewTabStop
The tab stop mode. |
TargetFilters
Gets the FilterDescriptorCollection where this column will add its ColumnFilterDescriptor. By default these are the RadGridView.FilterDescriptors since the column is filtering RadGridView.
Declaration
protected virtual FilterDescriptorCollection TargetFilters { get; }
Property Value
FilterDescriptorCollection
The FilterDescriptorCollection where this column will add its ColumnFilterDescriptor. |
TextAlignment
Gets or sets the text alignment for GridViewColumn cells content.
Declaration
public TextAlignment TextAlignment { get; set; }
Property Value
System.Windows.TextAlignment
The text alignment. |
TextDecorations
Gets or sets the text decoration. Affects all the cells in the column. This is a dependency property.
Declaration
public TextDecorationCollection TextDecorations { get; set; }
Property Value
System.Windows.TextDecorationCollection
|
TextTrimming
Gets or sets TextTrimming that will be used to trim the text in this column cells. This is a dependency property.
Declaration
public TextTrimming TextTrimming { get; set; }
Property Value
System.Windows.TextTrimming
TextTrimming that will be used to trim the inner text in each cell for this column. The default value is System.Windows.TextTrimming.None |
TextWrapping
Gets or sets TextWrapping that will be used to wrap the text in this column cells. This is a dependency property.
Declaration
public TextWrapping TextWrapping { get; set; }
Property Value
System.Windows.TextWrapping
TextWrapping that will be used to wrap the inner text in each cell for this column. The default value is System.Windows.TextWrapping.NoWrap |
ToolTipShowDuration
Gets or sets the amount of time (in milliseconds) that a tooltip remains visible.
Declaration
public int ToolTipShowDuration { get; set; }
Property Value
System.Int32
|
Remarks
Please refer to ToolTipShowDuration for more information on the property.
ToolTipTemplate
Gets or sets the template for the cell tooltip.
Declaration
public DataTemplate ToolTipTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
Remarks
Please refer to ToolTipTemplate for more information on the property.
ToolTipTemplateSelector
Gets or sets the data template selector for the cell tooltip.
Declaration
public DataTemplateSelector ToolTipTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector
|
UniqueName
Gets or sets the unique name of the Column used for identifier.
Declaration
public virtual string UniqueName { get; set; }
Property Value
System.String
The unique name. |
Implements
Width
Gets or sets the column width or an automatic sizing mode.
Declaration
public GridViewLength Width { get; set; }
Property Value
GridViewLength
A structure that represents the column width or an automatic sizing mode. The default is the RadGridView.ColumnWidth property value. |
Remarks
This property overrides the RadGridView.ColumnWidth property.
Methods
CanEdit(Object)
Determines whether the data represented by the column can be edited.
Declaration
public virtual bool CanEdit(object item)
Parameters
System.Object
item
|
Returns
System.Boolean
|
CanFilter()
Determines whether the data represented by the column can be filtered by the RadGridView control.
Declaration
public virtual bool CanFilter()
Returns
System.Boolean
|
CanGroup()
Determines whether the data represented by the column can be grouped.
Declaration
public virtual bool CanGroup()
Returns
System.Boolean
|
CanSort()
Determines whether the data represented by the column can be sorted.
Declaration
public virtual bool CanSort()
Returns
System.Boolean
|
ClearFilters()
Clears all filtering associated with this column.
Declaration
public void ClearFilters()
CopyPropertiesFrom(GridViewColumn)
Copy properties from source column.
Declaration
public virtual void CopyPropertiesFrom(GridViewColumn source)
Parameters
GridViewColumn
source
|
CreateCellEditElement(GridViewCell, Object)
Creates the element for the cell in edit mode.
Declaration
public virtual FrameworkElement CreateCellEditElement(GridViewCell cell, object dataItem)
Parameters
GridViewCell
cell
|
System.Object
dataItem
|
Returns
System.Windows.FrameworkElement
|
CreateCellElement(GridViewCell, Object)
Creates the element for the cell in view mode.
Declaration
public virtual FrameworkElement CreateCellElement(GridViewCell cell, object dataItem)
Parameters
GridViewCell
cell
|
System.Object
dataItem
|
Returns
System.Windows.FrameworkElement
|
CreateColumnFilterDescriptor()
Creates the column filter descriptor.
Declaration
public virtual IColumnFilterDescriptor CreateColumnFilterDescriptor()
Returns
IColumnFilterDescriptor
|
CreateField()
Creates a field described by the descriptor.
Declaration
public virtual ContentControl CreateField()
Returns
System.Windows.Controls.ContentControl
|
Implements
CreateFieldFilterEditor()
Creates the field filter editor.
Declaration
public virtual FrameworkElement CreateFieldFilterEditor()
Returns
System.Windows.FrameworkElement
|
GetAggregateResults(QueryableCollectionViewGroup)
Gets aggregates results for specified group.
Declaration
public IEnumerable<AggregateResult> GetAggregateResults(QueryableCollectionViewGroup group)
Parameters
QueryableCollectionViewGroup
group
|
Returns
System.Collections.Generic.IEnumerable<AggregateResult>
|
GetFilteringDisplayString(Object)
Gets the filtering display string for a distinct value.
Declaration
public string GetFilteringDisplayString(object distinctValue)
Parameters
System.Object
distinctValue
The distinctValue. |
Returns
System.String
|
GetGridViewColumn(IFieldDescriptor)
Gets the GridViewColumn object.
Declaration
public static GridViewColumn GetGridViewColumn(IFieldDescriptor fieldDescriptor)
Parameters
IFieldDescriptor
fieldDescriptor
The field descriptor. |
Returns
GridViewColumn
|
OnAggregateFunctionsCollectionChanged(NotifyCollectionChangedEventArgs)
Called when the aggregate functions collection has changed.
Declaration
protected virtual void OnAggregateFunctionsCollectionChanged(NotifyCollectionChangedEventArgs e)
Parameters
System.Collections.Specialized.NotifyCollectionChangedEventArgs
e
The System.Collections.Specialized.NotifyCollectionChangedEventArgs instance containing the event data. |
OnAggregateFunctionsItemChanged(ItemChangedEventArgs<AggregateFunction>)
Called when an item in the aggregate functions collection is changed.
Declaration
protected virtual void OnAggregateFunctionsItemChanged(ItemChangedEventArgs<AggregateFunction> e)
Parameters
ItemChangedEventArgs<AggregateFunction>
e
The event arguments containing the event data. |
OnCopyingCellClipboardContent(Object)
This method is called for each selected cell to retrieve the default cell content.
Declaration
public virtual object OnCopyingCellClipboardContent(object item)
Parameters
System.Object
item
The data context for the selected element. |
Returns
System.Object
An object that represents the content of the cell. |
OnInitialized(EventArgs)
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs
e
|
OnPastingCellClipboardContent(Object, Object)
This method is called for each selected cell to replace the cell content with data from the clipboard.
Declaration
public virtual void OnPastingCellClipboardContent(object item, object value)
Parameters
System.Object
item
The data context for the selected element. |
System.Object
value
The clipboard data for the selected cell. |
OnPropertyChanged(PropertyChangedEventArgs)
Raises the PropertyChanged event.
Declaration
protected virtual void OnPropertyChanged(PropertyChangedEventArgs args)
Parameters
System.ComponentModel.PropertyChangedEventArgs
args
The System.ComponentModel.PropertyChangedEventArgs instance containing the event data. |
OnPropertyChanged(String)
Raises the PropertyChanged event.
Declaration
protected void OnPropertyChanged(string propertyName)
Parameters
System.String
propertyName
|
PrepareCellForEdit(FrameworkElement, RoutedEventArgs)
Prepares GridViewCell for edit.
Declaration
protected virtual object PrepareCellForEdit(FrameworkElement editingElement, RoutedEventArgs editingEventArgs)
Parameters
System.Windows.FrameworkElement
editingElement
The editing element. |
System.Windows.RoutedEventArgs
editingEventArgs
The System.Windows.RoutedEventArgs instance containing the event data. |
Returns
System.Object
|
Refresh()
Refresh this column cells.
Declaration
protected virtual void Refresh()
RefreshCellElement(FrameworkElement, DependencyProperty)
Called when cell element needs refresh.
Declaration
protected virtual void RefreshCellElement(FrameworkElement element, DependencyProperty dependencyProperty)
Parameters
System.Windows.FrameworkElement
element
|
System.Windows.DependencyProperty
dependencyProperty
|
SortDistinctValues(IQueryable)
Sorts the distinct values.
Declaration
protected virtual IQueryable SortDistinctValues(IQueryable source)
Parameters
System.Linq.IQueryable
source
The unsorted distinct values. |
Returns
System.Linq.IQueryable
The sorted distinct values. |
SortDistinctValuesByFilteringDisplay(IQueryable)
Sorts the distinct values according to their display value.
Declaration
protected virtual IQueryable SortDistinctValuesByFilteringDisplay(IQueryable source)
Parameters
System.Linq.IQueryable
source
The unsorted distinct values. |
Returns
System.Linq.IQueryable
The distinct values sorted according to their display value. |
Remarks
Use this method only if you have bound RadGridView to an in-memory collection, i.e. the source.Provider is EnumerableQuery. Other providers may not support this method and will throw an exception.
Events
PropertyChanged
Occurs when a property value changes.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler
|
SortingStateChanged
Occurs after when the sorting state of a column changes.
Declaration
public event EventHandler<RadRoutedPropertyChangedEventArgs<SortingState>> SortingStateChanged
Event Type
System.EventHandler<RadRoutedPropertyChangedEventArgs<SortingState>>
|