Class SfTextInputLayout

The text input layout control adds decorative elements such as floating label, icons, and assistive labels on the top of the input views.

Inheritance
System.Object
SfTextInputLayout
Implements
System.IDisposable
Namespace: Syncfusion.UI.Xaml.TextInputLayout
Assembly: Syncfusion.SfTextInputLayout.WPF.dll
Syntax
public class SfTextInputLayout : Control, IDisposable, ITextInputLayoutNotification
Examples
<inputLayout:SfTextInputLayout Hint="Hint" HelperText="Helper" ErrorText="Error">
    <TextBox />
</inputLayout:SfTextInputLayout>

Constructors

SfTextInputLayout()

Initializes a new instance of the SfTextInputLayout class.

Declaration
public SfTextInputLayout()

Fields

ActiveForegroundProperty

Identifies the ActiveForeground dependency property.

Declaration
public static readonly DependencyProperty ActiveForegroundProperty
Field Value
Type
System.Windows.DependencyProperty

CharCountVisibilityProperty

Identifies the CharCountVisibility dependency property.

Declaration
public static readonly DependencyProperty CharCountVisibilityProperty
Field Value
Type
System.Windows.DependencyProperty

CharMaxLengthProperty

Identifies the CharMaxLength dependency property.

Declaration
public static readonly DependencyProperty CharMaxLengthProperty
Field Value
Type
System.Windows.DependencyProperty

ContainerBackgroundProperty

Identifies the ContainerBackground dependency property.

Declaration
public static readonly DependencyProperty ContainerBackgroundProperty
Field Value
Type
System.Windows.DependencyProperty

ContainerTypeProperty

Identifies the ContainerType dependency property.

Declaration
public static readonly DependencyProperty ContainerTypeProperty
Field Value
Type
System.Windows.DependencyProperty

ErrorForegroundProperty

Identifies the ErrorForeground dependency property.

Declaration
public static readonly DependencyProperty ErrorForegroundProperty
Field Value
Type
System.Windows.DependencyProperty

ErrorTextProperty

Identifies the ErrorText dependency property.

Declaration
public static readonly DependencyProperty ErrorTextProperty
Field Value
Type
System.Windows.DependencyProperty

FocusedBorderBrushProperty

Identifies the FocusedBorderBrush dependency property.

Declaration
public static readonly DependencyProperty FocusedBorderBrushProperty
Field Value
Type
System.Windows.DependencyProperty

FocusedForegroundProperty

Identifies the FocusedForeground dependency property.

Declaration
public static readonly DependencyProperty FocusedForegroundProperty
Field Value
Type
System.Windows.DependencyProperty

FocusedStrokeThicknessProperty

Identifies the FocusedStrokeThickness dependency property.

Declaration
public static readonly DependencyProperty FocusedStrokeThicknessProperty
Field Value
Type
System.Windows.DependencyProperty

HasErrorProperty

Identifies the HasError dependency property.

Declaration
public static readonly DependencyProperty HasErrorProperty
Field Value
Type
System.Windows.DependencyProperty

HelperTextProperty

Identifies the HelperText dependency property.

Declaration
public static readonly DependencyProperty HelperTextProperty
Field Value
Type
System.Windows.DependencyProperty

HelperTextVisibilityProperty

Identifies the HelperTextVisibility dependency property.

Declaration
public static readonly DependencyProperty HelperTextVisibilityProperty
Field Value
Type
System.Windows.DependencyProperty

HintFloatModeProperty

Identifies the HintFloatMode dependency property.

Declaration
public static readonly DependencyProperty HintFloatModeProperty
Field Value
Type
System.Windows.DependencyProperty

HintProperty

Identifies the Hint dependency property.

Declaration
public static readonly DependencyProperty HintProperty
Field Value
Type
System.Windows.DependencyProperty

HintVisibilityProperty

Identifies the HintVisibility dependency property.

Declaration
public static readonly DependencyProperty HintVisibilityProperty
Field Value
Type
System.Windows.DependencyProperty

InputViewPaddingProperty

Identifies the InputViewPadding dependency property.

Declaration
public static readonly DependencyProperty InputViewPaddingProperty
Field Value
Type
System.Windows.DependencyProperty

InputViewProperty

Identifies the InputView dependency property.

Declaration
public static readonly DependencyProperty InputViewProperty
Field Value
Type
System.Windows.DependencyProperty

LeadingViewPositionProperty

Identifies the LeadingViewPosition dependency property.

Declaration
public static readonly DependencyProperty LeadingViewPositionProperty
Field Value
Type
System.Windows.DependencyProperty

LeadingViewProperty

Identifies the LeadingView dependency property.

Declaration
public static readonly DependencyProperty LeadingViewProperty
Field Value
Type
System.Windows.DependencyProperty

OutlineCornerRadiusProperty

Identifies the OutlineCornerRadius dependency property.

Declaration
public static readonly DependencyProperty OutlineCornerRadiusProperty
Field Value
Type
System.Windows.DependencyProperty

StrokeThicknessProperty

Identifies the StrokeThickness dependency property.

Declaration
public static readonly DependencyProperty StrokeThicknessProperty
Field Value
Type
System.Windows.DependencyProperty

TrailingViewPositionProperty

Identifies the TrailingViewPosition dependency property.

Declaration
public static readonly DependencyProperty TrailingViewPositionProperty
Field Value
Type
System.Windows.DependencyProperty

TrailingViewProperty

Identifies the TrailingView dependency property.

