38.6 apex.lang namespace

Add messages for use by getMessage and the format functions. Can be called multiple times. Additional messages are merged. It is generally not necessary to call this function, because it is automatically called with all the application text messages that have Used in JavaScript set to Yes.

Parameters

Example

This example adds a message.

apex.lang.addMessages({
  APPLY_BUTTON_LABEL: "Apply"
});

Remove all messages.

Parameters

None.

Example

This example removes all messages.

apex.lang.clearMessages()

Same as formatMessage except the message pattern is given directly (already localized or isn't supposed to be). It is not a key. The replacement arguments are HTML escaped.

Parameters

Returns

The localized and formatted message text string.

Example

This example returns Total cost: $34.00 assuming the orderTotal variable equals 34.00.

apex.lang.format("Total cost: $%0", orderTotal);

Format a message. Parameters in the message %0 to %9 are replaced with the corresponding function argument. Use %% to include a single %. The replacement arguments are HTML escaped.

Parameters

Returns

The localized and formatted message text string. If the key is not found then the key is returned.

Example

This example returns "Process 60% complete" when the PROCESS_STATUS message text is "Process %0%% complete" and the progress variable value is 60.

apex.lang.formatMessage("PROCESS_STATUS", progress);

Same as formatMessage except the replacement arguments are not HTML escaped. They must be known to be safe or are used in a context that is safe. See "apex.lang.formatMessage".

Parameters

Returns

The localized and formatted message text string. If the key is not found then the key is returned.

Example

This example returns "You entered <ok>" when the CONFIRM message text is "You entered %0" and the inputValue variable value is "<ok>". Note this string must be used in a context where HTML escaping is done to avoid XSS vulnerabilities.

apex.lang.formatMessageNoEscape("CONFIRM", inputValue);

Same as format, except the replacement arguments are not HTML escaped. They must be known to be safe or are used in a context that is safe.

Parameters

Returns

The localized and formatted message text string. If the key is not found then the key is returned.

Example

This example returns "You entered <ok>" when the inputValue variable value is "<ok>". Note this string must be used in a context where HTML escaping is done to avoid XSS vulnerabilities.

apex.lang.formatNoEscape("You entered %0", inputValue);

Return the message associated with the given key. The key is looked up in the messages added with addMessages.

Parameters

Returns

The localized message text string. If the key is not found then the key is returned.

Example

This example returns "OK" when the localized text for key OK_BTN_LABEL is "OK".

apex.lang.getMessage("OK_BTN_LABEL");