Quick tutorial

On this page you will see the basics of SPCoder and learn how to use it.

1. Enter the url of your portal in the address box of the Explorer window and click Connect button.

spcoder0

After that the portal’s structure will be shown in the tree view below. Site, Webs, Lists and Libraries will be shown in the tree view.

2. Drag any node from treeview to Context window. By doing that the IronPython engine becomes aware of the SharePoint object that has been dropped to context and you can use that object in your scripts.

spcoder0.5

3. Start writing the code. You can use objects from Context in your code. The editor is aware of the types of objects in Context, so you have the “autocomplete” support.

spcoder1.5

4. By using “out” variable you can write to Output window. If you drag’n’drop a SPWeb object to the context, you can try executing the following script (by pressing F5 or clicking the Execute button):
out.writeln(web.Url)
out.writeln(web.Title)
That code will write the Url and the Title of the web object to Output window.
The code out.writeCol(web.Lists, "Title") will write titles of all the lists to the Output window.

spcoder3

5. Describer window can be opened by right clicking the item in the Context and choosing the Describe option in context menu. The describer window shows all the properties of the object (property names and values).

spcoder4

spcoder5

“Object chaining” is the feature of the Describer window that allows you to describe the property of the property, which can be accomplished using standard dot notation. For example if you described the “site” object, you can enter “site.Owner” in the text box and click the Describe button. That will describe the Owner property of the site object. This can easily be achieved by double clicking the name of the property and after that clicking the Describe button.
Another great feature is the bread crumb trail which can be used to get back to any previously described object.

spcoder6

For all the features please visit the Documentation page.

Last edited Dec 13, 2013 at 7:19 PM by tomdam, version 8