Share via


Clipboard.SetText Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Sets Unicode text data to store on the clipboard, for later access with GetText.

Namespace:  System.Windows
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
Public Shared Sub SetText ( _
    text As String _
)
public static void SetText(
    string text
)

Parameters

  • text
    Type: System.String
    A string that contains the Unicode text data to store on the clipboard.

Exceptions

Exception Condition
SecurityException

Invoked this method from outside a user-initiated context.

-or-

Clipboard access user dialog box was not confirmed.

Remarks

Under partial trust (the default mode), Silverlight restricts clipboard access to its two key APIs: GetText and SetText. These APIs can only be invoked from within a context that is determined by the Silverlight runtime to be in response to a user-initiated action. For example, clipboard access is valid from within a handler for a Click or KeyDown event. For examples of situations that are not considered user-initiated, clipboard access is not valid from a handler for Loaded or from a constructor. Clipboard access under partial trust also requires the user to confirm access through completion of a Silverlight access-confirmation dialog box.

If you specifically produce an out-of-browser application and request elevated trust, this security restriction on the API and its dialog box are not used. For more information, see Trusted Applications.

Version Information

Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.