XmlForm.NotifyHost メソッド
ホストしているアプリケーションまたは ASPX ページにカスタム値を提供します。
名前空間: Microsoft.Office.InfoPath
アセンブリ: Microsoft.Office.InfoPath (Microsoft.Office.InfoPath.dll)
構文
'宣言
Public MustOverride Sub NotifyHost ( _
notification As String _
)
'使用
Dim instance As XmlForm
Dim notification As String
instance.NotifyHost(notification)
public abstract void NotifyHost(
string notification
)
パラメーター
- notification
型: System.String
ホストしているアプリケーションまたは ASPX ページのコードによって使用されるカスタム値です。
例外
| 例外 | 条件 |
|---|---|
| ArgumentNullException | このメソッドに渡されたパラメーターは null 参照 (Visual Basic ではNothing ) です。 |
| ArgumentException | このメソッドに渡されたパラメーターは無効です。たとえば、型または形式が正しくありません。 |
解説
NotifyHost メソッドは、InfoPath フォーム テンプレートが、Microsoft SharePoint Server 2010 で InfoPath Forms Services を使用して実行されている ASPX ページで、Microsoft.Office.InfoPath.Server.Controls.XmlFormView コントロールにホストされているシナリオ用です。notification パラメーターに指定する値は、カスタム アクションを実行するためにホスト ASPX ページの分離コードで使用可能な文字列です。
ASPX ページでの InfoPath フォーム テンプレートのホストについては、MSDN の「InfoPath デベロッパー ポータル」にある「カスタム Windows フォーム アプリケーションで InfoPath フォーム編集環境をホストする」という記事を参照してください。
NotifyHost メソッドは、InfoPath アプリケーション自体が別のアプリケーションでコントロールとしてホストされている場合にも使用できます。ただし、そのシナリオでは、通常、Host プロパティを使用して、代わりにホスト アプリケーションのオブジェクト モデルを使用して作業するためのカスタム オブジェクトを取得します。
別のアプリケーションでの InfoPath のホストについては、MSDN の「InfoPath デベロッパー ポータル」にある「カスタム Windows フォーム アプリケーションで InfoPath フォーム編集環境をホストする」という記事を参照してください。
このメンバーには、現在開いているフォームと同じドメインで実行中のフォーム、またはクロスドメインのアクセス許可が与えられたフォームのみがアクセスできます。
この型またはメンバーには、Microsoft InfoPath Filler または Web ブラウザーで開かれたフォームを実行中のコードからアクセスできます。
例
次のコードの例では、NotifyHost メソッドによって提供される文字列値を受け取るために、ASPX ページの分離コードに含まれるイベント ハンドラーをどのように指定する必要があるかを示しています。この例では、NotifyHost メソッドは "ActionA" を notification パラメーターとして提供し、値を受け取ったときにイベント ハンドラーが条件付きアクションを実行します。
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