Class TreeGridComboBoxColumn
Represents a column that host the ComboBox and enumeration as its cell content in edit mode.
Inheritance
Inherited Members
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.SfGrid.WPF.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 Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.DisplayMemberPath dependency property.
Declaration
public static readonly DependencyProperty DisplayMemberPathProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.DisplayMemberPath dependency property.
IsEditableProperty
Identifies the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.IsEditable dependency property.
Declaration
public static readonly DependencyProperty IsEditableProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.IsEditable dependency property.
ItemsSourceProperty
Identifies the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.ItemsSource dependency property.
Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.ItemsSource dependency property.
ItemsSourceSelectorProperty
Identifies the ItemsSourceSelector dependency property.
Declaration
public static readonly DependencyProperty ItemsSourceSelectorProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the ItemsSourceSelector dependency property.
ItemTemplateProperty
Identifies the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.ItemTemplate dependency property.
Declaration
public static readonly DependencyProperty ItemTemplateProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.ItemTemplate dependency property.
SelectedValuePathProperty
Identifies the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.SelectedValuePath dependency property.
Declaration
public static readonly DependencyProperty SelectedValuePathProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.SelectedValuePath dependency property.
StaysOpenOnEditProperty
Identifies the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.StaysOpenOnEdit dependency property.
Declaration
public static readonly DependencyProperty StaysOpenOnEditProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.StaysOpenOnEdit dependency property.
TextDecorationsProperty
Identifies the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.TextDecorations dependency property.
Declaration
public static readonly DependencyProperty TextDecorationsProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.TextDecorations dependency property.
TextTrimmingProperty
Identifies the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.TextTrimming dependency property.
Declaration
public static readonly DependencyProperty TextTrimmingProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.TextTrimming dependency property.
TextWrappingProperty
Identifies the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.TextWrapping dependency property.
Declaration
public static readonly DependencyProperty TextWrappingProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Remarks
The identifier for the Syncfusion.UI.Xaml.TreeGrid.TreeGridComboBoxColumn.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. |
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. |
ItemTemplate
Gets or sets the System.Windows.DataTemplate that is used to display each item in TreeGridComboBoxColumn.
Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.DataTemplate | A System.Windows.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 that 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. |
TextDecorations
Gets or sets a value that indicates a System.Windows.TextDecorationCollection that contains the effects to apply to the cell content.
Declaration
public TextDecorationCollection TextDecorations { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.TextDecorationCollection | One of the System.Windows.TextDecorationCollection enumeration that specifies effects to apply to the cell content. The default value is null. |
Remarks
System.Windows.TextDecorations is applicable for display content alone. When you move to edit mode in ComboBox column, System.Windows.TextDecorations will not be applied to System.Windows.Controls.ComboBox editor.
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 |
---|---|
System.Windows.TextTrimming | One of the System.Windows.TextTrimming enumeration that specifies text trimming behavior of cell content. The default value is System.Windows.TextTrimming.None. |
Remarks
System.Windows.TextTrimming is applicable for display content alone. When you move to edit mode in ComboBox column, System.Windows.TextTrimming will not be applied to System.Windows.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 |
---|---|
System.Windows.TextWrapping | One of the System.Windows.TextWrapping enumeration that specifies wrapping behavior of cell content. The default value is System.Windows.TextWrapping.NoWrap. |
Remarks
System.Windows.TextWrapping is applicable for display content alone. When you move to edit mode in ComboBox column, System.Windows.TextWrapping will not be applied to System.Windows.Controls.ComboBox editor.
Methods
SetDisplayBindingConverter()
Sets the converter for the
Declaration
protected override void SetDisplayBindingConverter()
Overrides
Remarks
You can override this method to specify the converter for
UpdateBindingBasedOnAllowEditing()
Updates the binding for the AllowEdit property changes in the TreeGridComboBoxColumn.
Declaration
protected override void UpdateBindingBasedOnAllowEditing()