Skip to main content

ITextSearchableColumn<TModel> Interface

Definition

Assembly:Avalonia.Controls.TreeDataGrid
Package:Avalonia.Controls.TreeDataGrid

Defines a column in a Avalonia.Controls.Models.TreeDataGrid that supports text-based searching.

public interface ITextSearchableColumn<TModel>

Remarks

The Avalonia.Controls.Models.TreeDataGrid.ITextSearchableColumn<T> interface is implemented by column types that can participate in text search operations within a TreeDataGrid. This allows users to find rows by typing text that matches content in these columns.

Column implementations like Avalonia.Controls.Models.TreeDataGrid.TextColumn<T1, T2> and Avalonia.Controls.Models.TreeDataGrid.TemplateColumn<T> implement this interface to enable their content to be searched.

For template columns, the Avalonia.Controls.Models.TreeDataGrid.TemplateColumnOptions<T>.TextSearchValueSelector property provides a way to extract searchable text from complex content.

Properties

NameDescription
IsTextSearchEnabledGets a value indicating whether text search is enabled for this column.

IsTextSearchEnabled Property

Gets a value indicating whether text search is enabled for this column.

public bool IsTextSearchEnabled { get; set; }

Remarks

When set to true, the column's content will be included in text search operations. When false, the column will be skipped during text searches.

This property can be configured through column options, such as Avalonia.Controls.Models.TreeDataGrid.TextColumnOptions<T>.IsTextSearchEnabled or Avalonia.Controls.Models.TreeDataGrid.TemplateColumnOptions<T>.IsTextSearchEnabled.