Class SfTextBoxExt

Text box class

Inheritance

System.Object

SfTextBoxExt

SfMaskedEdit

SfNumericTextBox

Implements

IDataValidator

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Controls.Input

Assembly: Syncfusion.SfInput.UWP.dll

Syntax

public class SfTextBoxExt : TextBox, IDataValidator, IDisposable

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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

DropDownBackgroundProperty

Identifies the dependency property.

Declaration

public static readonly DependencyProperty DropDownBackgroundProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Remarks

This property can be used to provide background for suggestion box.

DropDownCornerRadiusProperty

Using a DependencyProperty as the backing store for DropDownCornerRadius. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DropDownCornerRadiusProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

DropDownFooterViewHeightProperty

Using a DependencyProperty as the backing store for FooterHeight. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DropDownFooterViewHeightProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

DropDownFooterViewProperty

Using a DependencyProperty as the backing store for FooterTemplate. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DropDownFooterViewProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

DropDownHeaderViewHeightProperty

Using a DependencyProperty as the backing store for HeaderHeight. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DropDownHeaderViewHeightProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

DropDownHeaderViewProperty

Using a DependencyProperty as the backing store for HeaderTemplate. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty DropDownHeaderViewProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

EnableSelectionIndicatorProperty

Using a DependencyProperty as the backing store for EnableSelectionIndicator. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty EnableSelectionIndicatorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Filter

Returns a SuggestionPredicate on filtering

Declaration

public SfTextBoxExt.SuggestionPredicate<object> Filter

Field Value

Type
SfTextBoxExt.SuggestionPredicate<System.Object>

FilteredItemsProperty

Using a DependencyProperty as the backing store for FilteredItems. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty FilteredItemsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

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
Windows.UI.Xaml.DependencyProperty

HighlightedTextFontStyleProperty

HighlightedTextFontStyle property. This property can be used to set the font style of the MatchingText in the drop-down.

Declaration

public static readonly DependencyProperty HighlightedTextFontStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HighlightedTextFontWeightProperty

HighlightedTextFontWeight property. This property can be used to set the font weight of the MatchingText in the drop-down.

Declaration

public static readonly DependencyProperty HighlightedTextFontWeightProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

IsFocusedProperty

Using a DependencyProperty as the backing store for IsFocused. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty IsFocusedProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IsSelectedItemsVisibleInDropDownProperty

Using a DependencyProperty as the backing store for IsSelectedItemVisibleInDropDown. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty IsSelectedItemsVisibleInDropDownProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

LoadMoreTextProperty

Using a DependencyProperty as the backing store for LoadMoreText. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LoadMoreTextProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

MaximumSuggestionProperty

// Using a DependencyProperty as the backing store for MaximumSuggestion. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty MaximumSuggestionProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

NoResultsFoundTextProperty

Declaration

public static readonly DependencyProperty NoResultsFoundTextProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

SelectedItemsProperty

Identifies the dependency property.

Declaration

public static readonly DependencyProperty SelectedItemsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Remarks

This property is meant to be used when does not equal . If the selection mode is the correct property to use is

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
Windows.UI.Xaml.DependencyProperty

ShowBorderProperty

Using a DependencyProperty as the backing store for IsVisible. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ShowBorderProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowClearButtonProperty

Using a DependencyProperty as the backing store for ShowClearButton. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ShowClearButtonProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowDropDownFooterViewProperty

Using a DependencyProperty as the backing store for ShowFooter. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ShowDropDownFooterViewProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowDropDownHeaderViewProperty

Declaration

public static readonly DependencyProperty ShowDropDownHeaderViewProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

SuggestionItemFontFamilyProperty

Using a DependencyProperty as the backing store for SuggestionItemFontFamily. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SuggestionItemFontFamilyProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SuggestionItemFontSizeProperty

Using a DependencyProperty as the backing store for SuggestionItemFontSize. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SuggestionItemFontSizeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SuggestionItemFontStyleProperty

Using a DependencyProperty as the backing store for SuggestionItemFontStyle. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SuggestionItemFontStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SuggestionItemFontWeightProperty

Using a DependencyProperty as the backing store for SuggestionItemFontWeight. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SuggestionItemFontWeightProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SuggestionItemForegroundProperty

Using a DependencyProperty as the backing store for SuggestionItemForeground. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SuggestionItemForegroundProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SuggestionItemHeightProperty

