FormEvents.VersionUpgrade イベント
開かれているフォームのバージョン番号が、基になっているフォーム テンプレートのバージョン番号よりも古いと発生します。
名前空間: Microsoft.Office.InfoPath
アセンブリ: Microsoft.Office.InfoPath (Microsoft.Office.InfoPath.dll)
構文
'宣言
Public MustOverride Event VersionUpgrade As VersionUpgradeEventHandler
'使用
Dim instance As FormEvents
Dim handler As VersionUpgradeEventHandler
AddHandler instance.VersionUpgrade, handler
public abstract event VersionUpgradeEventHandler VersionUpgrade
例外
| 例外 | 条件 |
|---|---|
| InvalidOperationException | 開発者は、InternalStartup メソッドとは異なる場所でイベントをバインドしようとしました。 |
解説
重要
VersionUpgrade イベントは、フォーム コードで開発者がインスタンス化するためのものではありません。開発者は、Microsoft InfoPath 2010 デザイン モード ユーザー インターフェイスからフォーム レベル イベントに対するイベント ハンドラーの追加だけを行います。デザイン モード ユーザー インターフェイスからフォーム テンプレートにイベント ハンドラーを追加すると、InfoPath は、EventManager クラスおよび FormEvents クラスのメンバーを使用してフォーム コード ファイルの InternalStartup メソッドにコードを生成し、イベントをイベント ハンドラーにバインドします。InfoPath のデザイン モードでイベント ハンドラーを追加する方法の詳細については、「[方法] イベント ハンドラーを追加する方法」を参照してください。
VersionUpgrade イベントのイベント ハンドラーを使用すると、フォームを最後に開いた後でフォームの基になっているフォーム テンプレートがアップグレードされている場合に、コードを実行してフォームを更新できます。
VersionUpgrade イベントは、VersionUpgradeEventHandler デリゲートを使用してバインドされます。
VersionUpgradeEventArgs クラスの CancelableArgs プロパティを使用して Cancel プロパティを true に設定することで、VersionUpgrade イベントを取り消せます。
この型またはメンバーには、Microsoft InfoPath Filler または Web ブラウザーで開かれたフォームを実行中のコードからアクセスできます。
例
次の例では、VersionUpgradeEventArgs クラスの DocumentVersion プロパティと FormTemplateVersion プロパティを使用して、フォームとフォーム テンプレートのバージョン番号を表示しています。
public void FormEvents_VersionUpgrade(object sender, VersionUpgradeEventArgs e)
{
MessageBox.Show("The form version: " + e.DocumentVersion +
"\nThe form template version: " + e.FormTemplateVersion);
// Write code to update form here.
}
Public Sub FormEvents_VersionUpgrade(ByVal sender As Object, _
ByVal e As VersionUpgradeEventArgs)
MessageBox.Show("The form version: " & e.DocumentVersion & _
vbNewLine & "The form template version: " & _
e.FormTemplateVersion)
' Write code to update form here.
End Sub