Awesome

<img src="/src/icon.png" height="30px"> TextCopy

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

See Milestones for release notes.

NuGet package

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

Usage

SetTextAsync

<a id='snippet-SetTextAsync'></a>

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

^{<a href='/src/Tests/Snippets.cs#L34-L38' title='Snippet source file'>snippet source</a> | <a href='#snippet-SetTextAsync' title='Start of snippet'>anchor</a>}

SetText

<a id='snippet-SetText'></a>

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

^{<a href='/src/Tests/Snippets.cs#L9-L13' title='Snippet source file'>snippet source</a> | <a href='#snippet-SetText' title='Start of snippet'>anchor</a>}

GetTextAsync

<a id='snippet-GetTextAsync'></a>

var text = await ClipboardService.GetTextAsync();

^{<a href='/src/Tests/Snippets.cs#L43-L47' title='Snippet source file'>snippet source</a> | <a href='#snippet-GetTextAsync' title='Start of snippet'>anchor</a>}

GetText

<a id='snippet-GetText'></a>

var text = ClipboardService.GetText();

^{<a href='/src/Tests/Snippets.cs#L25-L29' title='Snippet source file'>snippet source</a> | <a href='#snippet-GetText' title='Start of snippet'>anchor</a>}

Clearing The Clipboard

<a id='snippet-ClearClipboard'></a>

ClipboardService.SetText("");

^{<a href='/src/Tests/Snippets.cs#L52-L54' title='Snippet source file'>snippet source</a> | <a href='#snippet-ClearClipboard' title='Start of snippet'>anchor</a>}

<a id='snippet-ClearClipboardAsync'></a>

await ClipboardService.SetTextAsync("");

^{<a href='/src/Tests/Snippets.cs#L59-L61' title='Snippet source file'>snippet source</a> | <a href='#snippet-ClearClipboardAsync' title='Start of snippet'>anchor</a>}

Instance API

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

<a id='snippet-SetTextInstance'></a>

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

^{<a href='/src/Tests/Snippets.cs#L15-L20' title='Snippet source file'>snippet source</a> | <a href='#snippet-SetTextInstance' title='Start of snippet'>anchor</a>}

Dependency Injection

An instance of Clipboard can be injected into IServiceCollection:

<a id='snippet-InjectClipboard'></a>

serviceCollection.InjectClipboard();

^{<a href='/src/BlazorSample/Program.cs#L9-L11' title='Snippet source file'>snippet source</a> | <a href='#snippet-InjectClipboard' title='Start of snippet'>anchor</a>}

The instance should be injected by using IClipboard.

There is also a InjectMockClipboard that injects an instance of MockClipboard with all methods stubbed out.

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
• Blazor WebAssembly 6.0 and up

Blazor WebAssembly

Due to the dependency on JSInterop the static ClipboardService is not supported on Blazor.

Instead inject an IClipboard:

<a id='snippet-BlazorStartup'></a>

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

^{<a href='/src/BlazorSample/Program.cs#L6-L13' title='Snippet source file'>snippet source</a> | <a href='#snippet-BlazorStartup' title='Start of snippet'>anchor</a>}

Then consume it:

<a id='snippet-Inject'></a>

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

    public string Content { get; set; }

    public Task CopyTextToClipboard() =>
        Clipboard.SetTextAsync(Content);

    public async Task ReadTextFromClipboard() =>
        Content = await Clipboard.GetTextAsync();
}

^{<a href='/src/BlazorSample/Pages/IndexModel.cs#L9-L24' title='Snippet source file'>snippet source</a> | <a href='#snippet-Inject' title='Start of snippet'>anchor</a>}

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.

Icon

Clone designed by Wes Breazell from The Noun Project.