Class TextAreaBuilder
Inheritance
System.Object
TextAreaBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class TextAreaBuilder : ControlBuilder
Constructors
TextAreaBuilder()
Declaration
TextAreaBuilder(TextArea)
Declaration
public TextAreaBuilder(TextArea model)
Parameters
Fields
model
Declaration
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
System.Collections.Generic.IDictionary<System.String, System.Object> |
ID
Declaration
public string ID { get; set; }
Property Value
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
System.IO.TextWriter |
Overrides
Methods
Blur(String)
Triggers when the TextArea has focus-out.
Declaration
public TextAreaBuilder Blur(string blur)
Parameters
Type |
Name |
Description |
System.String |
blur |
|
Returns
Change(String)
Triggers when the content of TextArea has changed and gets focus-out.
Declaration
public TextAreaBuilder Change(string change)
Parameters
Type |
Name |
Description |
System.String |
change |
|
Returns
ColumnsCount(Double)
specifies the visible width of the textarea, measured in average character widths.
Declaration
public TextAreaBuilder ColumnsCount(double columnsCount)
Parameters
Type |
Name |
Description |
System.Double |
columnsCount |
|
Returns
Created(String)
Triggers when the TextArea component is created.
Declaration
public TextAreaBuilder Created(string created)
Parameters
Type |
Name |
Description |
System.String |
created |
|
Returns
CssClass(String)
Specifies the CSS class value that is appended to wrapper of Textbox.
Declaration
public TextAreaBuilder CssClass(string cssClass)
Parameters
Type |
Name |
Description |
System.String |
cssClass |
|
Returns
Destroyed(String)
Triggers when the TextArea component is destroyed.
Declaration
public TextAreaBuilder Destroyed(string destroyed)
Parameters
Type |
Name |
Description |
System.String |
destroyed |
|
Returns
Enabled(Boolean)
Specifies a Boolean value that indicates whether the TextArea allow user to interact with it.
Declaration
public TextAreaBuilder Enabled(bool enabled = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enabled |
|
Returns
EnablePersistence(Boolean)
Enable or disable persisting TextArea state between page reloads. If enabled, the value
state will be persisted.
Declaration
public TextAreaBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public TextAreaBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
FloatLabelType(FloatLabelType)
Specifies the floating label behavior of the TextArea that the placeholder text floats above the TextArea based on the below values.
Possible values are:
Never
- The placeholder text should not be float ever.
Always
- The placeholder text floats above the TextArea always.
Auto
- The placeholder text floats above the TextArea while focusing or enter a value in TextArea.
Declaration
public TextAreaBuilder FloatLabelType(FloatLabelType floatLabelType)
Parameters
Returns
Focus(String)
Triggers when the TextArea gets focus.
Declaration
public TextAreaBuilder Focus(string focus)
Parameters
Type |
Name |
Description |
System.String |
focus |
|
Returns
HtmlAttributes(Object)
You can add the additional html attributes such as disabled, value etc., to the element.
If you configured both property and equivalent html attribute then the component considers the property value.
Declaration
public TextAreaBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
Input(String)
Triggers each time when the value of TextArea has changed.
Declaration
public TextAreaBuilder Input(string input)
Parameters
Type |
Name |
Description |
System.String |
input |
|
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public TextAreaBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
MaxLength(Double)
Specifies the maximum number of characters allowed in TextArea.
Declaration
public TextAreaBuilder MaxLength(double maxLength)
Parameters
Type |
Name |
Description |
System.Double |
maxLength |
|
Returns
Placeholder(String)
Specifies the text that is shown as a hint/placeholder until the user focus or enter a value in TextArea.
The property is depending on the floatLabelType property.
Declaration
public TextAreaBuilder Placeholder(string placeholder)
Parameters
Type |
Name |
Description |
System.String |
placeholder |
|
Returns
Readonly(Boolean)
Declaration
public TextAreaBuilder Readonly(bool readOnly = true)
Parameters
Type |
Name |
Description |
System.Boolean |
readOnly |
|
Returns
Render()
Declaration
public HtmlString Render()
Returns
Type |
Microsoft.AspNetCore.Html.HtmlString |
ResizeMode(Resize)
Specifies the resize mode of textarea.
possible values are:
Vertical
- The textarea element can be resized vertically.
Horizontal
- The textarea element can be resized horizontally.
Both
- The textarea element can be resized both vertically and horizontally.
None
- The textarea element cannot be resized.
Declaration
public TextAreaBuilder ResizeMode(Resize resizeMode)
Parameters
Type |
Name |
Description |
Resize |
resizeMode |
|
Returns
RowsCount(Double)
specifies the visible height of the textarea, measured in lines
Declaration
public TextAreaBuilder RowsCount(double rowsCount)
Parameters
Type |
Name |
Description |
System.Double |
rowsCount |
|
Returns
ShowClearButton(Boolean)
Specifies a Boolean value that indicates whether the clear button is displayed in TextArea.
Declaration
public TextAreaBuilder ShowClearButton(bool showClearButton = true)
Parameters
Type |
Name |
Description |
System.Boolean |
showClearButton |
|
Returns
Value(String)
Sets the content of the TextArea.
Declaration
public TextAreaBuilder Value(string value)
Parameters
Type |
Name |
Description |
System.String |
value |
|
Returns
Width(Double)
Specifies the width of the TextArea component.
Declaration
public TextAreaBuilder Width(double width)
Parameters
Type |
Name |
Description |
System.Double |
width |
|
Returns
Width(String)
Specifies the width of the TextArea component.
Declaration
public TextAreaBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns