Class TextInputLayoutSettings

Represents a class that holds the Text input layout settings of the DataFormItem.

Inheritance

System.Object

TextInputLayoutSettings

Namespace: Syncfusion.Maui.DataForm

Assembly: Syncfusion.Maui.DataForm.dll

Syntax

public class TextInputLayoutSettings : Element

Constructors

TextInputLayoutSettings()

Declaration

public TextInputLayoutSettings()

Fields

ContainerTypeProperty

Identifies the ContainerType dependency property.

Declaration

public static readonly BindableProperty ContainerTypeProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for ContainerType dependency property.

EnableFloatingProperty

Identifies the EnableFloating dependency property.

Declaration

public static readonly BindableProperty EnableFloatingProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for EnableFloating dependency property.

EnableHintAnimationProperty

Identifies the EnableHintAnimation dependency property.

Declaration

public static readonly BindableProperty EnableHintAnimationProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for EnableHintAnimation dependency property.

FocusedStrokeProperty

Identifies the FocusedStroke dependency property.

Declaration

public static readonly BindableProperty FocusedStrokeProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for FocusedStroke dependency property.

FocusedStrokeThicknessProperty

Identifies the FocusedStrokeThickness dependency property.

Declaration

public static readonly BindableProperty FocusedStrokeThicknessProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for FocusedStrokeThickness dependency property.

HelperTextStyleProperty

Identifies the HelperTextStyle dependency property.

Declaration

public static readonly BindableProperty HelperTextStyleProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for HelperTextStyle dependency property.

InputViewPaddingProperty

Identifies the InputViewPadding dependency property.

Declaration

public static readonly BindableProperty InputViewPaddingProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for InputViewPadding dependency property.

IsHintAlwaysFloatedProperty

Identifies the IsHintAlwaysFloated dependency property.

Declaration

public static readonly BindableProperty IsHintAlwaysFloatedProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for IsHintAlwaysFloated dependency property.

OutlineCornerRadiusProperty

Identifies the OutlineCornerRadius dependency property.

Declaration

public static readonly BindableProperty OutlineCornerRadiusProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for OutlineCornerRadius dependency property.

ShowHelperTextProperty

Identifies the ShowHelperText dependency property.

Declaration

public static readonly BindableProperty ShowHelperTextProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for ShowHelperText dependency property.

StrokeProperty

Identifies the Stroke dependency property.

Declaration

public static readonly BindableProperty StrokeProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for Stroke dependency property.

UnfocusedStrokeThicknessProperty

Identifies the UnfocusedStrokeThickness dependency property.

Declaration

public static readonly BindableProperty UnfocusedStrokeThicknessProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for UnfocusedStrokeThickness dependency property.

Properties

ContainerType

Gets or sets a value that determines the appearance of background and its border of data form floating label layout type.

Declaration

public TextInputLayoutContainerType ContainerType { get; set; }

Property Value

Type
TextInputLayoutContainerType

Remarks

The ContainerType property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the ContainerType property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       ContainerType="Outlined"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { ContainerType = TextInputLayoutContainerType.Outlined };

EnableFloating

Gets or sets a value that indicates whether to float the label when it is focused or unfocused of data form floating label layout type.

Declaration

public Nullable<bool> EnableFloating { get; set; }

Property Value

Type
System.Nullable<System.Boolean>

Remarks

The EnableFloatingProperty property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the EnableFloatingProperty property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       EnableFloating="False"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { EnableFloating = false };

EnableHintAnimation

Gets or sets a value that indicates whether to enable animation for the hint text of data form floating label layout type.

Declaration

public Nullable<bool> EnableHintAnimation { get; set; }

Property Value

Type
System.Nullable<System.Boolean>

Remarks

The EnableHintAnimation property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the EnableHintAnimation property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       EnableHintAnimation="False"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { EnableHintAnimation = false };

FocusedStroke

Gets or sets the focused border color or focused base line color based on container type of data form floating label layout type.

Declaration

public Color FocusedStroke { get; set; }

Property Value

Type
Microsoft.Maui.Graphics.Color

Remarks

