Class SfTextBoxExt
Text box class
Namespace: Syncfusion.Windows.Controls.Input
Assembly: Syncfusion.SfInput.Wpf.dll
Syntax
public class SfTextBoxExt : TextBox, IDisposable, ITextInputLayoutSelector
Remarks
The TextBoxExt is inherited from Windows.UI.Xaml.Controls.TextBox.
Constructors
SfTextBoxExt()
Initializes a new instance of the SfTextBoxExt class.
Declaration
public SfTextBoxExt()
Fields
AllowPointerEventsProperty
Using a DependencyProperty as the backing store for AllowPointerEvents. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty AllowPointerEventsProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AutoCompleteItemsPanelProperty
Using a DependencyProperty as the backing store for AutoCompleteItemsPanel. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty AutoCompleteItemsPanelProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AutoCompleteItemTemplateProperty
Using a DependencyProperty as the backing store for AutoCompleteItemTemplate. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty AutoCompleteItemTemplateProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AutoCompleteItemTemplateSelectorProperty
Using a DependencyProperty as the backing store for AutoCompleteItemTemplateSelector. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty AutoCompleteItemTemplateSelectorProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AutoCompleteModeProperty
Using a DependencyProperty as the backing store for AutoCompleteMode. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty AutoCompleteModeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AutoCompleteSourceProperty
Using a DependencyProperty as the backing store for AutoCompleteSource. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty AutoCompleteSourceProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
AutoHighlightMatchedItemProperty
Declaration
public static readonly DependencyProperty AutoHighlightMatchedItemProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
DelimiterProperty
Using a DependencyProperty as the backing store for Delimiter. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty DelimiterProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
DropDownBackgroundProperty
Identifies the DropDownBackground dependency property.
Declaration
public static readonly DependencyProperty DropDownBackgroundProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
This property can be used to provide background for suggestion box.
EnableAutoSizeProperty
Using a DependencyProperty as the backing store for EnableAutoSize. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty EnableAutoSizeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Filter
Returns a SuggestionPredicate on filtering
Declaration
public SfTextBoxExt.SuggestionPredicate<object> Filter
Field Value
| Type |
|---|
| SfTextBoxExt.SuggestionPredicate<System.Object> |
HighlightedTextColorProperty
HighlightedTextColor property. This property can be used to change the text color of the highlighted character.
Declaration
public static readonly DependencyProperty HighlightedTextColorProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
HighlightedTextStyleProperty
Declaration
public static readonly DependencyProperty HighlightedTextStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
IgnoreCaseProperty
Using a DependencyProperty as the backing store for IgnoreCase. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty IgnoreCaseProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
IgnoreDiacriticProperty
IgnoreDiacritic property. This property indicates whether the diacritic is enabled or not in the AutoComplete control.
Declaration
public static readonly DependencyProperty IgnoreDiacriticProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ImageMemberPathProperty
Using a DependencyProperty as the backing store for TokenIconPath. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty ImageMemberPathProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
IsSuggestionOpenProperty
Using a DependencyProperty as the backing store for IsSuggestionOpen. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty IsSuggestionOpenProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
MaxDropDownHeightProperty
Using a DependencyProperty as the backing store for MaxDropDownHeight. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty MaxDropDownHeightProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
MaximumSuggestionsCountProperty
Declaration
public static readonly DependencyProperty MaximumSuggestionsCountProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
MinimumPrefixCharactersProperty
Using a DependencyProperty as the backing store for MinimumPrefixCharacters. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty MinimumPrefixCharactersProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
MultiSelectModeProperty
Using a DependencyProperty as the backing store for Autocompletetype. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty MultiSelectModeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
NoResultsFoundTemplateProperty
Using a DependencyProperty as the backing store for NoResultsFoundTemplate. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty NoResultsFoundTemplateProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
PopupDelayProperty
Using a DependencyProperty as the backing store for PopupDelay. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty PopupDelayProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SearchItemPathProperty
Using a DependencyProperty as the backing store for SearchItemPath. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SearchItemPathProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SelectedItemProperty
Using a DependencyProperty as the backing store for SelectedItem. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SelectedItemProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SelectedItemsProperty
Identifies the SelectedItems dependency property.
Declaration
public static readonly DependencyProperty SelectedItemsProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
This property is meant to be used when MultiSelectMode does not equal None. If the selection mode is None the correct property to use is SelectedItem
SelectedValueProperty
Using a DependencyProperty as the backing store for SelectedValue. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SelectedValueProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SelectionBackgroundColorProperty
Declaration
public static readonly DependencyProperty SelectionBackgroundColorProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ShowClearButtonProperty
Identifies the ShowClearButton dependency property.
Declaration
public static readonly DependencyProperty ShowClearButtonProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
true if clear button is showed; otherwise, false.The default value is false.
ShowDropDownButtonProperty
Using a DependencyProperty as the backing store for ShowDropDownButton. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty ShowDropDownButtonProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ShowSuggestionsOnFocusProperty
Using a DependencyProperty as the backing store for ShowSuggestionsOnFocus. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty ShowSuggestionsOnFocusProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SuggestionBoxPlacementProperty
Using a DependencyProperty as the backing store for AutoCompleteMode. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SuggestionBoxPlacementProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SuggestionBoxPositionProperty
Using a DependencyProperty as the backing store for SuggestionBoxPosition. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SuggestionBoxPositionProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SuggestionBoxStyleProperty
Using a DependencyProperty as the backing store for SuggestionBoxStyle. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SuggestionBoxStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SuggestionIndexProperty
Using a DependencyProperty as the backing store for SuggestionIndex. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SuggestionIndexProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SuggestionModeProperty
Using a DependencyProperty as the backing store for AutoCompleteMode. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SuggestionModeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SuggestionsProperty
Using a DependencyProperty as the backing store for Suggestions. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty SuggestionsProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
TextHighlightModeProperty
TextHighlightMode property. This property can be used to highlight whether the first character or all same character in text.
Declaration
public static readonly DependencyProperty TextHighlightModeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
TokensWrapModeProperty
Using a DependencyProperty as the backing store for TokenLayoutMode. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty TokensWrapModeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
ValueMemberPathProperty
Using a DependencyProperty as the backing store for ValueMemberPath. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty ValueMemberPathProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
WatermarkProperty
Using a DependencyProperty as the backing store for Watermark. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty WatermarkProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
WatermarkTemplateProperty
Using a DependencyProperty as the backing store for WatermarkTemplate. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty WatermarkTemplateProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
WatermarkTemplateSelectorProperty
Using a DependencyProperty as the backing store for WatermarkTemplateSelector. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty WatermarkTemplateSelectorProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Properties
AllowPointerEvents
Gets or sets a value indicating whether true or false.
Declaration
public bool AllowPointerEvents { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
AutoCompleteItemsPanel
Gets or sets Windows.UI.Xaml.Controls.ItemsPanelTemplate that defines the panel to use for the layout of the items.
Declaration
public ItemsPanelTemplate AutoCompleteItemsPanel { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Controls.ItemsPanelTemplate | The default value is null. |
See Also
AutoCompleteItemTemplate
Gets or sets the Windows.UI.Xaml.Controls.DataTemplate that is used to display the content of the suggestion items with auto complete.
Declaration
public DataTemplate AutoCompleteItemTemplate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.DataTemplate | The default value is null. |
See Also
AutoCompleteItemTemplateSelector
Gets or sets a selection object that changes the DataTemplate to apply for content, based on processing information about the content item or its container at run time.
Declaration
public DataTemplateSelector AutoCompleteItemTemplateSelector { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Controls.DataTemplateSelector | The default value is null. |
AutoCompleteMode
Gets or sets Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.AutoCompleteMode that display the Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions in several ways.
Declaration
public AutoCompleteMode AutoCompleteMode { get; set; }
Property Value
| Type | Description |
|---|---|
| AutoCompleteMode | The default value is Syncfusion.UI.Xaml.Controls.Input.AutoCompleteMode.None. |
AutoCompleteSource
Gets or sets an IEnumerable source used to generate the content of the AutoComplete
Declaration
public IEnumerable AutoCompleteSource { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.IEnumerable | The auto complete source. |
Remarks
The default value is null.
AutoHighlightMatchedItem
Declaration
public bool AutoHighlightMatchedItem { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Delimiter
Gets or sets a string as a delimiter
Declaration
public string Delimiter { get; set; }
Property Value
| Type |
|---|
| System.String |
DropDownBackground
Gets or sets a value of suggestion box background.
Declaration
public Brush DropDownBackground { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
EnableAutoSize
Gets or sets whether to autosize the control based on selected items. Syncfusion.UI.Xaml.Controls.Input.SfTextBoxExt
Declaration
public bool EnableAutoSize { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Remarks
The EnableAutoSize property indicates whether auto size are enabled for a specified control. When the EnableAutoSize property is true the size will change based of Maximum Height property.
HighlightedTextColor
Gets or sets the value of the HighlightedTextColor. This property can be used to change the text color of highlighted character.
Declaration
public Brush HighlightedTextColor { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
HighlightedTextStyle
Gets or sets the style applied for the text that is highlighted based on the TextHighlightMode.
Declaration
public Style HighlightedTextStyle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Style | The style that is applied to the selected drop down item in SfTextBoxExt. The default value is null. |
IgnoreCase
Gets or sets a value indicating whether to consider the lower or upper case letters for suggestions.
Declaration
public bool IgnoreCase { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Remarks
The default value is false.
IgnoreDiacritic
Gets or sets a value that indicates whether the diacritic is enabled or not in the
Declaration
public bool IgnoreDiacritic { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
ImageMemberPath
Gets or sets a value that indicates the image member path of the selected token.
Declaration
public string ImageMemberPath { get; set; }
Property Value
| Type |
|---|
| System.String |
Remarks
The ImageMemberPath property specifies the path to the property that is used to determine the image of the Token. If the ImageMemberPath was null then image not shown in the Token.
IsSuggestionOpen
Gets or sets a value indicating whether this instance is Syncfusion.UI.Xaml.Controls.Input.SuggestionBox open.
Declaration
public bool IsSuggestionOpen { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
See Also
MaxDropDownHeight
Gets or sets the height of the Syncfusion.UI.Xaml.Controls.Input.SuggestionBox.
Declaration
public double MaxDropDownHeight { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Double | The default values is 200. |
MaximumSuggestionsCount
Gets or sets a value indicating whether to rectrict the number of filtered items should be shown in the dropdown.
Declaration
public int MaximumSuggestionsCount { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The maximum number of suggestions. The default value is -1. |
Remarks
If we have 500 items matching search criteria and MaximumSuggestionsCount is 100, the first 100 items will be displayed over 500 matching items.
MinimumPrefixCharacters
Gets or sets the minimum number of prefix characters.
Declaration
public int MinimumPrefixCharacters { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
MultiSelectMode
Specifies the selection mode and UI of the TextBoxExt
Declaration
public MultiSelectMode MultiSelectMode { get; set; }
Property Value
| Type |
|---|
| MultiSelectMode |
NoResultsFoundTemplate
Gets or sets a value that indicates the template of no results found entered text is not in datasource.
Declaration
public DataTemplate NoResultsFoundTemplate { get; set; }
Property Value
| Type |
|---|
| System.Windows.DataTemplate |
Remarks
You can show the new template when the entered text is not in datasource.
PopupDelay
Gets or sets the delay in popup
Declaration
public TimeSpan PopupDelay { get; set; }
Property Value
| Type |
|---|
| System.TimeSpan |
SearchItemPath
Gets or sets the search item path is used to search the Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions.
Declaration
public string SearchItemPath { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | The default value is null. |
See Also
SelectedItem
Gets or sets currently selected item in the TextBoxExt Syncfusion.UI.Xaml.Controls.Input.SfTextBoxExt
Declaration
public object SelectedItem { get; set; }
Property Value
| Type |
|---|
| System.Object |
Remarks
When you set the SelectedItem property to an object, the TextBoxExt attempts to make that object the currently selected one in the list. If the object is found in the list, it is displayed in the edit portion of the TextBoxExt and the SuggestionIndex property is set to the corresponding index. If the object does not exist in the list, the SuggestionIndex property is left at -1 value.
SelectedItems
Gets or sets the currently selected items from the AutoCompleteSource API.
Declaration
public IEnumerable SelectedItems { get; set; }
Property Value
| Type |
|---|
| System.Collections.IEnumerable |
Remarks
This property is meant to be used when MultiSelectMode does not equal None. If the selection mode is None the correct property to use is SelectedItem
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | The MultiSelectMode property is set to None. |
SelectedValue
Gets or sets the value of the SelectedItem obtained by using ValueMemberPath. Syncfusion.UI.Xaml.Controls.Input.SfTextBoxExt
Declaration
public object SelectedValue { get; set; }
Property Value
| Type |
|---|
| System.Object |
Remarks
The ValueMemberPath property specifies the path to the property that is used to determine the value of the SelectedValue property.Setting SelectedValue to a value X attempts to select an item whose value evaluates to X; if no such item can be found, the selection is cleared.If the ValueMemberPath was null then SelectedItem will set on SelectedValue.
SelectionBackgroundColor
Gets or sets a brush that specifies the background color for the selected item in the drop down.
Declaration
public Brush SelectionBackgroundColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Media.Brush | The brush used to apply to the selected item in the drop down. The default value is System.Drawing.Color.Transparent. |
See Also
ShowClearButton
Gets or sets a value that indicates whether to show the clear button.
Declaration
public bool ShowClearButton { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | true if clear button is showed; otherwise, false.The default value is false. |
Remarks
For Token mode the selected token and entered text was cleared.
See Also
ShowDropDownButton
Gets or sets a value indicating whether to show dropdown button. Dropdown button used to open suggestions.
Declaration
public bool ShowDropDownButton { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
ShowSuggestionsOnFocus
Gets or sets a value indicating whether true or false.
Declaration
public bool ShowSuggestionsOnFocus { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
SuggestionBoxPlacement
Gets or sets the Syncfusion.UI.Xaml.Controls.Input.SuggestionBoxPlacement to display the Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions.
Declaration
public SuggestionBoxPlacement SuggestionBoxPlacement { get; set; }
Property Value
| Type | Description |
|---|---|
| SuggestionBoxPlacement | The default value is Syncfusion.UI.Xaml.Controls.Input.SuggestionBoxPlacement.Bottom. |
See Also
SuggestionBoxPosition
Gets the Windows.Foundation.Point that position the Syncfusion.UI.Xaml.Controls.Input.SuggestionBox.
Declaration
public Point SuggestionBoxPosition { get; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Point | The default values is null. |
See Also
SuggestionBoxStyle
Gets or sets the style with Syncfusion.UI.Xaml.Controls.Input.SuggestionBox.
Declaration
public Style SuggestionBoxStyle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Style | The default values is null. |
See Also
SuggestionIndex
Gets the index of the suggestion.
Declaration
public int SuggestionIndex { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | The default values is 0. |
See Also
SuggestionMode
Gets or sets the Syncfusion.UI.Xaml.Controls.Input.SuggestionMode to filter the Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions
Declaration
public SuggestionMode SuggestionMode { get; set; }
Property Value
| Type | Description |
|---|---|
| SuggestionMode | The suggestion mode. |
See Also
Suggestions
Gets the currently filtered items from the AutoCompleteSource API.
Declaration
public ObservableCollection<object> Suggestions { get; }
Property Value
| Type |
|---|
| System.Collections.ObjectModel.ObservableCollection<System.Object> |
TextHighlightMode
Gets or sets the value of TextHighlightMode. This property can be used to highlight whether the first character or all same character in text.
Declaration
public OccurrenceMode TextHighlightMode { get; set; }
Property Value
| Type | Description |
|---|---|
| OccurrenceMode | The default text highlight mode is none. |
TokensWrapMode
Gets or sets a value that indicates the token arrangement in SfTextBoxExt.
Declaration
public TokensWrapMode TokensWrapMode { get; set; }
Property Value
| Type |
|---|
| TokensWrapMode |
Remarks
You can arrange a Token by setting the TokensWrapMode property.
ValueMemberPath
Gets or sets the path that is used to get the SelectedValue from the SelectedItem.
Declaration
public string ValueMemberPath { get; set; }
Property Value
| Type |
|---|
| System.String |
Remarks
The ValueMemberPath property specifies the path to the property that is used to determine the value of the SelectedValue property. If the ValueMemberPath was null then SelectedItem will set on SelectedValue property.
Watermark
Gets or sets the content displayed as a watermark in the Syncfusion.UI.Xaml.Controls.Input.TextBoxExt when it is empty.
Declaration
public object Watermark { get; set; }
Property Value
| Type |
|---|
| System.Object |
See Also
WatermarkTemplate
Gets or sets the Windows.UI.Xaml.DataTemplate used to display the Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Watermark of the Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.
Declaration
public DataTemplate WatermarkTemplate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.DataTemplate | The Default value is null. |
See Also
WatermarkTemplateSelector
Gets or sets a value to Provides a way to choose a Windows.UI.Xaml.Controls.DataTemplateSelector based on the data object and the data-bound Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.
Declaration
public DataTemplateSelector WatermarkTemplateSelector { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Controls.DataTemplateSelector | The default value is null. |
See Also
Methods
Dispose()
Method for disposing unwanted objects
Declaration
public void Dispose()
Dispose(Boolean)
Dispose method
Declaration
protected virtual void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing | boolean type |
FilterSuggestions()
Filters the Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions based the text.
Declaration
public void FilterSuggestions()
Remarks
The Return value is void.
OnApplyTemplate()
Initialize all the child elements of Syncfusion.UI.Xaml.Controls.Input.TextBoxExt control.
Declaration
public override void OnApplyTemplate()
OnAutoCompleteSourceChanged(DependencyObject, DependencyPropertyChangedEventArgs)
Invoked when the AutoCompleteSource has changed.
Declaration
public static void OnAutoCompleteSourceChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | Dependency object |
| System.Windows.DependencyPropertyChangedEventArgs | args | dependency property changed event args |
OnDelimiterChanged(DependencyObject, DependencyPropertyChangedEventArgs)
Invoked when the Delimiter has changed.
Declaration
public static void OnDelimiterChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | Dependency object |
| System.Windows.DependencyPropertyChangedEventArgs | args | dependency property changed event args |
OnDelimiterChanged(DependencyPropertyChangedEventArgs)
Prepares the text when the Delimiter has changed.
Declaration
protected void OnDelimiterChanged(DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | args | Dependency property changed event args |
OnGotFocus(RoutedEventArgs)
Occurs when focus is obtained.
Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.RoutedEventArgs | e | Routed event args |
OnIsSuggestionOpenChanged(DependencyObject, DependencyPropertyChangedEventArgs)
Occurs when the IsSuggestionOpen has changed.
Declaration
public static void OnIsSuggestionOpenChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | Dependency object |
| System.Windows.DependencyPropertyChangedEventArgs | args | dependency property changed event args |
OnIsSuggestionOpenChanged(DependencyPropertyChangedEventArgs)
Occurs when the IsSuggestionOpen has changed.
Declaration
protected void OnIsSuggestionOpenChanged(DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | args | Dependency property changed event args |
OnLostFocus(RoutedEventArgs)
Occurs when focus is lost.
Declaration
protected override void OnLostFocus(RoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.RoutedEventArgs | e | Routed event args |
OnMinimumPrefixCharactersChanged(DependencyObject, DependencyPropertyChangedEventArgs)
Occurs when the value of MinimumPrefixCharacters have changed
Declaration
public static void OnMinimumPrefixCharactersChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | Dependency object type |
| System.Windows.DependencyPropertyChangedEventArgs | args | Dependency property changed event args |
OnMouseDown(MouseButtonEventArgs)
Occurs when the pointer is pressed
Declaration
protected override void OnMouseDown(MouseButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseButtonEventArgs | e | Pointer Routed event args |
OnMouseUp(MouseButtonEventArgs)
Occurs when the pointer is released
Declaration
protected override void OnMouseUp(MouseButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseButtonEventArgs | e | Mouse button event args |
OnPreviewKeyDown(KeyEventArgs)
Occurs when the key is pressed
Declaration
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.KeyEventArgs | e | key event args |
OnSelectedItemChanged(DependencyObject, DependencyPropertyChangedEventArgs)
Occurs when the Selected Item has changed.
Declaration
public static void OnSelectedItemChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | Dependency object |
| System.Windows.DependencyPropertyChangedEventArgs | args | Dependency property changed event args |
OnSelectedItemChanged(DependencyPropertyChangedEventArgs)
Occurs when the Selected Item has changed.
Declaration
protected void OnSelectedItemChanged(DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | args | Dependency property changed event args |
OnSelectedItemsChanged(DependencyPropertyChangedEventArgs)
Occurs when the Selected Items has changed.
Declaration
protected void OnSelectedItemsChanged(DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | args | Dependency property changed event args |
OnSuggestionsChanged(DependencyObject, DependencyPropertyChangedEventArgs)
Occurs when the Suggestions have changed.
Declaration
public static void OnSuggestionsChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj | Dependency object |
| System.Windows.DependencyPropertyChangedEventArgs | args | Dependency property changed event args |
OnSuggestionsChanged(DependencyPropertyChangedEventArgs)
Occurs when the Suggestions have changed.
Declaration
protected void OnSuggestionsChanged(DependencyPropertyChangedEventArgs args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyPropertyChangedEventArgs | args | Dependency property changed event args |
Events
SelectedItemChanged
Occurs when Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions changed.
Declaration
public event PropertyChangedCallback SelectedItemChanged
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |
SuggestionPopupClosed
Occurs when suggestion box popup is closed. Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.IsSuggestionOpen
Declaration
public event PropertyChangedCallback SuggestionPopupClosed
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |
SuggestionPopupOpened
Occurs when suggestion box popup is opened.
Declaration
public event PropertyChangedCallback SuggestionPopupOpened
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |
See Also
SuggestionsChanged
Occurs when Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions changed.
Declaration
public event PropertyChangedCallback SuggestionsChanged
Event Type
| Type |
|---|
| System.Windows.PropertyChangedCallback |
Explicit Interface Implementations
ITextInputLayoutSelector.GetSelectedItems()
Method used to get selected items of InputView.
Declaration
IEnumerable ITextInputLayoutSelector.GetSelectedItems()
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerable | Returns IEnumerable collection, that represents items selected in InputView. |
ITextInputLayoutSelector.IsDropDownOpen
Boolean value that used to set InputView's drop down state.
Declaration
bool ITextInputLayoutSelector.IsDropDownOpen { get; set; }
Returns
| Type |
|---|
| System.Boolean |
ITextInputLayoutSelector.IsTextInputLayoutChild
Boolean value that indicates the parent is SfTextInputLayout or not.
Declaration
bool ITextInputLayoutSelector.IsTextInputLayoutChild { get; set; }
Returns
| Type |
|---|
| System.Boolean |