TextCopy

• AppVeyor:
• TravisCI:
• 

A cross platform package to copy text to and from the clipboard.

Support is available via a Tidelift Subscription.

Contents

• Usage
  • SetTextAsync
  • SetText
  • GetTextAsync
  • GetText
• Clearing The Clipboard
• Instance API
  • Dependency Injection
• Supported on
• Blazor WebAssembly
• Linux
• Security contact information<!-- endToc -->

NuGet package

https://nuget.org/packages/TextCopy/

Usage

SetTextAsync

cs
await ClipboardService.SetTextAsync("Text to place in clipboard");

SetText

cs
ClipboardService.SetText("Text to place in clipboard");

GetTextAsync

cs
var text = await ClipboardService.GetTextAsync();

GetText

cs
var text = ClipboardService.GetText();

Clearing The Clipboard

cs
ClipboardService.SetText("");

cs
await ClipboardService.SetTextAsync("");

Instance API

In addition to the above static API, there is an instance API exposed:

cs
Clipboard clipboard = new();
clipboard.SetText("Text to place in clipboard");

Dependency Injection

An instance of

Clipboard

IServiceCollection

cs
serviceCollection.InjectClipboard();

The instance should be injected by using

IClipboard

There is also a

InjectMockClipboard

MockClipboard

Supported on

• Windows with .NET Framework 4.6.1 and up
• Windows with .NET Core 2.0 and up
• Windows with Mono 5.0 and up
• OSX with .NET Core 2.0 and up
• OSX with Mono 5.20.1 and up
• Linux with .NET Core 2.0 and up
• Linux with Mono 5.20.1 and up
• Xamarin.Android 9.0 and up
• Xamarin.iOS 10.0 and up
• Universal Windows Platform version 10.0.16299 and up
• Blazor WebAssembly 5.0 and up

Blazor WebAssembly

Due to the dependency on

JSInterop

ClipboardService

Instead inject an

IClipboard

cs
var builder = WebAssemblyHostBuilder.CreateDefault();
var serviceCollection = builder.Services;
serviceCollection.InjectClipboard();
builder.RootComponents.Add("app");

Then consume it:

```cs public partial class IndexModel : ComponentBase { [Inject] public IClipboard Clipboard { get; set; }

public string Content { get; set; }

public Task CopyTextToClipboard()
{
    return Clipboard.SetTextAsync(Content);
}
public async Task ReadTextFromClipboard()
{
    Content = await Clipboard.GetTextAsync();
}

} ``` <sup>snippet source | anchor</sup> <!-- endSnippet -->

Blazor support requires the browser APIs clipboard.readText and clipboard.writeText.

Linux

Linux uses xsel to access the clipboard. As such it needs to be installed and callable.

Security contact information

To report a security vulnerability, use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Icon

Clone designed by Wes Breazell from The Noun Project.