salesforce
  1. salesforce-apex-pagemessages-component

apex:pageMessages Component

The apex:pageMessages component in Salesforce Visualforce is a powerful tool for displaying error messages and other informational messages to users. This component displays all messages for a particular page, including errors, warnings, and success messages, among others.

Syntax

The syntax for using the apex:pageMessages component is as follows:

<apex:pageMessages [id="identifier"] [style="style"] [styleClass="styleClass"] [showDetail="true|false"] [showSummary="true|false"] />

Example

Consider the following example that demonstrates the use of the apex:pageMessages component in Visualforce:

<!-- Visualforce Page -->
<apex:page>
   <apex:pageMessages />

   <apex:pageBlock>
      <apex:pageBlockButtons>
         <apex:commandButton value="Save" action="{!saveRecord}" />
      </apex:pageBlockButtons>
      <apex:pageBlockSection>
         <apex:inputField value="{!Account.Name}" required="true" />
         <apex:inputField value="{!Account.Industry}" />
      </apex:pageBlockSection>
   </apex:pageBlock>
</apex:page>

The above Visualforce page displays an Account form with a Save button, and the apex:pageMessages component is used to display any errors or success messages.

Explanation

The apex:pageMessages component is placed at the beginning of the Visualforce page, and any messages for the page are automatically displayed when the page is loaded. In this example, the component is placed before a page block that contains the Save button and the Account form. When the user clicks the Save button, the saveRecord action is called, and any error messages are displayed in the apex:pageMessages component.

Use

The apex:pageMessages component is used to display error messages, warning messages, and success messages to users in Visualforce pages. This component is often used in conjunction with form submissions, where errors and success messages need to be displayed to the user.

Important Points

  • The apex:pageMessages component should be placed at the beginning of the Visualforce page to ensure that any messages are displayed as soon as the page loads.
  • The component can be customized with styling attributes such as style and styleClass.
  • The showDetail and showSummary attributes can be used to control the level of detail displayed in the messages.

Summary

The apex:pageMessages component in Salesforce Visualforce is a powerful tool for displaying error messages, warning messages, and success messages to users. This component is often used in conjunction with form submissions to ensure that users are informed of any issues or success messages. Placement, customization, and control through the showDetail and showSummary attributes are important points to keep in mind when using this component.

Published on: