Summary

Represents a DataGrid column that can bind to a property in the grid's data source.

Namespace

Interfaces

IAvaloniaObject
IAvaloniaObjectDebug
INotifyPropertyChanged
IValueSink

Base Types

Derived Types

graph BT Type-->Base0["DataGridColumn"] click Base0 "/api/Avalonia.Controls/DataGridColumn" Base0-->Base1["AvaloniaObject"] click Base1 "/api/Avalonia/AvaloniaObject" Base1-->Base2["object"] Type-.->Interface0["IAvaloniaObject"] click Interface0 "/api/Avalonia/IAvaloniaObject" Type-.->Interface1["IAvaloniaObjectDebug"] click Interface1 "/api/Avalonia.Diagnostics/IAvaloniaObjectDebug" Type-.->Interface2["INotifyPropertyChanged"] Type-.->Interface3["IValueSink"] Type["DataGridBoundColumn"] class Type type-node Derived0["DataGridCheckBoxColumn"]-->Type click Derived0 "/api/Avalonia.Controls/DataGridCheckBoxColumn" Derived1["DataGridTextColumn"]-->Type click Derived1 "/api/Avalonia.Controls/DataGridTextColumn"

Syntax

public abstract class DataGridBoundColumn : DataGridColumn, IAvaloniaObject, IAvaloniaObjectDebug, 
    INotifyPropertyChanged, IValueSink

Events

Name	Type	Summary
PropertyChanged	EventHandler<AvaloniaPropertyChangedEventArgs>	Raised when a `AvaloniaProperty` value changes on this object. Inherited from AvaloniaObject

Properties

Name	Value	Summary
ActualWidth	double	Actual visible width after Width, MinWidth, and MaxWidth setting at the Column level and DataGrid level have been taken into account Inherited from DataGridColumn
Binding	IBinding	Gets or sets the binding that associates the column with a property in the data source.
CanUserReorder	bool	Gets or sets a value that indicates whether the user can change the column display position by dragging the column header. Inherited from DataGridColumn
CanUserResize	bool	Gets or sets a value that indicates whether the user can adjust the column width using the mouse. Inherited from DataGridColumn
CanUserSort	bool	Gets or sets a value that indicates whether the user can sort the column by clicking the column header. Inherited from DataGridColumn
CellStyleClasses	Classes	Inherited from DataGridColumn
ClipboardContentBinding	IBinding	The binding that will be used to get or set cell content for the clipboard. If the base ClipboardContentBinding is not explicitly set, this will return the value of Binding.
CustomSortComparer	IComparer	Holds a Comparer to use for sorting, if not using the default. Inherited from DataGridColumn
DisplayIndex	int	Gets or sets the display position of the column relative to the other columns in the `DataGrid`. Inherited from DataGridColumn
Header	object	Inherited from DataGridColumn
InheritanceParent	IAvaloniaObject	Gets or sets the parent object that inherited `AvaloniaProperty` values are inherited from. Inherited from AvaloniaObject
IsAutoGenerated	bool	Inherited from DataGridColumn
IsFrozen	bool	Inherited from DataGridColumn
IsReadOnly	bool	Inherited from DataGridColumn
IsVisible	bool	Determines whether or not this column is visible. Inherited from DataGridColumn
MaxWidth	double	Inherited from DataGridColumn
MinWidth	double	Inherited from DataGridColumn
SortMemberPath	string	Holds the name of the member to use for sorting, if not using the default. Inherited from DataGridColumn
this[AvaloniaProperty]	object	Gets or sets the value of a `AvaloniaProperty`. Inherited from AvaloniaObject
this[IndexerDescriptor]	IBinding	Gets or sets a binding for a `AvaloniaProperty`. Inherited from AvaloniaObject
Width	DataGridLength	Inherited from DataGridColumn

Methods

Name	Value	Summary
BeginBatchUpdate()	void	Inherited from AvaloniaObject
Bind<T>(DirectPropertyBase<T>, IObservable<BindingValue<T>>)	IDisposable	Binds a `AvaloniaProperty` to an observable. Inherited from AvaloniaObject
Bind<T>(StyledPropertyBase<T>, IObservable<BindingValue<T>>, BindingPriority)	IDisposable	Binds a `AvaloniaProperty` to an observable. Inherited from AvaloniaObject
CancelCellEdit(IControl, object)	void	When overridden in a derived class, causes the column cell being edited to revert to the unedited value. Inherited from DataGridColumn
CheckAccess()	bool	Inherited from AvaloniaObject
ClearValue(AvaloniaProperty)	void	Clears a `AvaloniaProperty`'s local value. Inherited from AvaloniaObject
ClearValue<T>(AvaloniaProperty<T>)	void	Clears a `AvaloniaProperty`'s local value. Inherited from AvaloniaObject
ClearValue<T>(DirectPropertyBase<T>)	void	Clears a `AvaloniaProperty`'s local value. Inherited from AvaloniaObject
ClearValue<T>(StyledPropertyBase<T>)	void	Clears a `AvaloniaProperty`'s local value. Inherited from AvaloniaObject
CoerceValue<T>(StyledPropertyBase<T>)	void	Coerces the specified `AvaloniaProperty`. Inherited from AvaloniaObject
EndBatchUpdate()	void	Inherited from AvaloniaObject
Equals(object)	bool	Compares two objects using reference equality. Inherited from AvaloniaObject
GenerateEditingElement(DataGridCell, object, ICellEditBinding)	IControl
GenerateEditingElementDirect(DataGridCell, object)	IControl
GenerateElement(DataGridCell, object)	IControl	When overridden in a derived class, gets a read-only element that is bound to the column's `Binding` property value. Inherited from DataGridColumn
GetBaseValue<T>(StyledPropertyBase<T>, BindingPriority)	Optional<T>	Gets an `AvaloniaProperty` base value. Inherited from AvaloniaObject
GetCellContent(DataGridRow)	IControl	Inherited from DataGridColumn
GetCellContent(object)	IControl	Inherited from DataGridColumn
GetColumnContainingElement(IControl)	DataGridColumn	Returns the column which contains the given element Inherited from DataGridColumn static
GetHashCode()	int	Gets the hash code for the object. Inherited from AvaloniaObject
GetValue(AvaloniaProperty)	object	Gets a `AvaloniaProperty` value. Inherited from AvaloniaObject
GetValue<T>(DirectPropertyBase<T>)	T	Gets a `AvaloniaProperty` value. Inherited from AvaloniaObject
GetValue<T>(StyledPropertyBase<T>)	T	Gets a `AvaloniaProperty` value. Inherited from AvaloniaObject
IsAnimating(AvaloniaProperty)	bool	Checks whether a `AvaloniaProperty` is animating. Inherited from AvaloniaObject
IsSet(AvaloniaProperty)	bool	Checks whether a `AvaloniaProperty` is set on this object. Inherited from AvaloniaObject
NotifyPropertyChanged(string)	void	Called by a specific column type when one of its properties changed, and its current cells need to be updated. Inherited from DataGridColumn
PrepareCellForEdit(IControl, RoutedEventArgs)	object	When overridden in a derived class, called when a cell in the column enters editing mode. Inherited from DataGridColumn
SetValue(AvaloniaProperty, object, BindingPriority)	void	Sets a `AvaloniaProperty` value. Inherited from AvaloniaObject
SetValue<T>(DirectPropertyBase<T>, T)	void	Sets a `AvaloniaProperty` value. Inherited from AvaloniaObject
SetValue<T>(StyledPropertyBase<T>, T, BindingPriority)	IDisposable	Sets a `AvaloniaProperty` value. Inherited from AvaloniaObject
VerifyAccess()	void	Inherited from AvaloniaObject

Extension Methods