Newer Version Available
apex:sectionHeader
A title bar for a page. In a standard Salesforce page, the title bar is a colored header displayed directly under the tab bar.
This component supports HTML pass-through attributes using the "html-" prefix. Pass-through attributes are attached to the generated container <div> tag.
Example
1<!-- For this example to render properly, you must associate the Visualforce page
2with a valid account record in the URL.
3For example, if 001D000000IRt53 is the account ID, the resulting URL should be:
4https://MyDomain_login_URL/apex/myPage?id=001D000000IRt53
5-->
6
7
8<apex:page standardController="Opportunity" tabStyle="Opportunity" sidebar="false">
9 <apex:sectionHeader title="One of Your Opportunities" subtitle="Exciting !"/>
10 <apex:detail subject="{!opportunity.ownerId}" relatedList="false" title="false"/>
11</apex:page>Attributes
| Attribute Name | Attribute Type | Description | Required? | API Version | Access |
|---|---|---|---|---|---|
| description | String | Descriptive text for the page that displays under the colored title bar. The escape attribute determines whether markup in the description is evaluated. | 10.0 | global | |
| escape | Boolean | A Boolean value that specifies whether sensitive HTML and XML
characters are escaped in the description
attribute's output.
We recommend that Independent Software Vendors (ISVs) explicitly set the escape attribute of any <apex:sectionHeader> components used. Setting the escape attribute overrides the default behavior that the subscriber org configures, so <apex:sectionHeader> retains the expected behavior in all subscriber orgs. |
10.0 | global | |
| help | String | The URL for the page's help file. When this value is specified, a Help for this Page link automatically appears on the right side of the colored title bar. The URL must be a fully-qualified, absolute, or relative URL; JavaScript URLs aren't permitted. Invalid URLs display a warning icon instead of the help link. | 10.0 | global | |
| id | String | An identifier that allows the sectionHeader component to be referenced by other components in the page. | 10.0 | global | |
| printUrl | String | The URL for the printable view. | 18.0 | ||
| rendered | Boolean | A Boolean value that specifies whether the component is rendered on the page. If not specified, this value defaults to true. | 10.0 | global | |
| subtitle | String | The text displayed just under the main title in the colored title bar. | 10.0 | global | |
| title | String | The text displayed at the top of the colored title bar. | 10.0 | global |