Skip to main content

DataGridTextColumn Class

Represents a DataGrid column that hosts textual content in its cells.

Definition

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

public class DataGridTextColumn : DataGridBoundColumn
View Source
InheritanceObjectAvaloniaObjectDataGridColumnDataGridBoundColumn → DataGridTextColumn

Constructors

DataGridTextColumn()Initializes a new instance of the DataGridTextColumn class.

Properties

ActualWidthActual visible width after Width, MinWidth, and MaxWidth setting at the Column level and DataGrid level have been taken into account
(Inherited from DataGridColumn)
BindingGets or sets the binding that associates the column with a property in the data source.
(Inherited from DataGridBoundColumn)
BindingTarget
(Inherited from DataGridBoundColumn)
CanUserReorderGets or sets a value that indicates whether the user can change the column display position by dragging the column header.
(Inherited from DataGridColumn)
CanUserResizeGets or sets a value that indicates whether the user can adjust the column width using the mouse.
(Inherited from DataGridColumn)
CanUserSortGets or sets a value that indicates whether the user can sort the column by clicking the column header.
(Inherited from DataGridColumn)
CellStyleClasses
(Inherited from DataGridColumn)
CellThemeGets or sets the DataGridColumnHeader cell theme.
(Inherited from DataGridColumn)
ClipboardContentBindingThe 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.
(Inherited from DataGridBoundColumn)
CustomSortComparerHolds a Comparer to use for sorting, if not using the default.
(Inherited from DataGridColumn)
DisplayIndexGets or sets the display position of the column relative to the other columns in the DataGrid.
(Inherited from DataGridColumn)
FontFamilyGets or sets the font name.
FontSizeGets or sets the font size.
FontStretchGets or sets the font weight or thickness.
FontStyleGets or sets the font style.
FontWeightGets or sets the font weight or thickness.
ForegroundGets or sets a brush that describes the foreground of the column cells.
HeaderGets or sets the DataGridColumnHeader content
(Inherited from DataGridColumn)
HeaderTemplateGets or sets an IDataTemplate for the Header
(Inherited from DataGridColumn)
InheritanceParentGets or sets the parent object that inherited AvaloniaProperty values are inherited from.
(Inherited from AvaloniaObject)
IsAutoGenerated
(Inherited from DataGridColumn)
IsFrozen
(Inherited from DataGridColumn)
IsReadOnly
(Inherited from DataGridColumn)
IsVisibleDetermines whether or not this column is visible.
(Inherited from DataGridColumn)
Item(AvaloniaProperty)Gets or sets the value of a AvaloniaProperty.
(Inherited from AvaloniaObject)
Item(IndexerDescriptor)Gets or sets a binding for a AvaloniaProperty.
(Inherited from AvaloniaObject)
MaxWidth
(Inherited from DataGridColumn)
MinWidth
(Inherited from DataGridColumn)
OwningGridGets the DataGrid control that contains this column.
(Inherited from DataGridColumn)
SortMemberPathHolds the name of the member to use for sorting, if not using the default.
(Inherited from DataGridColumn)
TagGets or sets an object associated with this column.
(Inherited from DataGridColumn)
Width
(Inherited from DataGridColumn)

Methods