Using a DependencyProperty as the backing store for SuggestionItemHeight. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SuggestionItemHeightProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

TokenSettingsProperty

Using a DependencyProperty as the backing store for TokenSettings. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty TokenSettingsProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyProperty

WatermarkForegroundProperty

Using a DependencyProperty as the backing store for WatermarkForeground. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty WatermarkForegroundProperty

Field Value

Type
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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	`true` if instance is created ; otherwise, `false`.

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
Windows.UI.Xaml.Controls.ItemsPanelTemplate	The default value is null.

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
Windows.UI.Xaml.DataTemplate	The default value is null.

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
Windows.UI.Xaml.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 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.

Delimiter

Gets or sets a string as a delimiter The optimal value for Delimiter is any single character.

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
Windows.UI.Xaml.Media.Brush

DropDownCornerRadius

Gets or sets the corner radius for the drop down. Optimal value is between 0.0 and 5.0.

Declaration

public double DropDownCornerRadius { get; set; }

Property Value

Type
System.Double

DropDownFooterView

DropDownFooterView object.

Declaration

public object DropDownFooterView { get; set; }

Property Value

Type
System.Object

DropDownFooterViewHeight

DropDownFooterViewHeight object.

Declaration

public double DropDownFooterViewHeight { get; set; }

Property Value

Type
System.Double

DropDownHeaderView

DropDownHeaderView object.

Declaration

public object DropDownHeaderView { get; set; }

Property Value

Type
System.Object

DropDownHeaderViewHeight

DropDownHeaderViewHeight object.

Declaration

public double DropDownHeaderViewHeight { get; set; }

Property Value

Type
System.Double

EnableSelectionIndicator

Gets or Sets the value of EnableSelectionIndicator

Declaration

public bool EnableSelectionIndicator { get; set; }

Property Value

Type
System.Boolean

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
Windows.UI.Xaml.Media.Brush

HighlightedTextFontStyle

Gets or sets the highlighting font style for matched characters in suggestion list

Declaration

public FontStyle HighlightedTextFontStyle { get; set; }

Property Value

Type
Windows.UI.Text.FontStyle

HighlightedTextFontWeight

Gets or sets the highlighting font weight for matched characters in suggestion list

Declaration

public FontWeight HighlightedTextFontWeight { get; set; }

Property Value

Type
Windows.UI.Text.FontWeight

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	`true` if suggestions are displayed by typed letter case ; otherwise, `false`.

Remarks

The default value is false.

IgnoreDiacritic

Gets or sets a value that indicates whether the diacritic is enabled or not in the control.

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.

IsFocused

Gets or sets a value indicating whether the control is focused.

Clearing focus by setting value 'false' to this property is not allowed due to the following limitation. You can't remove focus from a control by calling Control.Focus(FocusState) method with Unfocused as the parameter. This value is not allowed and causes an exception. To remove focus from a control, set focus to a different control.

Declaration

public bool IsFocused { get; set; }

Property Value

Type
System.Boolean

IsSelectedItemsVisibleInDropDown

Gets or sets whether to show or hide the selected items in the suggestion box.

Declaration

public bool IsSelectedItemsVisibleInDropDown { get; set; }

Property Value

Type
System.Boolean

IsSuggestionOpen

Gets or sets a value indicating whether this instance is SuggestionBox open.

Declaration

public bool IsSuggestionOpen { get; set; }

Property Value

Type	Description
System.Boolean	`true` if this instance is suggestion open; otherwise, `false`. The default value is false.

LoadMoreText

LoadMoreText property

Declaration

public string LoadMoreText { get; set; }

Property Value

Type
System.String

MaxDropDownHeight

Gets or sets the height of the SuggestionBox.

Declaration

public double MaxDropDownHeight { get; set; }

Property Value

Type	Description
System.Double	The default values is 200.

MaximumSuggestion

Gets or sets a value indicating MaximumSuggestion in suggestionbox.

Declaration

public int MaximumSuggestion { get; set; }

Property Value

Type
System.Int32

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

NoResultsFoundText

Gets or sets a value of NoResultsFound text.

Declaration

public string NoResultsFoundText { get; set; }

Property Value

Type
System.String

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.

SelectedItem

Gets or sets currently selected item in the TextBoxExt 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 API.

Declaration

public IEnumerable SelectedItems { get; set; }

Property Value

Type
System.Collections.IEnumerable

Remarks

This property is meant to be used when does not equal . If the selection mode is the correct property to use is

Exceptions

