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
  エラーが関連付けられるノードにある XPathNavigator オブジェクト。

• name
  エラーの名前 (空白は不可)。

• message
  エラーの短いメッセージ。

• messageDetails
  エラーの詳細なメッセージ。

• errorCode
  エラーのエラー コード。

• errorMode
  エラー メッセージを表示するモードを指定する ErrorMode。

戻り値

コレクションに追加された新しい FormError への参照。

例外処理

コメント

新しい FormError の FormErrorType は UserDefined に設定されます。

メモ :
同じ name パラメータ値を持つ複数のエラーを異なる context ノードに追加することは可能です。ただし、同じ名前を持つエラーを同じ context ノードに 2 回追加した場合、2 回目に追加したエラーで最初のエラーが上書きされます。

このメンバは、現在開いているフォームと同じドメイン内で実行されているフォーム、またはドメインを越えたアクセス許可を付与されているフォームだけがアクセスできます。

この型またはメンバは、Microsoft Office InfoPath 2007 または 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)

関連項目

参照

FormErrorCollection クラス
FormErrorCollection のメンバ
Microsoft.Office.InfoPath 名前空間