Using JavaScript, there are a variety of different methods to open a URL in a popup dialog in SharePoint 2010 . In this article, we will talk about how to open a popup using one of these methods, OpenPopUpPageWithTitle, and how to refresh the page after returning from the popup.

Challenge:

How do I open a popup using the OpenPopUpPageWithTitle method, and refresh the page after returning from the popup?

Solution:

Open Popup

Below is the signature of the method: 

OpenPopUpPageWithTitle(url, callback, width, height, title);

While the method parameters are self-explanatory, internally, the OpenPopUpPageWithTitle method is calling SP.UI.ModalDialog.showModalDialog(options), where the options are the parameters passed to the method.

URL is the path to a custom application page.

Callback is a method called and, in essence, can be anything along the lines of display notification(SP.UI.Notify).

Width and Height represent the size (in pixels) of the popup. If you want a fixed height and width, and you use null, then size will be defined automatically.

Title is the title of the popup.

Below is a screen shot of my example:

Close Popup

In the custom application page, we need to close the popup whenever it has finished executing. Below is the code to close the dialog box:

window.frameElement.commitPopup();

Refresh the Page After Returning From the Popup

Once the user has made some changes and closed the popup by clicking the OK button, on return from the popup, the .aspx page should be reloaded. To do so, you should use following function:

OpenPopUpPageWithTitle(url, RefreshPage , width, height, title);

RefreshPage: Using this method, we define and refresh the underlying page when the dialog closes.

Please enjoy, and good luck!

See Also:

• SharePoint Anchor Tags [MSDN]

Note:

Please see the attachment for the source code and script of my example.