Skip to main content
LinkedIn
Copied!

Table of Contents

Customizing a Signature capture control

Applicable to Theme UI-Kit applications

The Cell Properties dialog for the Signature capture control consists of the following tabs. You can create or modify CSS base styles for the control and create custom Accept / Clear buttons, as described in the subsequent sections, below. See also Adding a Signature Capture control.

Tab Description
General

Displays various configuration settings for how the Signature capture control is displayed via the following fields:

Signature name
Name of the Signature attachment.
Category
Attachment category of the Signature attachment (defaults to file).
Tooltip
Set a tooltip to display on a hover action.
Visibility
Select from the dropdown the conditions for whether the control appears based on user input.
Disable
Select from the dropdown the conditions for when to disable this field.
Tour ID
Optional: Provide an ID for use in a guided tour. Use a combination of numbers, letters, and underscores. Pega Platform uses the Tour ID when it finds an anchor button during a tour stop anchor point.
Test ID
Optional: If authorized, you can provide a unique Test ID to better support automated testing of your application.

When creating a control that supports you can use a combination of numbers, letters, and underscores, or click the Generate ID button to create a unique ID. The attribute data-test-id is then generated for the selected element.

After the test ID has been generated, you can view your Test ID in HTML or display it in the Live UI panel. You also have the option to have all controls that support Test IDs in a ruleset updated in bulk.

The Test ID is available to access groups that include the PegaRULES:TestID privilege. To disable Test ID, remove the PegaRULES:TestID from the access group.

Presentation

Allows you to change the advanced presentation options via the following fields:

Edit options
Selects the edit options for the Signature capture control:
  • Auto – whether the control is read-only or can be edited is inherited from the parent section it appears in. It will be read-only if it is placed in a read-only section. It will be editable if placed in a section that can also be edited.
  • Read-only (expression) – the control will be read-only only if a defined expression holds true.
  • Read-only (when rule) – the control will be read-only only if a defined when rule holds true.
  • Editable – the control is always editable - including when it is placed in a read-only section.
Max width (px)
On desktops, defines the maximum width for the Signature capture canvas in pixels. On mobile devices the canvas takes 100% width available to it. Default value is 700.
Min height (px)
Defines the height for the Signature capture canvas in pixels. Default value is 100.
Hide default accept action
Hides the default Accept action in the control. Selecting this option is useful when creating a custom Accept button.
Hide default accept/clear actions
Hides the default Accept/Clear actions in the control. Selecting this option is useful when creating custom Accept/Clear buttons.
Include a label
Displays a text label for the control.
Label name
Defines the name for the label. Only visible when the Include a label check box is selected.
Label format
Specifies the format for the label. Only visible when the Include a label check box is selected.

Advanced Presentation Options

Instead of creating a new custom format in the skin, you can adjust elements in a cell by applying Cascading Style Sheet (CSS) helper classes. For example, you can use a CSS helper class to center an element in a cell or to double the standard right margin for the element.

  • Cell read-write classes – Click the Open helper class picker icon to specify one or more CSS helper classes to apply to this cell when the form is displayed in read-write mode. You can enter several helper classes, separated by a space. Alternatively, you can enter the name of a custom style to apply to this cell.
  • Cell read-only classes – Click the Open helper class picker icon to specify one or more CSS helper classes to apply to this cell when the form is displayed in read-only mode. You can enter several helper classes, separated by a space. Alternatively, you can enter the name of a custom style to apply to this cell.
  • Inline style (not for production use) – You can use this field to define an inline style by entering CSS code. However, entering an inline style results in a guardrail warning. For maintainability and reuse, the recommended approach is to use read-write or read-only classes.
For more information, see CSS helper classes.

CSS styling options

This control contains border, background and base styles. You can modify them via CSS by overriding the default values. The new style definition is added as a custom style sheet on the Additional CSS tab once you open the application skin - see Skin form - CSS tab, for more information. You can modify the following for the control:

  • signature border thickness
  • signature border color
  • signature background color
  • signature baseline thickness
  • signature baseline color

The following example shows a custom style sheet for the Signature capture control:

*****************************************
* Base styles for signature pad control *
*****************************************
.signature-da-style{
   border: 3px solid #2DA2CF; /* border of signature capture control */
   background-color: #FFFFE6; /* background color of signature canvas */

}

.signature-baseline-style{
   border : 1px solid #2DA2CF; /*thickness and color of signature pad baseline */

}

Using custom Accept / Clear buttons

To add your own custom icons for the Accept and Clear actions in the Signature capture control, leverage a click action with a JavaScript event. Follow the instructions presented below.

  1. Make sure the Hide default Accept/Clear actions option is selected in the options for the control.
  2. Add two icons, for instance, within a section containing the Signature capture control - each representing the Accept and Clear actions.
  3. Open the Cell Properties dialog for each icon and add an action of the Run Script type.
  4. Enter the following JavaScript function name in double quotes, for the action representing the Accept icon:
    • pega.ui.signature.acceptSignature
  5. Enter the following JavaScript function name in double quotes, for the action representing the Clear icon:
    • pega.ui.signature.clearSignature
  6. Make sure that for each function two parameters are defined: signature name and category - to uniquely identify a Signature capture control on a screen.
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