Sharepoint modal dialog tutorial (and how to use it like JQuey modal dialog, and why not to use JQuey modal dialog)

so lets talk about the Sharepoint Modal Dialog, the one that comes form SP.UI.ModalDialog

 part 1 - why not to use the jquery modal

that is simple, jquery modal looks to put an overlay on the screen, and its almost impossible to fix it with sharepoint for the multiple wrapping elements, good luck with that.

part 2 - but jquery modal is better, easier, and easier to use and customize

you're right. so go solve part 1. or try part 3.

part 3 - how to easily use SP modal's easy, and more like JQ's

well the most easy way is to prepare a div element with everything you need inside and let the dialog execute on it, for example (note that "html" mean HTMLElement, not html text...):

<div style="display:none">
    <div class="divForModal" title="Happy Dialog">
      <img src="../mouseovericon.png">
      <!-- and all other content -->
    </div>
</div>
<script>
MyNS.OpenItemModal = function (anchor) {
   var modal = $(anchor).parents('.cbs-pictureOnTopContainer').find('.divForModal');

    SP.UI.ModalDialog.showModalDialog({
      html: modal[0],         
      title: modal.attr('title'),
      allowMaximize: false,
      showClose: true,
      autoSize: true
   });
};
</script>

 see? just like ur simple JQ.

part 4 - its not working!!!

most of the times its your code, but the other times its because Sharepoint does not bring this script file. you can do it in the conservative way:

<SharePoint:ScriptLink Name="SP.js" runat="server" OnDemand="false" LoadAfterUI="true" Localizable="false"/>
<SharePoint:ScriptLink Name="SP.UI.Dialog.js" runat="server" OnDemand="false" LoadAfterUI="true" Localizable="false"/>

 part 5 - SP.SOD, or "I cant/don't want to touch the master"

 Sharepoint kindly gives us the option to let him handle everything by using the SP.SOD ns. the most simple example is execute:
SP.SOD.execute(key, functionName, args) Method
this one say, hey, this function, this js file, here are your arguments, make it work. can be with a minor change:

MyNS.OpenItemModal = function (anchor) {
   var modal = $(anchor).parents('.cbs-pictureOnTopContainer').find('.divForModal');

    var options = {
            html: modal[0],
            title: modal.attr('title'),
            allowMaximize: false,
            showClose: true,
            autoSize: true
   };
   SP.SOD.execute('sp.ui.dialog.js', 'SP.UI.ModalDialog.showModalDialog', options);
};

 as you can see, just prepare the options and let Sharepoint worry about the script and his dependencies.

part 5 - it only opens once!

Thanks to Yuval my T.L. i now know that when you give SP Dialog a DOM element it destroys it, not before taking it out of the DOM.
There is a most simple solution - clone ( jQuery: var spdElem = $(...).clone() ).

part 6 - epilogue 

SP.SOD has some other nice options that you should use
SP.SOD Methods
http://msdn.microsoft.com/en-us/library/office/ff408081(v=office.14).aspx

also SP.UI.ModalDialog.showModalDialog has many other option to customize it, and even callback functions
SP.UI.ModalDialog.showModalDialog(options) Method
http://msdn.microsoft.com/en-us/library/office/ff410058(v=office.14).aspx

plus the SP.UI.ModalDialog class itself has some other nice functionality
SP.UI.ModalDialog Methods
http://msdn.microsoft.com/en-us/library/office/ff410259(v=office.14).aspx

Good Luck!!

Comments

Post a Comment

Popular posts from this blog

OverTheWire[.com] Natas Walkthrough - JUST HINT, NO SPOILERS

game portal: http://overthewire.org/wargames/natas/ PASSWORDS for each level are stored in /etc/natas_webpass/natasX I made this walkthrough for people like me, i needed some help, but didnt want the spoiler, so here i will give you all the information needed to pass each level, yet not the solution. For levels needed custom web request i made a different post for powershell and javascript  with how-to's, since is a piece of learning for itself, and also for those of us that play at work and have only powershell at their hands. Although its not a complete spoiler there, its quite most of the solution so try yourself 1st. Natas The Natas game is from basic to advances web hacking. Every few levels is about whole new exploitation (with some harder ones doing comeback later), so a lot of learning. If you're new, you're the reason i am writing so much even for the 1st level, just please google EVERY topic you see, since in the following levels i assume you know the ...
Read more

Asp.Net Ending Response options, Response.End() vs CompleteRequest()

this blog is for any1 who get the ThreadAbortException when caling Response.End(), and then tried the other options such as HttpContext.Current.ApplicationInstance.CompleteRequest() and found out that there was no replacement. i'll start with the bottom line: if you want to stop right now your response and send it as is you dont have any other option other than Response.End(), period and it's the right thing to throw that EX in that case. the answer is its because there is the "HTTP pipeline" and the "Asp.Net pipeline", and CompleteRequest() cuts the HTTP pipeline but not the Asp.Net one so everything that is from handlers forwars (including all page events) continues but your part, the asp one, stays in your hands so that no information will be lost, so ur suppose to manage your code currectly, since information lost is really a bad thing, although in most cases we use Response.End() we know what we are losing and we want it. see this short article ab...
Read more

SOLVED The item could not be indexed successfully because the item failed in the indexing subsystem

if you got an error like this The item could not be indexed successfully because the item failed in the indexing subsystem. ( The item could not be indexed successfully because the item failed in the indexing subsystem.; Failed to recover content group; Aborting insert of item in Link Database because it was not inserted to the Search Index.; ; SearchID = 04081656-B51B-4DCD-96D4-6DB2D2CEEEE7 ) as well as these: The item could not be indexed successfully because the item failed in the indexing subsystem. ( The item could not be indexed successfully because the item failed in the indexing subsystem.; Caught exception when preparing generation GID[7]: (Previous generation (last=GID[6], curr=GID[7]) is still active. Cannot open GID[7]); Aborting insert of item in Link Database because it was not inserted to the Search Index.; ; SearchID = 92EB0180-C086-4853-BED8-F4878D9748AD ) the solution for me was to clear configuration cache (PS)  and then restart SP Search Services. THX ...
Read more