Masked Text Box

Properties

• Class is an optional CSS class (or space separated classes) added to the top level of the control. CSS specific to the control can be applied. The class must be defined in a Renderer CSS file. For more information, see Custom Styles.

• Disabled sets a control to disabled.

  • Must be true or false, or a binding beginning with "vm.models.".

  • A property array string index requires single quotes, e.g., vm.models.xxx.CustomProperties['yyyyy'].

  • An expression can be used that evaluates to true or false, e.g., vm.models.myvalue==7 (>,<, !=, ==, >=, <=).

  • If comparing to a string, it must be in single quotes.

  • (true and false must be all lowercase)

• Format controls the input format for masked text values. The Mask Rules table lists the valid input characters.

  Mask Rules

  Rule	Description
  0	Digit. Accepts any digit between 0 and 9.
  9	Digit or space. Accepts any digit between 0 and 9, plus space.
  #	Digit or space. Like 9 rule but allows also (+) and (-) signs.
  L	Letter. Restricts input to letters a-z and A-Z. This rule is equivalent to [a-zA-Z] in regular expressions.
  ?	Letter or space. Restricts input to letters a-z and A-Z. This rule is equivalent to [a-zA-Z] in regular expressions.
  &	Character. Accepts any character. The rule is equivalent to \S in regular expressions.
  C	Character or space. Accepts any character. The rule is equivalent to . in regular expressions.
  A	Alphanumeric. Accepts letters and digits only.
  a	Alphanumeric or space. Accepts letters, digits and space only.
  .	Decimal placeholder. The decimal separator will be taken from the current culture used by Kendo.
  ,	Thousands placeholder. The display character will be taken from the current culture used by Kendo.
  $	Currency symbol. The display character will be taken from the current culture used by Kendo.

• Id is required. It can be any valid JavaScript id attribute value. (Must start with a letter followed by 0 to 9, a to z, dash, or underscore characters).

  • Using a globally unique identifier (GUID) from GuidGen or GuidGenerator prefixed by at least one letter prevents a clash with any other id.

  • Id should contain only a to z (uppercase or lowercase), 0 to 9, dash, or underscore. It should not have spaces.

  • Binding is not supported for this property.

• Label is the value displayed in the label.

  • If this value is bound, it must be enclosed in double braces, e.g., {{vm.models.myLabel}}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Model is required for binding to a workflow argument or another control. If the Model property is not specified, the component will be displayed on the form, but any values the user enters on the form cannot be captured or used in the workflow.

  • The Model value must always start with "vm.models.", e.g., vm.models.myArgument.

  • This value may initialize the control, and may be updated by the control, and if matched to a workflow argument, is available in the workflow (readable or writable).

  • Ensure your model argument is defined in your workflow for custom components if it is used in the workflow. Otherwise, a workflow argument is not required.

  • The casing of an argument used in the workflow MUST match the "vm.models." suffix casing.

  • If the model addresses CustomProperties or MultiValueCustomProperties, the property identifier string must be enclosed in single quotes, e.g., vm.models.myentity.CustomProperties['mycustomprop']

  If an OData query is specified and this binding is specified, it will be overwritten with the value of the OData query results and thus be available read-only in the workflow.

  If only "Model Data" is specified and the workflow variable is either not initialized or set to an empty array, this value will be initialized to the "Model Data" value.

  Construction of the model in the workflow is done by assigning data from a provider.

• Placeholder is the prompt text displayed in a ghost style in an input box when nothing has been entered.

  • If this property is bound, it must start with {{vm.models. and end with }}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Read-only makes the control read-only. It is set to false by default. If you want the component to be read-only, set the property value to true. It is typically used for an input box.

  • Can be bound to a workflow argument or another control's value.

  • A property array string index requires single quotes, e.g., vm.models.xxx.CustomProperties['yyyyy'].

  • An expression can be used that evaluates to true or false, e.g., vm.models.myvalue==7 (>,<, !=, ==, >=, <=).

  • If comparing to a string, it must be in single quotes.

  • (true and false must be all lowercase)

• Required makes the control required and will raise a validation error on the form. It is set to false by default. If input is required, set the property value to true. The rendered form will display a red asterisk () next to the component.

  • Can be bound to a workflow argument or another control's value.

  • A property array string index requires single quotes, e.g., vm.models.xxx.CustomProperties['yyyyy'].

  • An expression can be used that evaluates to true or false, e.g., vm.models.myvalue==7 (>,<, !=, ==, >=, <=).

  • If comparing to a string, it must be in single quotes.

  • (true and false must be all lowercase)

