Please read the documentation (starting with the General Instructions at the bottom of this page) before asking questions. I'm happy to help out, but it's so much nicer when folks read the documentation.

Core

Function Name Short Description Introduced Certification
$().SPServices This is the core function of the library, which you can use to make Ajax calls to the SharePoint Web Services. Note: As of version 2013.01, all calls return a jQuery deferred object aka a promise. 0.2.3 See individual Web Services
$().SPServices.defaults With this defaults function, you can set the defaults for the remainder of the page life. This can be useful if you'd like to make many calls into the library for a single list or site. 0.2.4 NA
$().SPServices.Version Returns the current version of SPServices as a string, e.g., "0.7.2" 0.7.2 NA

 

Form Enhancements/Assistance

Function Name Short Description Introduced SharePoint 2010
$().SPServices.SPCascadeDropdowns This is the first function we implemented which allows you to take advantage of the Web Services calls in a meaningful way. It allows you to easily set up cascading dropdowns on a list form. (What we mean by cascading dropdowns is the situation where the available options for one column depend on the value you select in another column.) 0.2.6 Certified for SharePoint 2010
$().SPServices.SPDisplayRelatedInfo This function lets you display related information on forms when an option in a dropdown is chosen. 0.2.9 Certified for SharePoint 2010
$().SPServices.SPLookupAddNew This function allows you to provide a link in forms for Lookup columns so that the user can add new values to the Lookup list easily. It is based on a blog post by Waldek Mastykarz. (see Credits) 0.3.2 Works with Caveats with SharePoint 2010
$().SPServices.SPRedirectWithID This function allows you to redirect to a another page from a new item form with the new item's ID. This allows chaining of forms from item creation onward. 0.4.0 Not Tested with SharePoint 2010
$().SPServices.SPRequireUnique Checks to see if the value for a column on the form is unique in the list. 0.4.0 Certified for SharePoint 2010
$().SPServices.SPSetMultiSelectSizes Sets the size of the boxes in a multi-select picker based on the values they contain. 0.4.8 Certified for SharePoint 2010
$().SPServices.SPArrangeChoices Rearranges radio buttons or checkboxes in a form from vertical to horizontal display to save page real estate. 0.5.0 Certified for SharePoint 2010
$().SPServices.SPAutocomplete The SPAutocomplete lets you provide values for a Single line of text column from values in a SharePoint list. The function is highly configurable and can enhance the user experience with forms. 0.5.4 Certified for SharePoint 2010
$().SPServices.SPUpdateMultipleListItems SPUpdateMultipleListItems allows you to update multiple items in a list based upon some common characteristic or metadata criteria. 0.5.8 Certified for SharePoint 2010
$().SPServices.SPFilterDropdown The SPFilterDropdown function allows you to filter the values available in a Lookup column using CAML against the Lookup column's source list. 0.6.1 Certified for SharePoint 2010
$().SPServices.SPComplexToSimpleDropdown Converts a "complex" dropdown (which SharePoint displays if there are 20+ options) to a "simple" dropdown (select). 0.6.2 Certified for SharePoint 2010
$().SPServices.SPFindPeoplePicker The SPFindPeoplePicker function helps you find and set People Picker column values. 0.7.2 Certified for SharePoint 2010
$().SPServices.SPFindMMSPicker The SPFindMMSPicker function helps you find an MMS Picker's values. 2013.01 Certified for SharePoint 2010

 

Utilities

Function Name Short Description Introduced SharePoint 2010
$().SPServices.SPGetCurrentSite This utility function, which is also publicly available, simply returns the current site's URL. It mirrors the functionality of the WebUrlFromPageUrl operation. 0.2.4 Certified for SharePoint 2010
$().SPServices.SPDebugXMLHttpResult This function displays the XMLHttpResult from an Ajax call formatted for easy debugging. You can call it manually as part of your completefunc. 0.2.10 Certified for SharePoint 2010
$().SPServices.SPGetCurrentUser This function returns information about the current user. It is based on an insightful trick from Einar Otto Stangvik (see Credits). 0.3.1 Certified for SharePoint 2010
$().SPServices.SPGetLastItemId Function to return the ID of the last item created on a list by a specific user. Useful for maintaining parent/child relationships. 0.4.0 Certified for SharePoint 2010
$().SPServices.SPGetDisplayFromStatic This function returns the DisplayName for a column based on the StaticName. 0.4.0 Certified for SharePoint 2010
$().SPServices.SPGetStaticFromDisplay This function returns the StaticName for a column based on the DisplayName. 0.5.4 Certified for SharePoint 2010
$().SPServices.SPScriptAudit The SPScriptAudit function allows you to run an auditing report showing where scripting is in use in a site. 0.4.8 Certified for SharePoint 2010
$().SPServices.SPGetQueryString The SPGetQueryString function returns an array containing the Query String parameters and their values. 0.5.1 Certified for SharePoint 2010
$().SPServices.SPListNameFromUrl Returns the current list's GUID *if* called in the context of a list, meaning that the URL is within the list, like /DocLib or /Lists/ListName. 0.5.7 Certified for SharePoint 2010
$().SPFilterNode Can be used to find namespaced elements in returned XML, such as rs:data or z:row from GetListItems. 0.7.0 Certified for SharePoint 2010
$().SPXmlToJson SPXslToJson is a function to convert XML data into JSON for client-side processing. 0.7.1 Certified for SharePoint 2010
$().SPServices.SPConvertDateToISO Convert a JavaScript date to the ISO 8601 format required by SharePoint to update list items. 2013.01 Certified for SharePoint 2010
$().SPServices.SPGetListItemsJson SPGetListItemsJson combines several SPServices capabilities into one powerful function. By calling GetListItemChangesSinceToken, parsing the list schema, and passing the resulting mapping and data to SPXmlToJson automagically, we have a one-stop shop for retrieving SharePoint list data in JSON format. No manual mapping required! 2014.01 Certified for SharePoint 2010
$().SPServices.SPDropdownCtl The function finds a dropdown in a form based on the name of the column (either the DisplayName or the StaticName) and returns an object you can use in your own functions. 2014.01 Certified for SharePoint 2010

 

