Skip to end of metadata
Go to start of metadata

Represents a UXGridView column.

Definition

public abstract class UXGridViewColumn : DependencyObject

Summary

The following table summarizes the members exposed in this class.

Public Properties

ActualWidth Gets the current width of the column in pixels.
Background Gets or sets the background brush for all cells belong to this column.
CanUserFilter Gets or sets a value that indicates whether the user can filter the data from this column.
CanUserGroup Gets or sets a value that indicates whether the user can group this column.
CanUserReorder Gets or sets a value that indicates whether the user can change the column display position by dragging the column header.
CanUserResize Gets or sets a value that indicates whether the user can adjust the column width using the mouse.
CanUserSort Gets or sets a value that indicates whether the user can sort the column by clicking the column header.
CellHorizontalAlignment Gets or sets the horizontal alignment for all cells belong to this column.
CellStyle Gets or sets the style that is used when rendering cells in the column.
CellTemplate Gets or sets the template that is used when rendering cells in the column.
CellVerticalAlignment Gets or sets the vertical alignment for all cells belong to this column.
ClipboardContentBinding Gets or sets the binding that provides access to cell contents for clipboard operations.
ColumnFooterCellStyle Gets or sets the style that is used when rendering column footer cells in the column.
ColumnFooterCellTemplate Gets or sets the template that is used when rendering column footer cells in the column.
DisplayIndex Gets or sets the display position of the column relative to the other columns in the UXGridView.
DragIndicatorStyle Gets or sets the style that is used to render the column while it is being dragged.
Header Gets or sets the content of the column header.
HeaderBinding Gets or sets the content of the column header binding.
HeaderStyle Gets or sets the style that is used when rendering the column header.
HeaderTemplate Gets or sets the template that is used when rendering the column header.
IsAutoGenerated Gets a value that indicates whether the column is auto-generated.
IsFrozen Gets a value that indicates whether the column is prevented from scrolling horizontally.
IsReadOnly Gets or sets a value that indicates whether cells in the column can be edited.
MaxWidth Gets or sets the maximum column width in pixels.
MinWidth Gets or sets the minimum column width in pixels.
OwningGrid Gets the owning grid of this column.
PropertyName Gets or sets the property name.
RowGroupFooterCellStyle Gets or sets the style that is used when rendering row group footer cells in the column.
RowGroupFooterCellTemplate Gets or sets the template that is used when rendering row group footer cells in the column.
RowGroupHeaderTemplate Gets or sets the template that is used when rendering row group header.
SortMemberPath Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by.
Visibility Gets or sets the visibility of the column.
VisibilityBinding
Width Gets or sets the column width or automatic sizing mode.

Fields

BackgroundProperty Identifies the Background dependency property.
CellHorizontalAlignmentProperty Identifies the CellHorizontalAlignment dependency property.
CellVerticalAlignmentProperty Identifies the CellVerticalAlignment dependency property.
PropertyNameProperty Identifies the PropertyName dependency property.
VisibilityProperty Identifies the Visibility dependency property.

Static Methods

GetColumnContainingElement(FrameworkElement) Returns the column that contains the specified element.

Public Methods

GetCellContent(object) Gets the Content property value for the cell at the intersection of this column and the row that represents the specified data item.
GetCellContent(UXGridViewRow) Gets the Content property value for the cell at the intersection of this column and the specified row.

Protected Methods

CancelCellEdit(FrameworkElement, object) When overridden in a derived class, causes the column cell being edited to revert to the unedited value.
GenerateEditingElement(UXGridViewCell, object) When overridden in a derived class, gets an editing element that is bound to the column's Binding property value.
GenerateElement(UXGridViewCell, object) When overridden in a derived class, gets a read-only element that is bound to the column's Binding property value.
GenerateFooterElement(UXGridViewCell, CollectionViewGroup) When overridden in a derived class, gets a footer element of this column.
NotifyPropertyChanged(string) Called by a specific column type when one of its properties changes and its current cells need to be updated.
PrepareCellForEdit(FrameworkElement, RoutedEventArgs) When overridden in a derived class, called when a cell in the column enters editing mode.

Public Properties

public double ActualWidth { get; }

Gets the current width of the column in pixels.

public Brush Background { get; set; }

Gets or sets the background brush for all cells belong to this column.

public bool CanUserFilter { get; set; }

Gets or sets a value that indicates whether the user can filter the data from this column.

public bool CanUserGroup { get; set; }

Gets or sets a value that indicates whether the user can group this column.

public bool CanUserReorder { get; set; }

Gets or sets a value that indicates whether the user can change the column display position by dragging the column header.

public bool CanUserResize { get; set; }

Gets or sets a value that indicates whether the user can adjust the column width using the mouse.

public bool CanUserSort { get; set; }

Gets or sets a value that indicates whether the user can sort the column by clicking the column header.

public HorizontalAlignment CellHorizontalAlignment { get; set; }

Gets or sets the horizontal alignment for all cells belong to this column.

public Style CellStyle { get; set; }

Gets or sets the style that is used when rendering cells in the column.

public DataTemplate CellTemplate { get; set; }

Gets or sets the template that is used when rendering cells in the column.

