Skip to content
MrMEteo edited this page Apr 29, 2016 · 15 revisions

Welcome to the SPServices wiki!

You could see complete documentation on CodePlex

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 N/A
$().SPServices.Version Returns the current version of SPServices as a string, e.g., "0.7.2" 0.7.2 N/A

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 SPXmlToJson 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