Skip to main content

TextInputOptions Class

Definition

Assembly:Avalonia.Base
Package:Avalonia
public class TextInputOptions

Inheritance: object -> TextInputOptions

Constructors

NameDescription
TextInputOptionsNo summary available.

TextInputOptions Constructor

public TextInputOptions()

Methods

NameDescription
FromStyledElementNo summary available.
GetAutoCapitalizationGets the value of the attached Avalonia.Input.TextInput.TextInputOptions.AutoCapitalizationProperty.
GetContentTypeGets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ContentTypeProperty.
GetIsSensitiveGets the value of the attached Avalonia.Input.TextInput.TextInputOptions.IsSensitiveProperty.
GetLowercaseGets the value of the attached Avalonia.Input.TextInput.TextInputOptions.LowercaseProperty.
GetMultilineGets the value of the attached Avalonia.Input.TextInput.TextInputOptions.MultilineProperty.
GetReturnKeyTypeGets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ReturnKeyTypeProperty.
GetShowSuggestionsGets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ShowSuggestionsProperty.
GetUppercaseGets the value of the attached Avalonia.Input.TextInput.TextInputOptions.UppercaseProperty.
SetAutoCapitalizationSets the value of the attached Avalonia.Input.TextInput.TextInputOptions.AutoCapitalizationProperty on a control.
SetContentTypeSets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ContentTypeProperty on a control.
SetIsSensitiveSets the value of the attached Avalonia.Input.TextInput.TextInputOptions.IsSensitiveProperty on a control.
SetLowercaseSets the value of the attached Avalonia.Input.TextInput.TextInputOptions.LowercaseProperty on a control.
SetMultilineSets the value of the attached Avalonia.Input.TextInput.TextInputOptions.MultilineProperty on a control.
SetReturnKeyTypeSets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ReturnKeyTypeProperty on a control.
SetShowSuggestionsNo summary available.
SetUppercaseSets the value of the attached Avalonia.Input.TextInput.TextInputOptions.UppercaseProperty on a control.

FromStyledElement Method

