Class

GridViewColumn

Declaration

public GridViewColumn()

Identifies the Background dependency property.

Declaration

public static readonly DependencyProperty BackgroundProperty

Field Value

Identifies the CellEditTemplateProperty property.

Declaration

public static readonly DependencyProperty CellEditTemplateProperty

Field Value

Identifies the CellEditTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty CellEditTemplateSelectorProperty

Field Value

Identifies the CellStyle dependency property.

Declaration

public static readonly DependencyProperty CellStyleProperty

Field Value

Identifies the CellStyleSelector dependency property.

Declaration

public static readonly DependencyProperty CellStyleSelectorProperty

Field Value

Identifies the CellTemplate property.

Declaration

public static readonly DependencyProperty CellTemplateProperty

Field Value

Identifies the CellTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty CellTemplateSelectorProperty

Field Value

Identifies the DisplayIndex dependency property.

Declaration

public static readonly DependencyProperty DisplayIndexProperty

Field Value

Identifies the DistinctValuesDisplayMode dependency property.

Declaration

public static readonly DependencyProperty DistinctValuesDisplayModeProperty

Field Value

Identifies the DistinctValuesSearchMode dependency property.

Declaration

public static readonly DependencyProperty DistinctValuesSearchModeProperty

Field Value

Identifies the EditTriggers dependency property.

Declaration

public static readonly DependencyProperty EditTriggersProperty

Field Value

Identifies the EnableDistinctValuesFiltering dependency property.

Declaration

public static readonly DependencyProperty EnableDistinctValuesFilteringProperty

Field Value

Identifies the FilterMemberType dependency property.

Declaration

public static readonly DependencyProperty FilterMemberTypeProperty

Field Value

Identifies the FilteringControlStyle dependency property.

Declaration

public static readonly DependencyProperty FilteringControlStyleProperty

Field Value

Identifies the FooterCellStyle dependency property.

Declaration

public static readonly DependencyProperty FooterCellStyleProperty

Field Value

Identifies the Footer dependency property.

Declaration

public static readonly DependencyProperty FooterProperty

Field Value

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 FooterTextAlignmentProperty

Field Value

Identifies the GroupFooterCellStyle dependency property.

Declaration

public static readonly DependencyProperty GroupFooterCellStyleProperty

Field Value

Identifies the GroupFooterCellStyleSelector dependency property.

Declaration

public static readonly DependencyProperty GroupFooterCellStyleSelectorProperty

Field Value

Identifies the GroupFooterTemplate property.

Declaration

public static readonly DependencyProperty GroupFooterTemplateProperty

Field Value

Identifies the GroupFooterTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty GroupFooterTemplateSelectorProperty

Field Value

Identifies the GroupFooterTemplateProperty property.

Declaration

public static readonly DependencyProperty GroupHeaderTemplateProperty

Field Value

Identifies the GroupHeaderTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderTemplateSelectorProperty

Field Value

Identifies the HeaderCellStyle dependency property.

Declaration

public static readonly DependencyProperty HeaderCellStyleProperty

Field Value

Identifies the Header dependency property.

Declaration

public static readonly DependencyProperty HeaderProperty

Field Value

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

Identifies the HeaderTextDecorations dependency property.

Declaration

public static readonly DependencyProperty HeaderTextDecorationsProperty

Field Value

Identifies the HeaderTextTrimming property.

Declaration

public static readonly DependencyProperty HeaderTextTrimmingProperty

Field Value

Identifies the HeaderTextWrapping property.

Declaration

public static readonly DependencyProperty HeaderTextWrappingProperty

Field Value

Identifies the IsCustomSortingEnabled dependency property.

Declaration

public static readonly DependencyProperty IsCustomSortingEnabledProperty

Field Value

Identifies the IsFilterable dependency property.

Declaration

public static readonly DependencyProperty IsFilterableProperty

Field Value

Identifies the IsFilteringDeferred dependency property.

Declaration

public static readonly DependencyProperty IsFilteringDeferredProperty

Field Value

Identifies the IsFrozen readonly dependency property.

Declaration

public static readonly DependencyProperty IsFrozenProperty

Field Value

Identifies the IsGroupable dependency property.

Declaration

public static readonly DependencyProperty IsGroupableProperty

Field Value

Identifies the IsReadOnly dependency property.

Declaration

public static readonly DependencyProperty IsReadOnlyProperty

Field Value

Identifies the IsReorderable dependency property.

Declaration

public static readonly DependencyProperty IsReorderableProperty

Field Value

Identifies the IsResizable dependency property.

Declaration

public static readonly DependencyProperty IsResizableProperty

Field Value

Identifies the IsSelected dependency property.

Declaration

public static readonly DependencyProperty IsSelectedProperty

