Document.Selection object

 

 

 Prototype for Document.Selection objects.

Syntax

 You cannot create a Document.Selection object directly. You create derived objects such as TextDocument.Selection, FolderDocument.Selection...

Parameters

none.

Property Of

none.

Implemented In

ECMerge 2.1

Description

Document.Selection objects define a subset of a Document which is appropriate for particular actions. Selections can be defined arbitrarily, several can co-exist at a time, though only one can be active at a time in a View object. 

Properties

none. 

Methods

empty
is_empty

Examples

Example 1.

Tells whether current selection is empty or not:

alert ("Current selection is " + (current_frame.coordinator.current_view.clone_selection().is_empty() ? "" : "not") + " empty");

See Also 

 TextDocument.Selection object, FolderDocument.Selection object

Method empty

Syntax

 function empty ( )

Parameters

none.

Method Of

Document.Selection

Implemented In

ECMerge 2.1

Description

Empties the selection, deselecting any previously selected item inside it.

Method is_empty

Syntax

function is_empty ( )
returns a Boolean

Parameters

none.

Method Of

none.

Implemented In

ECMerge 2.1

Description

Returns true if the selection is currently empty, i.e., if it contains no element.