The FocusedStroke property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the FocusedStroke property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       FocusedStroke="Blue"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { FocusedStroke = Colors.Blue };

FocusedStrokeThickness

Gets or sets a value to customize the stroke width in focused state of data form floating label layout type.

Declaration

public double FocusedStrokeThickness { get; set; }

Property Value

Type
System.Double

Remarks

The FocusedStrokeThickness property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the FocusedStrokeThickness property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       FocusedStrokeThickness="3.0"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { FocusedStrokeThickness = 3.0 };

HelperTextStyle

Gets or sets the style for helper label of data form floating label layout type.

Declaration

public DataFormTextStyle HelperTextStyle { get; set; }

Property Value

Type
DataFormTextStyle

Remarks

The HelperTextStyle property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the HelperTextStyle property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       <dataForm:TextInputLayoutSettings.HelperTextStyle>
            <dataForm:DataFormTextStyle TextColor="Green"/>
        </dataForm:TextInputLayoutSettings.HelperTextStyle>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { HelperTextStyle = new DataFormTextStyle { TextColor = Colors.Green} };

InputViewPadding

Gets or sets padding for input view of data form floating label layout type.

Declaration

public Thickness InputViewPadding { get; set; }

Property Value

Type
Microsoft.Maui.Thickness

Remarks

The InputViewPadding property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the InputViewPadding property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       InputViewPadding="10"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { InputViewPadding = new Thickness(10) };

IsHintAlwaysFloated

Gets or sets a value that indicates whether to fix the hint label always at the top even when the text is empty of data form floating label layout type.

Declaration

public Nullable<bool> IsHintAlwaysFloated { get; set; }

Property Value

Type
System.Nullable<System.Boolean>

Remarks

The IsHintAlwaysFloated property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the IsHintAlwaysFloated property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       IsHintAlwaysFloated="False"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { IsHintAlwaysFloated = false };

OutlineCornerRadius

Gets or sets a value to customize the customize the corner radius of outline border of data form floating label layout type.

Declaration

public double OutlineCornerRadius { get; set; }

Property Value

Type
System.Double

Remarks

The OutlineCornerRadius property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the OutlineCornerRadius property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       OutlineCornerRadius="10.0"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { OutlineCornerRadius = 10.0 };

ShowHelperText

Gets or sets a value indicating whether to show the helper text for the editor of data form floating label layout type.

Declaration

public Nullable<bool> ShowHelperText { get; set; }

Property Value

Type
System.Nullable<System.Boolean>

Remarks

The ShowHelperText property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the OutlineCornerRadius property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       ShowHelperText="False"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { ShowHelperText = false };

Stroke

Gets or sets the border color or base line color based on container type of data form floating label layout type.

Declaration

public Color Stroke { get; set; }

Property Value

Type
Microsoft.Maui.Graphics.Color

Remarks

The Stroke property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the Stroke property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       Stroke="Green"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { Stroke = Colors.Green };

UnfocusedStrokeThickness

Gets or sets a value to customize the stroke width in unfocused state of data form floating label layout type.

Declaration

public double UnfocusedStrokeThickness { get; set; }

Property Value

Type
System.Double

Remarks

The UnfocusedStrokeThickness property is applicable only when LayoutType or LayoutType is TextInputLayout.

Examples

The below example shows, how to set the UnfocusedStrokeThickness property of TextInputLayoutSettings in the SfDataForm.

XAML
C#

<dataForm:SfDataForm x:Name="dataForm" LayoutType="TextInputLayout">
  <dataForm:SfDataForm.TextInputLayoutSettings>
    <dataForm:TextInputLayoutSettings
       UnfocusedStrokeThickness="3.0"/>
  </dataForm:SfDataForm.TextInputLayoutSettings>
</dataForm:SfDataForm>

this.dataForm.LayoutType = DataFormLayoutType.TextInputLayout;
this.dataForm.TextInputLayoutSettings = new TextInputLayoutSettings { UnfocusedStrokeThickness = 3.0 };

Methods

OnBindingContextChanged()

Invokes on the binding context of the view changed.

Declaration

protected override void OnBindingContextChanged()