• Required Message is optional. It overrides the default "Required" message.

  • If this value is bound, it must be enclosed in double braces, e.g., {{vm.models.myMessage}}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Tab Index allows you to specify the order of elements that are brought into focus when the user presses the Tab key on the rendered form. Allowed values are -1, 0, and positive numbers.

  • A value of "-1" removes the element from the sequential tab order preventing keyboard users from focusing on it.

  • A value of "0" means the element is ignored in the tab order, but that does not mean users cannot tab to and focus an element.

  • A value of "1" sets the element as the first item to gain focus when tabbing through the page followed by any higher numbered tab indices, followed by any other keyboard focusable elements such as buttons. required fields, and CAPTCHA.

    The tab index value should not match another control's tab index.

  • A blank value (default) will not add a tab index in the HTML.

  For more information, see https://html.spec.whatwg.org/multipage/interaction.html#the-tabindex-attribute and https://www.alexlande.com/articles/cross-browser-tabindex-woes/.

• Tooltip is the value to display when hovering over the control's label.

  • If this value is bound, it must be enclosed in double braces, e.g., {{vm.models.myTooltip}}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Tooltip Duration is the amount of time in milliseconds a tooltip is displayed (default=750). The value must be greater than 0. If it is set to 0, a form validation error will occur.

  • If this value is bound, it must be enclosed in double braces, e.g., {{vm.models.myToolTip}}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Validation Message is the message shown when the user's input does not match the pattern of the regular expression defined in the Validation Regex property.