Type	Condition
System.InvalidOperationException	The property is set to .

SelectedValue

Gets or sets the value of the SelectedItem obtained by using ValueMemberPath. 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.

ShowBorder

Gets or sets ShowBorder.

Declaration

public bool ShowBorder { get; set; }

Property Value

Type
System.Boolean

ShowClearButton

Gets or sets a value indicating whether the clear button is shown.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type
System.Boolean

ShowDropDownFooterView

Gets or sets ShowDropDownFooterView.

Declaration

public bool ShowDropDownFooterView { get; set; }

Property Value

Type
System.Boolean

ShowDropDownHeaderView

Gets or sets ShowDropDownHeaderView.

Declaration

public bool ShowDropDownHeaderView { 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 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 Bottom.

SuggestionBoxPosition

Gets the Windows.Foundation.Point that position the SuggestionBox.

Declaration

public Point SuggestionBoxPosition { get; }

Property Value

Type	Description
Windows.Foundation.Point	The default values is null.

SuggestionBoxStyle

Gets or sets the style with SuggestionBox.

Declaration

public Style SuggestionBoxStyle { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Style	The default values is null.

SuggestionIndex

Gets the index of the suggestion.

Declaration

public int SuggestionIndex { get; }

Property Value

Type	Description
System.Int32	The default values is 0.

SuggestionItemFontFamily

Gets or sets the font family of suggestion item

Declaration

public FontFamily SuggestionItemFontFamily { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.FontFamily

SuggestionItemFontSize

Gets or sets the font size of suggestion item

Declaration

public double SuggestionItemFontSize { get; set; }

Property Value

Type
System.Double

SuggestionItemFontStyle

Gets or sets the font style of suggestion item

Declaration

public FontStyle SuggestionItemFontStyle { get; set; }

Property Value

Type
Windows.UI.Text.FontStyle

SuggestionItemFontWeight

Gets or sets the font weight of suggestion item

Declaration

public FontWeight SuggestionItemFontWeight { get; set; }

Property Value

Type
Windows.UI.Text.FontWeight

SuggestionItemForeground

Gets or sets the foreground of suggestion item

Declaration

public Brush SuggestionItemForeground { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

SuggestionItemHeight

Gets or sets the height of Suggestion box item

Declaration

public double SuggestionItemHeight { get; set; }

Property Value

Type
System.Double

SuggestionMode

Gets or sets the 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.

Suggestions

Gets the list of suggestions associated with Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.SuggestionMode.

Declaration

public IEnumerable Suggestions { get; }

Property Value

Type	Description
System.Collections.IEnumerable	The suggestions.

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 OccurenceMode TextHighlightMode { get; set; }

Property Value

Type	Description
OccurenceMode	The default text highlight mode is none.

TokenSettings

Gets or sets the customization settings to token.

Declaration

public TokenSettings TokenSettings { get; set; }

Property Value

Type
TokenSettings

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

WatermarkForeground

Gets or sets a value to change Watermark foreground

Declaration

public Brush WatermarkForeground { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

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
Windows.UI.Xaml.DataTemplate	The Default value is null.

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
Windows.UI.Xaml.Controls.DataTemplateSelector	The default value is null.

Methods

add_DropDownClosing(SfTextBoxExt.DropDownCancelEventHandler)

Declaration

public void add_DropDownClosing(SfTextBoxExt.DropDownCancelEventHandler value)

Parameters

Type	Name	Description
SfTextBoxExt.DropDownCancelEventHandler	value

add_SelectionChanging(SfTextBoxExt.SelectionChangingEventHandler)

Declaration

public void add_SelectionChanging(SfTextBoxExt.SelectionChangingEventHandler value)

Parameters

Type	Name	Description
SfTextBoxExt.SelectionChangingEventHandler	value

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.

MultiselectionChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Invoked when the MultiSelectMode has changed.

Declaration

public static void MultiselectionChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
Windows.UI.Xaml.DependencyObject	obj	Dependency object
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	Dependency property changed event args

OnApplyTemplate()

Initialize all the child elements of Syncfusion.UI.Xaml.Controls.Input.TextBoxExt control.

Declaration

protected 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
Windows.UI.Xaml.DependencyObject	obj	Dependency object
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	dependency property changed event args

OnCompleted(DependencyObject, DependencyPropertyChangedEventArgs)

Occurs when press the Enter key

Declaration

public static void OnCompleted(DependencyObject obj, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
Windows.UI.Xaml.DependencyObject	obj	Dependency object
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	Dependency property changed event args

OnCompleted(DependencyPropertyChangedEventArgs)

Occurs when press the Enter key

Declaration

protected void OnCompleted(DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyObject	obj	Dependency object
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyObject	obj	Dependency object
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	Dependency property changed event args

OnKeyDown(KeyRoutedEventArgs)

Occurs when the key is pressed

Declaration

protected override void OnKeyDown(KeyRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.KeyRoutedEventArgs	e	Key routed event args

OnLostFocus(RoutedEventArgs)

Occurs when focus is lost.

Declaration

protected override void OnLostFocus(RoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyObject	obj	Dependency object type
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	Dependency property changed event args

OnPointerPressed(PointerRoutedEventArgs)

Occurs when the pointer is pressed

Declaration

protected override void OnPointerPressed(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	Pointer Routed event args

OnPointerReleased(PointerRoutedEventArgs)

Occurs when the pointer is released

Declaration

protected override void OnPointerReleased(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	Mouse button 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
Windows.UI.Xaml.DependencyObject	obj	Dependency object
Windows.UI.Xaml.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
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	Dependency property changed event args

OnSelectionChanging(SelectionChangingEventArgs)

Invoke when selecteditem has changed

Declaration

protected void OnSelectionChanging(SelectionChangingEventArgs e)

Parameters

Type	Name	Description
SelectionChangingEventArgs	e

OnSuggestionsChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Occurs when the Suggestions have changed.

Declaration

public static void OnSuggestionsChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
Windows.UI.Xaml.DependencyObject	obj	Dependency object
Windows.UI.Xaml.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
Windows.UI.Xaml.DependencyPropertyChangedEventArgs	args	Dependency property changed event args

remove_DropDownClosing(SfTextBoxExt.DropDownCancelEventHandler)

Declaration

public void remove_DropDownClosing(SfTextBoxExt.DropDownCancelEventHandler value)

Parameters

Type	Name	Description
SfTextBoxExt.DropDownCancelEventHandler	value

remove_SelectionChanging(SfTextBoxExt.SelectionChangingEventHandler)

Declaration

public void remove_SelectionChanging(SfTextBoxExt.SelectionChangingEventHandler value)

Parameters

Type	Name	Description
SfTextBoxExt.SelectionChangingEventHandler	value

SetCursorPosition(Int32)

Sets Cursor Position

Declaration

public void SetCursorPosition(int Position)

Parameters

Type	Name	Description
System.Int32	Position

Validate(ValidationEventArgs)

Validate the states Syncfusion.UI.Xaml.Controls.Input.VisualStates

Declaration

public void Validate(ValidationEventArgs args)

Parameters

Type	Name	Description
ValidationEventArgs	args	Validation event args

Events

Completed

Completed event

Declaration

public event PropertyChangedCallback Completed

Event Type

Type
Windows.UI.Xaml.PropertyChangedCallback

DropDownClosing

Gets raised when the dropdown is being closed or when the control is unfocused or a value is selected.

Declaration

public event SfTextBoxExt.DropDownCancelEventHandler DropDownClosing

Event Type

Type
SfTextBoxExt.DropDownCancelEventHandler

Remarks

Based on the Cancel property the dropdown is shown in the SfTextBoxExt.

SelectedItemChanged

Occurs when Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions changed.

Declaration

public event PropertyChangedCallback SelectedItemChanged

Event Type

Type
Windows.UI.Xaml.PropertyChangedCallback

SelectionChanging

Occurs when the selected item has changed.

Declaration

public event SfTextBoxExt.SelectionChangingEventHandler SelectionChanging

Event Type

Type
SfTextBoxExt.SelectionChangingEventHandler

SuggestionPopupClosed

Occurs when suggestion box popup is closed. Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.IsSuggestionOpen

Declaration

public event PropertyChangedCallback SuggestionPopupClosed

Event Type

Type
Windows.UI.Xaml.PropertyChangedCallback

SuggestionPopupOpened

Occurs when suggestion box popup is opened.

Declaration

public event PropertyChangedCallback SuggestionPopupOpened

Event Type

Type
Windows.UI.Xaml.PropertyChangedCallback

SuggestionsChanged

Occurs when Syncfusion.UI.Xaml.Controls.Input.TextBoxExt.Suggestions changed.

Declaration

public event PropertyChangedCallback SuggestionsChanged

Event Type

Type
Windows.UI.Xaml.PropertyChangedCallback

Implements

IDataValidator

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)