public Avalonia.Input.TextInput.TextInputOptions FromStyledElement(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

Returns

Avalonia.Input.TextInput.TextInputOptions

GetAutoCapitalization Method

Gets the value of the attached Avalonia.Input.TextInput.TextInputOptions.AutoCapitalizationProperty.

public bool GetAutoCapitalization(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

The target.

Returns

bool

true if AutoCapitalization

GetContentType Method

Gets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ContentTypeProperty.

public Avalonia.Input.TextInput.TextInputContentType GetContentType(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

The target.

Returns

Avalonia.Input.TextInput.TextInputContentType

TextInputContentType

GetIsSensitive Method

Gets the value of the attached Avalonia.Input.TextInput.TextInputOptions.IsSensitiveProperty.

public bool GetIsSensitive(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

The target.

Returns

bool

true if IsSensitive

GetLowercase Method

Gets the value of the attached Avalonia.Input.TextInput.TextInputOptions.LowercaseProperty.

public bool GetLowercase(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

The target.

Returns

bool

true if Lowercase

GetMultiline Method

Gets the value of the attached Avalonia.Input.TextInput.TextInputOptions.MultilineProperty.

public bool GetMultiline(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

The target.

Returns

bool

true if multiline

GetReturnKeyType Method

Gets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ReturnKeyTypeProperty.

public Avalonia.Input.TextInput.TextInputReturnKeyType GetReturnKeyType(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

The target.

Returns

Avalonia.Input.TextInput.TextInputReturnKeyType

TextInputReturnKeyType

GetShowSuggestions Method

Gets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ShowSuggestionsProperty.

public Nullable<bool> GetShowSuggestions(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

The target.

Returns

Nullable<bool>

true if ShowSuggestions

GetUppercase Method

Gets the value of the attached Avalonia.Input.TextInput.TextInputOptions.UppercaseProperty.

public bool GetUppercase(Avalonia.StyledElement avaloniaObject)

Parameters

avaloniaObject Avalonia.StyledElement

The target.

Returns

bool

true if Uppercase

SetAutoCapitalization Method

Sets the value of the attached Avalonia.Input.TextInput.TextInputOptions.AutoCapitalizationProperty on a control.

public void SetAutoCapitalization(Avalonia.StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject Avalonia.StyledElement

The control.

value bool

The property value to set.

SetContentType Method

Sets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ContentTypeProperty on a control.

public void SetContentType(Avalonia.StyledElement avaloniaObject, Avalonia.Input.TextInput.TextInputContentType value)

Parameters

avaloniaObject Avalonia.StyledElement

The control.

value Avalonia.Input.TextInput.TextInputContentType

The property value to set.

SetIsSensitive Method

Sets the value of the attached Avalonia.Input.TextInput.TextInputOptions.IsSensitiveProperty on a control.

public void SetIsSensitive(Avalonia.StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject Avalonia.StyledElement

The control.

value bool

The property value to set.

SetLowercase Method

Sets the value of the attached Avalonia.Input.TextInput.TextInputOptions.LowercaseProperty on a control.

public void SetLowercase(Avalonia.StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject Avalonia.StyledElement

The control.

value bool

The property value to set.

SetMultiline Method

Sets the value of the attached Avalonia.Input.TextInput.TextInputOptions.MultilineProperty on a control.

public void SetMultiline(Avalonia.StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject Avalonia.StyledElement

The control.

value bool

The property value to set.

SetReturnKeyType Method

Sets the value of the attached Avalonia.Input.TextInput.TextInputOptions.ReturnKeyTypeProperty on a control.

public void SetReturnKeyType(Avalonia.StyledElement avaloniaObject, Avalonia.Input.TextInput.TextInputReturnKeyType value)

Parameters

avaloniaObject Avalonia.StyledElement

The control.

value Avalonia.Input.TextInput.TextInputReturnKeyType

The property value to set.

SetShowSuggestions Method

public void SetShowSuggestions(Avalonia.StyledElement avaloniaObject, Nullable<bool> value)

Parameters

avaloniaObject Avalonia.StyledElement

value Nullable<bool>

SetUppercase Method

Sets the value of the attached Avalonia.Input.TextInput.TextInputOptions.UppercaseProperty on a control.

public void SetUppercase(Avalonia.StyledElement avaloniaObject, bool value)

Parameters

avaloniaObject Avalonia.StyledElement

The control.

value bool

The property value to set.

Properties

NameDescription
AutoCapitalizationAutomatically capitalize letters at the start of the sentence
ContentTypeThe content type (mostly for determining the shape of the virtual keyboard)
IsSensitiveText contains sensitive data like card numbers and should not be stored
LowercaseText is in lower case
MultilineText is multiline
ReturnKeyTypeDetermines what the Return key says and how it behaves.
ShowSuggestionsShow virtual keyboard suggestions
UppercaseText is in upper case

AutoCapitalization Property

Automatically capitalize letters at the start of the sentence

public bool AutoCapitalization { get; set; }

ContentType Property

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

public Avalonia.Input.TextInput.TextInputContentType ContentType { get; set; }

IsSensitive Property

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

public bool IsSensitive { get; set; }

Lowercase Property

Text is in lower case

public bool Lowercase { get; set; }

Multiline Property

Text is multiline

public bool Multiline { get; set; }

ReturnKeyType Property

Determines what the Return key says and how it behaves.

public Avalonia.Input.TextInput.TextInputReturnKeyType ReturnKeyType { get; set; }

ShowSuggestions Property

Show virtual keyboard suggestions

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

Uppercase Property

Text is in upper case

public bool Uppercase { get; set; }

Fields

AutoCapitalizationProperty Field

Defines the Avalonia.Input.TextInput.TextInputOptions.AutoCapitalization property.

public Avalonia.AttachedProperty<TValue><bool> AutoCapitalizationProperty

ContentTypeProperty Field

Defines the Avalonia.Input.TextInput.TextInputOptions.ContentType property.

public Avalonia.AttachedProperty<TValue><Avalonia.Input.TextInput.TextInputContentType> ContentTypeProperty

Default Field

public Avalonia.Input.TextInput.TextInputOptions Default

IsSensitiveProperty Field

Defines the Avalonia.Input.TextInput.TextInputOptions.IsSensitive property.

public Avalonia.AttachedProperty<TValue><bool> IsSensitiveProperty

LowercaseProperty Field

Defines the Avalonia.Input.TextInput.TextInputOptions.Lowercase property.

public Avalonia.AttachedProperty<TValue><bool> LowercaseProperty

MultilineProperty Field

Defines the Avalonia.Input.TextInput.TextInputOptions.Multiline property.

public Avalonia.AttachedProperty<TValue><bool> MultilineProperty

ReturnKeyTypeProperty Field

Defines the Avalonia.Input.TextInput.TextInputOptions.ReturnKeyType property.

public Avalonia.AttachedProperty<TValue><Avalonia.Input.TextInput.TextInputReturnKeyType> ReturnKeyTypeProperty

ShowSuggestionsProperty Field

Defines the Avalonia.Input.TextInput.TextInputOptions.ShowSuggestions property.

public Avalonia.AttachedProperty<TValue><Nullable<bool>> ShowSuggestionsProperty

UppercaseProperty Field

Defines the Avalonia.Input.TextInput.TextInputOptions.Uppercase property.

public Avalonia.AttachedProperty<TValue><bool> UppercaseProperty