Skip to content
ConsoleMonster

API Reference

Class

ClipboardService

Edit on GitHub
Namespace ConsoleMonster.Clipboard
Assembly ConsoleMonster
Source ClipboardService.cs:12
Modifiers sealed

Copies serialized output as Unicode clipboard text. Uses the Windows clipboard, macOS pbcopy, or Linux wl-copy/xclip without a runtime package dependency. SSH sessions are refused to protect the remote host's clipboard.

Inheritance

  • Object
  • ClipboardService

Constructors

public ClipboardService() #
ClipboardService.cs:12

Creates a service for the current operating system and desktop session.

Methods

public Boolean TryCopy(String text, out String? error) #
ClipboardService.cs:23
Returns: Boolean

Copies text, Markdown source or HTML source as text, returning a diagnostic instead of throwing for unavailable providers.

Parameters

text System.String requiredposition: 0
The serialized document. It is passed through standard input, never through command arguments.
error System.String? requiredposition: 1
Null on success; an actionable diagnostic on failure (without the copied content).

Returns

True only if the clipboard provider reports success.