Imagine a scenario where the accounting department at Contoso, Inc. tracks corporate assets through an Asset Management System built on SharePoint. One module in the system allows employees to order office equipment such as laptops, conference phones, and ergonomic chairs through an InfoPath form. At first, the order form was built using only declarative logic. It could enforce required fields, surface validation messages, and submit the form to SharePoint without any code.
As the ordering process grew more complex, users started adding additional requirements to the system. The variety of inventory available to employees increased, so they wanted a way sort items by name and description real-time in the order form. Contoso also started shipping their office equipment out of three warehouses. This prevented the warehouse crew from fulfilling complete orders, and as such, the system needed to track shipping status and quantity of individual items in the order. To meet the new requirements, Contoso added the following features to the form:
- A custom sort interface
- Logic for managing complex data when the form is submitted
- Logic to add items to a SharePoint list
Sort interfaces, sophisticated submit routines, and database (i.e. list) management are common requirements for forms. Fortunately, this functionality can be added to InfoPath forms with a few lines of code. Let me explain these features, the code required to build them, and the prerequisites for developing managed code in InfoPath in more detail.
Equipment Request Form
The employee orders module in the Asset Management system consists of three core components:
- A SharePoint form library, “Equipment Orders”, where users go to fill out the Equipment Order Request form shown below.
- A SharePoint list, “Equipment Inventory”, which stores the items available for users to order. This list contains fields specifying items’ names, descriptions, and quantities used to populate the Equipment Order Request form.
- A SharePoint list, “Equipment Shipping”, which stores a list of items ordered by users that have been scheduled for shipping. This list contains fields for the names and quantities of items being ordered as well as the name of the user who placed the order.
The Equipment Request Form enables users to sort through Contoso’s available inventory and submit a request to the warehouse for shipping.
The order form is a repeating table, where each row in the table represents the name, description, and quantity of the item being ordered.
Sorting data in the form
The Equipment Order Form has a Picture Button Control displaying an arrow next to each of the column labels.
The buttons are used to sort the order items in ascending order by the respective column. When the user clicks the button, the values in the selected column are compared, and the rows of data are sorted based on the comparison result.
The sorting routine in this example is based on a
complete solution provided by Hagen Green. Read through his post to learn how to provide a descending sort which also takes localization and data types into consideration.
private string GetValue(string xpath)
{ // return the value of the specified node
XPathNavigator myNav = this.MainDataSource.CreateNavigator().SelectSingleNode(xpath, NamespaceManager);
if (myNav != null)
return myNav.Value;
else
return "";
}
private void Swap(string xpath1, string xpath2)
{ // swap two rows of the table
XPathNavigator item1 = this.MainDataSource.CreateNavigator().SelectSingleNode(xpath1, NamespaceManager);
XPathNavigator item2 = this.MainDataSource.CreateNavigator().SelectSingleNode(xpath2, NamespaceManager);
if (item1 != null && item2 != null)
{ // Make a copy of item1
// Move item2 to item1
// Make the original item2 be item1 that we cloned earlier
XPathNavigator item1Clone = item1.Clone();
item1.ReplaceSelf(item2);
item2.ReplaceSelf(item1Clone);
}
}
private void SortOrder(string sortBy)
{ string itemsToSort = "/my:myFields/my:Order/my:OrderItem";
XPathNodeIterator items = this.MainDataSource.CreateNavigator().Select(itemsToSort, NamespaceManager);
if (items != null)
{ int numItems = items.Count;
// basic bubble sort implementation
for (int i = 1; i < numItems; i++) // xpath is 1-based
{ for (int j = i + 1; j <= numItems; j++)
{ // swap (i,j) if necessary
string iValue = GetValue(itemsToSort + "[" + i + "]" + sortBy);
string jValue = GetValue(itemsToSort + "[" + j + "]" + sortBy);
if (String.Compare(iValue, jValue, true) > 0)
Swap(itemsToSort + "[" + i + "]", itemsToSort + "[" + j + "]");
}
}
}
}
public void ItemNameSort_Clicked(object sender, ClickedEventArgs e)
{ // Sort order by ItemName
// Repeat this code for the other buttons
string sortBy = "/my:ItemName";
SortOrder(sortBy);
}
Managing complex data during submit and updating SharePoint lists using the SharePoint object model
The user is eventually going to finish selecting items and submit the order. Each item ordered through the form is handled independently because, for example, an item in the order may be delayed or shipped from a remote warehouse. So, we need submit logic which will break up the complex data (i.e. the repeating table of items being ordered) into individual rows, and add a shipping request to the Equipment Shipping list for each item-quantity pair. After an item is added to the Equipment Shipping list, a SharePoint workflow is used to track status and manage the Inventory Equipment list’s quantity values.
- The first thing you’ll need to do is use the Submit Options button on the Data tab in the ribbon to add a custom submit handler to your VSTA project.
- Add a reference to Microsoft.SharePoint.dll to your VSTA project. This will allow you to develop code using the SharePoint object model. This DLL is installed in %CommonProgramFiles%\Microsoft Shared\Web Server Extensions\14\ISAPI with your licensed copy of Microsoft SharePoint Server.
- Add custom submit logic to create a SharePoint list item for each item in the order form. See the code below for an example, and notice the use of the ServerInfo class. The ServerInfo class is new to InfoPath 2010 and allows you to write portable code with relative references to SharePoint server URLs.
public void FormEvents_Submit(object sender, SubmitEventArgs e)
{ // Loop through each item-quantity pair in the order form.
// Submit pairs to the Equipment Shipping list.
// Note: Workflow will handle updating item quantities and track shipping status.
using (SPSite mySite = new SPSite(ServerInfo.SharePointSiteUrl.ToString()))
{ using (SPWeb myWeb = mySite.OpenWeb())
{ XPathNodeIterator orderItems;
if (myWeb != null && myWeb.Lists["Equipment Shipping"] != null)
{ SPList shippingList = myWeb.Lists["Equipment Shipping"];
myWeb.AllowUnsafeUpdates = true;
orderItems = this.MainDataSource.CreateNavigator().Select("/my:myFields/my:Order/my:OrderItem", NamespaceManager); if (orderItems != null)
{ while (orderItems.MoveNext())
{ // Add rows from the form where user selected an item and specified a quantity.
string itemName = orderItems.Current.SelectSingleNode("./my:ItemName", NamespaceManager).Value; string itemQuantity = orderItems.Current.SelectSingleNode("./my:ItemQuantity", NamespaceManager).Value; if (itemName != string.Empty && itemQuantity != string.Empty)
{ SPListItem shipItem = shippingList.AddItem();
shipItem["Title"] = itemName;
shipItem["Quantity"] = itemQuantity;
shipItem.Update();
}
}
}
//cleanup
//signal successful submit
//return
myWeb.AllowUnsafeUpdates = false;
e.CancelableArgs.Cancel = false;
return;
}
}
}
}
Along with the features covered above, you’ll find that code is useful for implementing complex data validation logic and managing content from multiple data sources. Such requirements are especially common when your forms are part of an advanced application. You can learn more about validation and working with the InfoPath DOM in our
MSDN XmlEvent.Validating documentation and our post on
working with InfoPath data sources programmatically. You can also review the
InfoPath and
SharePoint object models on MSDN for a more granular view into programming with InfoPath 2010.
If you’d like to get started with programming in InfoPath, then please read on. The rest of this post introduces our system requirements, integrated development environment, and programmability user experience.
How to add code to an InfoPath form
To add code to an InfoPath form:
- Make sure you meet the minimum system requirements.
- Install Visual Studio Tools for Applications (VSTA).
- Choose a programming language.
- Add event handlers and code.
Minimum system requirements
The minimum system requirement to get started with InfoPath 2010 development is Microsoft .NET Framework 2.0, but we suggest you install Microsoft .NET Framework 3.5 SP1 if you’re developing for the SharePoint platform. You can install all versions of Microsoft .NET Framework from
http://www.microsoft.com/downloads.
Installing Visual Studio Tools for Applications
Visual Studio Tools for Applications (VSTA) is an optional installation component available in Microsoft Office 2010 setup. To install VSTA:
- Launch Office 2010 setup from your Office 2010 installation media or from the Control Panel Programs and Features application.
- If you’re installing a new copy of Office 2010, click the Customize button in the installer. If you’ve already installed Office 2010, choose the Add or Remove Features radio button in the installer.
- Set the Visual Studio Tools for Applications option to Run from My Computer and continue through the setup wizard.
Choosing a programming language
InfoPath 2010 allows you to program in C# and Visual Basic .NET. If you want to program with Visual Basic, you do not need to do anything to select your programming language when designing InfoPath 2010 compatible forms. If you plan on programming with C#, or adding code to InfoPath 2007/2003 compatible forms, you can change the programming language by clicking the Language button in the Code group of the Developer tab.
After you click the Language button, you can change your programming language by using the Form template code language drop down:
Hint: You can change the default language for InfoPath 2010 compatible forms by using the Options menu in the Backstage.
- Click the File > Options tab
- Click the More Options button in the General category of the InfoPath Options dialog
- Change the Programming language dropdowns in the Programming Defaults section of the Design Options
Adding event handlers
The Developer tab is the primary entry point for programming in InfoPath 2010. It’s designed to help you add event handlers compatible with the controls and mode of the form you are designing. For example, if you don’t have a control selected on your form view, then you’ll only be able to select the events that apply to the entire form. Notice that the Loading and View Switched event below are enabled, but the entire Control Events group is disabled.
But, as soon as I select a text box on the form, the Control Events group lights up.
Notice that the Sign, Context Changed, and Changing events are disabled in both screenshots of the Developer tab. That’s because I’m working with a browser compatible form, and those events are only available for InfoPath Filler forms.
Note: You’ll find a table of all events, and their compatibility, towards the end of this section.
Certain control and form programming events can be accessed through buttons on other tabs in the ribbon. If you add a Picture Button control on the form view, highlight the button, and then click on the Properties tab then you’ll find the Custom Code button enabled. Clicking the Custom Code button in the ribbon will add an OnClick event for the Picture Button control.
In the Equipment Order Request form, we added a Submit event handler to add items to a SharePoint list. To do this, navigate to the Data tab, and click the Submit Options button in the Submit Form group.
This will launch the Submit Options dialog where you can check “Allow users to submit this form”, “Perform custom action using Code”, and then click the Edit Code button.
The Fields task pane is another main entry point to add event handlers. In the next screenshot, I access the Validating and Changed events for ItemDescription by right clicking the field in the Fields task pane and scrolling through its context menu.
The following tables provide a list of all events and compatibility in InfoPath 2010. Note that InfoPath forms trigger three types of events: Form Events, Data Events, and Button Events. Aside from the button event, InfoPath event handling is different from other web programming paradigms (e.g. WinForm and HTML forms); events are fired when the data changes, not when control state changes. As such, you should consider the optimal configuration for your forms’ post-back settings to provide the best performance while still ensuring that events get fired when necessary. See our
performance post on MSDN to learn more about general performance and event handler post-backs.
After you’ve designed your form and authored the source code, the final step is to publish the form. Your InfoPath form with code can be published to SharePoint and to client machines, but you need to make a security decision before you publish: configure the form as domain trust or full trust.
Domain trust forms can be published to SharePoint as Sandboxed Solutions directly from the InfoPath 2010 Designer. With Sandboxed Solutions, SharePoint Server farm administrators can restrict the resources available to the code and developers cannot access resources subject to operating system security. This establishes a safe environment where Site Collection administrators can publish code to SharePoint without the overhead of administrator approval!
Note: Publishing full trust forms to a client-side environment requires that the form is signed with a code-signing certificate or installed through a custom MSI built in Visual Studio. Publishing a full trust form to SharePoint requires a farm administrator to activate the solution through the SharePoint Central Administration portal.
Best Practice: You should always use the lowest level of trust possible when publishing forms.
Summary
Most forms you design with InfoPath 2010 are not going to require code, but when they do, just install Visual Studio Tools for Applications and you’re ready to start programming. To add code, select the language of your choice, and use entry points in the Ribbon and Fields task pane to automatically insert event handlers. Finally, decide whether or not your form requires full-trust, and publish it to SharePoint or a client environment accordingly. If you’re interested in learning more about the InfoPath and SharePoint programmability, please visit
http://www.msdn.com and keep checking for updates here on the InfoPath blog.
Examples
Let’s assume you want to modify this document, adding content that should be included in the table of contents. This next example takes the following steps.
Up until now, we've not had to use Word (or any other Office client) as all we've been doing is generating documents, not rendering them. Just like you can create an HTML document without requiring a browser, it's perfectly valid to create a Word document (or any other OpenXML format document) without using Word.
