About the Microsoft Office InfoPath Primary Interop Assembly
The Microsoft Office InfoPath 2007 application is a Component Object Model (COM) application that exposes its programmability interfaces for both external automation and script used within form templates as COM interfaces. To support the creation of InfoPath solutions that use managed-code languages such as Visual C# and Visual Basic, the .NET Programmability Support option in the Office InfoPath 2007 setup program installs three interop assemblies. Interop assemblies are .NET assemblies that act as a bridge between managed and unmanaged code, mapping COM object members to equivalent .NET managed members.
The files for the three interop assemblies installed by InfoPath are named:
Microsoft.Office.Interop.InfoPath.dll
Microsoft.Office.Interop.InfoPath.SemiTrust.dll
Microsoft.Office.Interop.InfoPath.Xml.dll
This topic discusses the object model exposed through the Microsoft.Office.Interop.InfoPath interop assembly, which is used exclusively for external automation code. For information on the Microsoft.Office.Interop.InfoPath.SemiTrust assembly, which is used exclusively for writing and running managed-code that runs from within InfoPath form templates (.xsn), see InfoPath 2003 Compatible Object Models.
Important Installation Information
By default, the Typical installation option of the Office InfoPath 2007 setup program installs the Microsoft.Office.Interop.InfoPath assembly in the Global Assembly Cache (GAC), the contents of which can be viewed from the C:\Windows\Assembly folder. This assembly is referred to as the "Microsoft Office InfoPath Primary Interop Assembly" and is typically used in conjunction with the Microsoft.Office.Interop.InfoPath.Xml assembly, which is also installed in the GAC, to automate the InfoPath application from external applications that use managed code. For information about the Microsoft.Office.Interop.InfoPath.Xml assembly, see About the InfoPath XML Interop Assembly.
If the Microsoft.Office.Interop.InfoPath assembly is not visible in GAC, you should confirm that Office InfoPath 2007 was installed correctly. The .NET Programmability Support option in the setup program is set to Run from My Computer for a Typical installation of InfoPath as long as the .NET Framework 1.1 Redistributable or .NET Framework 1.1 Software Development Kit (SDK) is installed before running setup. If these interop assemblies are not available on your computer, you must confirm that the .NET Framework 1.1 is installed, and then run Add or Remove Programs from the Control Panel and set the .NET Programmability Support option of Microsoft Office InfoPath to Run from My Computer.
For information on downloading the .NET Framework 1.1 Redistributable, see .NET Framework 1.1 Redistributable.
The Microsoft.Office.Interop.InfoPath Namespace
Although the process of writing managed code for a given task in an InfoPath form template is very similar to performing the same programming task using a COM language such as Microsoft Visual Basic or JScript, the object model exposed when viewing the Microsoft.Office.Interop.InfoPath namespace from the Object Browser in Microsoft Visual Studio looks more complex. This is because interoperability with the .NET Framework requires a COM server to expose all of its public interfaces, as well as some additional constructs required by the .NET Framework itself. For more information on how and why the object model exposed by an interop assembly appears more complex, see the "How COM Objects are Exposed to Managed Code" section of the InfoPath 2003 Compatible Object Models topic.
Using IntelliSense
The examples in this section assume that you have established references to the Microsoft.Office.Interop.InfoPath and Microsoft.Office.Interop.InfoPath.Xml assemblies. For information on how to do that and for additional external automation examples, see External Automation Scenarios and Examples.
Before you can use Microsoft IntelliSense statement completion in external automation code, you must create an object variable for an instance of the Application class as shown in the following line of code.
Application myApp =
new Microsoft.Office.Interop.InfoPath.Application();
Dim myApp As Application = _
New Microsoft.Office.Interop.InfoPath.Application()
After creating the object variable, when you type the variable name followed by a period, a drop-down list is displayed with members of the Application class to select.
To work with an InfoPath form, declare an object variable of type XDocument, and then initialize it by opening the form from the XDocuments collection of the Application object variable as shown in the following line of code.
XDocument myXDoc = myApp.XDocuments.Open(
"c:\\temp\\Form1.xml",
(int) XdDocumentVersionMode.xdFailOnVersionOlder);
Dim myXDoc As XDocument = myApp.XDocuments.Open( _
"c:\\temp\\Form1.xml", _
XdDocumentVersionMode.xdFailOnVersionOlder)
The IntelliSense statement completion drop-down list for members of the XDocument class will be displayed when you type the name of the variable followed by a period.
To work with the contents of the underlying XML document for the form using Microsoft XML Core Services (MSXML) 5.0 for Microsoft Office, you must create a variable of type IXMLDOMDocument2, and then use the DOM property of the XDocument class to assign the XML Document Object Model (DOM) of the form to that variable.
IXMLDOMDocument2 doc= myXDoc.DOM as IXMLDOMDocument2;
Dim doc As IXMLDOMDocument2 = myXDoc.DOM
The IntelliSense statement completion drop-down list for members of the IXMLDOMDocument2 class will be displayed when you type the name of the variable followed by a period, which allows you to use MSXML 5.0 to work with the XML document.
Using the Class Library Reference Documentation
The organization of the Microsoft.Office.Interop.InfoPath namespace Class Library reference documentation reflects the relationships between coclass interfaces and the inherited interfaces they implement. The topics are organized in the same way as the InfoPath Object Model Reference for writing script that is part of the InfoPath Developer Reference, which is included with Office InfoPath 2007. With the exception of the topics for the Application and XDocument interfaces, all of the COM coclass interface topics map to the equivalent "Object" and "Collection" topics from the InfoPath scripting reference. For example, the "UIObject Interface" and the "WindowsCollection Interface" topics of the Microsoft.Office.Interop.InfoPath namespace reference documentation map to the same or similar content in the "UI Object" and "Windows Collection" topics of the InfoPath Object Model Reference scripting reference.
However, the link to the members of the coclass interface following the description of the interface at the beginning of the topic displays an empty topic. To display the list of members that are implemented by the coclass interface, you must open the topic for the most recent interface that is inherited by the coclass, and then open the table of its members. A link to the inherited interface is provided at the beginning of the Remarks section in the coclass interface topic.
When you press F1 in the Visual Studio Code Editor, the behavior is similar, except that the member on which you invoke F1 Help will be displayed directly, because you are most typically working with members of an interface. However, the fact that a member can be implemented from a versioned interface may be confusing the first time you encounter it. For example, if you type myXDocument.UI.Alert and place the cursor on Alert and press F1, a topic titled "UI2.Alert Method" is displayed. This is because the Alert method is an implementation of a member of the UI2 interface.
Passing Optional Parameters to InfoPath Object Model Members
If an InfoPath object model member contains an optional parameter, and you do not specify a value for that parameter, you must pass the Type.Missing field for that parameter. Failure to pass the Type.Missing field when an actual value is omitted will result in a build error. This is true for code written in both C# and Visual Basic .NET. For example, the SelectNodes method of the ViewObject interface includes two optional parameters: varEndNode and varViewContext. A line of code that does not specify actual values for these optional parameters should look like the following examples.
myXDocument.View.SelectNodes(group1, Type.Missing, Type.Missing);
myXDocument.View.SelectNodes(group1, Type.Missing, Type.Missing)