EndEditMode メソッド (ValueEditor)

編集モードを終了します。

シンタックス

Visual Basic

'宣言
 
Public Sub EndEditMode( _
   ByVal acceptChanges As Boolean, _
   ByVal force As Boolean _
) 

C#

public void EndEditMode( 
   bool acceptChanges,
   bool force
)

パラメータ

acceptChanges

True の場合、編集モード中に行われた変更を受け入れます。

force

True の場合、アクションのキャンセルを防止します。

解説

EndEditMode は編集モードを終了し、acceptChanges が True の場合、同時にユーザーの入力を検証します。acceptChanges が False であれば、ユーザー入力は破棄され、Value が元の値に戻されます。

編集モードの終了プロセスの一部として、EditModeEnding および EditModeEnded イベントが発生します。編集モードの終了をキャンセルするには、EditModeEnding イベントをキャンセルできます。

注： 一般的に、このメソッドを直接呼び出す必要はありません。このエディターは、必要に応じて自動的に編集モードに入ったり終了します。たとえば、XamDataGrid のフィールド内に組み込まれているエディターを使用する場合、セルがクリックされるとエディターは自動的に編集モードになり、フォーカスがセルから離れると編集モードを終了します。スタンドアローン コントロールとしてエディターを使用する場合、このエディターはフォーカスを受け取ると自動的に編集モードに入り （たとえば、マウスをクリックしたり、タブに入れられると）、エディターがフォーカスを失うと編集モードを終了します。このデフォルトの動作は、IsAlwaysInEditMode プロパティを使用して制御することができます。

使用例

Visual Basic

Private Sub Button1_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
        ' When edit mode ends, the value will be committed and OriginalValue and
        ' HasValueChanged will be reset.
        Me.textEditor1.EndEditMode(True, False)

        Me.textEditor1.Value = "A"

        ' HasValueChanged and OriginalValue properties are only applicable during
        ' edit mode. These properties are set when the value of the editor is
        ' modified after entering edit mode.
        Me.textEditor1.StartEditMode()

        ' The following will print out 'A' and False respectively.
        Debug.WriteLine("After entering edit mode:")
        Debug.WriteLine("OriginalValue = '" & Me.textEditor1.OriginalValue & "'")
        Debug.WriteLine("HasValueChanged = " & Me.textEditor1.HasValueChanged)

        Me.textEditor1.Value = "B"

        ' The Value was modified to B above. The following will print out 'A' and 
        ' True respectively.
        Debug.WriteLine("After changing value to B:")
        Debug.WriteLine("OriginalValue = '" & Me.textEditor1.OriginalValue & "'")
        Debug.WriteLine("HasValueChanged = " & Me.textEditor1.HasValueChanged)

        ' When edit mode ends, the value will be committed and HasValueChanged will 
        ' be reset.
        Me.textEditor1.EndEditMode(True, False)

        ' The following will print out False.
        Debug.WriteLine("After exiting edit mode:")
        Debug.WriteLine("HasValueChanged = " & Me.textEditor1.HasValueChanged)
    End Sub

C#

public void button1_Click( object sender, RoutedEventArgs e )
{
	// When edit mode ends, the value will be committed and OriginalValue and
	// HasValueChanged will be reset.
	this.textEditor1.EndEditMode( true, false );

	this.textEditor1.Value = "A";

	// HasValueChanged and OriginalValue properties are only applicable during
	// edit mode. These properties are set when the value of the editor is
	// modified after entering edit mode.
	this.textEditor1.StartEditMode( );

	// The following will print out 'A' and False respectively.
	Debug.WriteLine( "After entering edit mode:" );
	Debug.WriteLine( "OriginalValue = '" + this.textEditor1.OriginalValue + "'" );
	Debug.WriteLine( "HasValueChanged = " + this.textEditor1.HasValueChanged );

	this.textEditor1.Value = "B";

	// The Value was modified to B above. The following will print out 'A' and 
	// True respectively.
	Debug.WriteLine( "After changing value to B:" );
	Debug.WriteLine( "OriginalValue = '" + this.textEditor1.OriginalValue + "'" );
	Debug.WriteLine( "HasValueChanged = " + this.textEditor1.HasValueChanged );

	// When edit mode ends, the value will be committed and HasValueChanged will 
	// be reset.
	this.textEditor1.EndEditMode( true, false );

	// The following will print out False.
	Debug.WriteLine( "After exiting edit mode:" );
	Debug.WriteLine( "HasValueChanged = " + this.textEditor1.HasValueChanged );
}