kitmenke / sputility Goto Github PK

A JavaScript library used to make modifications to SharePoint's list forms (NewForm.aspx and EditForm.aspx in a survey, custom list or library).

License: MIT License

JavaScript 42.06% HTML 57.03% CSS 0.91%

sputility's Introduction

This project is no longer being maintained. The final release of SPUtility.js is 0.14.2.

SPUtility.js

A JavaScript library used to make modifications to SharePoint's list forms (NewForm.aspx and EditForm.aspx in a survey, custom list or library). SPUtility.js works with SharePoint 2007, 2010, and 2013.

This library depends on jQuery (tested with v1.9.0+). I recommend using version 1.x of jQuery in order to support older versions of IE.

Usage

Upload jQuery and SPUtility into a Document Library in your SharePoint site.

Edit the SharePoint form you wish to modify and add a Content Editor Web Part with the following script inside of it:

<script src="/site/Files/jquery.js"></script>
<script src="/site/Files/sputility.min.js"></script>
<script>
$(window).load(function () {
   // TODO: Your scripts go here!

   // EXAMPLE: Set the value of the Title field to Hello world!
   SPUtility.GetSPField('Title').SetValue('Hello world!');
});
</script>

Step by step install instructions are located here: https://github.com/kitmenke/sputility/blob/master/WikiFiles/docs/Installation.md

Documentation

Documentation was migrated from Codeplex to Markdown files in this repo: https://github.com/kitmenke/sputility/blob/master/WikiFiles/docs/

Examples

// Set the value of the Title field to Hello world!
SPUtility.GetSPField('Title').SetValue('Hello world!');

// Get the value of the Title field
SPUtility.GetSPField('Title').GetValue(); // returns "Hello world!"

// Make the Title field read only
SPUtility.GetSPField('Title').MakeReadOnly();

// Hide the entire row from view
SPUtility.GetSPField('Title').Hide();

// You can also set a variable to the returned field
var fTitle = SPUtility.GetSPField('Title');
fTitle.SetValue('Using my variable!');

For Developers Getting Started

SPUtility.js uses Grunt to run tests, check code syntax, and compress/minify/uglify files for use in production.

Install node.js and npm.

Install grunt:

npm install -g grunt-cli
npm install grunt

Install git and clone SPUtility.js:

git clone https://github.com/kitmenke/sputility.git

Install SPUtility.js dependencies:

cd sputility
npm install

If everything went ok, you should be able to run grunt in the sputility directory.

Executing grunt will run all of the tasks (jshint, qunit, uglify). Or, you can run them individually, for example: grunt jshint will run just the unit tests.

Contributing

This project is no longer maintained so contributions are no longer accepted.

Release History

https://github.com/kitmenke/sputility/blob/master/WikiFiles/docs/Changelog.md

License

MIT

sputility's People

Contributors

Stargazers

Watchers

sputility's Issues

Support for SPFieldChoice fields with no HTML comment

Support SPFieldChoice fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

IsRequired

Can anyone please assist me on how IsRequired is implemented because it doesn't seem to work on my side.

People fields (SPUserField) set value and get value not working

Hello,

I'd like to submit 2 bug fixings and 2 new features.

Bug: SPUserField, it misses the "#" part (around line 1286)

this.upLevelDiv = $("#" + this.spanUserField.id + '_upLevelDiv');
this.textareaDownLevelTextBox = $("#" + this.spanUserField.id + '_downlevelTextBox');
this.linkCheckNames = $("#" +this.spanUserField.id + '_checkNames');
this.txtHiddenSpanData = $("#" +this.spanUserField.id + '_hiddenSpanData');

GetValue() (line 1291)

this.GetValue = function () {
     var peopleSpans = this.upLevelDiv.find('span.ms-entity-resolved');
     if (peopleSpans.length > 0) {
        return arrayToSemicolonList(peopleSpans);
     }
     return '';
};

Feature: add Description to SPField (line 377)
This expose the Description of a field as a text element.

this.Description = (function(ctls) { var c = ctls.childNodes[ctls.childNodes.length-1]; return (c.nodeType!=3 || $(c).text().replace(/\s/g,'').length == 0)? null : c; })(fieldParams.controlsCell);

