GenerallyPositive.GPALClipboard Class Reference

The Windows clipboard. There is one per machine, so this is a standalone object rather than something hanging off a browser or an application.
Instantiated with GPAL.Clipboard. More...

Inheritance diagram for GenerallyPositive.GPALClipboard:

Public Member Functions
IGPALClipboard	ToGPALObject ()
IAllowClipboardSet	WithInput (string text)
	The text to put on the clipboard.
IAllowClipboardSet	WithInput (IGPALGrid< string > grid)
	The grid to put on the clipboard. Rows become lines and cells are separated by tabs, which is the form a spreadsheet reads back as cells.
IAllowClipboardSet	WithInput (GPALFile file)
	The file to put on the clipboard. Its text goes on for every type except FileList, where the file itself goes on, which is what pasting into a folder expects.
IGPALClipboard	SetClipboard (ClipboardType clipboardType=ClipboardType.Text)
	Puts what WithInput named onto the clipboard.
IAllowClipboardInto	GetClipboard (ClipboardType clipboardType=ClipboardType.Text)
	Reads the clipboard. The type says which of the forms on it to take, and a clipboard usually holds several at once: a browser copy is text and html, a spreadsheet copy is text and html and an image.
IGPALClipboard	SaveTo (out string text)
	What is on the clipboard, as text. An image comes back base64 encoded, since that is the only form of it a string can hold.
IGPALClipboard	SaveTo (out IGPALGrid< string > grid)
	What is on the clipboard, split into a grid. Lines become rows and tabs separate the cells, which is how a spreadsheet writes a copied range.
IGPALClipboard	SaveTo (GPALFile file)
	Writes what is on the clipboard to a file.
IGPALClipboard	Clear ()
	Empties the clipboard.

Detailed Description

The Windows clipboard. There is one per machine, so this is a standalone object rather than something hanging off a browser or an application.
Instantiated with GPAL.Clipboard.

GPAL.Clipboard
    .GetClipboard()
    .SaveTo(out string text);
 
GPAL.Clipboard
    .WithInput(rows)
    .SetClipboard();

Definition at line 57 of file GPALClipboard.cs.

Member Function Documentation

Clear()

IGPALClipboard GenerallyPositive.GPALClipboard.Clear

(

)

Empties the clipboard.

Returns

The clipboard

Implements GenerallyPositive.IAllowClipboardInput.

Definition at line 211 of file GPALClipboard.cs.

GetClipboard()

IAllowClipboardInto GenerallyPositive.GPALClipboard.GetClipboard

(

ClipboardType

clipboardType = ClipboardType::Text

)

Reads the clipboard. The type says which of the forms on it to take, and a clipboard usually holds several at once: a browser copy is text and html, a spreadsheet copy is text and html and an image.

Parameters

clipboardType

The form to take. Text when not given.

Returns

Fluent interface to save what was read

Implements GenerallyPositive.IAllowClipboardInput.

Definition at line 137 of file GPALClipboard.cs.

SaveTo() [1/3]

IGPALClipboard GenerallyPositive.GPALClipboard.SaveTo

(

GPALFile

file

)

Writes what is on the clipboard to a file.

Parameters

file	The file to write

Returns

The clipboard

Implements GenerallyPositive.IAllowClipboardInto.

Definition at line 188 of file GPALClipboard.cs.

SaveTo() [2/3]

IGPALClipboard GenerallyPositive.GPALClipboard.SaveTo

(

out IGPALGrid< string >

grid

)

What is on the clipboard, split into a grid. Lines become rows and tabs separate the cells, which is how a spreadsheet writes a copied range.

Parameters

grid	Receives the rows

Returns

The clipboard

Implements GenerallyPositive.IAllowClipboardInto.

Definition at line 168 of file GPALClipboard.cs.

SaveTo() [3/3]

IGPALClipboard GenerallyPositive.GPALClipboard.SaveTo

(

out string

text

)

What is on the clipboard, as text. An image comes back base64 encoded, since that is the only form of it a string can hold.

Parameters

text	Receives the text, null when the clipboard holds nothing of that type

Returns

The clipboard

Implements GenerallyPositive.IAllowClipboardInto.

Definition at line 149 of file GPALClipboard.cs.

SetClipboard()

IGPALClipboard GenerallyPositive.GPALClipboard.SetClipboard

(

ClipboardType

clipboardType = ClipboardType::Text

)

Puts what WithInput named onto the clipboard.

Parameters

clipboardType

The form to put it on as. Text when not given.

Returns

The clipboard

Implements GenerallyPositive.IAllowClipboardSet.

Definition at line 117 of file GPALClipboard.cs.

ToGPALObject()

IGPALClipboard GenerallyPositive.GPALClipboard.ToGPALObject

(

)

Implements GenerallyPositive.IAllowToGPALObject< TResult >.

Definition at line 72 of file GPALClipboard.cs.

WithInput() [1/3]

IAllowClipboardSet GenerallyPositive.GPALClipboard.WithInput

(

GPALFile

file

)

The file to put on the clipboard. Its text goes on for every type except FileList, where the file itself goes on, which is what pasting into a folder expects.

Parameters

file

The file

Returns

Fluent interface to set the clipboard

Implements GenerallyPositive.IAllowClipboardInput.

Definition at line 106 of file GPALClipboard.cs.

WithInput() [2/3]

IAllowClipboardSet GenerallyPositive.GPALClipboard.WithInput

(

IGPALGrid< string >

grid

)

The grid to put on the clipboard. Rows become lines and cells are separated by tabs, which is the form a spreadsheet reads back as cells.

Parameters

grid

The grid

Returns

Fluent interface to set the clipboard

Implements GenerallyPositive.IAllowClipboardInput.

Definition at line 94 of file GPALClipboard.cs.

WithInput() [3/3]

IAllowClipboardSet GenerallyPositive.GPALClipboard.WithInput

(

string

text

)

The text to put on the clipboard.

Parameters

text

The text

Returns

Fluent interface to set the clipboard

Implements GenerallyPositive.IAllowClipboardInput.

Definition at line 82 of file GPALClipboard.cs.

---

The documentation for this class was generated from the following file:

• Common/GPALClipboard.cs