Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Specifying the caption for a Button control

Updated on April 5, 2022

Using a caption for a Button control makes it easier for application users to understand the button's purpose and to complete their tasks.

If you plan to localize the application that includes this Button control, limit the caption's text length to 64 characters. A field value rule with pyButtonLabel as the second key part and this text as the final key part is needed for each locale. When practical, choose a caption that is already included in a language pack, to simplify later localization.

  1. On the General tab of the Properties panel, set the Button caption option to one of the following settings:

    • Text – Select this setting and in the adjacent field enter the text to display as the button's caption.
    • Property Reference – Select this setting and use the adjacent field to configure the button caption as a property reference.
  2. To make it possible for users to execute a button's activity by using shortcut keys, include an ampersand (&) immediately before a letter in the caption text to designate that letter as the shortcut key.

    For example, enter &History as the caption text to allow application users to press ALT + h to access work item history.

  3. If your application includes non-autogenerated sections that reference buttons using the ampersand shortcut technique, you must revise the section to include the following JavaScript line:

    pega.u.d. processAccessKeysOnClient = true

    If the sections are part of a harness, you can reference a JavaScript function containing the above line on the Scripts & styles tab of the Harness form.

  • Button controls

    Use a Button control to enable users to take action on a form, such as submitting the form after filling it out.

  • Styling options for Button controls

    Establishing a consistent look for Button controls in your application saves development time, gives your application a more predictable user interface, and makes it easier for users to complete forms.

  • Adding and configuring a Button control

    By adding a Button control to a layout, you make it possible for application users to complete a task, such as submitting a form after completing its fields. By configuring a Button control, you give your application a consistent look and feel.

  • Specifying the image source and tooltip for a Button control

    Using images and tooltips to indicate a button's purpose makes it easier for application users to understand a form and to complete their tasks.

  • Specifying presentation options for a Button control

    Three predefined formats are available for buttons: Strong, Standard, and Simple. Using these formats consistently in your application makes the user interface more predictable and makes it easier for users to complete forms.

  • Defining the behavior of form elements

    Ensure that users see and complete only the fields that are relevant to the processing of a case by defining the rules that govern the behavior of form elements.

  • Copying, moving, or deleting a control

    You can use basic Windows operations to speed the development of your controls.

  • Previous topic Adding a Button control to a harness
  • Next topic Specifying the image source and tooltip for a Button control

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us