Class TextInputOptions

Namespace

Avalonia.Input.TextInput

Assembly

Avalonia.Base.dll

public class TextInputOptions

Inheritance

object

TextInputOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TextInputOptions()

public TextInputOptions()

Fields

AutoCapitalizationProperty

Defines the AutoCapitalization property.

public static readonly AttachedProperty<bool> AutoCapitalizationProperty

Field Value

AttachedProperty<bool>

ContentTypeProperty

Defines the ContentType property.

public static readonly AttachedProperty<TextInputContentType> ContentTypeProperty

Field Value

AttachedProperty<TextInputContentType>

Default

public static readonly TextInputOptions Default

Field Value

TextInputOptions

IsSensitiveProperty

Defines the IsSensitive property.

public static readonly AttachedProperty<bool> IsSensitiveProperty

Field Value

AttachedProperty<bool>

LowercaseProperty

Defines the Lowercase property.

public static readonly AttachedProperty<bool> LowercaseProperty

Field Value

AttachedProperty<bool>

MultilineProperty

Defines the Multiline property.

public static readonly AttachedProperty<bool> MultilineProperty

Field Value

AttachedProperty<bool>

ReturnKeyTypeProperty

Defines the ReturnKeyType property.

public static readonly AttachedProperty<TextInputReturnKeyType> ReturnKeyTypeProperty

Field Value

AttachedProperty<TextInputReturnKeyType>

ShowSuggestionsProperty

Defines the ShowSuggestions property.

public static readonly AttachedProperty<bool?> ShowSuggestionsProperty

Field Value

AttachedProperty<bool?>

UppercaseProperty

Defines the Uppercase property.

public static readonly AttachedProperty<bool> UppercaseProperty

Field Value

AttachedProperty<bool>

Properties

AutoCapitalization

Automatically capitalize letters at the start of the sentence

public bool AutoCapitalization { get; set; }

Property Value

bool

ContentType

The content type (mostly for determining the shape of the virtual keyboard)

public TextInputContentType ContentType { get; set; }

Property Value

TextInputContentType

IsSensitive

Text contains sensitive data like card numbers and should not be stored

public bool IsSensitive { get; set; }

Property Value

bool

Lowercase

Text is in lower case

public bool Lowercase { get; set; }

Property Value

bool

Multiline

Text is multiline

public bool Multiline { get; set; }

Property Value

bool

ReturnKeyType

Determines what the Return key says and how it behaves.

public TextInputReturnKeyType ReturnKeyType { get; set; }

Property Value

TextInputReturnKeyType

ShowSuggestions

Show virtual keyboard suggestions

public bool? ShowSuggestions { get; set; }

Property Value

bool?

Uppercase

Text is in upper case

public bool Uppercase { get; set; }

Property Value

bool

Methods

FromStyledElement(StyledElement)

public static TextInputOptions FromStyledElement(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

Returns

TextInputOptions

GetAutoCapitalization(StyledElement)

Gets the value of the attached AutoCapitalizationProperty.

public static bool GetAutoCapitalization(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

The target.

Returns

bool

true if AutoCapitalization

GetContentType(StyledElement)

Gets the value of the attached ContentTypeProperty.

public static TextInputContentType GetContentType(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

The target.

Returns

TextInputContentType

TextInputContentType

GetIsSensitive(StyledElement)

Gets the value of the attached IsSensitiveProperty.

public static bool GetIsSensitive(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

The target.

Returns

bool

true if IsSensitive

GetLowercase(StyledElement)

Gets the value of the attached LowercaseProperty.

public static bool GetLowercase(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

The target.

Returns

bool

true if Lowercase

GetMultiline(StyledElement)

Gets the value of the attached MultilineProperty.

public static bool GetMultiline(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

The target.

Returns

bool

true if multiline

GetReturnKeyType(StyledElement)

Gets the value of the attached ReturnKeyTypeProperty.

public static TextInputReturnKeyType GetReturnKeyType(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

The target.

Returns

TextInputReturnKeyType

TextInputReturnKeyType

GetShowSuggestions(StyledElement)

Gets the value of the attached ShowSuggestionsProperty.

public static bool? GetShowSuggestions(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

The target.

Returns

bool?

true if ShowSuggestions

GetUppercase(StyledElement)

Gets the value of the attached UppercaseProperty.

public static bool GetUppercase(StyledElement avaloniaObject)

Parameters

avaloniaObject StyledElement

The target.

Returns

bool

true if Uppercase

SetAutoCapitalization(StyledElement, bool)

Sets the value of the attached AutoCapitalizationProperty on a control.

public static void SetAutoCapitalization(StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject StyledElement

The control.

value bool

The property value to set.

SetContentType(StyledElement, TextInputContentType)

Sets the value of the attached ContentTypeProperty on a control.

public static void SetContentType(StyledElement avaloniaObject, TextInputContentType value)

Parameters

avaloniaObject StyledElement

The control.

value TextInputContentType

The property value to set.

SetIsSensitive(StyledElement, bool)

Sets the value of the attached IsSensitiveProperty on a control.

public static void SetIsSensitive(StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject StyledElement

The control.

value bool

The property value to set.

SetLowercase(StyledElement, bool)

Sets the value of the attached LowercaseProperty on a control.

public static void SetLowercase(StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject StyledElement

The control.

value bool

The property value to set.

SetMultiline(StyledElement, bool)

Sets the value of the attached MultilineProperty on a control.

public static void SetMultiline(StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject StyledElement

The control.

value bool

The property value to set.

SetReturnKeyType(StyledElement, TextInputReturnKeyType)

Sets the value of the attached ReturnKeyTypeProperty on a control.

public static void SetReturnKeyType(StyledElement avaloniaObject, TextInputReturnKeyType value)

Parameters

avaloniaObject StyledElement

The control.

value TextInputReturnKeyType

The property value to set.

SetShowSuggestions(StyledElement, bool?)

Sets the value of the attached ShowSuggestionsProperty on a control.

public static void SetShowSuggestions(StyledElement avaloniaObject, bool? value)

Parameters

avaloniaObject StyledElement

The control.

value bool?

The property value to set.

SetUppercase(StyledElement, bool)

Sets the value of the attached UppercaseProperty on a control.

public static void SetUppercase(StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject StyledElement

The control.

value bool

The property value to set.