Version: 2.0 |

TextBoxFormGroup

in namespace DotVVM.Framework.Controls.Bootstrap4

Renders a FormGroup control with a TextBox

Properties

Name Type Description Notes Default Value
ContentTemplate List<DotvvmControl> Gets or sets the content of the form group.
attribute
inner element
static value
bindable
default
Enabled Boolean Gets or sets a value indicating whether the control is enabled and can be modified.
attribute
inner element
static value
bindable
default
False
FormatString String Gets or sets a format of presentation of value to client.
attribute
inner element
static value
bindable
default
LabelSize Int32? Gets or sets the size of size the label area for all screen sizes. This applies only to the Horizontal forms.
attribute
inner element
static value
bindable
default
LabelSizeLG Int32? Gets or sets the size of the label area large screen. This applies only to the Horizontal forms.
attribute
inner element
static value
bindable
default
LabelSizeMD Int32? Gets or sets the size of the label area for medium screen. This applies only to the Horizontal forms.
attribute
inner element
static value
bindable
default
LabelSizeSM Int32? Gets or sets the size of the label area small screen. This applies only to the Horizontal forms.
attribute
inner element
static value
bindable
default
LabelSizeXL Int32? Gets or sets the size of the label area for extra large screen. This applies only to the Horizontal forms.
attribute
inner element
static value
bindable
default
LabelTemplate ITemplate Gets or sets the template of the label area. This property cannot be combined with the LabelText property.
attribute
inner element
static value
bindable
default
LabelText String Gets or sets the label text. This property cannot be combined with the LabelTemplate property.
attribute
inner element
static value
bindable
default
SelectAllOnFocus Boolean Gets or sets whether all text inside the TextBox becomes selected when the element gets focused.
attribute
inner element
static value
bindable
default
False
Size Size Gets or sets the size of controls in the form group.
attribute
inner element
static value
bindable
default
Default
Text Object Gets or sets the text in the TextBox.
attribute
inner element
static value
bindable
default
TextBoxType TextBoxType Gets or sets the mode of the text field.
attribute
inner element
static value
bindable
default
Normal
Type FormGroupType Gets or sets the type of the form.
attribute
inner element
static value
bindable
default
Default
UpdateTextAfterKeydown Boolean Gets or sets whether the viewmodel property will be updated after the key is pressed. By default, the viewmodel is updated after the control loses its focus.
attribute
inner element
static value
bindable
default
False

Events

Name Type Description
Changed Command Gets or sets the command that will be triggered when the onchange event is fired.

Usage & Scenarios

Represents a TextBox in FormGroup.

HTML Rendered by the Control

Sample 1: Basic Text Box Form Group

The TextBoxFormGroup control has the LabelText property for the label and the Text property for text inside the text field.

Both these properties can also be binded to properties in viewmodel.

<bs:TextBoxFormGroup LabelText="Static label" Text="Static value" />

<bs:TextBoxFormGroup LabelText="{value: LabelText}" Text="{value: ValueText}" />

<bs:TextBoxFormGroup LabelText="No value" />
using DotVVM.Framework.ViewModel;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap4.TextBoxFormGroup.sample1
{
    public class ViewModel : DotvvmViewModelBase
    {
        public string LabelText { get; set; } = "Binded label";
        public string ValueText { get; set; } = "Binded value";
    }
}

Sample 2: Text Box Form Group - Enabled and Visible

The Enabled property is used to enable / disable the TextBoxFormGroup control.

It is also possible to show / hide the TextBoxFormGroup control with the Visible property.

<bs:TextBoxFormGroup LabelText="Label" Text="Enabled textbox" Enabled="true" />

<bs:TextBoxFormGroup LabelText="Label" Text="Disabled textbox" Enabled="false" />

<bs:TextBoxFormGroup LabelText="Label" Text="Visible textbox" Visible="{value: TrueValue}" />

<bs:TextBoxFormGroup LabelText="Label" Text="Invisible textbox" Visible="{value: FalseValue}" />
using DotVVM.Framework.ViewModel;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap4.TextBoxFormGroup.sample2
{
    public class ViewModel : DotvvmViewModelBase
    {
        public bool TrueValue { get; set; } = true;
        public bool FalseValue { get; set; } = false;
    }
}

Sample 3: Text Box Form Group - Format String

The content of TextBox can be formatted with the FormatString property if needed.

<bs:TextBoxFormGroup LabelText="Formating string" Text="{value: NumberValue}" FormatString="#0.00" />
using DotVVM.Framework.ViewModel;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap4.TextBoxFormGroup.sample3
{
    public class ViewModel : DotvvmViewModelBase
    {
        public double NumberValue { get; set; } = 123.456789;
    }
}

Sample 4: Text Box Form Group - Type and ValueType

The Type property is used to change the mode of the text field. Possible values are:

  • Normal
  • Password
  • MultiLine
  • Telephone
  • Url
  • Email
  • Date
  • Time
  • Color
  • Search
  • Number

The ValueType property is used for changing the type of value being formatted. Possible values are:

  • Text
  • DateTime
  • Number
<bs:TextBoxFormGroup LabelText="Password box" Text="password" Type="Password" />

<bs:TextBoxFormGroup LabelText="Numeric value" Text="0" ValueType="Number" />

Sample 5: Text Box Form Group - UpdateTextAfterKeydown and Changed

If you need property binded to Text property to update after every pressed key just set the UpdateTextAfterKeydown property to true.

With the Changed property it is possible to bind to onchange event and perform specific actions when the value of text field changes.

<bs:TextBoxFormGroup LabelText="Update test" Text="{value: UpdateTestText}" UpdateTextAfterKeydown="true" />
<span>{{value: UpdateTestText}}</span>

<bs:TextBoxFormGroup LabelText="OnChanged test" Text="{value: ChangedTestText}" Changed="{command: Changed()}" />
<span>{{value: ChangedValue}}</span>
using DotVVM.Framework.ViewModel;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap4.TextBoxFormGroup.sample5
{
    public class ViewModel : DotvvmViewModelBase
    {
        public string UpdateTestText { get; set; } = "Change this";
        public string ChangedValue { get; set; } = "Not changed";
        public string ChangedTestText { get; set; } = "text";

        public void Changed()
        {
            ChangedValue = "Changed to " + ChangedTestText;
        }
    }
}

Suggestions


Help & Contribute

The documentation is maintained on GitHub.
We'll be happy if you edit the page and create a pull request.

Send message