Bind(AvaloniaProperty, IBinding)Binds a AvaloniaProperty to an IBinding.
(Inherited from AvaloniaObject)
Bind(AvaloniaProperty, IObservable(Object), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(T))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(BindingValue(T)))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(Object))Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(T), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(BindingValue(T)), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(Object), BindingPriority)Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
CancelCellEdit(Control, Object)Causes the column cell being edited to revert to the specified value.
(Overrides DataGridColumn.CancelCellEdit(Control, Object))
CheckAccess()Returns a value indicating whether the current thread is the UI thread.
(Inherited from AvaloniaObject)
ClearSort()Clears the current sort direction
(Inherited from DataGridColumn)
ClearValue(AvaloniaProperty)Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValue(T)(AvaloniaProperty(T))Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValue(T)(DirectPropertyBase(T))Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValue(T)(StyledProperty(T))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.
(Inherited from DataGridColumn)
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)
(Inherited from DataGridBoundColumn)
GenerateEditingElementDirect(DataGridCell, Object)Gets a TextBox control that is bound to the column's Binding property value.
(Overrides DataGridBoundColumn.GenerateEditingElementDirect(DataGridCell, Object))
GenerateElement(DataGridCell, Object)Gets a read-only TextBlock element that is bound to the column's Binding property value.
(Overrides DataGridColumn.GenerateElement(DataGridCell, Object))
GetBaseValue(T)(StyledProperty(T))Gets an AvaloniaProperty base value.
(Inherited from AvaloniaObject)
GetCellContent(DataGridRow)
(Inherited from DataGridColumn)
GetCellContent(Object)
(Inherited from DataGridColumn)
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)
GetValue(T)(DirectPropertyBase(T))Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
GetValue(T)(StyledProperty(T))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.
(Inherited from DataGridColumn)
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)
(Overrides DataGridColumn.OnPropertyChanged(AvaloniaPropertyChangedEventArgs))
OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)Called when a avalonia property changes on the object.
(Inherited from AvaloniaObject)
PrepareCellForEdit(Control, RoutedEventArgs)Called when the cell in the column enters editing mode.
(Overrides DataGridColumn.PrepareCellForEdit(Control, RoutedEventArgs))
RaisePropertyChanged(T)(DirectPropertyBase(T), T, T)Raises the PropertyChanged event for a direct property.
(Inherited from AvaloniaObject)
RefreshCellContent(Control, String)Called by the DataGrid control when this column asks for its elements to be updated, because a property changed.
(Overrides DataGridColumn.RefreshCellContent(Control, String))
SetAndRaise(T)(DirectPropertyBase(T), 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)
SetCurrentValue(T)(StyledProperty(T), 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)
SetValue(T)(DirectPropertyBase(T), T)Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
SetValue(T)(StyledProperty(T), T, BindingPriority)Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
Sort()Switches the current state of sort direction
(Inherited from DataGridColumn)
Sort(ListSortDirection)Changes the sort direction of this column
(Inherited from DataGridColumn)
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

HeaderPointerPressedOccurs when the pointer is pressed over the column's header
(Inherited from DataGridColumn)
HeaderPointerReleasedOccurs when the pointer is released over the column's header
(Inherited from DataGridColumn)
PropertyChangedRaised when a AvaloniaProperty value changes on this object.
(Inherited from AvaloniaObject)

Fields

FontFamilyPropertyIdentifies the FontFamily dependency property.
FontSizePropertyIdentifies the FontSize dependency property.
FontStretchPropertyIdentifies the FontStretch dependency property.
FontStylePropertyIdentifies the FontStyle dependency property.
FontWeightPropertyIdentifies the FontWeight dependency property.
ForegroundPropertyIdentifies the Foreground dependency property.

Extension Methods

Bind(AvaloniaProperty, IBinding, Object)Binds a property on an AvaloniaObject to an IBinding.
(Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(BindingValue(T)), BindingPriority)Binds an AvaloniaProperty to an observable.
(Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(T), BindingPriority)Binds an AvaloniaProperty to an observable.
(Defined by AvaloniaObjectExtensions)
GetBaseValue(AvaloniaProperty)Gets an AvaloniaProperty base value.
(Defined by AvaloniaObjectExtensions)
GetBaseValue(T)(AvaloniaProperty(T))Gets an AvaloniaProperty base value.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(AvaloniaProperty)Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(T)(AvaloniaProperty(T))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(TResult)(AvaloniaProperty, Func(Object, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingSubject(AvaloniaProperty, BindingPriority)Gets a subject for a AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetBindingSubject(T)(AvaloniaProperty(T), 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)
GetObservable(T)(AvaloniaProperty(T))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservable(TResult)(AvaloniaProperty, Func(Object, TResult))Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, 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)
GetSubject(T)(AvaloniaProperty(T), BindingPriority)Gets a subject for an AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetValue(T)(AvaloniaProperty(T))Gets a AvaloniaProperty value.
(Defined by AvaloniaObjectExtensions)
GetValueStoreDiagnostic()Gets a value store diagnostics for a AvaloniaObject.
(Defined by AvaloniaObjectExtensions)

See Also

Reference

Avalonia.Controls Namespace