Feature: registering "change" event in SPUserField (line 1334, at the bottom of SPUserField class)

var currentValue = null;
this.OnChange = function(fn) {
      var handler = getMethodName(fn) + "()";
      $(this.upLevelDiv[0], this.textareaDownLevelTextBox[0]).attr("onvaluesetfrompicker", handler);

      currentValue = this.GetValue();
      this.upLevelDiv.blur($.proxy(function() {
           if (this.GetValue() !== currentValue) {
               currentValue = this.GetValue();
               fn();
           }
      }, this));
};

Usage:

SPUtility.GetSPField("Nominated User").OnChange(requestUser);
function requestUser() {
    var val = SPUtility.GetSPField("Nominated User").GetValue();
    if (!val.length) return;
    alert(val);
}

And this method to get the list of resolved users by loginName/display Name:

this.GetUsers = function() {
    var people = [], peopleSpans = this.upLevelDiv.find('span.ms-entity-resolved');
    if (peopleSpans.length > 0) {
        $(peopleSpans).each(function () {
            var c = this.firstChild;
            people.push({ id: c.getAttribute('key'), title: c.getAttribute('displaytext') });
        });
    }
    return people;
};

Of course, feel free to rename the methods as you want.

Tested on IE 8 & Chrome

SPUtility should allow retrieving fields by internal column name

Allow retrieving a fields by internal column name.

Currently lazyLoadSPFields works quickly by only finding the display names. To index internal column names, each field would have to be parsed which can cause performance issues with large lists.

Considering adding a new method or an overload of GetSPField to allow this.

SPUserField not working with jQuery 1.9

