DataGridColumn Class

Definition

Namespace: Avalonia.Controls
Assembly: Avalonia.Controls.DataGrid (in Avalonia.Controls.DataGrid.dll) Version: 11.3.999

C#View Source

public abstract class DataGridColumn : AvaloniaObject

VBView Source

Public MustInherit Class DataGridColumn
	Inherits AvaloniaObject

F#View Source

[<AbstractClassAttribute>]
type DataGridColumn = 
    class
        inherit AvaloniaObject
    end

Inheritance: Object AvaloniaObject DataGridColumn

Derived: Avalonia.ControlsDataGridBoundColumn
Avalonia.ControlsDataGridTemplateColumn

Properties

ActualWidth	Actual visible width after Width, MinWidth, and MaxWidth setting at the Column level and DataGrid level have been taken into account
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.
CellStyleClasses
CellTheme	Gets or sets the DataGridColumnHeader cell theme.
ClipboardContentBinding	The binding that will be used to get or set cell content for the clipboard.
CustomSortComparer	Holds a Comparer to use for sorting, if not using the default.
DisplayIndex	Gets or sets the display position of the column relative to the other columns in the DataGrid.
Header	Gets or sets the DataGridColumnHeader content
HeaderTemplate	Gets or sets an IDataTemplate for the Header
InheritanceParent	Gets or sets the parent object that inherited AvaloniaProperty values are inherited from. (Inherited from AvaloniaObject)
IsAutoGenerated
IsFrozen
IsReadOnly
IsVisible	Determines whether or not this column is visible.
ItemAvaloniaProperty	Gets or sets the value of a AvaloniaProperty. (Inherited from AvaloniaObject)
ItemIndexerDescriptor	Gets or sets a binding for a AvaloniaProperty. (Inherited from AvaloniaObject)
MaxWidth
MinWidth
OwningGrid	Gets the DataGrid control that contains this column.
SortMemberPath	Holds the name of the member to use for sorting, if not using the default.
Tag	Gets or sets an object associated with this column.
Width

Methods

Bind(AvaloniaProperty, IBinding)	Binds a AvaloniaProperty to an IBinding. (Inherited from AvaloniaObject)
Bind(AvaloniaProperty, IObservableObject, BindingPriority)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
BindT(DirectPropertyBaseT, IObservableT)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
BindT(DirectPropertyBaseT, IObservableBindingValueT)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
BindT(DirectPropertyBaseT, IObservableObject)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
BindT(StyledPropertyT, IObservableT, BindingPriority)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
BindT(StyledPropertyT, IObservableBindingValueT, BindingPriority)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
BindT(StyledPropertyT, IObservableObject, BindingPriority)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
CancelCellEdit(Control, Object)	When overridden in a derived class, causes the column cell being edited to revert to the unedited value.
CheckAccess	Returns a value indicating whether the current thread is the UI thread. (Inherited from AvaloniaObject)
ClearSort	Clears the current sort direction
ClearValue(AvaloniaProperty)	Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject)
ClearValueT(AvaloniaPropertyT)	Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject)
ClearValueT(DirectPropertyBaseT)	Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject)
ClearValueT(StyledPropertyT)	Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject)
CoerceValue(AvaloniaProperty)	Coerces the specified AvaloniaProperty. (Inherited from AvaloniaObject)
EndCellEdit	When overridden in a derived class, called when a cell in the column exits editing mode.
Equals(Object)	Compares two objects using reference equality. (Inherited from AvaloniaObject)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GenerateEditingElement(DataGridCell, Object, ICellEditBinding)	When overridden in a derived class, gets an editing element that is bound to the column's Binding property value.
GenerateElement(DataGridCell, Object)	When overridden in a derived class, gets a read-only element that is bound to the column's Binding property value.
GetBaseValueT(StyledPropertyT)	Gets an AvaloniaProperty base value. (Inherited from AvaloniaObject)
GetCellContent(DataGridRow)
GetCellContent(Object)
GetColumnContainingElement(Control)	Returns the column which contains the given element
GetHashCode	Gets the hash code for the object. (Inherited from AvaloniaObject)
GetType	Gets the Type of the current instance. (Inherited from Object)
GetValue(AvaloniaProperty)	Gets a AvaloniaProperty value. (Inherited from AvaloniaObject)
GetValueT(DirectPropertyBaseT)	Gets a AvaloniaProperty value. (Inherited from AvaloniaObject)
GetValueT(StyledPropertyT)	Gets a AvaloniaProperty value. (Inherited from AvaloniaObject)
IsAnimating(AvaloniaProperty)	Checks whether a AvaloniaProperty is animating. (Inherited from AvaloniaObject)
IsSet(AvaloniaProperty)	Checks whether a AvaloniaProperty is set on this object. (Inherited from AvaloniaObject)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
NotifyPropertyChanged(String)	Called by a specific column type when one of its properties changed, and its current cells need to be updated.
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)	(Overrides AvaloniaObjectOnPropertyChanged(AvaloniaPropertyChangedEventArgs))
OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)	Called when a avalonia property changes on the object. (Inherited from AvaloniaObject)
PrepareCellForEdit(Control, RoutedEventArgs)	When overridden in a derived class, called when a cell in the column enters editing mode.
RaisePropertyChangedT(DirectPropertyBaseT, T, T)	Raises the PropertyChanged event for a direct property. (Inherited from AvaloniaObject)
RefreshCellContent(Control, String)	Called by the DataGrid control when a column asked for its elements to be refreshed, typically because one of its properties changed.
SetAndRaiseT(DirectPropertyBaseT, T, T)	Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed. (Inherited from AvaloniaObject)
SetCurrentValue(AvaloniaProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from AvaloniaObject)
SetCurrentValueT(StyledPropertyT, T)	Sets the value of a dependency property without changing its value source. (Inherited from AvaloniaObject)
SetValue(AvaloniaProperty, Object, BindingPriority)	Sets a AvaloniaProperty value. (Inherited from AvaloniaObject)
SetValueT(DirectPropertyBaseT, T)	Sets a AvaloniaProperty value. (Inherited from AvaloniaObject)
SetValueT(StyledPropertyT, T, BindingPriority)	Sets a AvaloniaProperty value. (Inherited from AvaloniaObject)
Sort	Switches the current state of sort direction
Sort(ListSortDirection)	Changes the sort direction of this column
ToString	Returns a string that represents the current object. (Inherited from Object)
UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception)	Called to update the validation state for properties for which data validation is enabled. (Inherited from AvaloniaObject)
VerifyAccess	Checks that the current thread is the UI thread and throws if not. (Inherited from AvaloniaObject)