Field Value

Identifies the IsSortable dependency property.

Declaration

public static readonly DependencyProperty IsSortableProperty

Field Value

Identifies the IsVisible dependency property.

Declaration

public static readonly DependencyProperty IsVisibleProperty

Field Value

The DependencyProperty that represents the MaxWidth property.

Declaration

public static readonly DependencyProperty MaxWidthProperty

Field Value

The DependencyProperty that represents the MinWidth property.

Declaration

public static readonly DependencyProperty MinWidthProperty

Field Value

Identifies the OptimizeDistinctFilterQuery dependency property.

Declaration

public static readonly DependencyProperty OptimizeDistinctFilterQueryProperty

Field Value

Identifies the ShouldGenerateFieldFilterEditors dependency property.

Declaration

public static readonly DependencyProperty ShouldGenerateFieldFilterEditorsProperty

Field Value

Identifies the ShowColumnWhenGrouped dependency property.

Declaration

public static readonly DependencyProperty ShowColumnWhenGroupedProperty

Field Value

Identifies the ShowDistinctFilters dependency property.

Declaration

public static readonly DependencyProperty ShowDistinctFiltersProperty

Field Value

Identifies the ShowFieldFilters dependency property.

Declaration

public static readonly DependencyProperty ShowFieldFiltersProperty

Field Value

Identifies the ShowFilterButton dependency property.

Declaration

public static readonly DependencyProperty ShowFilterButtonProperty

Field Value

Identifies the ShowToolTipOnTrimmedText dependency property.

Declaration

public static readonly DependencyProperty ShowToolTipOnTrimmedTextProperty

Field Value

Identifies the SortingIndex readonly dependency property.

Declaration

public static readonly DependencyProperty SortingIndexProperty

Field Value

Identifies the SortingStateChanged routed event.

Declaration

public static readonly RoutedEvent SortingStateChangedEvent

Field Value

Identifies the SortingState dependency property.

Declaration

public static readonly DependencyProperty SortingStateProperty

Field Value

Identifies the TabStopMode dependency property.

Declaration

public static readonly DependencyProperty TabStopModeProperty

Field Value

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

Identifies the TextDecorations dependency property.

Declaration

public static readonly DependencyProperty TextDecorationsProperty

Field Value

Identifies the TextTrimming property.

Declaration

public static readonly DependencyProperty TextTrimmingProperty

Field Value

Identifies the TextWrapping property.

Declaration

public static readonly DependencyProperty TextWrappingProperty

Field Value

Identifies the ToolTipShowDurationProperty property.

Declaration

public static readonly DependencyProperty ToolTipShowDurationProperty

Field Value

Identifies the ToolTipTemplateProperty property.

Declaration

public static readonly DependencyProperty ToolTipTemplateProperty

Field Value

Identifies the ToolTipTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty ToolTipTemplateSelectorProperty

Field Value

The DependencyProperty that represents the Width property.

Declaration

public static readonly DependencyProperty WidthProperty

Field Value

Gets the current width of the column in pixels.

Declaration

public double ActualWidth { get; }

Property Value

Gets an observable collection of the aggregate functions defined for the column.

Declaration

public AggregateFunctionCollection AggregateFunctions { get; }

Property Value

Gets or sets the color behind the content of the column.

Declaration

public Brush Background { get; set; }

Property Value

Gets or sets the data template for the cell in edit mode.

Declaration

public DataTemplate CellEditTemplate { get; set; }

Property Value

Remarks

Gets or sets the data template selector for the cell in edit mode.

Declaration

public DataTemplateSelector CellEditTemplateSelector { get; set; }

Property Value

Gets or sets the style to be applied for the cells in that column.

Declaration

public Style CellStyle { get; set; }

Property Value

Gets or sets the style selector for the cell.

Declaration

public StyleSelector CellStyleSelector { get; set; }

Property Value

Gets or sets the data template for the cell in view mode.

Declaration

public DataTemplate CellTemplate { get; set; }

Property Value

Remarks

Gets or sets the data template selector for the cell in view mode.

Declaration

public DataTemplateSelector CellTemplateSelector { get; set; }

Property Value

Gets the column filter descriptor.

Declaration

public IColumnFilterDescriptor ColumnFilterDescriptor { get; }

Property Value

Gets or sets the name of the group this column belongs to.

Declaration

public string ColumnGroupName { get; set; }

Property Value

Gets the owning grid.

Declaration

public GridViewDataControl DataControl { get; }

Property Value

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

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

Gets or sets the search mode for the distinct values.

Declaration

public TextSearchMode DistinctValuesSearchMode { get; set; }

Property Value

Gets or sets the edit triggers.

Declaration

