Export (0) Print
Expand All

XmlForm.NotifyHost Method

Office 2010

Provides a custom value to the hosting application or ASPX page.

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

public abstract void NotifyHost(
	string notification
)

Parameters

notification
Type: System.String

A custom value that will be used by the code in the hosting application or ASPX page.

ExceptionCondition
ArgumentNullException

The parameter passed to this method is a null reference (Nothing in Visual Basic).

ArgumentException

The parameter passed to this method is not valid. For example, it is of the wrong type or format.

The NotifyHost method is intended for use in scenarios where an InfoPath form template is hosted in an Microsoft.Office.InfoPath.Server.Controls.XmlFormView control on an ASPX page running on Microsoft SharePoint Server 2010 with InfoPath Forms Services. The value you provide for the notification parameter is a string that can be used by the code-behind of the host ASPX page to perform a custom action.

For information about hosting an InfoPath form template in an ASPX page, see the article titled "Hosting the InfoPath Form Editing Environment in a Custom Web Form" on the InfoPath Developer Portal on MSDN.

The NotifyHost method can also be used when the InfoPath application is itself hosted as a control in another application, although in that scenario you would typically use the Host property to retrieve a custom object for working with the host application's object model instead.

For information about hosting InfoPath in another application, see the article titled "Hosting the InfoPath Editing Environment in a Custom Windows Form Application" on the InfoPath Developer Portal on MSDN.

This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.

This type or member can be accessed from code running in forms opened in Microsoft InfoPath Filler or in a Web browser.

The following code example shows what the event handler in the code-behind of an ASPX page would need look like in order to receive the string value provided by the NotifyHost method. In this example, the NotifyHost method would be providing "ActionA" as the notification parameter, and the event handler would perform a conditional action when the value is received.

private void XmlFormView1_NotifyHost(Object sender, 
   NotifyHostEventArgs e)
{
   if (e.Notification == "ActionA")
   {
      // Code to perform if 'ActionA' is received.
   }

   else 
   {
      // Code to perform an alternative action.
   }
}
Show:
© 2014 Microsoft