Events

HeaderPointerPressed	Occurs when the pointer is pressed over the column's header
HeaderPointerReleased	Occurs when the pointer is released over the column's header
PropertyChanged	Raised when a AvaloniaProperty value changes on this object. (Inherited from AvaloniaObject)

Fields

CellThemeProperty	Backing field for CellTheme property.
HeaderProperty	Backing field for Header property
HeaderTemplateProperty	Backing field for Header property
IsVisibleProperty	Defines the IsVisible property.
WidthProperty

Extension Methods

Bind(AvaloniaProperty, IBinding, Object)	Binds a property on an AvaloniaObject to an IBinding. (Defined by AvaloniaObjectExtensions)
BindT(AvaloniaPropertyT, IObservableBindingValueT, BindingPriority)	Binds an AvaloniaProperty to an observable. (Defined by AvaloniaObjectExtensions)
BindT(AvaloniaPropertyT, IObservableT, BindingPriority)	Binds an AvaloniaProperty to an observable. (Defined by AvaloniaObjectExtensions)
GetBaseValue(AvaloniaProperty)	Gets an AvaloniaProperty base value. (Defined by AvaloniaObjectExtensions)
GetBaseValueT(AvaloniaPropertyT)	Gets an AvaloniaProperty base value. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(AvaloniaProperty)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservableT(AvaloniaPropertyT)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservableTResult(AvaloniaProperty, FuncObject, TResult)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservableTSource, TResult(AvaloniaPropertyTSource, FuncTSource, TResult)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingSubject(AvaloniaProperty, BindingPriority)	Gets a subject for a AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetBindingSubjectT(AvaloniaPropertyT, BindingPriority)	Gets a subject for a AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetDiagnostic(AvaloniaProperty)	Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject. (Defined by AvaloniaObjectExtensions)
GetObservable(AvaloniaProperty)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservableT(AvaloniaPropertyT)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservableTResult(AvaloniaProperty, FuncObject, TResult)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservableTSource, TResult(AvaloniaPropertyTSource, FuncTSource, TResult)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetPropertyChangedObservable(AvaloniaProperty)	Gets an observable that listens for property changed events for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetSubject(AvaloniaProperty, BindingPriority)	Gets a subject for an AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetSubjectT(AvaloniaPropertyT, BindingPriority)	Gets a subject for an AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetValueT(AvaloniaPropertyT)	Gets a AvaloniaProperty value. (Defined by AvaloniaObjectExtensions)
GetValueStoreDiagnostic	Gets a value store diagnostics for a AvaloniaObject. (Defined by AvaloniaObjectExtensions)

DataGridColumn Class

Definition

Properties

Methods

Events

Fields

Extension Methods

See Also

Reference