Provides a custom value to the hosting application or ASPX page.
Assembly: Microsoft.Office.Interop.InfoPath (in Microsoft.Office.Interop.InfoPath.dll)
'Declaration Sub NotifyHost ( _ bstrNotification As String _ ) 'Usage Dim instance As _XDocument3 Dim bstrNotification As String instance.NotifyHost(bstrNotification)
- Type: System.String
A custom value that will be used by the code in the hosting application or ASPX page.
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 from 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 as a control in another application, see the article titled "Hosting the InfoPath Form Editing Environment in a Custom Web Form" on the InfoPath Developer Portal on MSDN.
The following 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 bstrNotification parameter, and the event handler would perform a conditional action when the value is received.