TextBox.Paste イベント

定義

名前空間:

Windows.UI.Xaml.Controls

テキストがコントロールに貼り付けられたときに発生します。

public:
 virtual event TextControlPasteEventHandler ^ Paste;

// Register
event_token Paste(TextControlPasteEventHandler const& handler) const;

// Revoke with event_token
void Paste(event_token const* cookie) const;

// Revoke with event_revoker
TextBox::Paste_revoker Paste(auto_revoke_t, TextControlPasteEventHandler const& handler) const;

public event TextControlPasteEventHandler Paste;

function onPaste(eventArgs) { /* Your code */ }
textBox.addEventListener("paste", onPaste);
textBox.removeEventListener("paste", onPaste);
- or -
textBox.onpaste = onPaste;

Public Custom Event Paste As TextControlPasteEventHandler 

<TextBox Paste="eventhandler"/>

イベントの種類

TextControlPasteEventHandler

例

この例では、住所フィールドに貼り付けるときに、Paste イベントを処理して改行をコンマで置き換える方法を示します。 そうしないと、複数の行からコピーされたアドレスを貼り付けると、データが失われます。

<TextBox Header="Address" Paste="AddressTextBox_Paste"/>

private async void AddressTextBox_Paste(object sender, TextControlPasteEventArgs e)
{
    TextBox addressBox = sender as TextBox;
    if (addressBox != null)
    {
        // Mark the event as handled first. Otherwise, the
        // default paste action will happen, then the custom paste
        // action, and the user will see the text box content change.
        e.Handled = true;

        // Get content from the clipboard.
        var dataPackageView = Windows.ApplicationModel.DataTransfer.Clipboard.GetContent();
        if (dataPackageView.Contains(Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text))
        {
            try
            {
                var text = await dataPackageView.GetTextAsync();

                // Remove line breaks from multi-line text and
                // replace with comma(,).
                string singleLineText = text.Replace("\r\n", ", ");

                // Replace any text currently in the text box.
                addressBox.Text = singleLineText;
            }
            catch (Exception)
            {
                // Ignore or handle exception as needed.
            }
        }
    }
}

この例では、Paste イベントを処理して 、TextBox に貼り付ける文字数を制限する方法を示します。 クリップボードのテキストの長さが TextBox の MaxLength を超える場合は、メッセージがユーザーに表示されます。 ユーザーには、テキストの切り捨てを続行するか、貼り付け操作をキャンセルするオプションがあります。

<TextBox Paste="TextBox_Paste" MaxLength="10"/>

private async void TextBox_Paste(object sender, TextControlPasteEventArgs e)
{
    TextBox tb = sender as TextBox;
    if (tb != null)
    {
        // Mark the event as handled first. Otherwise, the
        // default paste action will happen, then the custom paste
        // action, and the user will see the text box content change.
        e.Handled = true;

        // Get content from the clipboard.
        var dataPackageView = Windows.ApplicationModel.DataTransfer.Clipboard.GetContent();
        if (dataPackageView.Contains(Windows.ApplicationModel.DataTransfer.StandardDataFormats.Text))
        {
            try
            {
                var text = await dataPackageView.GetTextAsync();
                if (text.Length > tb.MaxLength)
                {
                    // Pasted text is too long. Show a message to the user.
                    // Create the message dialog and set its content
                    var messageDialog = 
                        new Windows.UI.Popups.MessageDialog(
                            "Pasted text excedes maximum allowed (" 
                            + tb.MaxLength.ToString() + 
                            " characters). The text will be truncated.");

                    // Add commands to the message dialog.
                    messageDialog.Commands.Add(new UICommand("Continue", (command) =>
                    {
                        // Truncate the text to be pasted to the MaxLength of the text box.
                        string truncatedText = text.Substring(0, tb.MaxLength);
                        tb.Text = truncatedText;
                    }));
                    messageDialog.Commands.Add(new UICommand("Cancel", (command) =>
                    {
                        // Cancelled. Do nothing.
                    }));

                    // Set the command that will be invoked by default.
                    messageDialog.DefaultCommandIndex = 0;

                    // Set the command to be invoked when escape is pressed.
                    messageDialog.CancelCommandIndex = 1;

                    // Show the message dialog.
                    await messageDialog.ShowAsync();
                }
                else
                {
                    tb.Text = text;
                }                          
            }
            catch (Exception)
            {
                // Ignore or handle exception as needed.
            }
        }
    }
}

注釈

Paste イベントは、コンテンツがコントロールに挿入される前に発生します。 このイベントを処理してクリップボードの内容をチェックし、挿入する前にコンテンツに対してアクションを実行できます。 アクションを実行する場合は、イベント引数の Handled プロパティを true に設定 します。それ以外の場合は、既定の貼り付けアクションが実行されます。 イベントを処理済みとしてマークすると、アプリが貼り付け操作を処理したと見なされ、既定のアクションは実行されません。 挿入する挿入ポイントとクリップボードのコンテンツを決定し、コンテンツを挿入する必要があります。

コードでカスタム貼り付けアクションを実行する前に、ハンドラーで Handled プロパティを true に設定する必要があります。 それ以外の場合は、既定の貼り付けアクションが実行され、カスタム アクションが実行されます。 ユーザーは TextBox でコンテンツの変更を確認できます。