Search results

InPlaceEditorComponent

ejs-inplace-editor represents the VueJS InPlaceEditor Component.

<ejs-inplaceeditor></ejs-inplaceeditor>

Properties

actionOnBlur

string

Specifies the action to be perform when user clicks outside the container, that is focus out of editable content. The possible options are,

  • Cancel: Cancel’s the editing and resets the old content.
  • Submit: Submit the edited content to the server.
  • Ignore: No action is perform with this type and allows to have many containers open.

Defaults to ‘Submit’

adaptor

string

Specifies the adaptor type that are used DataManager to communicate with DataSource. The possible values are,

  • UrlAdaptor: Base adaptor for interacting with remote data services.
  • ODataV4Adaptor: Used to interact with ODataV4 service.
  • WebApiAdaptor: Used to interact with Web api created with OData endpoint.

Defaults to ‘UrlAdaptor’

cancelButton

ButtonModel

Used to customize the “Cancel” button UI appearance by defining Button model configuration.

Defaults to { iconCss: ‘e-icons e-cancel-icon’ }

cssClass

string

Defines single/multiple classes (separated by space) to be used for customization of In-place editor.

Defaults to

disabled

boolean

Specifies whether to enable editing mode or not.

Defaults to false

editableOn

string

Specifies the event action of input to enter edit mode instead of using edit icon. The possible values are:

  • Click: Do the single click action on input to enter into the edit mode.
  • DblClick: Do the single double click action on input to enter into the edit mode.
  • EditIconClick: Disables the editing of event action of input and allows user to edit only through edit icon.

Defaults to ‘Click’

emptyText

string

Sets the text to be shown when an element has ‘Empty’ value.

Defaults to ‘Empty’

enableEditMode

boolean

Specifies to show/hide the editing mode.

Defaults to false

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads. If enabled, following list of states will be persisted.

  1. value

Defaults to false

enableRtl

boolean

Specifies the direction of In-place editor. For cultures like Arabic, Hebrew, etc. direction can be switched to right to left.

Defaults to false

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to

mode

string

Specifies the mode to be render while editing. The possible modes are :

  • Inline: Editable content is displayed as inline text and ok/cancel buttons are displayed at right bottom corner of input.
  • Popup: Editable content and ok/cancel buttons are displayed inside popup while editing.

Defaults to ‘Popup’

model

AutoCompleteModel | ColorPickerModel | ComboBoxModel | DatePickerModel | DateRangePickerModel | DateTimePickerModel | DropDownListModel | MaskedTextBoxModel | MultiSelectModel | NumericTextBoxModel | RichTextEditorModel | SliderModel | TextBoxModel | TimePickerModel

Specifies the model object configuration for the integrated components like AutoComplete, DatePicker,NumericTextBox, etc.

Defaults to null

name

string

  • Specifies the name of the field which is used to map data to the server. If name is not given, then component ID is taken as mapping field name.

Defaults to

popupSettings

PopupSettingsModel

Specifies the object to customize popup display settings like positions, animation etc.

Defaults to {}

primaryKey

string | number

Defines the unique primary key of editable field which can be used for saving data in data-base.

Defaults to

saveButton

ButtonModel

Used to customize the “Save” button UI appearance by defining Button model configuration.

Defaults to { iconCss: ‘e-icons e-save-icon’ }

showButtons

boolean

Used to show/hide the ok/cancel buttons of In-place editor.

Defaults to true

submitOnEnter

boolean

Sets to trigger the submit action with enter key pressing of input.

Defaults to true

template

string | HTMLElement

Specifies the HTML element ID as a string that can be added as a editable field.

Defaults to

type

string

Specifies the type of components that integrated with In-place editor to make it as editable.

Defaults to ‘Text’

url

string

Gets the url for server submit action.

Defaults to

validationRules

Object

Maps the validation rules for the input.

Defaults to null

value

string | number | Date | string[] | Date[] | number[]

Specifies the display value for input when original input value is empty.

Defaults to null

Methods

destroy

Removes the control from the DOM and also removes all its related events.

Returns void

save

Submit the edited input value to the server.

Returns void

validate

Validate current editor value.

Returns void

Events

actionBegin

EmitType<ActionBeginEventArgs>

The event will be fired before the data submitted to the server.

actionFailure

EmitType<ActionEventArgs>

The event will be fired when data submission failed.

actionSuccess

EmitType<ActionEventArgs>

The event will be fired when data submitted successfully to the server.

created

EmitType<Event>

The event will be fired once the component rendering is completed.

destroyed

EmitType<Event>

The event will be fired when the component gets destroyed.

validating

EmitType<ValidateEventArgs>

The event will be fired while validating current value.