Class InPlaceEditorBuilder

Inheritance

System.Object

ControlBuilder

InPlaceEditorBuilder

Inherited Members

ControlBuilder.Context

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.EJ2.InPlaceEditor

Assembly: Syncfusion.EJ2.dll

Syntax

public class InPlaceEditorBuilder : ControlBuilder

Constructors

InPlaceEditorBuilder()

Declaration

public InPlaceEditorBuilder()

InPlaceEditorBuilder(InPlaceEditor)

Declaration

public InPlaceEditorBuilder(InPlaceEditor model)

Parameters

Type	Name	Description
InPlaceEditor	model

Fields

model

Declaration

public InPlaceEditor model

Field Value

Type	Description
InPlaceEditor

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

ActionBegin(String)

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

Declaration

public InPlaceEditorBuilder ActionBegin(string actionBegin)

Parameters

Type	Name	Description
System.String	actionBegin

Returns

Type	Description
InPlaceEditorBuilder

ActionFailure(String)

The event will be fired when data submission failed.

Declaration

public InPlaceEditorBuilder ActionFailure(string actionFailure)

Parameters

Type	Name	Description
System.String	actionFailure

Returns

Type	Description
InPlaceEditorBuilder

ActionOnBlur(ActionBlur)

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

Declaration

public InPlaceEditorBuilder ActionOnBlur(ActionBlur actionOnBlur)

Parameters

Type	Name	Description
ActionBlur	actionOnBlur

Returns

Type	Description
InPlaceEditorBuilder

ActionSuccess(String)

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

Declaration

public InPlaceEditorBuilder ActionSuccess(string actionSuccess)

Parameters

Type	Name	Description
System.String	actionSuccess

Returns

Type	Description
InPlaceEditorBuilder

Adaptor(AdaptorType)

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

Declaration

public InPlaceEditorBuilder Adaptor(AdaptorType adaptor)

Parameters

Type	Name	Description
AdaptorType	adaptor

Returns

Type	Description
InPlaceEditorBuilder

BeforeSanitizeHtml(String)

Event triggers before sanitize the value.

Declaration

public InPlaceEditorBuilder BeforeSanitizeHtml(string beforeSanitizeHtml)

Parameters

Type	Name	Description
System.String	beforeSanitizeHtml

Returns

Type	Description
InPlaceEditorBuilder

BeginEdit(String)

The event will be fired before changing the mode from default to edit mode.

Declaration

public InPlaceEditorBuilder BeginEdit(string beginEdit)

Parameters

Type	Name	Description
System.String	beginEdit

Returns

Type	Description
InPlaceEditorBuilder

CancelButton(Object)

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

Declaration

public InPlaceEditorBuilder CancelButton(object cancelButton)

Parameters

Type	Name	Description
System.Object	cancelButton

Returns

Type	Description
InPlaceEditorBuilder

CancelClick(String)

Event triggers when click the cancel button.

Declaration

public InPlaceEditorBuilder CancelClick(string cancelClick)

Parameters

Type	Name	Description
System.String	cancelClick

Returns

Type	Description
InPlaceEditorBuilder

Change(String)

The event will be fired when the integrated component value has changed that render based on the type property in the In-place editor.

Declaration

public InPlaceEditorBuilder Change(string change)

Parameters

Type	Name	Description
System.String	change

Returns

Type	Description
InPlaceEditorBuilder

Created(String)

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

Declaration

public InPlaceEditorBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
InPlaceEditorBuilder

CssClass(String)

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

Declaration

public InPlaceEditorBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
InPlaceEditorBuilder

Destroyed(String)

The event will be fired when the component gets destroyed.

Declaration

public InPlaceEditorBuilder Destroyed(string destroyed)

Parameters

Type	Name	Description
System.String	destroyed

Returns

Type	Description
InPlaceEditorBuilder

Disabled(Boolean)

Specifies whether to enable editing mode or not.

Declaration

public InPlaceEditorBuilder Disabled(bool disabled = true)

Parameters

Type	Name	Description
System.Boolean	disabled

Returns

Type	Description
InPlaceEditorBuilder

EditableOn(EditableType)

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

Declaration

public InPlaceEditorBuilder EditableOn(EditableType editableOn)

Parameters

Type	Name	Description
EditableType	editableOn

Returns

Type	Description
InPlaceEditorBuilder

EmptyText(String)

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

Declaration

public InPlaceEditorBuilder EmptyText(string emptyText)

Parameters

Type	Name	Description
System.String	emptyText

Returns

Type	Description
InPlaceEditorBuilder

EnableEditMode(Boolean)

Specifies to show/hide the editing mode.

Declaration

public InPlaceEditorBuilder EnableEditMode(bool enableEditMode = true)

Parameters

Type	Name	Description
System.Boolean	enableEditMode

Returns

Type	Description
InPlaceEditorBuilder

EnableHtmlParse(Boolean)

It enables or disables the parsing of HTML string content into HTML DOM elements for In-place Editor. If the value of the property is set to false, the In-place Editor value will be displayed as HTML string instead of HTML DOM elements.

Declaration

public InPlaceEditorBuilder EnableHtmlParse(bool enableHtmlParse = true)

Parameters

Type	Name	Description
System.Boolean	enableHtmlParse

Returns

Type	Description
InPlaceEditorBuilder

EnableHtmlSanitizer(Boolean)

Defines whether to allow the cross-scripting site or not.

Declaration

public InPlaceEditorBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)

Parameters

Type	Name	Description
System.Boolean	enableHtmlSanitizer

Returns

Type	Description
InPlaceEditorBuilder

EnablePersistence(Boolean)

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

1. value

Declaration

public InPlaceEditorBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
InPlaceEditorBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public InPlaceEditorBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
InPlaceEditorBuilder