General Instructions

First, please read this blog post, which can help you to be sure that your script file references are correct.

The library can be implemented by adding a reference to it into a single page, a page layout, or a master page, depending upon your desired scope of use. The SPServices library requires the jQuery library. See the System Requirements section for required versions.

Most releases of the library include both a minified and a normal version of the release. If you would like to understand the workings of the library, look at the normal version, but use the minified version for any production use.

I recommend storing the jQuery library and SPServices in a Document Library in your Site Collection and referencing it as needed, like this:

<script language="javascript" type="text/javascript" src="/jQueryLibraries/jquery-1.11.0.min.js"></script>
<script language="javascript" type="text/javascript" src="/jQueryLibraries/jquery.SPServices-2014.01.min.js"></script>

You can also reference the js files from a CDN, like so:

<!-- Reference jQuery on the Google CDN -->
<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
<!-- Reference SPServices on cdnjs (Cloudflare) -->
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/jquery.SPServices/2013.02a/jquery.SPServices-2013.02a.min.js"></script>

See this post for more info on using CDNs.

Debug Mode, first implemented in v0.4.5, also can be helpful in implementing solutions with the library.

Here's a small example. If you want to add functionality to NewForm.aspx, then take a copy of the form, call it something like NewFormCustom.aspx, and add your script into it. I like to put my scripts below this line:

<asp:Content ContentPlaceHolderId="PlaceHolderMain" runat="server">

Other places may work, but this location has proven foolproof for me, regardless of what others may recommend.

...
<asp:Content ContentPlaceHolderId="PlaceHolderMain" runat="server">
<script type="text/javascript" language="javascript" src="/jQuery%20Libraries/jquery-1.11.1.min.js"></script>
<script type="text/javascript" language="javascript" src="/jQuery%20Libraries/jquery.SPServices-2014.01.min.js"></script>
<script type="text/javascript">
    $(document).ready(function() {
        $().SPServices.SPCascadeDropdowns({
            relationshipList: "Regions",
            relationshipListParentColumn: "Country",
            relationshipListChildColumn: "Title",
            parentColumn: "Country",
            childColumn: "Region"
        });
    });
</script>
...

Obviously, the src attributes should point to wherever you've put the .js files.

Alternatively, you can place the code in a Content Editor Web Part (CEWP). I prefer the approach above (see the FAQs), but the CEWP approach works as well.

Once you've got the page set up the way you want it, right click on the list in the Folder List pane, select Properties, and then the Supporting Files tab. Choose the Content Type in the dropdown (NOT Folder) and then browse to your NewFormCustom.aspx to set it as the New Item Form. Click OK and you should be good to go.

