# CKBoxCommand

class

The CKBox command. It is used by the [CKBox editing feature](module_ckbox_ckboxediting-CKBoxEditing.md) to open the CKBox file manager. The file manager allows inserting an image or a link to a file into the editor content.

```typescript
editor.execute( 'ckbox' );
```

**Note:** This command uses other features to perform the following tasks:

* To insert images it uses the ['insertImage'](module_image_image_insertimagecommand-InsertImageCommand.md) command from the [Image feature](module_image_image-Image.md).
* To insert links to other files it uses the ['link'](module_link_linkcommand-LinkCommand.md) command from the [Link feature](module_link_link-Link.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L45)

<a id="properties">

## Properties

<a id="member-affectsData">

### `affectsData: boolean` _(inherited)_

A flag indicating whether a command execution changes the editor data or not.

Commands with `affectsData` set to `false` will not be automatically disabled in the [read-only mode](module_core_editor_editor-Editor.md#member-isReadOnly) and [other editor modes](../features/read-only.md#related-features) with restricted user write permissions.

**Note:** You do not have to set it for your every command. It is `true` by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L170)

#### Parameters

* `affectsData: boolean`

<a id="member-editor">

### `editor: Editor` _(readonly)_

The editor on which this command will be used.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L40)

<a id="member-isEnabled">

### `isEnabled: boolean` _(readonly)_

Flag indicating whether a command is enabled or disabled. A disabled command will do nothing when executed.