SPUserField not working with jQuery 1.9 because of the line:
this.SetValue = function (value) {
1518: if ($.browser.msie) {

because jQuery seems to have deprecated this .msie line (see http://api.jquery.com/jquery.browser/)

Is there a version uses say:
var isIE = ("ActiveXObject" in window)
See: http://stackoverflow.com/questions/17907445/how-to-detect-ie11

field.MakeReadOnly() displays 12:00 AM for null Date (SPFieldDateTime) field

Created from https://sputility.codeplex.com/workitem/31

field.MakeReadOnly() displays 12:00 AM for null Date (SPFieldDateTime) field on the edit form.
I think it shouldn't display anything (empty string).
The field was provisioned with Type="DateTime"

This happens on SharePoint 2010 (did not test on 2013).

Empty numeric field displays as NaN

Created from #22

MakeReadOnly on an empty numeric field results in NaN.

Unable to make Multi-select lookup read only

SharePoint 2007
SPUtility.GetSPField('Multi-value Lookup').MakeReadOnly()

Gives error: "Object doesn't support this property or method"

SPUtility.GetSPField return 50 instead of 50.000

Before:
Title 50.000 (fifty thousand in the European numbering system)

var myField = SPUtility.GetSPField('Title');
myField.MakeReadOnly();

After:
Title 50 (fifty)

I use SP2007

Can you fix the problem?
Thanks

Stefano

How i can make a MakeReadOnly() field Editable again ?

I am facing this problem when using SPUtility.js inside my SP 2013 on-premises, now i want to do the following inside my sharepoint 2013 list forms:-

Set a Choice field as ReadOnly.
then chnage the value of the ReadOnly Choice field using SPUtility or pure JavaScript.

now to make my Choice field ReadOnly i use the following SPUtility method:-

SPUtility.GetSPFieldByInternalName('OrderStatus').MakeReadOnly();

but when i tired to change the value of the list after making it ReadOnly, as follow:-

SPUtility.GetSPFieldByInternalName('OrderStatus').SetValue("In Progress");

OR using pure javascript appraoch as follow:-

$('[id^="OrderStatus"]').val("In Progress");

i was unable to change the status value? so can anyone adivce how i can handle this problem? so i can change the value of a ReadOnly list?
second point, is there a way i can temporary remove the MakeReadOnly() effect on the field? if this is possible , then i can remove the ReadOnly effect on the Choice field, then set its value, then make it as ReadOnly again ?
Thanks

MakeReadOnly truncates field values if finds any special characters like '&'

Single line of text field in IE 11
Example -
SPUtility.GetSPField('CustomerCode').MakeReadOnly();
CustomerCode = "R&DI"
When form is displayed is only displays R and not R&DI

SPLookupMultiField SetValue timing issue with Firefox

Multi-select lookup fields use buttons to move selected options between the two select boxes.

In Firefox, calling SetValue multiple times in a row can result in a value not being set.

This issue does not seem to affect Chrome.
TODO: test IE

Calling MakeEditable after MakeReadOnly doesn't make the field editable again

MakeReadOnly turns the field into a label correctly but MakeEditable doesn't undo the changes correctly.

Implement GetValueString for all field types

Right now only SPNumberField, SPBooleanField, and SPUserField2013 have this method. It would be nice if all the fields implemented the GetValueString method so that you could do easy comparisons (before and after for example).

From:
https://sputility.codeplex.com/workitem/35

Allow customizing the date separator for date and time fields

The current separator is hard coded to '/'. Allow customizing the separator so that this works with other countries.

For example: '.'

Add support for GetValue/SetValue on DispForm

On DispForm.aspx GetValue throws an exception when used. https://sputility.codeplex.com/discussions/646901

It should at the very least be able to return a string value of the field but it would be nice to convert to the right type like on NewForm and EditForm.

SetValue for DateTime fields clears out a Read-only label instead of updating it

SharePoint 2007, Date and Time field:
Calling SPUtility.GetSPField('Date and Time').MakeReadOnly() makes the field read only OK.
Then calling:
SPUtility.GetSPField('Date and Time').SetValue(2014,3,14,'1 AM','00')
clears the label instead of updating it.

SPUtility should allow setting the date or time portions of DateTime fields individually

Date time fields contain multiple controls: a calendar control (textbox) for the date, a dropdown for hour, and a dropdown for minute.

The current API supports setting just date and date plus time. It does not support setting Time only.

API should support the ability to set just the time and force the user to fill out the date.
var field = SPUtility.GetSPField('Date and Time');
field.SetTime(8, 30);
field.SetTime('6 PM', '00');

Not working at all

I am trying to get SPutility to work in Sharepoint online. I could not get any scripts to work in neither script editor nor content editor web parts. I don't have access to custom forms advanced mode editing (yet - i hope i will get it soon from the admin). I managed to find a workaround by using Form HTML webpart and editing its source code and putting my script there. jQuery works and gives me the test alert, but nothing happens when i try to get an alert from SPUtility. ( I also tried using some functions on the form like autocomplete but no luck there as well. Here's the code:

<script language="javascript" type="text/javascript" src="/SiteAssets/jquery-3.2.1.js"></script>
<script language="javascript" type="text/javascript" src="/SiteAssets/jquery.SPServices.min.js"></script>
<script language="javascript" type="text/javascript">
$(document).ready(function() {
 alert("jQuery");
alert($().SPServices.SPGetCurrentSite());
});
</script>

Correctly detect DispForm for Document Libraries

The code below can't detect DispForm for document libraries:

if (formBodies.length > 0 && $(formBodies[0]).children().length === 0) {
   _isDispForm = true;
 }

Need to find better alternative, maybe look at the form's buttons?

Support for SPFieldMultiChoice fields with no HTML comment

Support SPFieldMultiChoice fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Getting a LookupField on the DispForm gives exception

Reported by GenericCodeMonkey:

When I want to get a LookupField in the DisplayForm i get the Exception:
throw "Unable to get input elements for " + this.Name;
from SPAutocompleteLookupField(fieldParams, elemInputs)
because elemInputs is passed with a length of 0 from getSPFieldFromType(spFieldParams)
at case 'SPFieldLookup'

My workaround is to just not throw the exception:

function SPAutocompleteLookupField(fieldParams, elemInputs) {
 SPField.call(this, fieldParams);
 if (this.Controls === null) {
    return;
 }

 if (1 === elemInputs.length) {
    // autocomplete lookup
    this.Textbox = $(elemInputs[0]);
    this.HiddenTextbox = $('input[id="' + this.Textbox.attr('optHid') + '"]');
 } else {
  return;//MyFix
    throw "Unable to get input elements for " + this.Name;
 }
}

Support for SPFieldLookup fields with no HTML comment

Support SPFieldLookup fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Support for SPFieldGridChoice fields with no HTML comment

Support SPFieldGridChoice fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Unable to SetValue for Multiple select lookup fields

SetValue works the first time you call the method. Then, the "possible values" list loses focus and subsequent calls stop working.

Not working in SharePoint 2013.

SPUtility error on Survey forms in SharePoint 2013

From: https://sputility.codeplex.com/discussions/647717

Uncaught Error creating field named ContractID: getSPFieldType error: TypeError: Cannot read property 'childNodes' of undefined

Error is coming out of createSPField because spFieldParams.controlsCell is null. Probably something going wrong in getFieldParams because it is not correctly detecting SharePoint 2013 Survey forms.

Add support for External Data fields

Add support for External Data fields.

Support for SPFieldURL fields with no HTML comment

Support SPFieldURL fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Support for SPFieldCurrency fields with no HTML comment

Support SPFieldCurrency fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Support for ContentTypeChoice fields with no HTML comment

Support ContentTypeChoice fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Support for SPFieldUser fields with no HTML comment

Support SPFieldUser fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Support for SPFieldNote fields with no HTML comment

Support SPFieldNote fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Support for SPFieldFile fields with no HTML comment

Support SPFieldFile fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

Support for SPFieldText fields with no HTML comment

Support SPFieldText fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

SPDateTimeField should accept SPDateTimeFieldValue as a single parameter

SPDateTimeField should accept SPDateTimeFieldValue as a single parameter in addition to the parameters separated out (year, month, day, hour, minute)

SPUserField2013 MakeReadOnly shows [object Object] instead of user's name

SPUserField2013 GetValue returns this.ClientPeoplePicker.GetAllUserInfo(); and MakeReadOnly uses this to set the label's text. Instead, it should pull out the user's name and display that in the label.

Support for SPFieldDateTime fields with no HTML comment

Support SPFieldDateTime fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

SPUtility.GetSPField('Title').SetValue('Hello world!');

Добрый день, Ваш пример не работает в SPS Russian language

SPUtility.GetSPField('Кем проверен кандидат').SetValue('Hello world!');
sputility.min.js:10 Uncaught Unable to get a SPField named Кем проверен кандидат
$.GetSPField @ sputility.min.js:10

Пробовал StaticName указать:
SPUtility.GetSPField('FirstEdit').SetValue('Hello world!');
sputility.min.js:10 Uncaught Unable to get a SPField named FirstEdit

Bower package

Hello,

just wondered, why isn't SPUtility available in bower? 👊

http://bower.io/search/?q=sputility

Support for SPFieldUserMulti fields with no HTML comment

Support SPFieldUserMulti fields where the HTML comment is missing.

Reported here: http://sputility.codeplex.com/discussions/654914

NPM

Hi,

please add your package to npm public repository. It would help all developers which use npm for their package repository a lot. In my company we are currently shifting from bower to npm

Thank you,
Viktor

Unable to Hide fields on DispForm

Attempting to hide the Title field on DispForm results in this error:

Uncaught Error creating field named Title: Unable to retrieve the input control for Title

Create a custom list
Turn on management of content types in advanced settings
Add multiple content types to the list
Create an item in the list
Edit the item

On the EditForm, a Content Type field is now displayed at the top. Expected behavior would be to get the value of this field like: SPUtility.GetSPField('Content Type').GetValue();

Issue is: SPUtility is unable to determine the type of the Content Type field and returns null.

kitmenke / sputility Goto Github PK

sputility's Introduction

This project is no longer being maintained. The final release of SPUtility.js is 0.14.2.

SPUtility.js

Usage

Documentation

Examples

For Developers Getting Started

Contributing

Release History

License

sputility's People

Contributors

Stargazers

Watchers

Forkers

sputility's Issues

Recommend Projects

Recommend Topics

Recommend Org