TreeDataGridTextColumn Class
Definition
A column in an Avalonia.Controls.TreeDataGridSource which displays its values as text.
public class TreeDataGridTextColumn
Constructors
| Name | Description |
|---|---|
| TreeDataGridTextColumn | Initializes a new instance of the Avalonia.Controls.TreeDataGridTextColumn class with default values for XAML instantiation. |
TreeDataGridTextColumn Constructor
Initializes a new instance of the Avalonia.Controls.TreeDataGridTextColumn class with default values for XAML instantiation.
public TreeDataGridTextColumn()
Methods
| Name | Description |
|---|---|
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Properties
| Name | Description |
|---|---|
| IsTextSearchEnabled | Gets or sets a value indicating whether the column takes part in text searches. |
| TextAlignment | Gets or sets the text alignment mode for the cells in the column. |
| TextTrimming | Gets or sets the text trimming mode for the cells in the column. |
| TextWrapping | Gets or sets the text wrapping mode for the cells in the column. |
| UseDrawnCells | Gets or sets a value indicating whether the column uses drawn cells instead of control-based cells for improved performance. |
| Binding | Gets or sets the binding which selects the column value from the model. Inherited from TreeDataGridBoundColumn. |
| IsReadOnly | Gets or sets a value indicating whether the column is readonly. Inherited from TreeDataGridBoundColumn. |
| ActualWidth | Gets the actual width of the column after measurement. Inherited from TreeDataGridColumn. |
| AllowTriStateSorting | Gets or sets whether the user can cycle through ascending, descending, and unsorted states when clicking the column header. Inherited from TreeDataGridColumn. |
| BeginEditGestures | Gets or sets the gesture(s) that will cause a cell to enter edit mode. Inherited from TreeDataGridColumn. |
| CanUserResize | Gets or sets a value indicating whether the user can resize the column by dragging. Inherited from TreeDataGridColumn. |
| CanUserSort | Gets or sets a value indicating whether the user can sort the column by clicking. Inherited from TreeDataGridColumn. |
| CellRenderer | Gets the cell renderer for this column, or null if the column uses control-based cells. Inherited from TreeDataGridColumn. |
| CompareAscending | Gets or sets a custom comparison for ascending sort order. Inherited from TreeDataGridColumn. |
| CompareDescending | Gets or sets a custom comparison for descending sort order. Inherited from TreeDataGridColumn. |
| Header | Gets or sets the column header. Inherited from TreeDataGridColumn. |
| IsVisible | Gets or sets a value indicating whether the column is visible. Inherited from TreeDataGridColumn. |
| MaxWidth | Gets or sets the maximum width for the column. Inherited from TreeDataGridColumn. |
| MinWidth | Gets or sets the minimum width for the column. Inherited from TreeDataGridColumn. |
| SortDirection | Gets or sets the sort direction indicator that will be displayed on the column. Inherited from TreeDataGridColumn. |
| Tag | Gets or sets a user-defined object attached to the column. Inherited from TreeDataGridColumn. |
| Width | Gets or sets the width of the column. Inherited from TreeDataGridColumn. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
IsTextSearchEnabled Property
Gets or sets a value indicating whether the column takes part in text searches.
public bool IsTextSearchEnabled { get; set; }
TextAlignment Property
Gets or sets the text alignment mode for the cells in the column.
public Avalonia.Media.TextAlignment TextAlignment { get; set; }
TextTrimming Property
Gets or sets the text trimming mode for the cells in the column.
public Avalonia.Media.TextTrimming TextTrimming { get; set; }
TextWrapping Property
Gets or sets the text wrapping mode for the cells in the column.
public Avalonia.Media.TextWrapping TextWrapping { get; set; }
UseDrawnCells Property
Gets or sets a value indicating whether the column uses drawn cells instead of control-based cells for improved performance.
public bool UseDrawnCells { get; set; }
Remarks
When true, the column's cells are rendered directly by the presenter without creating per-cell controls, which can significantly improve performance for large datasets.
Fields
IsTextSearchEnabledProperty Field
Defines the Avalonia.Controls.TreeDataGridTextColumn.IsTextSearchEnabled property.
public Avalonia.StyledProperty<bool> IsTextSearchEnabledProperty
TextAlignmentProperty Field
Defines the Avalonia.Controls.TreeDataGridTextColumn.TextAlignment property.
public Avalonia.StyledProperty<Avalonia.Media.TextAlignment> TextAlignmentProperty
TextTrimmingProperty Field
Defines the Avalonia.Controls.TreeDataGridTextColumn.TextTrimming property.
public Avalonia.StyledProperty<Avalonia.Media.TextTrimming> TextTrimmingProperty
TextWrappingProperty Field
Defines the Avalonia.Controls.TreeDataGridTextColumn.TextWrapping property.
public Avalonia.StyledProperty<Avalonia.Media.TextWrapping> TextWrappingProperty
UseDrawnCellsProperty Field
Defines the Avalonia.Controls.TreeDataGridTextColumn.UseDrawnCells property.
public Avalonia.StyledProperty<bool> UseDrawnCellsProperty
Events
| Name | Description |
|---|---|
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |