Visualforce Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
apex:commandLink
A link that executes an action defined by a controller, and then
either refreshes the current page, or navigates to a different page
based on the PageReference variable that is returned by the
action.
An <apex:commandLink> component must always be a child of an <apex:form> component.
To add request parameters to an <apex:commandLink>, use nested <apex:param> components.
See also: <apex:commandButton>, <apex:outputLink>.
This component supports HTML pass-through attributes using the "html-" prefix. Pass-through attributes are attached to the generated <a> tag.
Example
<apex:commandLink action="{!save}" value="Save" id="theCommandLink"/>The example above renders the following HTML:
<a id="thePage:theForm:theCommandLink" href="#" onclick="generatedJs()">Save</a>Attributes
| Attribute Name | Attribute Type | Description | Required? | API Version | Access |
|---|---|---|---|---|---|
| accesskey | String | The keyboard access key that puts the command link in focus. When the command link is in focus, pressing the Enter key is equivalent to clicking the link. | 10.0 | global | |
| action | ApexPages.Action | The action method invoked by the AJAX request to the server. Use merge-field syntax to reference the method. For example, action="{!save}" references the save() method in the controller. If an action isn't specified, the page simply refreshes. Note that command links associated with the save, edit, or delete actions in a standard controller are rendered only if the user has the appropriate permissions. Likewise, command links associated with the edit and delete actions are rendered only if a record is associated with the page. | 10.0 | global | |
| charset | String | The character set used to encode the specified URL. If not specified, this value defaults to "ISO-8859-1". | 10.0 | global | |
| coords | String | The position and shape of the hot spot on the screen used for the command link (for use in client-side image maps). The number and order of comma-separated values depends on the shape being defined. For example, to define a rectangle, use coords="left-x, top-y, right-x, bottom-y". To define a circle, use coords="center-x, center-y, radius". To define a polygon, use coords="x1, y1, x2, y2, ..., xN, yN", where x1 = nN and y1 = yN. Coordinates can be expressed in pixels or percentages, and represent the distance from the top-left corner of the image that is mapped. See also the shape attribute. | 10.0 | global | |
| dir | String | The direction in which the generated HTML component should be read. Possible values include "RTL" (right to left) or "LTR" (left to right). | 10.0 | global | |
| hreflang | String | The base language for the resource referenced by this command link, for example, "en" or "en-US". For more information on this attribute, see the W3C specifications. | 10.0 | global | |
| id | String | An identifier that allows the commandLink component to be referenced by other components in the page. | 10.0 | global | |
| immediate | Boolean | A Boolean value that specifies whether the action associated with this component should happen immediately, without processing any validation rules associated with the fields on the page. If set to true, the action happens immediately and validation rules are skipped. If not specified, this value defaults to false. See Use the immediate Attribute Carefully. | 11.0 | global | |
| lang | String | The base language for the generated HTML output, for example, "en" or "en-US". For more information on this attribute, see the W3C specifications. | 10.0 | global | |
| onblur | String | The JavaScript invoked if the onblur event occurs--that is, if the focus moves off of the command link. | 10.0 | global | |
| onclick | String | The JavaScript invoked if the onclick event occurs--that is, if the user clicks the command link. | 10.0 | global | |
| oncomplete | String | The JavaScript invoked when the result of an AJAX update request completes on the client. | 10.0 | global | |
| ondblclick | String | The JavaScript invoked if the ondblclick event occurs--that is, if the user clicks the command link twice. | 10.0 | global | |
| onfocus | String | The JavaScript invoked if the onfocus event occurs--that is, if the focus is on the command link. | 10.0 | global | |
| onkeydown | String | The JavaScript invoked if the onkeydown event occurs--that is, if the user presses a keyboard key. | 10.0 | global | |
| onkeypress | String | The JavaScript invoked if the onkeypress event occurs--that is, if the user presses or holds down a keyboard key. | 10.0 | global | |
| onkeyup | String | The JavaScript invoked if the onkeyup event occurs--that is, if the user releases a keyboard key. | 10.0 | global | |
| onmousedown | String | The JavaScript invoked if the onmousedown event occurs--that is, if the user clicks a mouse button. | 10.0 | global | |
| onmousemove | String | The JavaScript invoked if the onmousemove event occurs--that is, if the user moves the mouse pointer. | 10.0 | global | |
| onmouseout | String | The JavaScript invoked if the onmouseout event occurs--that is, if the user moves the mouse pointer away from the command link. | 10.0 | global | |
| onmouseover | String | The JavaScript invoked if the onmouseover event occurs--that is, if the user moves the mouse pointer over the command link. | 10.0 | global | |
| onmouseup | String | The JavaScript invoked if the onmouseup event occurs--that is, if the user releases the mouse button. | 10.0 | global | |
| rel | String | The relationship from the current document to the URL specified by this command link. The value of this attribute is a space-separated list of link types. For more information on this attribute, see the W3C specifications. | 10.0 | global | |
| 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 | |
| reRender | Object | The ID of one or more components that are redrawn when the result of an AJAX update request returns to the client. This value can be a single ID, a comma-separated list of IDs, or a merge field expression for a list or collection of IDs. | 10.0 | global | |
| rev | String | The reverse link from the URL specified by this command link to the current document. The value of this attribute is a space-separated list of link types. For more information on this attribute, see the W3C specifications. | 10.0 | global | |
| shape | String | The shape of the hot spot in client-side image maps. Valid values are default, circle, rect, and poly. See also the coords attribute. | 10.0 | global | |
| status | String | The ID of an associated component that displays the status of an AJAX update request. See the actionStatus component. | 10.0 | global | |
| style | String | The style used to display the commandLink component, used primarily for adding inline CSS styles. | 10.0 | global | |
| styleClass | String | The style class used to display the commandLink component, used primarily to designate which CSS styles are applied when using an external CSS stylesheet. | 10.0 | global | |
| tabindex | String | The order in which this link is selected compared to other page components when a user presses the Tab key repeatedly. This value must be an integer between 0 and 32767, with component 0 being the first component that is selected when a user presses the Tab key. | 10.0 | global | |
| target | String | The name of the frame where the resource retrieved by this command link should be displayed. Possible values for this attribute include "_blank", "_parent", "_self", and "_top". You can also specify your own target names by assigning a value to the name attribute of a desired destination. | 10.0 | global | |
| timeout | Integer | The amount of time (in milliseconds) before an AJAX update request should time out. | 10.0 | global | |
| title | String | The text to display as a tooltip when the user's mouse pointer hovers over this component. | 10.0 | global | |
| type | String | The MIME content type of the resource designated by this command link. Possible values for this attribute include "text/html", "image/png", "image/gif", "video/mpeg", "text/css", and "audio/basic". For more information, including a complete list of possible values, see the W3C specifications. | 10.0 | global | |
| value | Object | The text that is displayed as the commandLink label. Note that you can also specify text or an image to display as the command link by embedding content in the body of the commandLink tag. If both the value attribute and embedded content are included, they are displayed together. | 10.0 | global |