Skip to main content

TextBox How To's

How to's for the #linkDocument(DeveloperGuides.IDE.Form.TextBox) (TextBox) guide.

How to Set Placeholder?​

How to Set Placeholder Text in a TextBox​

The Placeholder property is used to display instructional or hint text inside a TextBox before the user types anything.

Steps​

  1. Select the TextBox control on the form design screen.
  2. In the Appearance panel, locate the field named Placeholder.
  3. Enter the text you want to display (e.g., “Please enter your name”).
  4. Save the form.

How to Use a TextBox?​

How to Use a TextBox?​

A TextBox is a fundamental component used in Synergy form design for both data entry and data display.
The steps below show how to add a TextBox to a form and how to configure it.

How to Add a TextBox to a Form?​

  1. Open the Synergy IDE form design screen.
  2. Locate the Form Objects (Toolbox) panel.
  3. Drag and drop the TextBox object onto the form.
  4. Select the object and configure it using the following tabs:
    • General
    • Label
    • Behavior
    • Appearance
    • Events

Binding the TextBox to a Form Field​

If needed, a TextBox can be bound to a form field:

  • When bound to a field in the form data model, the value entered by the user is automatically written to the model.
  • Dynamic data, programmatic values, or calculated information can be displayed inside the TextBox.

Why the TextBox Is Important​

  • Provides a flexible and easy method for data entry.
  • Supports advanced features such as validation, masking, and formatting.
  • Can operate in both editable and read-only modes.
  • Fully compatible with workflows, process forms, and data integrations.

The TextBox is an essential part of a user-friendly and efficient form design.

How to Set ReadOnly?​

How to Make a TextBox ReadOnly​

To prevent the user from editing while still displaying data, enable the Read Only option.

Steps​

  1. Select the TextBox component.
  2. In the Behavior panel, locate the Read Only field.
  3. Switch the toggle to Enabled.
  4. Save the form.

When to use​

  • Displaying system-generated values
  • Showing calculated fields
  • Locking fields based on user roles or conditions

How to Use Client Enabled?​

What is Client Enabled?​

Client Enabled is a property that defines whether a form control is active (enabled) on the client side when the form is first loaded.
If it is set to True, the control is immediately usable by the user.
If it is set to False, the control is disabled and cannot be interacted with until a specific condition or rule activates it.

This property is especially useful for controlling the user’s interaction flow and applying dynamic behaviors using the Rule Manager.

What Does It Do?​

The property allows developers to:

  • Control when a form control becomes interactive.
  • Prevent users from entering or changing data until prerequisites are met.
  • Dynamically enable or disable controls based on user input or logic.

Example Scenario — Conditional Activation​

Scenario:
A form contains a checkbox called “I Accept Terms” and a text field called “Signature.”
The goal is to make the “Signature” field inactive until the user checks “I Accept Terms.”

Steps to Implement:​

  1. Select the “Signature” field in the form editor.

  2. In the Properties panel, find the Client Enabled field.

  3. Set the value to False — the field will now be disabled by default when the form loads.

  4. Open the Rule Manager.

  5. Add a new rule:

    Condition:

Action:

  1. Save and publish the form.

Result:​

  • When the form loads, the “Signature” field is disabled.
  • Once the user checks “I Accept Terms,” the field automatically becomes active and editable.

Behavior Summary​

Property StateDescription
TrueThe control is active and ready for user interaction when the form loads.
FalseThe control is disabled at load time and can be enabled dynamically via rules or code.

Notes & Best Practices​

  • Use the Client Enabled property to manage client-side interactivity without requiring server actions.
  • Combine it with Rule Manager to define when and how controls become active.
  • Remember: if server enablement is disabled, the client cannot enable the control even if Client Enabled is set to True.
  • By default, this property is set to True (active).

Summary​

Client Enabled improves form usability by letting developers control when and how users interact with form controls.
It is essential for creating responsive, condition-based form experiences where user actions dynamically change the form’s state.

What Is a TextBox?​

shortDescription​

What is the TextBox object and for which purposes is it used in Synergy forms?​

What Is a TextBox?​

A TextBox is one of the most essential input control objects used in Synergy forms.
It allows the user to enter, display, and edit text-based information.

It can be used to represent the following data types:

  • Name, description, title
  • Code or reference number
  • Numeric character strings
  • Free-text fields

Purpose of the TextBox​

A TextBox is used for the following purposes:

  • Collecting data from users (e.g., name, description, code)
  • Displaying previously saved information
  • Showing dynamic values by binding to a data source
  • Working in harmony with other components such as ComboBox, NumberBox, DataGrid, and Lookup

Since it is needed in almost every form, it is one of the core elements of form design.

Where Is the TextBox Used?​

A TextBox is preferred in the following scenarios:

  • Request or application forms
  • Description / comment fields
  • Code or reference number entries
  • Displaying read-only values coming from query results
  • Capturing search text input
  • Displaying dynamic or calculated values