• Validation Regex is the regular expression pattern to validate the input. Use site like RegExLib.com to search and test Regex patterns, or construct your own with Regex tools like Expresso. If the user input does not produce a Regex match, the "Validation message" will be displayed.

  Examples:

  • Regex that enforces a minimum of 11 digits for a phone number where the first digit must be "1": 1\d{10}

  • Regex that enforces a phone number in the format (###)###-####: ^\([0-9]{3}\)[0-9]{3}\-[0-9]{4}$

  • Regex that matches a hyphen-separated social security number: ^\d{3}-\d{2}-\d{4}$

• Visible makes the control visible or hidden.

  • Can be bound to a workflow argument or another control's value. This property is dynamic.

  • A property array string index requires single quotes, e.g., vm.models.xxx.CustomProperties['yyyyy'].

  • An expression can be used that evaluates to true or false, e.g., vm.models.myvalue==7 (>,<, !=, ==, >=, <=). If comparing to a string, it must be in single quotes.

  • (true and false must be all lowercase)

  • When the control is not visible (usually based on some condition) and is a required field, the required field validation will not be triggered.

 

Properties

• Class is an optional CSS class (or space separated classes) added to the top level of the control. CSS specific to the control can be applied. The class must be defined in a Renderer CSS file. For more information, see Custom Styles.

• Disabled sets a control to disabled.

  • Must be true or false, or a binding beginning with "vm.models.".

  • A property array string index requires single quotes, e.g., vm.models.xxx.CustomProperties['yyyyy'].

  • An expression can be used that evaluates to true or false, e.g., vm.models.myvalue==7 (>,<, !=, ==, >=, <=).

  • If comparing to a string, it must be in single quotes.

  • (true and false must be all lowercase)

• Format controls the input format for masked text values. The Mask Rules table lists the valid input characters.

  Mask Rules

  Rule	Description
  0	Digit. Accepts any digit between 0 and 9.
  9	Digit or space. Accepts any digit between 0 and 9, plus space.
  #	Digit or space. Like 9 rule but allows also (+) and (-) signs.
  L	Letter. Restricts input to letters a-z and A-Z. This rule is equivalent to [a-zA-Z] in regular expressions.
  ?	Letter or space. Restricts input to letters a-z and A-Z. This rule is equivalent to [a-zA-Z] in regular expressions.
  &	Character. Accepts any character. The rule is equivalent to \S in regular expressions.
  C	Character or space. Accepts any character. The rule is equivalent to . in regular expressions.
  A	Alphanumeric. Accepts letters and digits only.
  a	Alphanumeric or space. Accepts letters, digits and space only.
  .	Decimal placeholder. The decimal separator will be taken from the current culture used by Kendo.
  ,	Thousands placeholder. The display character will be taken from the current culture used by Kendo.
  $	Currency symbol. The display character will be taken from the current culture used by Kendo.

• Id is required. It can be any valid JavaScript id attribute value. (Must start with a letter followed by 0 to 9, a to z, dash, or underscore characters).

  • Using a globally unique identifier (GUID) from GuidGen or GuidGenerator prefixed by at least one letter prevents a clash with any other id.

  • Id should contain only a to z (uppercase or lowercase), 0 to 9, dash, or underscore. It should not have spaces.

  • Binding is not supported for this property.

• Label is the value displayed in the label.

  • If this value is bound, it must be enclosed in double braces, e.g., {{vm.models.myLabel}}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Model is required for binding to a workflow argument or another control. If the Model property is not specified, the component will be displayed on the form, but any values the user enters on the form cannot be captured or used in the workflow.

  • The Model value must always start with "vm.models.", e.g., vm.models.myArgument.

  • This value may initialize the control, and may be updated by the control, and if matched to a workflow argument, is available in the workflow (readable or writable).

  • Ensure your model argument is defined in your workflow for custom components if it is used in the workflow. Otherwise, a workflow argument is not required.

  • The casing of an argument used in the workflow MUST match the "vm.models." suffix casing.

  • If the model addresses CustomProperties or MultiValueCustomProperties, the property identifier string must be enclosed in single quotes, e.g., vm.models.myentity.CustomProperties['mycustomprop']

  If an OData query is specified and this binding is specified, it will be overwritten with the value of the OData query results and thus be available read-only in the workflow.

  If only "Model Data" is specified and the workflow variable is either not initialized or set to an empty array, this value will be initialized to the "Model Data" value.

  Construction of the model in the workflow is done by assigning data from a provider.

• Placeholder is the prompt text displayed in a ghost style in an input box when nothing has been entered.

  • If this property is bound, it must start with {{vm.models. and end with }}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Read-only makes the control read-only. It is set to false by default. If you want the component to be read-only, set the property value to true. It is typically used for an input box.

  • Can be bound to a workflow argument or another control's value.

  • A property array string index requires single quotes, e.g., vm.models.xxx.CustomProperties['yyyyy'].

  • An expression can be used that evaluates to true or false, e.g., vm.models.myvalue==7 (>,<, !=, ==, >=, <=).

  • If comparing to a string, it must be in single quotes.

  • (true and false must be all lowercase)

• Required makes the control required and will raise a validation error on the form. It is set to false by default. If input is required, set the property value to true. The rendered form will display a red asterisk () next to the component.

  • Can be bound to a workflow argument or another control's value.

  • A property array string index requires single quotes, e.g., vm.models.xxx.CustomProperties['yyyyy'].

  • An expression can be used that evaluates to true or false, e.g., vm.models.myvalue==7 (>,<, !=, ==, >=, <=).

  • If comparing to a string, it must be in single quotes.

  • (true and false must be all lowercase)

• Required Message is optional. It overrides the default "Required" message.

  • If this value is bound, it must be enclosed in double braces, e.g., {{vm.models.myMessage}}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Tab Index allows you to specify the order of elements that are brought into focus when the user presses the Tab key on the rendered form. Allowed values are -1, 0, and positive numbers.

  • A value of "-1" removes the element from the sequential tab order preventing keyboard users from focusing on it.

  • A value of "0" means the element is ignored in the tab order, but that does not mean users cannot tab to and focus an element.

  • A value of "1" sets the element as the first item to gain focus when tabbing through the page followed by any higher numbered tab indices, followed by any other keyboard focusable elements such as buttons. required fields, and CAPTCHA.

    The tab index value should not match another control's tab index.

  • A blank value (default) will not add a tab index in the HTML.

  For more information, see https://html.spec.whatwg.org/multipage/interaction.html#the-tabindex-attribute and https://www.alexlande.com/articles/cross-browser-tabindex-woes/.

• Tooltip is the value to display when hovering over the control's label.

  • If this value is bound, it must be enclosed in double braces, e.g., {{vm.models.myTooltip}}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Tooltip Duration is the amount of time in milliseconds a tooltip is displayed (default=750). The value must be greater than 0. If it is set to 0, a form validation error will occur.

  • If this value is bound, it must be enclosed in double braces, e.g., {{vm.models.myToolTip}}.

  • Allowable suffix characters: starts with letter, then letters, numerals, or underscore.

• Validation Message is the message shown when the user's input does not match the pattern of the regular expression defined in the Validation Regex property.

• Validation Regex is the regular expression pattern to validate the input. Use site like RegExLib.com to search and test Regex patterns, or construct your own with Regex tools like Expresso. If the user input does not produce a Regex match, the "Validation message" will be displayed.

  Examples:

  • Regex that enforces a minimum of 11 digits for a phone number where the first digit must be "1": 1\d{10}

  • Regex that enforces a phone number in the format (###)###-####: ^\([0-9]{3}\)[0-9]{3}\-[0-9]{4}$

  • Regex that matches a hyphen-separated social security number: ^\d{3}-\d{2}-\d{4}$

• Visible makes the control visible or hidden.

  • Can be bound to a workflow argument or another control's value. This property is dynamic.

  • A property array string index requires single quotes, e.g., vm.models.xxx.CustomProperties['yyyyy'].

  • An expression can be used that evaluates to true or false, e.g., vm.models.myvalue==7 (>,<, !=, ==, >=, <=). If comparing to a string, it must be in single quotes.

  • (true and false must be all lowercase)