Workflow and ServiceDesk Community

 View Only

TextBox 

Jun 13, 2012 10:21 AM

TextBox

Component definition

This component adds a text box to a form. You can use this component only in a Windows or Web form builder component. At run-time, users type text into the text box, and the component creates a process variable of the text.

Component icon

edit.png

Description of component output paths

Unknown

The component output paths are described in the following table:

Property

Description

Unknown

Unknown

Unknown

Unknown

Description of component tabs and their properties

The properties on the Functionality tab in the TextBox component are listed and described in the following table:

Section

Property

Description

Data

Output Data

A variable from within your Project to hold the output data.

If you do not have a variable already declared, enter the name you want for the variable. A variable of this name is created when the Project is created.

 

Initial Value

An initial value for your text box.

Places the initial value in the text box until the user enters a value, even if the Output Data variable contains data before this component starts.

If no initial value is entered, No Value Set becomes the initial value.

 

Always Use Default Value

Lets you select if you always want an initial value to appear in this text box.

Lets you remove the data in the text box if your process loops to it. If you want to remove the data, every time it is accessed.

 

Output Paths

Lets you select how you want to use this component in each output path on the Web form.

Output Paths options:

  • Required

    This component is required for this output path.

  • Optional

    This component is optional for this output path.

  • Ignored

    This component is ignored for this output path.

 

Read Only

Unknown

Behavior

Custom Events

A list of customized events to which you want this component to respond.

You can add an event handler when you click Add and select the event name. Then, in the Edit Object dialog box, you can select the behavior configuration for the event handler you chose.

 

Remove HTML

Unknown

 

Remove Script Tags

Unknown

 

Script Regular Expression

Unknown

 

Post Form On Value Change

Lets you post the value in this text box to the Output Data variable as soon as a user clicks out of this component.

If Post Form On Value Change is unchecked, when a user clicks out of this component, the value in this text box is placed in a temporary variable. When the user takes a path out of the form, the value from the temporary variable is placed in the Output Data variable.

 

Specify Control ID

Lets you specify your own control ID.

If this option is unchecked, an automatically created control ID is specified for this component.

 

Control ID

Lets you enter a unique identifier for this component that identifies this component to the Web browser.

 

Tab Index

Lets you enter the tab order for this component on the page.

When a user presses the tab key, the curser moves to the component with the next, consecutive numbered Tab Index on the form.

 

Tab Stop

Lets you enable this component to be a tab stop.

If Tab Stop is unchecked, a user cannot get to this component by using the tab key.

 

Tool Tip

Lets you enter a tool tip for this component.

Tool tips are displayed when the user hovers the cursor over the component.

 

Visible

Lets you select whether you want this component to be visible.

Lets you use a variable for this component. Your workflow can change the variable so that this component only appears on the form in certain instances; for example, only on Tuesday.

Validation

Required Error Message

Lets you display an error message if you set this component to Required but the user did not select a value.

"Required" means that it is necessary for the successful completion of your form.

 

Use Custom Validation

Lets you select to use a custom validation system for this component.

A custom validation lets you check whether a user's input is valid. For example, you may want to check to see if the user provided a valid address.

 

Custom Validation Model

Lets you create a validation model.

Validation models are sets of components, arranged in a logical line which checks if the user's input is valid.

The model works by saving the user's entry in a variable called CustomValidationInput. This variable can be used elsewhere in your Project by selecting it under the OptionalData classification in the Select Variable window.

In this model, Symantec recommends that you use the form data variables. These variables only exist in the form.

The properties on the Appearance tab in the TextBox component are listed and described in the following table:

Section

Property

Description

Appearance

Component Size

Lest you specify the size you want for the component.

You can also adjust the component size when you click on it and drag on the box.

 

Overflow Behavior

Lets you select the behavior if a user types text that is wider than the component.

Overflow Behavior drop-down list options:

  • Overflow

    The component expands as the user types.

  • Clip

    Does not show the words that go past the edge of the component.

  • Scroll

    Places a scroll bar on the component, which lets the user scroll to see all the text.

Format

Text Box Mode

Lets you select the mode you want for your component.

Text Box Mode drop-down list options:

  • SingleLine

    Displays a single line only.

  • MultiLine

    Displays multiple lines.

  • Password

    Replaces all characters that are entered with an asterisk.

 

Maximum Length

Lets you set the maximum number of characters a user can enter in the component.

Look And Feel

Style

Lets you select the style information you want for this component. Style information includes font name, font face, font color, background color, and so forth.

 

Theme Style

Lets you select the theme style for this component.

Theme styles are only available when a theme is added to the form.

The properties on the Settings tab in the TextBox component are listed and described in the following table:

Property

Description

Component Class Name

The class name of this component. This property is not editable, but useful if you call Symantec support.

Description

The description of this component. This property lets you describe how the component is used. You can use it to provide any wanted documentation for this component.

This description is included in the model reports that are created when you click Plugins > Generate Business Model.

Location

The physical location of the top left point of this component on the workflow model.

Name

The name of this component. You can change the name.

If you changed the component name when you double-clicked it on the workflow model, the changed name appears here.

To Do

This property lets you record what you still need to do with the component. Use this property to help you remember the configuration that you want to apply to this component.

The text that you enter for this property appears at the bottom of the component editor. If you enter text for this property, a checklist symbol appears on the component in the workflow model.

Connection information

Not applicable

Component settings

Unknown

Use cases

Some examples for the TextBox component are as follows:

 
  • Text box for various text data

    A form uses text boxes for various text data.

  • Text box with default value

    A form includes text boxes with predefined values. Users see this text in the text box when they first open the form.

Text box for various text data

On a survey form, employees are asked to fill in a number of fields.

The following screen shot shows the run-time form:

In this example form, the two text boxes are empty. Two label components (Name and Comments) mark the text boxes. These labels are separate components; they are not part of the text box components.

If you double-click on the Name Text Box component, you see its editor.

The following screen shot shows the TextBox editor:

The output data variable is called SurveyName. This text-type variable is available to other components in the process after the user defines it.

Text box with default value

You can make a text box display a default text value when opened in a form. For example, in an employee survey, you want instructions to appear inside each text box instead of in a label component.

The following screen shot shows the form at run time:

The following screen shot shows the text box editor when it is set to show a default text value:

Compare the TextBox component with the MaskEdit text box component. The MaskEdit text box component lets you specify a format for user input. For example, using the MaskEdit text box component, you can force users to enter a phone number in a certain format (such as xxx-xxx-xxxx).

 

Statistics
0 Favorited
1 Views
0 Files
0 Shares
0 Downloads

Tags and Keywords

Related Entries and Links

No Related Resource entered.