public VerticalAlignment CellVerticalAlignment { get; set; }

Gets or sets the vertical alignment for all cells belong to this column.

public Binding ClipboardContentBinding { get; set; }

Gets or sets the binding that provides access to cell contents for clipboard operations.

public Style ColumnFooterCellStyle { get; set; }

Gets or sets the style that is used when rendering column footer cells in the column.

public DataTemplate ColumnFooterCellTemplate { get; set; }

Gets or sets the template that is used when rendering column footer cells in the column.

public int DisplayIndex { get; set; }

Gets or sets the display position of the column relative to the other columns in the UXGridView.

public Style DragIndicatorStyle { get; set; }

Gets or sets the style that is used to render the column while it is being dragged.

public object Header { get; set; }

Gets or sets the content of the column header.

public Binding HeaderBinding { get; set; }

Gets or sets the content of the column header binding.

public Style HeaderStyle { get; set; }

Gets or sets the style that is used when rendering the column header.

public DataTemplate HeaderTemplate { get; set; }

Gets or sets the template that is used when rendering the column header.

public bool IsAutoGenerated { get; }

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

public bool IsFrozen { get; }

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

public bool IsReadOnly { get; set; }

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

public double MaxWidth { get; set; }

Gets or sets the maximum column width in pixels.

public double MinWidth { get; set; }

Gets or sets the minimum column width in pixels.

public UXGridView OwningGrid { get; set; }

Gets the owning grid of this column.

public string PropertyName { get; set; }

Gets or sets the property name.

public Style RowGroupFooterCellStyle { get; set; }

Gets or sets the style that is used when rendering row group footer cells in the column.

public DataTemplate RowGroupFooterCellTemplate { get; set; }

Gets or sets the template that is used when rendering row group footer cells in the column.

public DataTemplate RowGroupHeaderTemplate { get; set; }

Gets or sets the template that is used when rendering row group header.

public string SortMemberPath { get; set; }

Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by.

public Visibility Visibility { get; set; }

Gets or sets the visibility of the column.

public Binding VisibilityBinding { get; set; }

public UXGridViewLength Width { get; set; }

Gets or sets the column width or automatic sizing mode.

Fields

public static readonly DependencyProperty BackgroundProperty

Identifies the Background dependency property.

public static readonly DependencyProperty CellHorizontalAlignmentProperty

Identifies the CellHorizontalAlignment dependency property.

public static readonly DependencyProperty CellVerticalAlignmentProperty

Identifies the CellVerticalAlignment dependency property.

public static readonly DependencyProperty PropertyNameProperty

Identifies the PropertyName dependency property.

public static readonly DependencyProperty VisibilityProperty

Identifies the Visibility dependency property.

Static Methods

public static UXGridViewColumn GetColumnContainingElement(FrameworkElement element)

Returns the column that contains the specified element.

Parameters

element An element contained in a column.

Return Types

The column that contains the element, or null if the element was not found.

Public Methods

public FrameworkElement GetCellContent(object dataItem)

Gets the Content property value for the cell at the intersection of this column and the row that represents the specified data item.

Parameters

dataItem The data item represented by the row that contains the intended cell.

Return Types

The cell content. Returns null if the row containing dataItem is not found.

public FrameworkElement GetCellContent(UXGridViewRow row)

Gets the Content property value for the cell at the intersection of this column and the specified row.

Parameters

row The row that contains the intended cell.

Return Types

The cell content.

Protected Methods

protected void CancelCellEdit(FrameworkElement editingElement, object uneditedValue)

When overridden in a derived class, causes the column cell being edited to revert to the unedited value.

Parameters

editingElement The element that the column displays for a cell in editing mode.
uneditedValue The previous, unedited value in the cell being edited.

protected FrameworkElement GenerateEditingElement(UXGridViewCell cell, object dataItem)

When overridden in a derived class, gets an editing element that is bound to the column's Binding property value.

Parameters

cell The cell that will contain the generated element.
dataItem The data item represented by the row that contains the intended cell.

Return Types

A new editing element that is bound to the column's Binding property value.

protected FrameworkElement GenerateElement(UXGridViewCell cell, object dataItem)

When overridden in a derived class, gets a read-only element that is bound to the column's Binding property value.

Parameters

cell The cell that will contain the generated element.
dataItem The data item represented by the row that contains the intended cell.

Return Types

A new, read-only element that is bound to the column's Binding property value.

protected FrameworkElement GenerateFooterElement(UXGridViewCell cell, CollectionViewGroup collectionViewGroup)

When overridden in a derived class, gets a footer element of this column.

Parameters

cell The cell that will contain the generated element.
collectionViewGroup The collection view group represented by this footer element.

Return Types

A new, footer element.

protected void NotifyPropertyChanged(string propertyName)

Called by a specific column type when one of its properties changes and its current cells need to be updated.

Parameters

propertyName

protected object PrepareCellForEdit(FrameworkElement editingElement, RoutedEventArgs editingEventArgs)

When overridden in a derived class, called when a cell in the column enters editing mode.

Parameters

editingElement The element that the column displays for a cell in editing mode.
editingEventArgs Information about the user gesture that is causing a cell to enter editing mode.

Return Types

The unedited value.
  • No labels