XDocument.NotifyHost Method

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

Version Information
 Version Added:  InfoPath 2007

Syntax

expression.NotifyHost(bstrNotification)

expression   An expression that returns an XDocument object.

Parameters

Return Value
nothing

Remarks

The NotifyHost method is intended for use in scenarios where an InfoPath form template is hosted in an XmlFormView control on an ASPX page running on Microsoft Office Forms Server 2007 or from Microsoft Office SharePoint Server 2007 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 Hosting the InfoPath 2007 Form Editing Environment in a Custom Web Form.

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 of the XDocument object to retrieve a custom object for working with the host application's object model instead. For information about hosting an InfoPath form template in a custom Windows application, see Hosting the InfoPath 2007 Form Editing Environment in a Custom Windows Form Application

Example

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.

  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.
}
}

  Private Sub XmlFormView1_NotifyHost(sender As Object, _
   e As NotifyHostEventArgs)
   If (e.Notification = "ActionA") Then
      ' Code to perform if 'ActionA' is received.
   Else 
      ' Code to perform an alternative action.
   End If
End Sub

Remarks

Security Level 3: Can be accessed only by fully trusted forms.