EndEdit(String)

The event will be fired when the edit action is finished and begin to submit/cancel the current value.

Declaration

public InPlaceEditorBuilder EndEdit(string endEdit)

Parameters

Type	Name	Description
System.String	endEdit

Returns

Type	Description
InPlaceEditorBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public InPlaceEditorBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
InPlaceEditorBuilder

Locale(String)

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

Declaration

public InPlaceEditorBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
InPlaceEditorBuilder

Mode(RenderMode)

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

Declaration

public InPlaceEditorBuilder Mode(RenderMode mode)

Parameters

Type	Name	Description
RenderMode	mode

Returns

Type	Description
InPlaceEditorBuilder

Model(Object)

Declaration

public InPlaceEditorBuilder Model(object modelValue)

Parameters

Type	Name	Description
System.Object	modelValue

Returns

Type	Description
InPlaceEditorBuilder

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.

Declaration

public InPlaceEditorBuilder Name(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
InPlaceEditorBuilder

PopupSettings(InPlaceEditorPopupSettings)

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

Declaration

public InPlaceEditorBuilder PopupSettings(InPlaceEditorPopupSettings popupSettings)

Parameters

Type	Name	Description
InPlaceEditorPopupSettings	popupSettings

Returns

Type	Description
InPlaceEditorBuilder

PopupSettings(Action<InPlaceEditorPopupSettingsBuilder>)

Declaration

public InPlaceEditorBuilder PopupSettings(Action<InPlaceEditorPopupSettingsBuilder> popupSettings)

Parameters

Type	Name	Description
System.Action<InPlaceEditorPopupSettingsBuilder>	popupSettings

Returns

Type	Description
InPlaceEditorBuilder

PrimaryKey(Double)

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

Declaration

public InPlaceEditorBuilder PrimaryKey(double primaryKey)

Parameters

Type	Name	Description
System.Double	primaryKey

Returns

Type	Description
InPlaceEditorBuilder

PrimaryKey(String)

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

Declaration

public InPlaceEditorBuilder PrimaryKey(string primaryKey)

Parameters

Type	Name	Description
System.String	primaryKey

Returns

Type	Description
InPlaceEditorBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
System.Web.HtmlString

SaveButton(Object)

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

Declaration

public InPlaceEditorBuilder SaveButton(object saveButton)

Parameters

Type	Name	Description
System.Object	saveButton

Returns

Type	Description
InPlaceEditorBuilder

ShowButtons(Boolean)

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

Declaration

public InPlaceEditorBuilder ShowButtons(bool showButtons = true)

Parameters

Type	Name	Description
System.Boolean	showButtons

Returns

Type	Description
InPlaceEditorBuilder

SubmitClick(String)

Event triggers when click the submit button.

Declaration

public InPlaceEditorBuilder SubmitClick(string submitClick)

Parameters

Type	Name	Description
System.String	submitClick

Returns

Type	Description
InPlaceEditorBuilder

SubmitOnEnter(Boolean)

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

Declaration

public InPlaceEditorBuilder SubmitOnEnter(bool submitOnEnter = true)

Parameters

Type	Name	Description
System.Boolean	submitOnEnter

Returns

Type	Description
InPlaceEditorBuilder

Template(String)

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

Declaration

public InPlaceEditorBuilder Template(string template)

Parameters

Type	Name	Description
System.String	template

Returns

Type	Description
InPlaceEditorBuilder

TextOption(TextOptionType)

Specifies the option to be set on initial rendering. It is applicable for DropDownList, AutoComplete, ComboBox, and MultiSelect component types. The possible options are:

Declaration

public InPlaceEditorBuilder TextOption(TextOptionType textOption)

Parameters

Type	Name	Description
TextOptionType	textOption

Returns

Type	Description
InPlaceEditorBuilder

Type(InputType)

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

Declaration

public InPlaceEditorBuilder Type(InputType type)

Parameters

Type	Name	Description
InputType	type

Returns

Type	Description
InPlaceEditorBuilder

Url(String)

Gets the url for server submit action.

Declaration

public InPlaceEditorBuilder Url(string url)

Parameters

Type	Name	Description
System.String	url

Returns

Type	Description
InPlaceEditorBuilder

Validating(String)

The event will be fired while validating current value.

Declaration

public InPlaceEditorBuilder Validating(string validating)

Parameters

Type	Name	Description
System.String	validating

Returns

Type	Description
InPlaceEditorBuilder

ValidationRules(Object)

Maps the validation rules for the input.

Declaration

public InPlaceEditorBuilder ValidationRules(object validationRules)

Parameters

Type	Name	Description
System.Object	validationRules

Returns

Type	Description
InPlaceEditorBuilder

Value(Double)

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

Declaration

public InPlaceEditorBuilder Value(double value)

Parameters

Type	Name	Description
System.Double	value

Returns

Type	Description
InPlaceEditorBuilder

Value(Double[])

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

Declaration

public InPlaceEditorBuilder Value(double[] value)

Parameters

Type	Name	Description
System.Double[]	value

Returns

Type	Description
InPlaceEditorBuilder

Value(Object)

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

Declaration

public InPlaceEditorBuilder Value(object value)

Parameters

Type	Name	Description
System.Object	value

Returns

Type	Description
InPlaceEditorBuilder

Value(String)

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

Declaration

public InPlaceEditorBuilder Value(string value)

Parameters

Type	Name	Description
System.String	value

Returns

Type	Description
InPlaceEditorBuilder

Value(String[])

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

Declaration

public InPlaceEditorBuilder Value(string[] value)

Parameters

Type	Name	Description
System.String[]	value

Returns

Type	Description
InPlaceEditorBuilder