Share via

XmlForm.NotifyHost Method (Microsoft.Office.InfoPath)

  • Article

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

Namespace: Microsoft.Office.InfoPath
Assembly: Microsoft.Office.InfoPath (in microsoft.office.infopath.dll)

Syntax

'Declaration
Public MustOverride Sub NotifyHost ( _
    notification As String _
)
'Usage
Dim instance As XmlForm
Dim notification As String

instance.NotifyHost(notification)

public abstract void NotifyHost (
    string notification
)

Parameters

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

Exceptions

Exception type Condition

ArgumentNullException

The parameter passed to this method is null.

ArgumentException

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

Remarks

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 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 the article titled "Hosting the InfoPath 2007 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 2007 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 Office InfoPath 2007 or in a Web browser.

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

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

See Also

Reference

XmlForm Class
XmlForm Members
Microsoft.Office.InfoPath Namespace