/* * SPServices - Work with SharePoint's Web Services using jQuery * Version 0.4.1 * @requires jQuery v1.3.2 * * Copyright (c) 2009 Sympraxis Consulting LLC * Examples and docs at: * http://spservices.codeplex.com * Licensed under the MIT license: * http://www.opensource.org/licenses/mit-license.php */ /** * @description Work with SharePoint's Web Services using jQuery * @type jQuery * @name SPServices * @cat Plugins/SPServices * @author Sympraxis Consulting LLC/marc.anderson@sympraxisconsulting.com */ (function($) { // Array to store operation / Web Service associations var WSops = new Array(); WSops["GetAlerts"] = "Alerts"; WSops["DeleteAlerts"] = "Alerts"; WSops["Mode"] = "Authentication"; WSops["Login"] = "Authentication"; WSops["GetForm"] = "Forms"; WSops["GetFormCollection"] = "Forms"; WSops["AddList"] = "Lists"; WSops["CheckInFile"] = "Lists"; WSops["CheckOutFile"] = "Lists"; WSops["DeleteList"] = "Lists"; WSops["GetAttachmentCollection"] = "Lists"; WSops["GetList"] = "Lists"; WSops["GetListAndView"] = "Lists"; WSops["GetListCollection"] = "Lists"; WSops["GetListItems"] = "Lists"; WSops["UpdateListItems"] = "Lists"; WSops["GetPermissionCollection"] = "Permissions"; WSops["GetLinks"] = "PublishedLinksService"; WSops["GetPortalSearchInfo"] = "Search"; WSops["GetSearchMetadata"] = "Search"; WSops["Query"] = "Search"; WSops["Status"] = "Search"; WSops["AddGroup"] = "usergroup"; WSops["AddGroupToRole"] = "usergroup"; WSops["AddRole"] = "usergroup"; WSops["GetAllUserCollectionFromWeb"] = "usergroup"; WSops["GetGroupCollection"] = "usergroup"; WSops["GetGroupCollectionFromRole"] = "usergroup"; WSops["GetGroupCollectionFromSite"] = "usergroup"; WSops["GetGroupCollectionFromUser"] = "usergroup"; WSops["GetGroupCollectionFromWeb"] = "usergroup"; WSops["GetGroupInfo"] = "usergroup"; WSops["GetRoleCollection"] = "usergroup"; WSops["GetRoleCollectionFromGroup"] = "usergroup"; WSops["GetRoleCollectionFromUser"] = "usergroup"; WSops["GetRoleCollectionFromWeb"] = "usergroup"; WSops["GetRolesAndPermissionsForCurrentUser"] = "usergroup"; WSops["GetRolesAndPermissionsForSite"] = "usergroup"; WSops["GetUserCollection"] = "usergroup"; WSops["GetUserCollectionFromGroup"] = "usergroup"; WSops["GetUserCollectionFromRole"] = "usergroup"; WSops["GetUserCollectionFromSite"] = "usergroup"; WSops["GetUserCollectionFromWeb"] = "usergroup"; WSops["GetUserInfo"] = "usergroup"; WSops["GetUserLoginFromEmail"] = "usergroup"; WSops["RemoveGroup"] = "usergroup"; WSops["GetCommonMemberships"] = "UserProfileService"; WSops["GetUserColleagues"] = "UserProfileService"; WSops["GetUserLinks"] = "UserProfileService"; WSops["GetUserMemberships"] = "UserProfileService"; WSops["GetUserPinnedLinks"] = "UserProfileService"; WSops["GetUserProfileByName"] = "UserProfileService"; WSops["GetUserProfileCount"] = "UserProfileService"; WSops["GetUserProfileSchema"] = "UserProfileService"; WSops["GetViewCollection"] = "Views"; WSops["DeleteAllVersions"] = "Versions"; WSops["DeleteVersion"] = "Versions"; WSops["GetVersions"] = "Versions"; WSops["RestoreVersion"] = "Versions"; WSops["GetWebPart2"] = "WebPartPages"; WSops["GetWebPartPage"] = "WebPartPages"; WSops["GetWebPartProperties2"] = "WebPartPages"; WSops["GetListTemplates"] = "Webs"; WSops["GetWeb"] = "Webs"; WSops["GetWebCollection"] = "Webs"; WSops["GetAllSubWebCollection"] = "Webs"; WSops["WebUrlFromPageUrl"] = "Webs"; WSops["GetTemplatesForItem"] = "Workflow"; WSops["GetToDosForItem"] = "Workflow"; WSops["GetWorkflowDataForItem"] = "Workflow"; WSops["GetWorkflowTaskData"] = "Workflow"; WSops["StartWorkflow"] = "Workflow"; // Set up SOAP envelope var SOAPEnvelope = new Object(); SOAPEnvelope.header = ""; SOAPEnvelope.footer = ""; SOAPEnvelope.payload = ""; // Main function, which calls SharePoint's Web Services directly. $.fn.SPServices = function(options) { // If there are no options passed in, use the defaults. Extend replaces each default with the passed option. var opt = $.extend({}, $.fn.SPServices.defaults, options); // Put together operation header and SOAPAction for the SOAP call based on which Web Service we're calling SOAPEnvelope.opheader = "<" + opt.operation + " "; switch(WSops[opt.operation]) { case "Alerts": SOAPEnvelope.opheader += "xmlns='http://schemas.microsoft.com/sharepoint/soap/2002/1/alerts/' >"; SOAPAction = "http://schemas.microsoft.com/sharepoint/soap/2002/1/alerts/"; break; case "Permissions": SOAPEnvelope.opheader += "xmlns='http://schemas.microsoft.com/sharepoint/soap/directory/' >"; SOAPAction = "http://schemas.microsoft.com/sharepoint/soap/directory/"; break; case "PublishedLinksService": SOAPEnvelope.opheader += "xmlns='http://microsoft.com/webservices/SharePointPortalServer/PublishedLinksService/' >"; SOAPAction = "http://microsoft.com/webservices/SharePointPortalServer/PublishedLinksService/"; break; case "Search": SOAPEnvelope.opheader += "xmlns='urn:Microsoft.Search' >"; SOAPAction = "urn:Microsoft.Search/"; break; case "usergroup": SOAPEnvelope.opheader += "xmlns='http://schemas.microsoft.com/sharepoint/soap/directory/' >"; SOAPAction = "http://schemas.microsoft.com/sharepoint/soap/directory/"; break; case "UserProfileService": SOAPEnvelope.opheader += "xmlns='http://microsoft.com/webservices/SharePointPortalServer/UserProfileService' >"; SOAPAction = "http://microsoft.com/webservices/SharePointPortalServer/UserProfileService/"; break; case "WebPartPages": SOAPEnvelope.opheader += "xmlns='http://microsoft.com/sharepoint/webpartpages' >"; SOAPAction = "http://microsoft.com/sharepoint/webpartpages/"; break; case "Workflow": SOAPEnvelope.opheader += "xmlns='http://schemas.microsoft.com/sharepoint/soap/workflow/' >"; SOAPAction = "http://schemas.microsoft.com/sharepoint/soap/workflow/"; break; default: SOAPEnvelope.opheader += "xmlns='http://schemas.microsoft.com/sharepoint/soap/'>"; SOAPAction = "http://schemas.microsoft.com/sharepoint/soap/"; break; } SOAPAction += opt.operation; SOAPEnvelope.opfooter = ""; // Build the URL for the Ajax call based on which operation we're calling // If the webURL has been provided, then use it, else use the current site var ajaxURL = ((opt.webURL != "") ? opt.webURL : $().SPServices.SPGetCurrentSite()) + "/_vti_bin/" + WSops[opt.operation] + ".asmx"; SOAPEnvelope.payload = ""; // Each operation requires a different set of values. This switch statement sets them up in the SOAPEnvelope.payload. switch(opt.operation) { // ALERT OPERATIONS case "GetAlerts": break; case "DeleteAlerts": SOAPEnvelope.payload += ""; for (i=0; i < opt.IDs.length; i++) { SOAPEnvelope.payload += wrapNode("string", opt.IDs[i]); } SOAPEnvelope.payload += ""; break; // AUTHENTICATION OPERATIONS case "Mode": break; case "Login": SOAPEnvelope.payload += wrapNode("username", opt.username); SOAPEnvelope.payload += wrapNode("password", opt.password); break; // FORM OPERATIONS case "GetForm": SOAPEnvelope.payload += wrapNode("listName", opt.listName); SOAPEnvelope.payload += wrapNode("formUrl", opt.formUrl); break; case "GetFormCollection": SOAPEnvelope.payload += wrapNode("listName", opt.listName); break; // LIST OPERATIONS case "AddList": SOAPEnvelope.payload += wrapNode("listName", opt.listName); SOAPEnvelope.payload += wrapNode("description", opt.description); SOAPEnvelope.payload += wrapNode("templateID", opt.templateID); break; case "CheckInFile": SOAPEnvelope.payload += wrapNode("pageUrl", opt.pageUrl); SOAPEnvelope.payload += wrapNode("comment", opt.comment); SOAPEnvelope.payload += wrapNode("CheckinType", opt.CheckinType); break; case "CheckOutFile": SOAPEnvelope.payload += wrapNode("pageUrl", opt.pageUrl); SOAPEnvelope.payload += wrapNode("checkoutToLocal", opt.checkoutToLocal); SOAPEnvelope.payload += wrapNode("lastmodified", opt.lastmodified); break; case "DeleteList": SOAPEnvelope.payload += wrapNode("listName", opt.listName); break; case "GetAttachmentCollection": SOAPEnvelope.payload += wrapNode("listName", opt.listName); SOAPEnvelope.payload += wrapNode("listItemID", opt.ID); break; case "GetList": SOAPEnvelope.payload += wrapNode("listName", opt.listName); break; case "GetListAndView": SOAPEnvelope.payload += wrapNode("listName", opt.listName); SOAPEnvelope.payload += wrapNode("viewName", opt.viewName); break; case "GetListCollection": break; case "GetListItems": SOAPEnvelope.payload += wrapNode("listName", opt.listName); SOAPEnvelope.payload += wrapNode("viewFields", opt.CAMLViewFields); SOAPEnvelope.payload += wrapNode("query", opt.CAMLQuery); SOAPEnvelope.payload += wrapNode("rowLimit", opt.CAMLRowLimit); SOAPEnvelope.payload += wrapNode("queryOptions", opt.CAMLQueryOptions); break; case "UpdateListItems": SOAPEnvelope.payload += wrapNode("listName", opt.listName); if(opt.updates.length > 0) { SOAPEnvelope.payload += wrapNode("updates", opt.updates); } else { SOAPEnvelope.payload += ""; for (i=0; i < opt.valuepairs.length; i++) { SOAPEnvelope.payload += "" + opt.valuepairs[i][1] + ""; } SOAPEnvelope.payload += "" + opt.ID + ""; SOAPEnvelope.payload += ""; } break; // PERMISSION OPERATIONS case "GetPermissionCollection": SOAPEnvelope.payload += wrapNode("objectName", opt.objectName); SOAPEnvelope.payload += wrapNode("objectType", opt.objectType); break; // PUBLISHEDLINKSSERVICE OPERATIONS case "GetLinks": break; // SEARCH OPERATIONS case "GetPortalSearchInfo": SOAPAction = "http://microsoft.com/webservices/OfficeServer/QueryService/" + opt.operation; SOAPEnvelope.opheader = "<" + opt.operation + " xmlns='http://microsoft.com/webservices/OfficeServer/QueryService'/>"; break; case "GetSearchMetadata": SOAPAction = "http://microsoft.com/webservices/OfficeServer/QueryService/" + opt.operation; SOAPEnvelope.opheader = "<" + opt.operation + " xmlns='http://microsoft.com/webservices/OfficeServer/QueryService'/>"; break; case "Query": SOAPEnvelope.payload += wrapNode("queryXml", escapeHTML(opt.queryXml)); break; case "Status": break; // USERS AND GROUPS OPERATIONS case "AddGroup": SOAPEnvelope.payload += wrapNode("groupName", opt.groupName); SOAPEnvelope.payload += wrapNode("ownerIdentifier", opt.ownerIdentifier); SOAPEnvelope.payload += wrapNode("ownerType", opt.ownerType); SOAPEnvelope.payload += wrapNode("defaultUserLoginName", opt.defaultUserLoginName); SOAPEnvelope.payload += wrapNode("groupName", opt.groupName); SOAPEnvelope.payload += wrapNode("description", opt.description); break; case "AddGroupToRole": SOAPEnvelope.payload += wrapNode("groupName", opt.groupName); SOAPEnvelope.payload += wrapNode("roleName", opt.roleName); break; case "AddRole": SOAPEnvelope.payload += wrapNode("roleName", opt.roleName); SOAPEnvelope.payload += wrapNode("description", opt.description); SOAPEnvelope.payload += wrapNode("permissionMask", opt.permissionMask); break; case "GetAllUserCollectionFromWeb": break; case "GetGroupCollectionFromRole": SOAPEnvelope.payload += wrapNode("roleName", opt.roleName); break; case "GetGroupCollection": SOAPEnvelope.payload += wrapNode("groupNamesXml", opt.groupNamesXml); break; case "GetGroupCollectionFromSite": break; case "GetGroupCollectionFromUser": SOAPEnvelope.payload += wrapNode("userLoginName", opt.userLoginName); break; case "GetGroupCollectionFromWeb": break; case "GetGroupInfo": SOAPEnvelope.payload += wrapNode("groupName", opt.groupName); break; case "GetRoleCollection": SOAPEnvelope.payload += wrapNode("roleNamesXml", opt.roleNamesXml); break; case "GetRoleCollectionFromGroup": SOAPEnvelope.payload += wrapNode("groupName", opt.groupName); break; case "GetRoleCollectionFromUser": SOAPEnvelope.payload += wrapNode("userLoginName", opt.userLoginName); break; case "GetRoleCollectionFromWeb": break; case "GetRoleInfo": SOAPEnvelope.payload += wrapNode("roleName", opt.roleName); break; case "GetRolesAndPermissionsForCurrentUser": break; case "GetRolesAndPermissionsForSite": break; case "GetUserCollection": SOAPEnvelope.payload += wrapNode("userLoginNamesXml", opt.userLoginNamesXml); break; case "GetUserCollectionFromGroup": SOAPEnvelope.payload += wrapNode("groupName", opt.groupName); break; case "GetUserCollectionFromRole": SOAPEnvelope.payload += wrapNode("roleName", opt.roleName); break; case "GetUserCollectionFromSite": break; case "GetUserCollectionFromWeb": break; case "GetUserInfo": SOAPEnvelope.payload += wrapNode("userLoginName", opt.userLoginName); break; case "GetUserLoginFromEmail": SOAPEnvelope.payload += wrapNode("emailXml", opt.emailXml); break; case "RemoveGroup": SOAPEnvelope.payload += wrapNode("groupName", opt.groupName); break; // USERPROFILESERVICE OPERATIONS case "GetCommonMemberships": SOAPEnvelope.payload += wrapNode("accountName", opt.accountName); break; case "GetUserColleagues": SOAPEnvelope.payload += wrapNode("accountName", opt.accountName); break; case "GetUserLinks": SOAPEnvelope.payload += wrapNode("accountName", opt.accountName); break; case "GetUserMemberships": SOAPEnvelope.payload += wrapNode("accountName", opt.accountName); break; case "GetUserPinnedLinks": SOAPEnvelope.payload += wrapNode("accountName", opt.accountName); break; case "GetUserProfileByName": SOAPEnvelope.payload += wrapNode("accountName", opt.accountName); break; case "GetUserProfileCount": break; case "GetUserProfileSchema": break; // VIEW OPERATIONS case "GetViewCollection": SOAPEnvelope.payload += wrapNode("listName", opt.listName); break; // VERSIONS OPERATIONS case "DeleteAllVersions": SOAPEnvelope.payload += wrapNode("fileName", opt.fileName); break; case "DeleteVersion": SOAPEnvelope.payload += wrapNode("fileName", opt.fileName); SOAPEnvelope.payload += wrapNode("fileVersion", opt.fileVersion); break; case "GetVersions": SOAPEnvelope.payload += wrapNode("fileName", opt.fileName); break; case "RestoreVersion": SOAPEnvelope.payload += wrapNode("fileName", opt.fileName); SOAPEnvelope.payload += wrapNode("fileVersion", opt.fileVersion); break; // WEBPARTPAGES OPERATIONS case "GetWebPart2": SOAPEnvelope.payload += wrapNode("pageUrl", opt.pageUrl); SOAPEnvelope.payload += wrapNode("storageKey", opt.storageKey); SOAPEnvelope.payload += wrapNode("storage", opt.storage); SOAPEnvelope.payload += wrapNode("behavior", opt.behavior); break; case "GetWebPartPage": SOAPEnvelope.payload += wrapNode("documentName", opt.documentName); SOAPEnvelope.payload += wrapNode("behavior", opt.behavior); break; case "GetWebPartProperties2": SOAPEnvelope.payload += wrapNode("pageUrl", opt.pageUrl); SOAPEnvelope.payload += wrapNode("storage", opt.storage); SOAPEnvelope.payload += wrapNode("behavior", opt.behavior); break; // WEB OPERATIONS case "GetWeb": SOAPEnvelope.payload += wrapNode("webUrl", opt.webURL); break; case "GetListTemplates": break; case "GetWebCollection": break; case "GetAllSubWebCollection": break; case "WebUrlFromPageUrl": SOAPEnvelope.payload += wrapNode("pageUrl", opt.pageURL); break; // WORKFLOW OPERATIONS case "GetTemplatesForItem": SOAPEnvelope.payload += wrapNode("item", opt.item); break; case "GetToDosForItem": SOAPEnvelope.payload += wrapNode("item", opt.item); break; case "GetWorkflowDataForItem": SOAPEnvelope.payload += wrapNode("item", opt.item); break; case "GetWorkflowTaskData": SOAPEnvelope.payload += wrapNode("item", opt.item); SOAPEnvelope.payload += wrapNode("listId", opt.listId); SOAPEnvelope.payload += wrapNode("taskId", opt.taskId); break; case "StartWorkflow": SOAPEnvelope.payload += wrapNode("item", opt.item); SOAPEnvelope.payload += wrapNode("templateId", opt.templateId); SOAPEnvelope.payload += wrapNode("workflowParameters", opt.workflowParameters); break; default: break; } // Glue together the pieces of the SOAP message var msg = SOAPEnvelope.header + SOAPEnvelope.opheader + SOAPEnvelope.payload + SOAPEnvelope.opfooter + SOAPEnvelope.footer; // Make the Ajax call $.ajax({ url: ajaxURL, async: opt.async, beforeSend: function (xhr) { xhr.setRequestHeader("SOAPAction", SOAPAction); }, type: "POST", data: msg, dataType: "xml", contentType: "text/xml; charset='utf-8'", complete: opt.completefunc }); }; // Defaults added as a function in our library means that the caller can override the defaults // for their session by calling this function. Each operation requires a different set of options; // we allow for all in a standardized way. $.fn.SPServices.defaults = { operation: "", // The Web Service operation webURL: "", // URL of the target Web pageURL: "", // URL of the target page listName: "", // Name of the list for list operations description: "", // Description field (used by many operations) templateID: "", // An integer that specifies the list template to use viewName: "", // Name of the view for list operations formUrl: "", // URL of the form for form operations fileName: "", // Name of the file for file operations fileVersion: "", // The number of the file version. ID: 1, // ID of the item for list operations updates: "", // A Batch element that contains one or more methods for adding, modifying, or deleting items and that can be assigned to a System.Xml.XmlNode object. comment: "", // Comment for checkins CheckinType: "", // One of the values 0, 1 or 2, where 0 = MinorCheckIn, 1 = MajorCheckIn, and 2 = OverwriteCheckIn. checkoutToLocal: "", // A string containing "true" or "false" that designates whether the file is to be flagged as checked out for offline editing. lastmodified: "", // A string in RFC 1123 date format representing the date and time of the last modification to the file; for example, "20 Jun 1982 12:00:00 GMT". // For operations requiring CAML, these options will override any abstractions CAMLViewName: "", // View name in CAML format. CAMLQuery: "", // Query in CAML format CAMLViewFields: "", // View fields in CAML format CAMLRowLimit: "", // Row limit in CAML format CAMLQueryOptions: "", // Query options in CAML format // Abstractions for CAML syntax valuepairs: [], // Fieldname / Fieldvalue pairs for UpdateListItems username: "", // Username for the Login operation password: "", // Password for the Login operation accountName: "", // User login in domain/user format for UserProfileService operations userLoginName: "", // User login in domain/user format for user operations groupNamesXml: "", // XML that specifies one or more group definition names groupName: "", // A string that contains the name of the group definition ownerIdentifier: "", // A string that contains the user name (DOMAIN\User_Alias) of the owner for the group ownerType: "", // A string that specifies the type of owner, which can be either user or group defaultUserLoginName: "", // A string that contains the user name (DOMAIN\User_Alias) of the default user for the group roleNamesXml: "", // XML that specifies one or more role definition names roleName: "", // A string that contains the name of the role definition permissionMask: "", // A string representation of the 32-bit integer in decimal format that represents a Microsoft.SharePoint.SPRights value userLoginNamesXml: "", // XML that contains information about the users emailXml: "", // A string that contains email address objectName: "", // objectName for operations which require it objectType: "List", // objectType for operations which require it IDs: null, // List of GUIDs documentName: "", // The name of the Web Part Page. behavior: "Version3", // An SPWebServiceBehavior indicating whether the client supports Windows SharePoint Services 2.0 or Windows SharePoint Services 3.0: {Version2 | Version3 } storageKey: "", // A GUID that identifies the Web Part storage: "Shared", // A Storage value indicating how the Web Part is stored: {None | Personal | Shared} item: "", // The URL location of an item on which a workflow is being run. listId: "", // Globally unique identifier (GUID) of a task list containing the task taskId: "", // Unique identifier (ID) of a task templateId: "", // Globally unique identifier (GUID) of a template workflowParameters: "", // The initiation form data fClaim: false, // Specifies if the action is a claim or a release. Specifies true for a claim and false for a release. queryXml: "", // A string specifying the search query XML async: true, // Allow the user to force async completefunc: null // Function to call on completion }; // Function to determine the current Web's URL. We need this for successful Ajax calls. // The function is also available as a public function. $.fn.SPServices.SPGetCurrentSite = function() { var thisSite = ""; var msg = SOAPEnvelope.header + "" + ((location.href.indexOf("?") > 0) ? location.href.substr(0, location.href.indexOf("?")) : location.href) + "" + SOAPEnvelope.footer; $.ajax({ async: false, // Need this to be synchronous so we're assured of a valid value url: "/_vti_bin/Webs.asmx", beforeSend: function (xhr) { xhr.setRequestHeader("SOAPAction", "http://schemas.microsoft.com/sharepoint/soap/WebUrlFromPageUrl"); }, type: "POST", data: msg, dataType: "xml", contentType: "text/xml; charset=\"utf-8\"", complete: function (xData, Status) { thisSite = $(xData.responseXML).find("WebUrlFromPageUrlResult").text(); } }); return thisSite; // Return the URL }; // Function to set up cascading dropdowns on a SharePoint form // (Newform.aspx, EditForm.aspx, or any other customized form.) $.fn.SPServices.SPCascadeDropdowns = function(options) { var opt = $.extend({}, { relationshipWebURL: "", // [Optional] The name of the Web (site) which contains the relationships list relationshipList: "", // The name of the list which contains the parent/child relationships relationshipListParentColumn: "", // The internal name of the parent column in the relationship list relationshipListChildColumn: "", // The internal name of the child column in the relationship list parentColumn: "", // The display name of the parent column in the form childColumn: "" // The display name of the child column in the form }, options); var childTypeLT20 = true; // Find the child column's select (dropdown) var childSelect = $().find("select:[Title='" + opt.childColumn + "']"); if (childSelect.html() == null) { childSelect = $().find("input:[Title='" + opt.childColumn + "']"); childSelect.attr("readonly", "readonly"); childTypeLT20 = false; } // Find the parent column's select (dropdown) var parentSelect = $().find("select:[Title='" + opt.parentColumn + "']"); if (parentSelect.html() == null) { parentSelect = $().find("input:[Title='" + opt.parentColumn + "']"); parentSelect.attr("readonly", "readonly"); // Bind to the parent column's onfocus event parentSelect.bind("focus", function() { var realSelect = parentSelect.parent().find("#_Select"); cascadeDropdown(realSelect, childSelect, childTypeLT20, opt); realSelect.trigger("change"); }); // Trigger the onchange event for the parent column to set the valid values parentSelect.parent().find("img").click(); parentSelect.blur(); } else { cascadeDropdown(parentSelect, childSelect, childTypeLT20, opt); parentSelect.trigger("change"); } }; function cascadeDropdown(ctr, childCtr, childTypeLT20, opt) { var parentSelectedValue; var displayedOnce = false; var choices = ""; ctr.bind("change", function() { // Get the current child column selection, if there is one var childSelectSelected = null; childTypeLT20 ? childSelectSelected = childCtr.find("option:selected").val() : childSelectSelected = childCtr.attr("value"); parentSelectedValue = ctr.find("option:selected").text(); // When the parent column's selected option changes, get the matching items from the relationship list $().SPServices({ operation: "GetListItems", // Force sync so that we have the right values for the child column onchange trigger async: false, webURL: opt.relationshipWebURL, listName: opt.relationshipList, // Filter based on the currently selected parent column's value CAMLQuery: "" + parentSelectedValue + "", // Only get the parent and child columns CAMLViewFields: "", // Override the default view rowlimit and get all appropriate rows CAMLRowLimit: "0", completefunc: function(xData, Status) { // Add an explanatory prompt if (childTypeLT20) { childCtr.attr({ length: 0 }).append(""); } else { choices = "(None)|0"; childCtr.attr("value", ""); } // Add an option for each child item $(xData.responseXML).find("z\\:row").each(function() { if (childTypeLT20) { var selected = ($(this).attr("ows_ID") == childSelectSelected) ? " selected='selected'" : ""; childCtr.append("" + $(this).attr("ows_" + opt.relationshipListChildColumn) + ""); } else { if ($(this).attr("ows_" + opt.relationshipListChildColumn) == childSelectSelected) childCtr.attr("value", childSelectSelected); choices = choices + "|" + $(this).attr("ows_" + opt.relationshipListChildColumn) + "|" + $(this).attr("ows_ID"); } }); childCtr.attr("choices", choices); } }); // Trigger the child column's onchange event if (childTypeLT20) childCtr.trigger("change"); else if (displayedOnce) { ctr.blur(); childCtr.parent().find("img").click(); childCtr.blur(); } if (ctr.css("display") != "none") displayedOnce = true; }); } // Function to display related information when an option is selected on a form. $.fn.SPServices.SPDisplayRelatedInfo = function(options) { var opt = $.extend({}, { columnName: "", // The display name of the parent in the form relatedWebURL: "", // [Optional] The name of the Web (site) which contains the relationships list relatedList: "", // The name of the list which contains the additional information relatedListColumn: "", // The internal name of the parent column in the related list relatedColumns: [], // An array of related columns to display displayFormat: "table", // The format to use in displaying the related information. Possible values are: "table". headerCSSClass: "ms-vh2", // CSS class for the table headers rowCSSClass: "ms-vb" // CSS class for the table rows }, options); // Find the column's select (dropdown) var columnSelect = $().find("select:[Title='" + opt.columnName + "']"); if (columnSelect.html() == null) { columnSelect = $().find("input:[Title='" + opt.columnName + "']"); columnSelect.attr("readonly", "readonly"); // Bind to the parent column's onfocus event columnSelect.bind("focus", function() { var realSelect = columnSelect.parent().find("#_Select"); showRelated(realSelect, opt); }); // Trigger the onchange event for the column to show the related values columnSelect.parent().find("img").click(); columnSelect.blur(); } else { showRelated(columnSelect, opt); columnSelect.trigger("change"); } }; function showRelated(ctr, opt) { var selectedValue; ctr.parent().append("
"); ctr.bind("change", function() { // When the column's selected option changes, get the matching items from the related list selectedValue = ctr.find("option:selected").text(); // Only get the requested columns var relatedColumnsXML = []; // Get information about the related list and its columns $().SPServices({ operation: "GetList", async: false, webURL: opt.relatedWebURL, listName: opt.relatedList, completefunc: function(xData, Status) { // Output each row $(xData.responseXML).find("Fields").each(function() { $(xData.responseXML).find("Field").each(function() { for (i=0; i < opt.relatedColumns.length; i++) { // If this is one of the columns we want to display, save the XML node if($(this).attr("Name") == opt.relatedColumns[i]) relatedColumnsXML[i] = $(this); } }); }); } }); // Get the list items which match the current selection var viewFields = " "; for (i=0; i < opt.relatedColumns.length; i++) { viewFields += ""; } $().SPServices({ operation: "GetListItems", async: false, webURL: opt.relatedWebURL, listName: opt.relatedList, // Filter based on the column's currently selected value CAMLQuery: "" + selectedValue + "", CAMLViewFields: "" + viewFields + "", // Override the default view rowlimit and get all appropriate rows CAMLRowLimit: "0", completefunc: function(xData, Status) { // Output each row switch(opt.displayFormat) { // Only implementing the table format in the first iteration (v0.2.9) case "table": var outString = ""; outString += ""; for (i=0; i < opt.relatedColumns.length; i++) { outString += ""; } outString += ""; $(xData.responseXML).find("z\\:row").each(function() { outString += ""; for (i=0; i < opt.relatedColumns.length; i++) { outString += ""; } outString += ""; }); outString += "
" + relatedColumnsXML[i].attr("DisplayName") + "
" + showColumn(relatedColumnsXML[i], $(this).attr("ows_" + opt.relatedColumns[i]), opt) + "
"; $("#showRelated_" + encodeColumn(opt.columnName)).html("").append(outString); break; default: break; } } }); }); } // Function to display related information when an option is selected on a form. $.fn.SPServices.SPDebugXMLHttpResult = function(options) { var opt = $.extend({}, { node: null, // An XMLHttpResult object from an ajax call outputId: "", // The id of the DOM object for output indent: 0 // Number of indents }, options); var NODE_TEXT = 3; var NODE_CDATA_SECTION = 4; var outString = ""; // For each new subnode, begin rendering a new TABLE outString += ""; // DisplayPatterns are a bit unique, so let's handle them differently if(opt.node.nodeName == "DisplayPattern") { outString += ""; // A node which has no children } else if (!opt.node.hasChildNodes()) { outString += ""; if (opt.node.attributes) { outString += ""; } // A CDATA_SECTION node } else if (opt.node.hasChildNodes() && opt.node.firstChild.nodeType == NODE_CDATA_SECTION) { outString += ""; // A TEXT node } else if (opt.node.hasChildNodes() && opt.node.firstChild.nodeType == NODE_TEXT) { outString += ""; // Handle child nodes } else { outString += ""; if (opt.node.attributes) { outString += ""; } // Since the node has child nodes, recurse outString += ""; } outString += "
" + opt.node.nodeName + "
" + opt.node.nodeName + "" + ((opt.node.nodeValue != null) ? checkLink(opt.node.nodeValue) : " ") + "
"; outString += showAttrs(opt.node, opt); outString += "
" + opt.node.nodeName + "
" + opt.node.nodeName + "" + checkLink(opt.node.firstChild.nodeValue) + "
" + opt.node.nodeName + "
"; outString += showAttrs(opt.node, opt); outString += "
"; for (var i = 0; i < opt.node.childNodes.length; i++) { outString += $().SPServices.SPDebugXMLHttpResult({ node: opt.node.childNodes.item(i), outputId: opt.outputId, indent: opt.indent + 1 }); } outString += "
"; // Return the HTML which we have built up return outString; }; // Function which returns the account name for the current user in DOMAIN\username format $.fn.SPServices.SPGetCurrentUser = function() { var username = ""; $.ajax({ async: false, // Need this to be synchronous so we're assured of a valid value url: "/_layouts/userdisp.aspx?Force=True", complete: function (xData, Status) { $(xData.responseText).find("table.ms-formtable td#SPFieldText").each(function() { if(/FieldInternalName=\"Name\"/.test($(this).html())) username = $(this).text(); }); } }); return username.replace(/(^[\s\xA0]+|[\s\xA0]+$)/g, ''); }; // Function which provides a link on a Lookup column for the user to follow // which allows them to add a new value to the Lookup list. // Based on http://blog.mastykarz.nl/extending-lookup-fields-add-new-item-option/ // by Waldek Mastykarz $.fn.SPServices.SPLookupAddNew = function(options) { var opt = $.extend({}, { lookupColumn: "", // The display name of the Lookup column promptText: "Add new {0}" // Text to use as prompt + column name }, options); var newUrl = ""; var lookupListUrl = ""; // Use GetList for the current list to determine the details for the Lookup column $().SPServices({ operation: "GetList", async: false, listName: listNameFromUrl(), completefunc: function (xData, Status) { $(xData.responseXML).find("Field").each(function() { if($(this).attr("DisplayName") == opt.lookupColumn) { // Use GetList for the Lookup column's list to determine the list's URL $().SPServices({ operation: "GetList", async: false, listName: $(this).attr("List"), completefunc: function (xData, Status) { $(xData.responseXML).find("List").each(function() { lookupListUrl = $(this).attr("WebFullUrl"); }); } }); // Get the NewItem form for the Lookup column's list $().SPServices({ operation: "GetFormCollection", async: false, listName: $(this).attr("List"), completefunc: function (xData, Status) { $(xData.responseXML).find("Form").each(function() { if($(this).attr("Type") == "NewForm") newUrl = $(this).attr("Url"); }); } }); } }); } }); if(newUrl.length > 0) { // Build the link to the Lookup column's list newLink = "" + opt.promptText.replace(/\{0\}/g, opt.lookupColumn) + ""; // Append the link to the Lookup columns's formbody table cell $("select[title=" + opt.lookupColumn + "]").parents("td.ms-formbody").append(newLink); } }; // Function to return the ID of the last item created on a list by a specific user. Useful for maintaining parent/child relationships // between list forms $.fn.SPServices.SPGetLastItemId = function(options) { var opt = $.extend({}, { webURL: "", // URL of the target Web. If not specified, the current Web is used. listName: "", // The name or GUID of the list userAccount: "" // The account for the user in DOMAIN\username format. If not specified, the current user is used. }, options); var userId; var lastId = 0; $().SPServices({ operation: "GetUserInfo", async: false, userLoginName: (opt.userAccount != "") ? opt.userAccount : $().SPServices.SPGetCurrentUser(), completefunc: function (xData, Status) { $(xData.responseXML).find("User").each(function() { userId = $(this).attr("ID"); }); } }); $().SPServices({ operation: "GetListItems", async: false, webURL: opt.webURL, listName: opt.listName, CAMLQuery: "" + userId + "", CAMLViewFields: "", CAMLRowLimit: "1", completefunc: function(xData, Status) { $(xData.responseXML).find("z\\:row").each(function() { lastId = $(this).attr("ows_ID"); }); } }); return lastId; }; $.fn.SPServices.SPRequireUnique = function (options) { var opt = $.extend({}, { columnStaticName: "Title", // Name of the column duplicateAction: 0, // 0 = warn, 1 = prevent ignoreCase: "false", // If set to true, the function ignores case, if false it looks for an exact match initMsg: "This value must be unique.", // Initial message to display after setup initMsgCSSClass: "ms-vb", // CSS class for initial message errMsg: "This value is not unique.", // Error message to display if not unique errMsgCSSClass: "ms-formvalidation" // CSS class for error message }, options); var msg = "{1}
"; var initMsg = msg.replace(/\{0\}/g, opt.initMsgCSSClass).replace(/\{1\}/g, opt.initMsg); var errMsg = msg.replace(/\{0\}/g, opt.errMsgCSSClass).replace(/\{1\}/g, opt.errMsg); var thisList = listNameFromUrl(); var columnDisplayName = $().SPServices.SPGetDisplayFromStatic({ listName: thisList, columnStaticName: opt.columnStaticName }); var columnObj = $("input:[Title='" + columnDisplayName + "']"); $(columnObj).parent().append(initMsg); $(columnObj).change(function () { var columnValueCount = 0; // Get the columnDisplayName's value var columnValue = $(this).attr("value"); // Call the Lists Web Service (GetListItems) to see if the value already exists $().SPServices({ operation: "GetListItems", async: false, listName: listNameFromUrl(), // Filter based on columnDisplayName's value CAMLViewFields: "", // Override the default view rowlimit and get all appropriate rows CAMLRowLimit: "0", completefunc: function(xData, Status) { var testValue = opt.ignoreCase ? columnValue.toUpperCase() : columnValue; $(xData.responseXML).find("z\\:row").each(function() { var thisValue = opt.ignoreCase ? $(this).attr("ows_" + opt.columnStaticName).toUpperCase() : $(this).attr("ows_" + opt.columnStaticName); if(testValue == thisValue) columnValueCount++; }); } }); var newMsg = initMsg; var buttonsDisabled = ""; if(columnValueCount > 0) { newMsg = errMsg; buttonsDisabled = "disabled"; if(opt.duplicateAction == 1) $("input:[Title='" + columnDisplayName + "']").focus(); } $("span#SPRequireUnique").html(newMsg); $("input:[value='OK']").attr("disabled", buttonsDisabled); }); }; $.fn.SPServices.SPGetDisplayFromStatic = function (options) { var opt = $.extend({}, { webURL: "", // URL of the target Web. If not specified, the current Web is used. listName: "", // The name or GUID of the list columnStaticName: "" // StaticName of the column }, options); var staticName = ""; $().SPServices({ operation: "GetList", async: false, webURL: opt.webURL, listName: opt.listName, completefunc: function(xData, Status) { $(xData.responseXML).find("Field").each(function() { //alert(opt.columnDisplayName + $(this).attr("Name") + $(this).attr("StaticName")); if($(this).attr("StaticName") == opt.columnStaticName) displayName = $(this).attr("DisplayName"); }); } }); return displayName; }; $.fn.SPServices.SPRedirectWithID = function (options) { var opt = $.extend({}, { redirectUrl: "" // Page for the redirect }, options); var thisList = listNameFromUrl(); var vals = new Object(); var qs = location.search.substring(1, location.search.length); var args = qs.split("&"); for (var i=0; i < args.length; i++) { var nameVal = args[i].split("="); var temp = unescape(nameVal[1]).split('+'); nameVal[1] = temp.join(' '); vals[nameVal[0]] = nameVal[1]; } var lastID = vals["ID"]; // On first load, change the form actions to redirect back to this page with the current lastID for this user and the // original Source. if(vals["ID"] == undefined) { lastID = $().SPServices.SPGetLastItemId({ listName: thisList }); $().find("form[name='aspnetForm']").each(function() { // Add the last ID this user has created to the postback action var thisSource = "Source=" + vals["Source"].replace(/\//g, "%2f").replace(/:/g, "%3a"); var thisUrl = location.href.substring(0, location.href.indexOf("?")); var newAction = thisUrl + "?Source=" + thisUrl + "?ID=" + lastID + "%26RealSource=" + vals["Source"] + ((vals["RedirectURL"] != undefined) ? ("%26RedirectURL=" + vals["RedirectURL"]) : ""); $(this).attr("action", newAction); }); // If this is the load after the item is saved, wait until the new item has been saved, then do the redirect // to redirectUrl with the new lastID, passing along the original Source. } else { while(vals["ID"] == lastID) { lastID = $().SPServices.SPGetLastItemId({ listName: thisList }); } // If there is a RedirectURL parameter on the Query String, then redirect there instead of the value // specified in the options (opt.redirectUrl) //alert("RedirectURL=" + vals["RedirectURL"] + " opt.redirectUrl=" + opt.redirectUrl); //alert(vals["RedirectURL"] == undefined); var thisRedirectUrl = (vals["RedirectURL"] == undefined) ? opt.redirectUrl : vals["RedirectURL"]; location.href = thisRedirectUrl + "?ID=" + lastID + "&Source=" + vals["RealSource"]; } }; //PRIVATE FUNCTIONS // Display a column (field) formatted correctly based on its definition in the list. // NOTE: Currently not dealing with locale differences. // columnXML The XML node for the column from a GetList operation // columnValue The text representation of the column's value // opt The current set of options function showColumn(columnXML, columnValue, opt) { if(columnValue == undefined) return ""; var outString = columnValue; switch(columnXML.attr("Type")) { case "Text": outString = columnValue; break; case "URL": outString = "" + columnValue.substring(columnValue.search(",") + 1) + ""; break; case "Number": outString = parseFloat(columnValue).toFixed(columnXML.attr("Decimals")).toString(); break; case "Lookup": // Get the display form URL for the lookup source list var dispUrl; $().SPServices({ operation: "GetFormCollection", async: false, listName: columnXML.attr("List"), completefunc: function (xData, Status) { $(xData.responseXML).find("Form").each(function() { if($(this).attr("Type") == "DisplayForm") dispUrl = $(this).attr("Url"); }); } }); outString = "" + columnValue.substring(columnValue.search(";#") + 2) + ""; break; case "Counter": outString = columnValue; break; default: break; } return outString; } // Show a single attribute of a node, enclosed in a table // node The XML node // opt The current set of options function showAttrs(node, opt) { var out = ""; for (var i = 0; i < node.attributes.length; i++) { out += ""; } out += "
" + i + "" + node.attributes.item(i).nodeName + "" + checkLink(node.attributes.item(i).nodeValue) + "
"; return out; } // Get the current list name from the URL function listNameFromUrl() { var thisSite = $().SPServices.SPGetCurrentSite(); var listPath = location.href.replace(thisSite, "").replace("/Lists/", ""); var thisList = listPath.substr(0,listPath.search("/")); return thisList; } // If a string is a URL, format it as a link, else return the string as-is function checkLink(s) { return ((s.indexOf("http") == 0) || (s.indexOf("/") == 0)) ? "" + s + "" : s; } // Escape string characters function escapeHTML(s) { return s.replace(/"/g,'"').replace(/&/g,'&').replace(//g,'>'); } // Encode a column name function encodeColumn(s) { return s.replace(/ /g,'_x0020_'); } // Wrap an XML node (n) around a value (v) function wrapNode(n, v) { return "<" + n + ">" + v + ""; } })(jQuery);