Debugging Hints and Tips

  1. If you are working in SharePoint Designer, Ctrl-click the addresses of each of the two .js references. If you get a "file not found" message, you have a bad src URL. Most often, it's an incomplete path or occasionally a very innocuous misspelling.
  2. Set the debug parameter to "true" (if available for the function you are using), and make one purposeful mistake, e.g., misspelling a column name. Then save and preview in a browser. You should get a popup error message. If not, your script is not running, most likely because it is in the wrong place. Reposition the script elsewhere in the code until you get an error message.
  3. Wrapping your script in
    $(document).ready(function()

means that the calls will be made once the page is fully loaded, i.e., the page is "ready". If you aren't getting the results you want and you aren't using $(document).ready(), then wrap your code in it and try again. (Depending on what you are trying to do, wrapping your script in $(document).ready() may *not* be what you want, but if you are just using the "value-added functions", you almost always will use it.)

Last edited Feb 20 at 2:47 AM by sympmarc, version 75

Comments

ashinbiet Feb 28 at 8:33 AM 
Most of the newly release library nodes has its own demerits and merits as they sometimes lacks with integrity and the other times they often mediates with the SP services that are linked with the other files.<a href="http://www.windows-8-support.com" rel="follow">Windows 8 support</a>

thorat_pradeep_21 Jan 6 at 5:52 AM 
I need to get items from two list and show them in one HTML table. For getting items from first list I am using $().SPServices GetListItem. Depending upon values present in the list item I need to get item from another list. So is it possible to call $().SPServices GetListItem within $().SPServices getListitem.

Please let me know if more details are required.

hartbypass Dec 6, 2013 at 3:23 AM 
Excited to get this to work, but seem to be having an issue. I have duplicated the code and I am using the Google and cloud flare references. For some reason the cascading drop downs work in edit mode, but not in new mode and I copied the code for the EditForm from the NewForm. Anyone have any thoughts? Basically the NewForm just shows the all the data in the drop down versus the filtered data.

Thanks.

ucb4u1 Nov 1, 2013 at 8:18 PM 
Hello, First off I love SPServices since I've been playing with it but must say that the documentation on the internet is scarce and sometimes incorrect. I wanted to point out that in the above code reference example is missing the ****listName**** which is what threw me for a loop for a couple days trying to get the code to work. Anyway keep up the good work and if you can add this line of code to the top of the example above relationshipList: "Regions", I think that some headaches would be avoided by others trying to Implement this wonderful piece of code. Thank again!!!!

jeyganesh Oct 29, 2013 at 6:12 AM 
We are implemented in SharePoint 2013 custom, list it is working fine. But it is not working in Task list.
how to solve this issue?

pnbadam Aug 4, 2013 at 2:47 PM 
Thanks a lot, not a programmer but saved my project.

pwools Nov 1, 2012 at 10:41 PM 
I could not get this working. Checked all the comments and documentation. Followed the instructions but it still did not work. This was a link between 3 dropdowns - Zone -> Region -> Office. Then a Ureka moment. I had the Zone-Region link first and the Region-Office second. with just the Region-Office link it worked fine. So I swapped the order of links to Region-Office then Zone-Region and BINGO! It worked just fine. So try this if you get stuck.

SPgoldBug Sep 19, 2012 at 12:04 PM 
Fantastic project! Very useful. Thank you very much.

swsouth Feb 17, 2012 at 5:19 PM 
Thank you ... thank you ... thank you!!! I could say it a million times and it still would nto be enough! I am fairly new to SharePoint (newly assigned duty at new job) and had been searching high and low for a way to increase MS's default width on the multi-select list box, but had no luck until I found your solution. WOW! Worked instantly! Thanks again for taking the time to help others like myself.

BruceX Dec 8, 2011 at 7:24 AM 
Amazing... It's really cool. Thanks, man.

NinjaGuiden Oct 4, 2011 at 8:06 PM 
Just wanted to take the time to thank you for all the work you put into this. Everytime I want to do something that's not supported OOB on SharePoint I google around and always come back to SPServices. Thanks Again!

chefren77 Jul 11, 2011 at 10:33 AM 
Yes agreed this library is a blessing for building some interactiveness into forms without having to use Designer.

Nerak Jun 15, 2011 at 5:58 PM 
I just want to kiss you and jump up and down. I have looked and looked and looked and this is the first example I've seen where a freaking test script is given to let you know if you've got everything installed but does not depend on you having a specific text box or list form or whatever on your page. I think you ROCK!

ondera Jan 18, 2011 at 8:52 AM 
Thanks.

cyclelynn Dec 21, 2010 at 6:36 PM 
Worked like a charm! Thanks!

dataman777 Dec 18, 2010 at 4:14 PM 
Loaded this on v4.master and now it works on every page in the SharePoint 2010 site. Thanks!

Spankh Dec 7, 2010 at 6:43 PM 
//Hello world. This is a quick script for new users to see if everything is working ok:
<script type="text/javascript">
alert ("js on.");
$(document).ready(function() {
alert ('jQuery on.');
var thisSite = $().SPServices.SPGetCurrentSite();
alert ('Hello World! Your site is : ' + thisSite );
});
</script>

sangeetahuja Nov 22, 2010 at 4:20 AM 
Your library covers good functionality. Many thanks.
Also, the documentation is neat, concise. Very good stuff.

Sharepointgig Sep 22, 2010 at 3:46 AM 
Love it....

akhileshgandhi Aug 1, 2010 at 2:19 PM 
Nice work. Thanks a lot.

larnera Jul 27, 2010 at 9:07 PM 
This is seriously good stuff.

cvgandhi Jul 20, 2010 at 7:10 PM 
you Rock man!!

AdrienM May 11, 2010 at 2:23 PM 
THanks a lot for this nice project!!!