• Article

CopyToClipboardEventArgs Class

Returns information when the OnCopyToClipboard event occurs.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.SqlServer.MessageBox.CopyToClipboardEventArgs

Namespace:  Microsoft.SqlServer.MessageBox
Assembly:  Microsoft.ExceptionMessageBox (in Microsoft.ExceptionMessageBox.dll)

Syntax

'Declaration
Public NotInheritable Class CopyToClipboardEventArgs _
    Inherits EventArgs
'Usage
Dim instance As CopyToClipboardEventArgs

public sealed class CopyToClipboardEventArgs : EventArgs

public ref class CopyToClipboardEventArgs sealed : public EventArgs

[<SealedAttribute>]
type CopyToClipboardEventArgs =  
    class
        inherit EventArgs
    end

public final class CopyToClipboardEventArgs extends EventArgs

The CopyToClipboardEventArgs type exposes the following members.

Constructors

  Name Description
Public method CopyToClipboardEventArgs() Creates a new instance of CopyToClipboardEventArgs with the default properties.
Public method CopyToClipboardEventArgs(String) Creates a new instance of CopyToClipboardEventArgs with the specified copied text.

Top

Properties

  Name Description
Public property ClipboardText Gets the error message information being copied.
Public property EventHandled Gets or sets whether the OnCopyToClipboard event is handled.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Remarks

The OnCopyToClipboard event is used when the message box is displayed in a multi-threaded application from a thread that does not belong to a Microsoft Windows form. In this case, an exception occurs, and the OnCopyToClipboard event enables the action to be marshaled manually to the appropriate thread. In this case, the EventHandled property should be set to true to prevent the exception message box from continuing with the copy operation.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.