Skip to main content

Table of Contents

Specifying the caption for a Button control

Applicable to Theme UI-Kit applications

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.

Did you find this content helpful?

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us