A given command class should control this value by overriding the [`refresh()`](#function-refresh) method.

It is possible to disable a command "from outside" using [`forceDisabled`](#function-forceDisabled) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L68)

<a id="member-value">

### `value: boolean` _(readonly)_

The value of the command. A given command class should define what it represents for it.

For example, the `'bold'` command's value indicates whether the selection starts in a bolded text. And the value of the `'link'` command may be an object with link details.

It is possible for a command to have no value (e.g. for stateless actions such as `'uploadImage'`).

A given command class should control this value by overriding the [`refresh()`](#function-refresh) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L46)

<a id="member-_chosenAssets">

### `_chosenAssets: Set<CKBoxAssetDefinition>` _(internal)_

A set of all chosen assets. They are stored temporarily and they are automatically removed 1 second after being chosen. Chosen assets have to be "remembered" for a while to be able to map the given asset with the element inserted into the model. This association map is then used to set the ID on the model element.

All chosen assets are automatically removed after the timeout, because (theoretically) it may happen that they will never be inserted into the model, even if the [`'link'`](module_link_linkcommand-LinkCommand.md) command or the [`'insertImage'`](module_image_image_insertimagecommand-InsertImageCommand.md) command is enabled. Such a case may arise when another plugin blocks the command execution. Then, in order not to keep the chosen (but not inserted) assets forever, we delete them automatically to prevent memory leakage. The 1 second timeout is enough to insert the asset into the model and extract the ID from the chosen asset.

The assets are stored only if the [`config.ckbox.ignoreDataId`](module_ckbox_ckboxconfig-CKBoxConfig.md#member-ignoreDataId) option is set to `false` (by default).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L65)

<a id="member-_isEnabledBasedOnSelection">

### `_isEnabledBasedOnSelection: boolean` _(protected)_

A flag indicating whether a command's `isEnabled` state should be changed depending on where the document selection is placed.

By default, it is set to `true`. If the document selection is placed in a [non-editable](module_engine_model_model-Model.md#function-canEditAt) place (such as non-editable root), the command becomes disabled.

The flag should be changed to `false` in a concrete command's constructor if the command should not change its `isEnabled` accordingly to the document selection.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L80)

<a id="member-_wrapper">

### `_wrapper: Element | null` _(private)_

The DOM element that acts as a mounting point for the CKBox dialog.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L70)

#### Static properties

<a id="static-member-_throwErrorWhenUsedAsAPlugin">

### `_throwErrorWhenUsedAsAPlugin: true` _(internal)_

`Command` class is commonly put in `config.plugins` array.

This property helps with better error detection.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L101)

<a id="methods">

## Methods

<a id="function-constructor">

### `constructor( editor )`

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L75)

#### Parameters

* `editor: Editor`

<a id="function-bind:DUAL_BIND">

### `bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, CKBoxCommand[ K1 ], K2, CKBoxCommand[ K2 ]>` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L996)

#### Type parameters

* * `K1`
  * `K2`

#### Parameters

* `bindProperty1: K1`

  Observable property that will be bound to other observable(s).

* `bindProperty2: K2`

  Observable property that will be bound to other observable(s).

#### Returns

* `ObservableDualBindChain<K1, CKBoxCommand[ K1 ], K2, CKBoxCommand[ K2 ]>`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-bind:MANY_BIND">

### `bind( bindProperties ) → ObservableMultiBindChain` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1074)

#### Parameters

* `bindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'refresh' | 'value' | 'affectsData' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'execute' | '_chosenAssets'>`

  Observable properties that will be bound to other observable(s).

#### Returns

* `ObservableMultiBindChain`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-bind:SINGLE_BIND">

### `bind( bindProperty ) → ObservableSingleBindChain<K, CKBoxCommand[ K ]>` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) guide covering the topic of property bindings with some additional examples.

Consider two objects: a `button` and an associated `command` (both `Observable`).

A simple property binding could be as follows:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
button.bind( 'isEnabled' ).to( command );
```

which works in the following way:

* `button.isEnabled` **instantly equals** `command.isEnabled`,
* whenever `command.isEnabled` changes, `button.isEnabled` will immediately reflect its value.

**Note**: To release the binding, use [`unbind`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```

The binding can include more than one observable, combining multiple data sources in a custom callback:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```

Using a custom callback allows processing the value before passing it to the target property:

```typescript
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```

It is also possible to bind to the same property in an array of observables. To bind a `button` to multiple commands (also `Observables`) so that each and every one of them must be enabled for the button to become enabled, use the following code:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L918)

#### Type parameters

* `K`

#### Parameters

* `bindProperty: K`

  Observable property that will be bound to other observable(s).

#### Returns

* `ObservableSingleBindChain<K, CKBoxCommand[ K ]>`

  The bind chain with the `to()` and `toMany()` methods.

<a id="function-clearForceDisabled">

### `clearForceDisabled( id ) → void` _(inherited)_

Clears forced disable previously set through [`forceDisabled`](#function-forceDisabled). See [`forceDisabled`](#function-forceDisabled).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L245)

#### Parameters

* `id: string`

  Unique identifier, equal to the one passed in [`forceDisabled`](#function-forceDisabled) call.

#### Returns

* `void`

<a id="function-decorate">

### `decorate( methodName ) → void` _(inherited)_

Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

Read more in the [dedicated](../framework/deep-dive/observables.md#decorating-object-methods) guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be [stopped](module_utils_eventinfo-EventInfo.md#member-stop):

```typescript
class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```

**Note**: The high [priority](module_utils_priorities-PriorityString.md) listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:

```typescript
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```

Finally, it is possible to access and modify the arguments the method is called with:

```typescript
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1159)

#### Parameters

* `methodName: 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'refresh' | 'value' | 'affectsData' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'execute' | '_chosenAssets'`

  Name of the method to decorate.

#### Returns

* `void`

<a id="function-delegate">

### `delegate( events ) → EmitterMixinDelegateChain` _(inherited)_

Delegates selected events to another [`Emitter`](module_utils_emittermixin-Emitter.md). For instance:

```typescript
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```

then `eventX` is delegated (fired by) `emitterB` and `emitterC` along with `data`:

```typescript
emitterA.fire( 'eventX', data );
```

and `eventY` is delegated (fired by) `emitterC` along with `data`:

```typescript
emitterA.fire( 'eventY', data );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L539)

#### Parameters

* `events: Array<string>`

  Event names that will be delegated to another emitter.

#### Returns

* `EmitterMixinDelegateChain`

<a id="function-destroy">

### `destroy() → void` _(inherited)_

Destroys the command.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L275)

#### Returns

* `void`

<a id="function-execute">

### `execute() → void`

Executes the command.

A command may accept parameters. They will be passed from [`editor.execute()`](module_core_editor_editor-Editor.md#function-execute) to the command.

The `execute()` method will automatically abort when the command is disabled ([`isEnabled`](#member-isEnabled) is `false`). This behavior is implemented by a high priority listener to the [event-execute](#event-execute) event.

In order to see how to disable a command from "outside" see the [`isEnabled`](#member-isEnabled) documentation.

This method may return a value, which would be forwarded all the way down to the [`editor.execute()`](module_core_editor_editor-Editor.md#function-execute).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L92)

#### Returns

* `void`

#### Fires

* [execute](#event-execute)

<a id="function-fire">

### `fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]` _(inherited)_

Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an [`EventInfo`](module_utils_eventinfo-EventInfo.md) object, followed by the optional `args` provided in the `fire()` method call.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L512)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `eventOrInfo: GetNameOrEventInfo<TEvent>`

  The name of the event or `EventInfo` object if event is delegated.

* `args: TEvent[ 'args' ]`

  Additional arguments to be passed to the callbacks.

#### Returns

* `GetEventInfo<TEvent>[ 'return' ]`

  By default the method returns `undefined`. However, the return value can be changed by listeners through modification of the [`evt.return`](module_utils_eventinfo-EventInfo.md#member-return)'s property (the event info is the first param of every callback).

<a id="function-forceDisabled">

### `forceDisabled( id ) → void` _(inherited)_

Disables the command.

Command may be disabled by multiple features or algorithms (at once). When disabling a command, unique id should be passed (e.g. the feature name). The same identifier should be used when [enabling back](#function-clearForceDisabled) the command. The command becomes enabled only after all features [enabled it back](#function-clearForceDisabled).

Disabling and enabling a command:

```typescript
command.isEnabled; // -> true
command.forceDisabled( 'MyFeature' );
command.isEnabled; // -> false
command.clearForceDisabled( 'MyFeature' );
command.isEnabled; // -> true
```

Command disabled by multiple features:

```typescript
command.forceDisabled( 'MyFeature' );
command.forceDisabled( 'OtherFeature' );
command.clearForceDisabled( 'MyFeature' );
command.isEnabled; // -> false
command.clearForceDisabled( 'OtherFeature' );
command.isEnabled; // -> true
```

Multiple disabling with the same identifier is redundant:

```typescript
command.forceDisabled( 'MyFeature' );
command.forceDisabled( 'MyFeature' );
command.clearForceDisabled( 'MyFeature' );
command.isEnabled; // -> true
```

**Note:** some commands or algorithms may have more complex logic when it comes to enabling or disabling certain commands, so the command might be still disabled after [`clearForceDisabled`](#function-clearForceDisabled) was used.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L231)

#### Parameters

* `id: string`

  Unique identifier for disabling. Use the same id when [enabling back](#function-clearForceDisabled) the command.

#### Returns

* `void`

<a id="function-listenTo:BASE_EMITTER">

### `listenTo( emitter, event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using `:`. When namespaced event is fired, it additionally fires all callbacks for that namespace.

```typescript
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```

An event callback can [stop the event](module_utils_eventinfo-EventInfo.md#member-stop) and set the [return value](module_utils_eventinfo-EventInfo.md#member-return) of the [`fire`](#function-fire) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L475)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `emitter: Emitter`

  The object that fires the event.

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-off">

### `off( event, callback ) → void` _(inherited)_

Stops executing the callback on the given event. Shorthand for [`this.stopListening( this, event, callback )`](#function-stopListening:BASE_STOP).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L444)

#### Parameters

* `event: string`

  The name of the event.

* `callback: Function`

  The function to stop being called.

#### Returns

* `void`

<a id="function-on">

### `on( event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed when an event is fired.

Shorthand for [`this.listenTo( this, event, callback, options )`](#function-listenTo:BASE_EMITTER) (it makes the emitter listen on itself).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L416)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-once">

### `once( event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling [`on`](#function-on) followed by [`off`](#function-off) in the callback.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L431)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### Parameters

* `event: TEvent[ 'name' ]`

  The name of the event.

* `callback: GetCallback<TEvent>`

  The function to be called on event.

* `options?: GetCallbackOptions<TEvent>`

  Additional options.

#### Returns

* `void`

<a id="function-refresh">

### `refresh() → void`

Refreshes the command. The command should update its [`isEnabled`](#member-isEnabled) and [`value`](#member-value) properties in this method.

This method is automatically called when [any changes are applied to the document](module_engine_model_document-ModelDocument.md#event-change).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L84)

#### Returns

* `void`

<a id="function-set:OBJECT">

### `set( values ) → void` _(inherited)_

Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

It accepts a single object literal containing key/value pairs with properties to be set.

This method throws the `observable-set-cannot-override` error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.

In TypeScript, those properties should be declared in class using `declare` keyword. In example:

```typescript
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L843)

#### Parameters

* `values: object & object`

  An object with `name=>value` pairs.

#### Returns

* `void`

<a id="function-set:KEY_VALUE">

### `set( name, value ) → void` _(inherited)_

Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

This method throws the `observable-set-cannot-override` error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.

In TypeScript, those properties should be declared in class using `declare` keyword. In example:

```typescript
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L815)

#### Type parameters

* `K`

#### Parameters

* `name: K`

  The property's name.

* `value: CKBoxCommand[ K ]`

  The property's value.

#### Returns

* `void`

<a id="function-stopDelegating">

### `stopDelegating( event?, emitter? ) → void` _(inherited)_

Stops delegating events. It can be used at different levels:

* To stop delegating all events.
* To stop delegating a specific event to all emitters.
* To stop delegating a specific event to a specific emitter.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L552)

#### Parameters

* `event?: string`

  The name of the event to stop delegating. If omitted, stops it all delegations.

* `emitter?: Emitter`

  (requires `event`) The object to stop delegating a particular event to. If omitted, stops delegation of `event` to all emitters.

#### Returns

* `void`

<a id="function-stopListening:BASE_STOP">

### `stopListening( emitter?, event?, callback? ) → void` _(inherited)_

Stops listening for events. It can be used at different levels:

* To stop listening to a specific callback.
* To stop listening to a specific event.
* To stop listening to all events fired by a specific object.
* To stop listening to all events fired by all objects.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L497)

#### Parameters

* `emitter?: Emitter`

  The object to stop listening to. If omitted, stops it for all objects.

* `event?: string`

  (Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it for all events from `emitter`.

* `callback?: Function`

  (Requires the `event`) The function to be removed from the call list for the given `event`.

#### Returns

* `void`

<a id="function-unbind">

### `unbind( unbindProperties ) → void` _(inherited)_

Removes the binding created with [`bind`](#function-bind:SINGLE_BIND).

```typescript
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1090)

#### Parameters

* `unbindProperties: Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'refresh' | 'value' | 'affectsData' | 'editor' | 'isEnabled' | 'forceDisabled' | 'clearForceDisabled' | 'execute' | '_chosenAssets'>`

  Observable properties to be unbound. All the bindings will be released if no properties are provided.

#### Returns

* `void`

<a id="function-_getValue">

### `_getValue() → boolean` _(protected)_

Indicates if the CKBox dialog is already opened.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L102)

#### Returns

* `boolean`

<a id="function-_checkEnabled">

### `_checkEnabled() → boolean` _(private)_

Checks whether the command can be enabled in the current context.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L109)

#### Returns

* `boolean`

<a id="function-_initListeners">

### `_initListeners() → void` _(private)_

Initializes various event listeners for the `ckbox:*` events, because all functionality of the `ckbox` command is event-based.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L187)

#### Returns

* `void`

<a id="function-_insertAsset">

### `_insertAsset( asset, isLastAsset, writer, isSingleAsset ) → void` _(private)_

Inserts the asset into the model.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L284)

#### Parameters

* `asset: CKBoxAssetDefinition`

  The asset to be inserted.

* `isLastAsset: boolean`

  Indicates if the current asset is the last one from the chosen set.

* `writer: ModelWriter`

  An instance of the model writer.

* `isSingleAsset: boolean`

  It's true when only one asset is processed.

#### Returns

* `void`

<a id="function-_insertImage">

### `_insertImage( asset ) → void` _(private)_

Inserts the image by calling the `insertImage` command.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L315)

#### Parameters

* `asset: CKBoxAssetImageDefinition`

  The asset to be inserted.

#### Returns

* `void`

<a id="function-_insertLink">

### `_insertLink( asset, writer, isSingleAsset ) → void` _(private)_

Inserts the link to the asset by calling the `link` command.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L345)

#### Parameters

* `asset: CKBoxAssetLinkDefinition`

  The asset to be inserted.

* `writer: ModelWriter`

  An instance of the model writer.

* `isSingleAsset: boolean`

  It's true when only one asset is processed.

#### Returns

* `void`

<a id="function-_prepareOptions">

### `_prepareOptions() → object` _(private)_

Creates the options object for the CKBox dialog.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L144)

#### Returns

* `object`

  The object with properties:

  * theme The theme for CKBox dialog.
  * language The language for CKBox dialog.
  * tokenUrl The token endpoint URL.
  * serviceOrigin The base URL of the API service.
  * forceDemoLabel Whether to force "Powered by CKBox" link.
  * assets.onChoose The callback function invoked after choosing the assets.
  * dialog.onClose The callback function invoked after closing the CKBox dialog.
  * dialog.width The dialog width in pixels.
  * dialog.height The dialog height in pixels.
  * categories.icons Allows setting custom icons for categories.
  * view\.openLastView Sets if the last view visited by the user will be reopened on the next startup.
  * view\.startupFolderId Sets the ID of the folder that will be opened on startup.
  * view\.startupCategoryId Sets the ID of the category that will be opened on startup.
  * view\.hideMaximizeButton Sets whether to hide the ‘Maximize’ button.
  * view\.componentsHideTimeout Sets timeout after which upload components are hidden after completed upload.
  * view\.dialogMinimizeTimeout Sets timeout after which upload dialog is minimized after completed upload.

<a id="events">

## Events

<a id="event-change:isEnabled">

### `change:isEnabled( eventInfo, name, value, oldValue )` _(inherited)_

Fired when the `isEnabled` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L68)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isEnabled`).

* `value: boolean`

  New value of the `isEnabled` property with given key or `null`, if operation should remove property.

* `oldValue: boolean`

  Old value of the `isEnabled` property with given key or `null`, if property was not set before.

<a id="event-change:value">

### `change:value( eventInfo, name, value, oldValue )`

Fired when the `value` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L46)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`value`).

* `value: boolean`

  New value of the `value` property with given key or `null`, if operation should remove property.

* `oldValue: boolean`

  Old value of the `value` property with given key or `null`, if property was not set before.

<a id="event-change:%7Bproperty%7D">

### `change:{property}( eventInfo, name, value, oldValue )` _(inherited)_

Fired when a property changed value.

```typescript
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1190)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  The property name.

* `value: TValue`

  The new property value.

* `oldValue: TValue`

  The previous property value.

<a id="event-execute">

### `execute( eventInfo, <anonymous> )` _(inherited)_

Event fired by the [`execute`](module_core_command-Command.md#function-execute) method. The command action is a listener to this event so it's possible to change/cancel the behavior of the command by listening to this event.

See [`decorate`](module_utils_observablemixin-Observable.md#function-decorate) for more information and samples.

**Note:** This event is fired even if command is disabled. However, it is automatically blocked by a high priority listener in order to prevent command execution.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L299)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: Parameters<TObservable[ TName ]>`

<a id="event-set:isEnabled">

### `set:isEnabled( eventInfo, name, value, oldValue )` _(inherited)_

Fired when the `isEnabled` property is going to be set but is not set yet (before the `change` event is fired).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/command.ts#L68)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isEnabled`).

* `value: boolean`

  New value of the `isEnabled` property with given key or `null`, if operation should remove property.

* `oldValue: boolean`

  Old value of the `isEnabled` property with given key or `null`, if property was not set before.

<a id="event-set:value">

### `set:value( eventInfo, name, value, oldValue )`

Fired when the `value` property is going to be set but is not set yet (before the `change` event is fired).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckbox/src/ckboxcommand.ts#L46)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`value`).

* `value: boolean`

  New value of the `value` property with given key or `null`, if operation should remove property.

* `oldValue: boolean`

  Old value of the `value` property with given key or `null`, if property was not set before.

<a id="event-set:%7Bproperty%7D">

### `set:{property}( eventInfo, name, value, oldValue )` _(inherited)_

Fired when a property value is going to be set but is not set yet (before the `change` event is fired).

You can control the final value of the property by using the [event's `return` property](module_utils_eventinfo-EventInfo.md#member-return).

```typescript
observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
					 // -> 'Current property value is 1'
					 // -> 'Value has changed from 1 to 3'
```

**Note:** The event is fired even when the new value is the same as the old value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1228)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  The property name.

* `value: TValue`

  The new property value.

* `oldValue: TValue`

  The previous property value.

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)