Class TreeGridComboBoxColumn

Represents a column that host the ComboBox and enumeration as its cell content in edit mode.

Inheritance
System.Object
ColumnBase<SfGridBase>
GridColumnBase
TreeGridColumn
TreeGridComboBoxColumn
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class TreeGridComboBoxColumn : TreeGridColumn, IDisposable, IFilterDefinition

Constructors

TreeGridComboBoxColumn()

Initializes a new instance of the TreeGridComboBoxColumn class.

Declaration
public TreeGridComboBoxColumn()

Fields

DisplayMemberPathProperty

Identifies the DisplayMemberPath dependency property.

Declaration
public static readonly DependencyProperty DisplayMemberPathProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the DisplayMemberPath dependency property.

IsEditableProperty

Identifies the IsEditable dependency property.

Declaration
public static readonly DependencyProperty IsEditableProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the IsEditable dependency property.

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the ItemsSource dependency property.

ItemsSourceSelectorProperty

Identifies the ItemsSourceSelector dependency property.

Declaration
public static readonly DependencyProperty ItemsSourceSelectorProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the ItemsSourceSelector dependency property.

ItemTemplateProperty

Identifies the ItemTemplate dependency property.

Declaration
public static readonly DependencyProperty ItemTemplateProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the ItemTemplate dependency property.

SelectedValuePathProperty

Identifies the SelectedValuePath dependency property.

Declaration
public static readonly DependencyProperty SelectedValuePathProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the SelectedValuePath dependency property.

StaysOpenOnEditProperty

Identifies the StaysOpenOnEdit dependency property.

Declaration
public static readonly DependencyProperty StaysOpenOnEditProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the StaysOpenOnEdit dependency property.

TextTrimmingProperty

Identifies the TextTrimming dependency property.

Declaration
public static readonly DependencyProperty TextTrimmingProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the TextTrimming dependency property.

TextWrappingProperty

Identifies the TextWrapping dependency property.

Declaration
public static readonly DependencyProperty TextWrappingProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the TextWrapping dependency property.

Properties

DisplayMemberPath

Gets or sets the path that is used to display the visual representation of object.

Declaration
public string DisplayMemberPath { get; set; }
Property Value
Type Description
System.String

A string that represents the path to display the visual representation of object.

IsEditable

Gets or sets a value that indicates whether the user can edit the cell value by typing through editor of TreeGridComboBoxColumn.

Declaration
public bool IsEditable { get; set; }
Property Value
Type Description
System.Boolean

true if the cell value is edited by typing through the editor of TreeGridComboBoxColumn ; otherwise , false. The default value is false .

ItemsSource

Gets or sets a collection used to generate the content of TreeGridComboBoxColumn.

Declaration
public IEnumerable ItemsSource { get; set; }
Property Value
Type Description
System.Collections.IEnumerable

The collection that is used to generate the content of TreeGridComboBoxColumn. The default value is null.
Examples
<treeGrid:SfTreeGrid x:Name="treeGrid"                              
                       AutoGenerateColumns="False"
                       ChildPropertyName="Children"                             
                       ItemsSource="{Binding Persons}">
   <treeGrid:SfTreeGrid.Columns>
       <treeGrid:TreeGridComboBoxColumn ItemsSource = "{Binding CityCollection, Source={StaticResource viewModel}}"  MappingName="City" />
   </treeGrid:SfTreeGrid.Columns>
</treeGrid:SfTreeGrid>
See Also

ItemsSourceSelector

Gets or Sets the different itemsSource for each row in TreeGridComboBoxColumn.

Declaration
public IItemsSourceSelector ItemsSourceSelector { get; set; }
Property Value
Type Description
IItemsSourceSelector

The itemsSourceSelector that is used to bind a different itemsSource for each row in TreeGridComboBoxColumn.
See Also

ItemTemplate

Gets or sets the Microsoft.UI.Xaml.DataTemplate that is used to display each item in TreeGridComboBoxColumn.

Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.DataTemplate

A Microsoft.UI.Xaml.DataTemplate that is used to display each item in TreeGridComboBoxColumn. The default value is null.

SelectedValuePath

Gets or sets the path that is used to get the SelectedValue from the SelectedItem.

Declaration
public string SelectedValuePath { get; set; }
Property Value
Type Description
System.String

The path that is used to get the SelectedValue from the SelectedItem.

StaysOpenOnEdit

Gets or sets a value that indicates whether a TreeGridComboBoxColumn opens and displays a drop-down control when a user clicks its text area .

Declaration
public bool StaysOpenOnEdit { get; set; }
Property Value
Type Description
System.Boolean

true to keep the drop-down control open when the user clicks on the text area to start editing; otherwise , false . The default value is false.

TextTrimming

Gets or sets a value that indicates the text trimming behavior when content overflows the cell area.

Declaration
public TextTrimming TextTrimming { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.TextTrimming

One of the Microsoft.UI.Xaml.TextTrimming enumeration that specifies text trimming behavior of cell content. The default value is Microsoft.UI.Xaml.TextTrimming.None.
Remarks

Microsoft.UI.Xaml.TextTrimming is applicable for display content alone. When you move to edit mode in ComboBox column, Microsoft.UI.Xaml.TextTrimming will not be applied to Microsoft.UI.Xaml.Controls.ComboBox editor.

TextWrapping

Gets or sets a value that indicates how cell content should be wrapped.

Declaration
public TextWrapping TextWrapping { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.TextWrapping

One of the Microsoft.UI.Xaml.TextWrapping enumeration that specifies wrapping behavior of cell content. The default value is Microsoft.UI.Xaml.TextWrapping.NoWrap.
Remarks

Microsoft.UI.Xaml.TextWrapping is applicable for display content alone. When you move to edit mode in ComboBox column, Microsoft.UI.Xaml.TextWrapping will not be applied to Microsoft.UI.Xaml.Controls.ComboBox editor.

Methods

SetDisplayBindingConverter()

Sets the converter for the DisplayBinding of GridComboBoxColumn.

Declaration
protected override void SetDisplayBindingConverter()
Overrides
Remarks

You can override this method to specify the converter for DisplayBinding .

UpdateBindingBasedOnAllowEditing()

Updates the binding for the AllowEdit property changes in the TreeGridComboBoxColumn.

Declaration
protected override void UpdateBindingBasedOnAllowEditing()
Overrides

Implements

System.IDisposable