FormErrorCollection.Add メソッド (XPathNavigator, String, String, String, Int32, ErrorMode)
現在のフォームに関連付けられた FormErrorCollection オブジェクトに新しい FormError を作成および追加します。
名前空間: Microsoft.Office.InfoPath
アセンブリ: Microsoft.Office.InfoPath (Microsoft.Office.InfoPath.dll)
構文
'宣言
Public MustOverride Function Add ( _
context As XPathNavigator, _
name As String, _
message As String, _
messageDetails As String, _
errorCode As Integer, _
errorMode As ErrorMode _
) As FormError
'使用
Dim instance As FormErrorCollection
Dim context As XPathNavigator
Dim name As String
Dim message As String
Dim messageDetails As String
Dim errorCode As Integer
Dim errorMode As ErrorMode
Dim returnValue As FormError
returnValue = instance.Add(context, name, _
message, messageDetails, errorCode, _
errorMode)
public abstract FormError Add(
XPathNavigator context,
string name,
string message,
string messageDetails,
int errorCode,
ErrorMode errorMode
)
パラメーター
- context
型: System.Xml.XPath.XPathNavigator
エラーが関連付けられるノードにある XPathNavigator オブジェクト。
- name
型: System.String
エラーの名前 (空白は不可)。
- message
型: System.String
エラーの短いメッセージ。
- messageDetails
型: System.String
エラーの詳細なメッセージ。
- errorCode
型: System.Int32
エラーのエラー コード。
- errorMode
型: Microsoft.Office.InfoPath.ErrorMode
エラー メッセージを表示するモードを指定する ErrorMode。
戻り値
型: Microsoft.Office.InfoPath.FormError
コレクションに追加された新しい FormError への参照。
例外
| 例外 | 条件 |
|---|---|
| ArgumentException | name が null 参照 (Visual Basic ではNothing ) または空文字列です。 |
| ArgumentException | 同じ名前のエラーがコレクション内に既に存在します。 |
| ArgumentNullException | このメソッドに渡されたパラメーターは null 参照 (Visual Basic ではNothing ) です。 |
| ArgumentException | このメソッドに渡されたパラメーターは有効ではありません。たとえば、型または形式が正しくありません。 |
解説
新しい FormError の FormErrorType は UserDefined に設定されます。
注意
同じ name パラメーター値を持つ複数のエラーを異なる context ノードに追加することはできますが、同じ名前を持つエラーを同じ context ノードに 2 回追加した場合、2 回目に追加したエラーで最初のエラーが上書きされます。
このメンバーには、現在開いているフォームと同じドメインで実行中のフォーム、またはクロスドメインのアクセス許可が与えられたフォームのみがアクセスできます。
この型またはメンバーには、Microsoft InfoPath Filler または Web ブラウザーで開かれたフォームを実行中のコードからアクセスできます。
例
次の例では、まず、エラーを関連付けるフィールドに XPathNavigator オブジェクトを配置します。次に、XPathNavigator、名前、メッセージ、詳細メッセージ、エラー コード、エラー番号、およびエラー表示モードを FormErrorCollection クラスの Add メソッドに渡し、フォームのエラー コレクションにエラーを追加します。
XPathNavigator root, txtbox;
// Create XPathNavigator for main data source.
root = this.MainDataSource.CreateNavigator();
// Create XPathNavigator positioned at field to associate with error.
txtbox = root.SelectSingleNode("//my:field1", this.NamespaceManager);
// Get form's collection of errors and add error.
this.Errors.Add(txtbox, "Field1Error", "Short error message.",
"Detailed error description.", 102057, ErrorMode.Modeless);
Dim root, txtbox As XPathNavigator
' Create XPathNavigator for main data source.
root = Me.MainDataSource.CreateNavigator()
' Create XPathNavigator positioned at field to add error.
txtbox = root.SelectSingleNode("//my:field1", Me.NamespaceManager)
' Get form's collection of errors and add error.
Me.Errors.Add(txtbox, "Field1Error", "Short error message.",
"Detailed error description.", 102057, ErrorMode.Modeless)