Class IgbTextarea

This element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form.

Inheritance
System.Object
BaseRendererControl
IgbTextarea
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbTextarea : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbTextarea()

Declaration
public IgbTextarea()

Properties

Autocapitalize

Controls whether and how text input is automatically capitalized as it is entered/edited by the user. MDN documentation.

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

Autocomplete

Specifies what if any permission the browser has to provide for automated assistance in filling out form field values, as well as guidance to the browser as to the type of information expected in the field. Refer to this page for additional information.

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

Blur

Declaration
public EventCallback<IgbVoidEventArgs> Blur { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

BlurScript

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

Change

Declaration
public EventCallback<IgbComponentValueChangedEventArgs> Change { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbComponentValueChangedEventArgs>

ChangeScript

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

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

Disabled

The disabled state of the component

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

Focus

Declaration
public EventCallback<IgbVoidEventArgs> Focus { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

FocusScript

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

Input

Declaration
public EventCallback<IgbComponentValueChangedEventArgs> Input { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbComponentValueChangedEventArgs>

InputMode

Hints at the type of data that might be entered by the user while editing the element or its contents. This allows a browser to display an appropriate virtual keyboard. MDN documentation

Declaration
[WCAttributeName("inputmode")]
public string InputMode { get; set; }
Property Value
Type Description
System.String

InputScript

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

Invalid

Control the validity of the control.

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

Label

The label for the control.

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

MaxLength

The maximum number of characters (UTF-16 code units) that the user can enter. If this value isn't specified, the user can enter an unlimited number of characters.

Declaration
[WCAttributeName("maxlength")]
public double MaxLength { get; set; }
Property Value
Type Description
System.Double

MinLength

The minimum number of characters (UTF-16 code units) required that the user should enter.

Declaration
[WCAttributeName("minlength")]
public double MinLength { get; set; }
Property Value
Type Description
System.Double

Outlined

Whether the control will have outlined appearance.

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

Placeholder

The placeholder attribute of the control.

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

ReadOnly

Makes the control a readonly field.

Declaration
[WCAttributeName("readonly")]
public bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean

Required

Makes the control a required field in a form context.

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

Resize

Controls whether the control can be resized. When auto is set, the control will try to expand and fit its content.

Declaration
public TextareaResize Resize { get; set; }
Property Value
Type Description
TextareaResize

Rows

The number of visible text lines for the control. If it is specified, it must be a positive integer. If it is not specified, the default value is 3.

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

Spellcheck

Controls whether the element may be checked for spelling errors.

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

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

ValidateOnly

Enables validation rules to be evaluated without restricting user input. This applies to the maxLength property when it is defined.

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

Value

The value of the component

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

ValueChanged

Declaration
public EventCallback<string> ValueChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.String>

Wrap

Indicates how the control should wrap the value for form submission. Refer to this page on MDN for explanation of the available values.

Declaration
public TextareaWrap Wrap { get; set; }
Property Value
Type Description
TextareaWrap

Methods

CheckValidity()

Declaration
public void CheckValidity()

CheckValidityAsync()

Checks for validity of the control and emits the invalid event if it invalid.

Declaration
public Task CheckValidityAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetCurrentValue()

Declaration
public string GetCurrentValue()
Returns
Type Description
System.String

GetCurrentValueAsync()

Declaration
public Task<string> GetCurrentValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

ReportValidity()

Declaration
public void ReportValidity()

ReportValidityAsync()

Checks for validity of the control and shows the browser message if it invalid.

Declaration
public Task ReportValidityAsync()
Returns
Type Description
System.Threading.Tasks.Task

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

Select()

Declaration
public void Select()

SelectAsync()

Selects all text within the control.

Declaration
public Task SelectAsync()
Returns
Type Description
System.Threading.Tasks.Task

SetCustomValidity(String)

Declaration
public void SetCustomValidity(string message)
Parameters
Type Name Description
System.String message

SetCustomValidityAsync(String)

Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

Declaration
public Task SetCustomValidityAsync(string message)
Parameters
Type Name Description
System.String message
Returns
Type Description
System.Threading.Tasks.Task

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable