TextBoxGroup

in namespace DotVVM.Framework.Controls.Bootstrap

Represents a group of Label and TextBox in the Form control.

Usage & Scenarios

Represents a group of Label and TextBox in the Form control.

Sample 1: Basic Text Box Group

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

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

page.dothtml
ViewModel.cs

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

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

    <bs:TextBoxGroup LabelText="No value" />
</bs:Form>

using DotVVM.Framework.ViewModel;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap.TextBoxGroup.sample1
{
    public class ViewModel : DotvvmViewModelBase
    {
        public string LabelText { get; set; } = "Data-bound label";
        public string ValueText { get; set; } = "Data-bound value";
    }
}

Sample 2: Text Box Group - Enabled and Visible

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

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

page.dothtml
ViewModel.cs

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

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

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

    <bs:TextBoxGroup LabelText="Label" Text="Invisible textbox" Visible="{value: FalseValue}" />
</bs:Form>

using DotVVM.Framework.ViewModel;

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

Sample 3: Text Box Group - Format String

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

page.dothtml
ViewModel.cs

<bs:Form>
    <bs:TextBoxGroup LabelText="Formatting string" Text="{value: NumberValue}" FormatString="#0.00" />
</bs:Form>

using DotVVM.Framework.ViewModel;

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

Sample 4: Text Box Group - Type

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

page.dothtml

<bs:Form>
    <bs:TextBoxGroup LabelText="Password box" Text="password" Type="Password" />

    <bs:TextBoxGroup LabelText="Numeric value" Text="0" />
</bs:Form>

Sample 5: Text Box Group - UpdateTextAfterKeydown and Changed

If you need property bound 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.

page.dothtml
ViewModel.cs

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

    <bs:TextBoxGroup LabelText="OnChanged test" Text="{value: ChangedTestText}" Changed="{command: Changed()}" />
</bs:Form>

<span>{{value: UpdateTestText}}</span>
<br />
<span>{{value: ChangedValue}}</span>

using DotVVM.Framework.ViewModel;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap.TextBoxGroup.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;
        }
    }
}

Show all inherited properties

Properties

Name	Type	Description	Notes	Default Value
ClientIDMode	ClientIDMode	Gets or sets the client ID generation algorithm.	attribute inner element static value bindable default	Static
DataContext	Object	Gets or sets a data context for the control and its children. All value and command bindings are evaluated in context of this value. The DataContext is null in client-side templates.	attribute inner element static value bindable default	null
Enabled	Boolean	Gets or sets a value indicating whether the control is enabled and can be modified.	attribute inner element static value bindable default	True
FormatString	String	Gets or sets a format of presentation of value to client.	attribute inner element static value bindable default	null
FormContent	List<DotvvmControl>	Gets or sets the content of the form group.	attribute inner element static value bindable default	null
ID	String	Gets or sets the control client ID within its naming container.	attribute inner element static value bindable default	null
IncludeInPage	Boolean	Gets or sets whether the control is included in the DOM of the page.	attribute inner element static value bindable default	True
InnerText	String	Gets or sets the inner text of the HTML element. Note that this property can only be used on HtmlGenericControl directly and when the control does not have any children.	attribute inner element static value bindable default	null
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	null
LabelText	String	Gets or sets the label text. This property cannot be combined with the LabelTemplate property.	attribute inner element static value bindable default	null
RenderContentContainers	Boolean	Gets or sets whether an additional container will be rendered around the content.	attribute inner element static value bindable default	True
Text	Object	Gets or sets the text in the TextBox.	attribute inner element static value bindable default
Type	TextBoxType	Gets or sets the mode of the text field.	attribute inner element static value bindable default	Normal
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
Visible	Boolean	Gets or sets whether the control is visible. When set to false, `style="display: none"` will be added to this control.	attribute inner element static value bindable default	True