Declaration
public static readonly DependencyProperty TrailingViewProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

ActiveForeground

Gets a brush that describes the foreground color based on focused state of control.

Declaration
public Brush ActiveForeground { get; }
Property Value
Type
System.Windows.Media.Brush
Remarks

This value is based on the control state fouced and unfocused.

CharCountVisibility

Gets or sets the user interface (UI) visibility of character count.

Declaration
public Visibility CharCountVisibility { get; set; }
Property Value
Type
System.Windows.Visibility

CharMaxLength

Gets or sets the maximum length of the character that was allowed to enter text of InputView. When the number of characters reaches the maximum length of the character, the error color will be applied by default.

Declaration
public int CharMaxLength { get; set; }
Property Value
Type
System.Int32

ContainerBackground

Gets or sets a brush that describes the background of the SfTextInputLayout container.

Declaration
public Brush ContainerBackground { get; set; }
Property Value
Type
System.Windows.Media.Brush

ContainerType

Gets or sets a value that determines the appearance of the SfTextInputLayout.

Declaration
public ContainerType ContainerType { get; set; }
Property Value
Type
ContainerType

DropDownBorder

Represents the dropdown icon for selector type InputViews.

Declaration
protected Border DropDownBorder { get; set; }
Property Value
Type
System.Windows.Controls.Border

ErrorForeground

Gets or sets a brush that describes the error state of the SfTextInputLayout.

Declaration
public Brush ErrorForeground { get; set; }
Property Value
Type
System.Windows.Media.Brush

ErrorText

Gets or sets the value for validation error. Error messages are displayed below the input line, replacing helper text until fixed.

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

FocusedBorderBrush

Gets or sets a brush that describes the foreground color at focused state.

Declaration
public Brush FocusedBorderBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

FocusedForeground

Gets or sets a brush that describes the foreground color at focused state.

Declaration
public Brush FocusedForeground { get; set; }
Property Value
Type
System.Windows.Media.Brush

FocusedStrokeThickness

Gets or sets the width of the base line stroke and border outline at focused state.

Declaration
public double FocusedStrokeThickness { get; set; }
Property Value
Type Description
System.Double

The default value is 2.

HasError

Gets or sets a value indicating whether there are validation errors in InputView text.

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

True if has error; otherwise, False.

HelperText

Gets or sets the additional information about the text to be entered in the InputView.

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

HelperTextVisibility

Gets or sets the user interface (UI) visibility of helper text.

Declaration
public Visibility HelperTextVisibility { get; set; }
Property Value
Type
System.Windows.Visibility

Hint

Gets or sets the hint to be displayed in the floating label.

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

HintFloatMode

Gets or sets a value to decide how to display the floating label.

Declaration
public HintFloatMode HintFloatMode { get; set; }
Property Value
Type
HintFloatMode

HintVisibility

Gets or sets the user interface (UI) visibility of hint text.

Declaration
public Visibility HintVisibility { get; set; }
Property Value
Type
System.Windows.Visibility

InputView

Gets or sets the content of the SfTextInputLayout.

Declaration
public FrameworkElement InputView { get; set; }
Property Value
Type
System.Windows.FrameworkElement

InputViewPadding

Gets or sets desired padding to override the default padding for the input view.

Declaration
public Thickness InputViewPadding { get; set; }
Property Value
Type
System.Windows.Thickness

LeadingView

Gets or sets the view to place before the input view.

Declaration
public FrameworkElement LeadingView { get; set; }
Property Value
Type
System.Windows.FrameworkElement

LeadingViewPosition

Gets or sets the value that determines whether to place the leading view within the layout.

Declaration
public ViewPosition LeadingViewPosition { get; set; }
Property Value
Type
ViewPosition

OutlineCornerRadius

Gets or sets the radius for the corners of the outlined border.

Declaration
public double OutlineCornerRadius { get; set; }
Property Value
Type Description
System.Double

The default value is 4.
Remarks

It is applicable only when set the ContainerType as Outlined.

StrokeThickness

Gets or sets the width of the base line stroke and border outline at unfocused or normal state.

Declaration
public double StrokeThickness { get; set; }
Property Value
Type Description
System.Double

The default value is 1.

TrailingView

Gets or sets the view to place after the input view.

Declaration
public FrameworkElement TrailingView { get; set; }
Property Value
Type
System.Windows.FrameworkElement

TrailingViewPosition

Gets or sets a value that determines whether to place the trailing view within the layout.

Declaration
public ViewPosition TrailingViewPosition { get; set; }
Property Value
Type
ViewPosition

Methods

Dispose()

Disposes the resources.

Declaration
public void Dispose()

OnApplyTemplate()

Called just before a UI element displays in an application.

Declaration
public override void OnApplyTemplate()

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Method that calls when property changed.

Declaration
protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

OnTemplateChanged(ControlTemplate, ControlTemplate)

Method called when template is changed

Declaration
protected override void OnTemplateChanged(ControlTemplate oldTemplate, ControlTemplate newTemplate)
Parameters
Type Name Description
System.Windows.Controls.ControlTemplate oldTemplate

Old Template value
System.Windows.Controls.ControlTemplate newTemplate

New template value

Explicit Interface Implementations

ITextInputLayoutNotification.OnSelectedItemsChanged()

Raised when the selected items get changed on SfTextBoxExt.

Declaration
void ITextInputLayoutNotification.OnSelectedItemsChanged()

Implements

System.IDisposable