DataGridTextColumn Class

Summary

Represents a DataGrid column that hosts textual content in its cells.
Namespace
Avalonia.Controls
Interfaces
Base Types
graph BT Type-->Base0["DataGridBoundColumn"] click Base0 "/api/Avalonia.Controls/DataGridBoundColumn" Base0-->Base1["DataGridColumn"] click Base1 "/api/Avalonia.Controls/DataGridColumn" Base1-->Base2["AvaloniaObject"] click Base2 "/api/Avalonia/AvaloniaObject" Base2-->Base3["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["DataGridTextColumn"] class Type type-node

Syntax

public class DataGridTextColumn : DataGridBoundColumn, IAvaloniaObject, IAvaloniaObjectDebug, 
    INotifyPropertyChanged, IValueSink

Constructors

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

Events

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

Fields

Name Constant Value Summary
FontFamilyProperty
Identifies the FontFamily dependency property.
static
FontSizeProperty
Identifies the FontSize dependency property.
static
FontStyleProperty
Identifies the FontStyle dependency property.
static
FontWeightProperty
Identifies the FontWeight dependency property.
static
ForegroundProperty
Identifies the Foreground dependency property.
static

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.
Inherited from DataGridBoundColumn
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.
Inherited from DataGridBoundColumn
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
FontFamily FontFamily
Gets or sets the font name.
FontSize double
Gets or sets the font size.
FontStyle FontStyle
Gets or sets the font style.
FontWeight FontWeight
Gets or sets the font weight or thickness.
Foreground IBrush
Gets or sets a brush that describes the foreground of the column cells.
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
Causes the column cell being edited to revert to the specified value.
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
Inherited from DataGridBoundColumn
GenerateEditingElementDirect(DataGridCell, object) IControl
Gets a TextBox control that is bound to the column's Binding property value.
GenerateElement(DataGridCell, object) IControl
Gets a read-only TextBlock element that is bound to the column's Binding property value.
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
OnPropertyChanged<T>(AvaloniaPropertyChangedEventArgs<T>) void
PrepareCellForEdit(IControl, RoutedEventArgs) object
Called when the cell in the column enters editing mode.
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

Name Value Summary
Bind(AvaloniaProperty, IObservable<BindingValue<object>>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Bind<T>(AvaloniaProperty<T>, IObservable<BindingValue<T>>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
GetBindingObservable(AvaloniaProperty) IObservable<BindingValue<object>>
Gets an observable for a AvaloniaProperty.
GetBindingObservable<T>(AvaloniaProperty<T>) IObservable<BindingValue<T>>
Gets an observable for a AvaloniaProperty.
GetBindingSubject(AvaloniaProperty, BindingPriority) ISubject<BindingValue<object>>
Gets a subject for a AvaloniaProperty.
GetBindingSubject<T>(AvaloniaProperty<T>, BindingPriority) ISubject<BindingValue<T>>
Gets a subject for a AvaloniaProperty.
GetDiagnostic(AvaloniaProperty) AvaloniaPropertyValue
Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject.
GetObservable(AvaloniaProperty) IObservable<object>
Gets an observable for a AvaloniaProperty.
GetObservable<T>(AvaloniaProperty<T>) IObservable<T>
Gets an observable for a AvaloniaProperty.
GetPropertyChangedObservable(AvaloniaProperty) IObservable<AvaloniaPropertyChangedEventArgs>
Gets an observable that listens for property changed events for an AvaloniaProperty.
GetSubject(AvaloniaProperty, BindingPriority) ISubject<object>
Gets a subject for a AvaloniaProperty.
GetSubject<T>(AvaloniaProperty<T>, BindingPriority) ISubject<T>
Gets a subject for a AvaloniaProperty.