Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/undergroundwires/asyncclipboardservice
📋 An async & low-level windows clipboard service implementation for .NET, C#
https://github.com/undergroundwires/asyncclipboardservice
async-await clipboard
Last synced: 3 months ago
JSON representation
📋 An async & low-level windows clipboard service implementation for .NET, C#
- Host: GitHub
- URL: https://github.com/undergroundwires/asyncclipboardservice
- Owner: undergroundwires
- License: mit
- Created: 2016-09-26T04:00:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-02-04T13:22:17.000Z (almost 5 years ago)
- Last Synced: 2024-10-12T14:26:41.044Z (3 months ago)
- Topics: async-await, clipboard
- Language: C#
- Homepage:
- Size: 3.18 MB
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AsyncWindowsClipboard
[](https://nuget.org/packages/AsyncClipboardService/)
[](https://www.nuget.org/packages/AsyncClipboardService/)
[](https://github.com/undergroundwires/AsyncWindowsClipboard)
[](https://codeclimate.com/github/undergroundwires/AsyncWindowsClipboard/maintainability)
**AsyncWindowsClipboard** is thread-safe, asynchronous windows clipboard service with retry strategy for .NET
## What it is
- It gives async/await syntax to communicate with Windows clipboard API's.
- It is thread safe.
- It gives lower (binary) level read & write access to strings in clipboard than .NET implementation.
- Implements retry strategies to connect to the clipboard when it's locked.
## How it works
`AsyncClipboardService` ensures that:
- The `Task`s for the communication always run in the same thread which makes the communication thread safe.
- The thread is in Single Thread Apartment (STA) model. WPF & Windows Forms uses COM interop to communicate with clipboard in STA state. Running the thread in same apartment state ensures that the library functions well. Read more at MSDN [1](https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-3.0/ms182351(v=vs.80)?redirectedfrom=MSDN), [2](https://blogs.msdn.microsoft.com/jfoscoding/2005/04/07/why-is-stathread-required/), [3](https://web.archive.org/web/20090417041403/http://msdn.microsoft.com/en-us/magazine/cc188722.aspx).
- Implements retry strategy to ensure clipboard operation ends successfully.
## How to use
### Simple usage
You can use a new instance of `WindowsClipboardService` to retrieve data. It's okay to use the instance from different threads.
```c#
var clipboardService = new WindowsClipboardService();
await clipboardService.SetTextAsync("Hello world"); // Sets the text
var data = await clipboardService.GetTextAsync(); // Reads "Hello world"
```
### Recommended usage
However, it's recommended to use `WindowsClipboardService` with a timeout strategy, as it'll then wait (in a spinning state) for the thread that blocks the windows api instead of failing. You can activate the timeout strategy by setting it in the constructor:
```c#
var clipboardService = new WindowsClipboardService(timeout:TimeSpan.FromMilliseconds(200));
// or via its property
var clipboardService = new ClipboardService { Timeout = TimeSpan.FromMilliseconds(200) };
```
## Contribute
Fork → Modify → Pull request
What's supported so far are :
- Text read + write
- Unicode bytes read + write
- File drop list read + write
Missing (contributions are welcomed):
- Audio read + write
- Image read + write
For reference implementations, take look at [Readers](./src/AsyncWindowsClipboard/Modifiers/Readers) and [Writers](./src/AsyncWindowsClipboard/Modifiers/Writers).
## License
[This project is MIT Licensed.](./LICENSE)