public GridViewEditTriggers EditTriggers { get; set; }

Property Value

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

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

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

Gets or sets the control used for filtering.

Declaration

public IFilteringControl FilteringControl { get; set; }

Property Value

Gets or sets the style which will be applied on the filtering control.

Declaration

public Style FilteringControlStyle { get; set; }

Property Value

Gets the filtering display function.

Declaration

protected virtual Func<object, object> FilteringDisplayFunc { get; }

Property Value

Remarks

Gets or sets the object used for Column footer.

Declaration

public object Footer { get; set; }

Property Value

Gets or sets the style to be applied for the footer cell in that column.

Declaration

public Style FooterCellStyle { get; set; }

Property Value

Gets or sets the text alignment for GridViewColumn footer cell content.

Declaration

public TextAlignment FooterTextAlignment { get; set; }

Property Value

Gets or sets the style to be applied for the group footer cell in that column.

Declaration

public Style GroupFooterCellStyle { get; set; }

Property Value

Gets or sets the style selector for group footer cells.

Declaration

public StyleSelector GroupFooterCellStyleSelector { get; set; }

Property Value

Gets or sets the data template for the group footer cell.

Declaration

public DataTemplate GroupFooterTemplate { get; set; }

Property Value

Remarks

Gets or sets the data template selector for the group footer cell.

Declaration

public DataTemplateSelector GroupFooterTemplateSelector { get; set; }

Property Value

Gets or sets the header format string. Used with string.Format statement.

Declaration

public string GroupHeaderFormatString { get; set; }

Property Value

Gets or sets the template for the group header.

Declaration

public DataTemplate GroupHeaderTemplate { get; set; }

Property Value

Remarks

Gets or sets the data template selector for the group header cell.

Declaration

public DataTemplateSelector GroupHeaderTemplateSelector { get; set; }

Property Value

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

Gets or sets the content of the column header.

Declaration

public virtual object Header { get; set; }

Property Value

Remarks

Gets or sets the style to be applied for the header cell in that column.

Declaration

public Style HeaderCellStyle { get; set; }

Property Value

Gets or sets the text alignment for GridViewColumn header cell content.

Declaration

public TextAlignment HeaderTextAlignment { get; set; }

Property Value

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

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

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

Gets a value that indicates whether the column is auto-generated.

Declaration

public bool IsAutoGenerated { get; set; }

Property Value

Gets or sets a value indicating whether custom sorting is enabled for this instance.

Declaration

public bool IsCustomSortingEnabled { get; set; }

Property Value

Gets or sets a value indicating whether this column can be filtered through the UI.

Declaration

public bool IsFilterable { get; set; }

Property Value

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

Remarks

Gets a value that indicates whether the column is prevented from scrolling horizontally.

Declaration

public bool IsFrozen { get; }

Property Value

Gets or sets a value indicating whether this instance can be grouped.

Declaration

public bool IsGroupable { get; set; }

Property Value

Gets a value that indicates whether the column frozen to the left side.

Declaration

public bool IsLeftSideFrozen { get; }

Property Value

Gets or sets a value indicating whether the cells in the column can be edited.

Declaration

public virtual bool IsReadOnly { get; set; }

Property Value

Implements IFieldDescriptor.IsReadOnly

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

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

Gets a value that indicates whether the column frozen to the right side.

Declaration

public bool IsRightSideFrozen { get; }

Property Value

Gets or sets a value indicating whether this column is selected.

Declaration

public bool IsSelected { get; set; }

Property Value

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

Gets or sets a value indicating whether this instance is visible.

Declaration

public bool IsVisible { get; set; }

Property Value

Gets the type of the item that the field belongs to.

Declaration

public virtual Type ItemType { get; }

Property Value

Gets or sets the maximum column width in pixels.

Declaration

public double MaxWidth { get; set; }

Property Value

Gets or sets the minimum column width in pixels.

Declaration

public double MinWidth { get; set; }

Property Value

Gets or sets a value indicating whether to optimize distinct filter query.

Declaration

public bool OptimizeDistinctFilterQuery { get; set; }

Property Value

Remarks

Gets or sets a value indicating whether field filter editors should be generated.

Declaration

public bool? ShouldGenerateFieldFilterEditors { get; set; }

Property Value

Indicates whether the column should be visible when grid is grouped by this column.

Declaration

public bool ShowColumnWhenGrouped { get; set; }

Property Value

Gets or sets a value indicating whether this column will show distinct filters.

Declaration

public bool ShowDistinctFilters { get; set; }

Property Value

Gets or sets a value indicating whether this column will show field filters.

Declaration

public bool ShowFieldFilters { get; set; }

Property Value

Gets or sets a value indicating whether this column will show the filter button.

Declaration

