Environment class

Provides properties to determine what runtime environment was used to open the form template.

Inheritance hierarchy

System.Object
  Microsoft.Office.InfoPath.Environment

Namespace:  Microsoft.Office.InfoPath
Assembly:  Microsoft.Office.InfoPath (in Microsoft.Office.InfoPath.dll)

Syntax

'Declaration
Public MustInherit Class Environment
'Usage
Dim instance As Environment
public abstract class Environment

Remarks

Use the Environment property of the XmlForm class to access an Environment object you can use determine which runtime environment and program was used to open the form template for editing.

The Environment class provides the IsBrowser and IsMobile properties which enable you to determine what editing environment was used to open a form template. If both properties return false, the form template was opened in Microsoft InfoPath. If either property returns true, the form template was opened from an appropriately configured document library on Microsoft SharePoint Server 2010 running InfoPath Forms Services in the program for the corresponding property: a Web browser (IsBrowser property) or a mobile browser (IsMobile property).

Examples

In the following example, a basic pattern is shown for checking the values of IsBrowser and IsMobile properties to conditionally run code depending on which environment and program was used to open the form.

if (this.Environment.IsBrowser)
{
   // Code to run if form is open in a Web browser.
}

else if (this.Environment.IsMobile)
{
   // Code to run if form is open in a mobile browser.
}
else
{
   // Code to run if form is open in the InfoPath editor.
}
If (Me.Environment.IsBrowser) Then
   ' Code to run if form is open in a Web browser.
ElseIf (Me.Environment.IsMobile) Then
   ' Code to run if form is open in a mobile browser.
Else
   ' Code to run if form is open in the InfoPath application.
End If

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See also

Reference

Environment members

Microsoft.Office.InfoPath namespace