Pages

Tuesday, December 23, 2008

URLFOR function finally explained!

While developing your Visualforce pages you may need to be able to obtain the URL of certain actions, s-controls or your static resources.

I found it personally a challenge since the documentation for "URLFOR" function is not included in "Visualforce Developer Guide" itself and instead included in the general help area of Salesforce.

Generally you can use the "URLFOR" function for three purposes:
  1. Obtain URL of a s-control
  2. Obtain URL of a static resource
  3. Obtain URL of an object's action
In this article I will demonstrate usages of the three above.

Generally, URLFOR function returns a relative URL for an action, s-control, or a file in a static resource archive in a Visualforce page. Following the syntax of the function:

{!URLFOR(target, id, [inputs], [no override])}

Parameters shown in brackets ([]) are optional.

  • target: You can replace target with a URL or action, s-control or static resource.
  • id: This is id of the object or resource name (string type) in support of the provided target.
  • inputs: Any additional URL parameters you need to pass you can use this parameter.
    you will to put the URL parameters in brackets and separate them with commas
    ex: [param1="value1", param2="value2"]
  • no override: A Boolean value which defaults to false, it applies to targets for standard Salesforce pages. Replace "no override" with "true" when you want to display a standard Salesforce page regardless of whether you have defined an override for it elsewhere.

Obtaining URL of a s-control:

<!-- Use $SControl global veriable to reference your s-control and pass it to the URLFOR function -->
<apex:outputLink value="{!URLFOR($SControl.MySControlName)}">Link to my S-Control</apex:outputLink>



Obtaining URL of a Static Resource

<!-- Use $Resource global veriable to reference your resource file -->
<apex:image url="{!URLFOR($Resource.LogoImg)}" width="50" height="50" />

<!-- If your file is in another ZIP file, then pass the path of the file as id to URLFOR -->
<apex:image url="{!URLFOR($Resource.CorpZip, 'images/logo.gif')}" width="50" height="50" />




Obtaining URLs of an Object's Actions:
In order to get URL of the an object's actions you need to know what actions that object supports. Below are some of the common actions most Objects support:
  • View: Shows the detail page of an object
  • Edit: Shows the object in Edit mode
  • Delete: URL for deleting an object
  • New: URL to create a new record of an object
  • Tab: URL to the home page of an object
However, each object may support additional actions for example Contact also supports "Clone" action and Case supports "CloseCase" action.

<!-- Use $Action global varialble to access the New action reference -->
<apex:outputLink value="{!URLFOR($Action.Account.New)}">New</apex:outputLink>
<br/>
<!-- View action requires the id parameter, a standard controller can be used to obtain the id -->
<apex:outputLink value="{!URLFOR($Action.Account.view, account.id)}">View</apex:outputLink>
<br/>
<!-- Edit action requires the id parameter, id is taken from standard controller in this example -->
<apex:outputLink value="{!URLFOR($Action.Account.Edit, account.id)}">Edit</apex:outputLink>
<br/>
<!-- Delete action requires the id parameter, also a confirm message is added to prevent deleting the record when clicked by mistake -->
<apex:outputLink value="{!URLFOR($Action.Account.delete, account.id)}" onclick="return window.confirm('Are you sure?');">Delete</apex:outputLink>
<br/>
<!-- From all custom buttons, links, s-controls and visualforce pages you can use the following to get the link of the object's homepage -->
<apex:outputLink value="{!URLFOR($Action.Account.Tab, $ObjectType.Account)}">Home</apex:outputLink>



23 comments:

  1. How are you able to use URLFOR to reference an image embedded into a zip file? Can you please explain - I can't make it work.

    ReplyDelete
  2. Hello
    Can i open a url of a new form and put some info the fields (ie account name ='XX')?
    it's possible ?
    Thanks

    ReplyDelete
  3. is there any way i could check if the object is null and perform a different action so that i dont get the error "Invalid parameter for function URLFOR"

    ReplyDelete
  4. Thanks for this, just what I was looking for after exhausting the resources you mention.

    ReplyDelete
  5. Nice work buddy:) Comprehensive and concise.

    ReplyDelete
  6. me too.. i cant use the zip files with this code.. and i never make it work

    ReplyDelete
  7. This is good help, Salesforce docs for URL for really needs to get upto the mark.

    ReplyDelete
  8. RE:How are you able to use URLFOR to reference an image embedded into a zip file? Can you please explain - I can't make it work.

    I am able to solve this. The format of the image URL should be StaticResourceName/ZipFileName/ImageName. I got confused too assuming that that StaticResourceName and ZipFileName are same..

    ReplyDelete
  9. Sam, I've used your page so many times in the last two years, I feel like I owe you royalty fees. Thanks for your post and examples.

    ReplyDelete
  10. Kalyan, it'd look something like this:

    {!URLFOR($Resource.StaticResourceName, 'imagename')}

    Similar to how the jQuery library is used:
    {!URLFOR($Resource.jquery, 'js/jquery-1.6.2.min.js')}

    ReplyDelete
  11. Hi Sam,

    Is it possible to use the URLFOR function to view the parentAccount from an account record. Below is my scenario. But it is showing error "Invalid parameter for function URLFOR".

    My scenario:

    URLFOR($Action.Account.View,a.parentId)

    Please help me.
    Thanks in advance.

    Thanks
    ashii

    ReplyDelete
  12. Excellent article! Thanks!

    ReplyDelete
  13. This is the best article I\ve read on this topic. Thanks a lot for writing it. I've tried to implement this to override the New opportunity button, so the stage name is set to New by default.

    {!URLFOR( $Action.Opportunity.New , null, [
    Opportunity.StageName='New'
    ],
    true)
    }

    I tried it with the amount field as well and it's still not working

    {!URLFOR($Action.Opportunity.New,null, [ Opportunity.Amount =5000] ,false)}"

    I'm sure it's obvious, but where am I going wrong?

    ReplyDelete
    Replies
    1. Try

      {!URLFOR($Action.Opportunity.New,null, [Amount ="5000"])}"

      Delete
  14. thank q BOSS i really get help with your blog

    ReplyDelete
  15. Very useful post. Looks like Salesforce has better documentation on this topic now.

    ReplyDelete
  16. I have a Vf page where i have a link when I click on that I am navigating to account detail page.

    My requirement is to navigate and scroll to product relatedlist .

    How to achieve this.??


    I used "More"

    Any idea how to get that

    ReplyDelete
  17. I am getting following error from the CONSOLE for detail page buttons which are calling a VF page with URL as a content source. The VF page is using a opportunity std controller and another extension. The URL is build using URLFOR

    Error: Id value is not valid for the Opportunity standard controller


    Button URL: {!URLFOR($Site.Prefix+"/apex/CreateOrderorQuote?Id=")}{!Opportunity.Id}&calledFrom=ConvertToSalesOrder


    For some reason the ID value is getting blank value

    Please let me know if there is anything wrong with the URL or why this error may be occuring

    Thanks

    ReplyDelete
  18. Is there a way to check for and handle null values for the target or id?

    ReplyDelete
  19. Though it an old thread. But can anybody answer chris anatalio question ? I am facing the same issue

    ReplyDelete
  20. how to assign id in the url

    ReplyDelete
  21. Thank you Sam - very helpful.

    ReplyDelete