public bool ShowFilterButton { get; set; }

Property Value

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

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

Gets the sorting index of the column when there is multiple column sorting.

Declaration

public int SortingIndex { get; }

Property Value

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

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

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

Gets or sets the text alignment for GridViewColumn cells content.

Declaration

public TextAlignment TextAlignment { get; set; }

Property Value

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

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

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

Gets or sets the amount of time (in milliseconds) that a tooltip remains visible.

Declaration

public int ToolTipShowDuration { get; set; }

Property Value

Remarks

Gets or sets the template for the cell tooltip.

Declaration

public DataTemplate ToolTipTemplate { get; set; }

Property Value

Remarks

Gets or sets the data template selector for the cell tooltip.

Declaration

public DataTemplateSelector ToolTipTemplateSelector { get; set; }

Property Value

Gets or sets the unique name of the Column used for identifier.

Declaration

public virtual string UniqueName { get; set; }

Property Value

Implements IFieldDescriptor.UniqueName

Gets or sets the column width or an automatic sizing mode.

Declaration

public GridViewLength Width { get; set; }

Property Value

Remarks

Determines whether the data represented by the column can be edited.

Declaration

public virtual bool CanEdit(object item)

Parameters

Returns

Determines whether the data represented by the column can be filtered by the RadGridView control.

Declaration

public virtual bool CanFilter()

Returns

Determines whether the data represented by the column can be grouped.

Declaration

public virtual bool CanGroup()

Returns

Determines whether the data represented by the column can be sorted.

Declaration

public virtual bool CanSort()

Returns

Clears all filtering associated with this column.

Declaration

public void ClearFilters()

Copy properties from source column.

Declaration

public virtual void CopyPropertiesFrom(GridViewColumn source)

Parameters

Creates the element for the cell in edit mode.

Declaration

public virtual FrameworkElement CreateCellEditElement(GridViewCell cell, object dataItem)

Parameters

Returns

Creates the element for the cell in view mode.

Declaration

public virtual FrameworkElement CreateCellElement(GridViewCell cell, object dataItem)

Parameters

Returns

Creates the column filter descriptor.

Declaration

public virtual IColumnFilterDescriptor CreateColumnFilterDescriptor()

Returns

Creates a field described by the descriptor.

Declaration

public virtual ContentControl CreateField()

Returns

Implements IFieldDescriptor.CreateField()

Creates the field filter editor.

Declaration

public virtual FrameworkElement CreateFieldFilterEditor()

Returns

Gets aggregates results for specified group.

Declaration

public IEnumerable<AggregateResult> GetAggregateResults(QueryableCollectionViewGroup group)

Parameters

Returns

Gets the filtering display string for a distinct value.

Declaration

public string GetFilteringDisplayString(object distinctValue)

Parameters

Returns

Gets the GridViewColumn object.

Declaration

public static GridViewColumn GetGridViewColumn(IFieldDescriptor fieldDescriptor)

Parameters

Returns

Called when the aggregate functions collection has changed.

Declaration

protected virtual void OnAggregateFunctionsCollectionChanged(NotifyCollectionChangedEventArgs e)

Parameters

Called when an item in the aggregate functions collection is changed.

Declaration

protected virtual void OnAggregateFunctionsItemChanged(ItemChangedEventArgs<AggregateFunction> e)

Parameters

This method is called for each selected cell to retrieve the default cell content.

Declaration

public virtual object OnCopyingCellClipboardContent(object item)

Parameters

Returns

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

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

Raises the PropertyChanged event.

Declaration

protected virtual void OnPropertyChanged(PropertyChangedEventArgs args)

Parameters

Raises the PropertyChanged event.

Declaration

protected void OnPropertyChanged(string propertyName)

Parameters

Prepares GridViewCell for edit.

Declaration

protected virtual object PrepareCellForEdit(FrameworkElement editingElement, RoutedEventArgs editingEventArgs)

Parameters

Returns

Refresh this column cells.

Declaration

protected virtual void Refresh()

Called when cell element needs refresh.

Declaration

protected virtual void RefreshCellElement(FrameworkElement element, DependencyProperty dependencyProperty)

Parameters

Sorts the distinct values.

Declaration

protected virtual IQueryable SortDistinctValues(IQueryable source)

Parameters

Returns

Sorts the distinct values according to their display value.

Declaration

protected virtual IQueryable SortDistinctValuesByFilteringDisplay(IQueryable source)

Parameters

Returns

Remarks

Occurs when a property value changes.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Value

Implements INotifyPropertyChanged.PropertyChanged

Occurs after when the sorting state of a column changes.

Declaration

public event EventHandler<RadRoutedPropertyChangedEventArgs<SortingState>> SortingStateChanged

Event Value