Class EditorPropertiesBuilder

Inheritance

System.Object

EditorPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

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.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class EditorPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

EditorPropertiesBuilder()

Declaration

public EditorPropertiesBuilder()

EditorPropertiesBuilder(Currency)

Used to display only currency values

Declaration

public EditorPropertiesBuilder(Currency edit)

Parameters

Type	Name	Description
Currency	edit

EditorPropertiesBuilder(Numeric)

Used to display only numeric values.

Declaration

public EditorPropertiesBuilder(Numeric edit)

Parameters

Type	Name	Description
Numeric	edit

EditorPropertiesBuilder(Percent)

Used to display only percentage values

Declaration

public EditorPropertiesBuilder(Percent edit)

Parameters

Type	Name	Description
Percent	edit

Fields

editor

Used to display only numeric values.

Declaration

public Numeric editor

Field Value

Type	Description
Numeric

Methods

ClientSideEvents(Action<EditorClientSideEventsBuilder>)

Represents the client side events

Declaration

public EditorPropertiesBuilder ClientSideEvents(Action<EditorClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<EditorClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
EditorPropertiesBuilder

CssClass(String)

Sets the root CSS class for Editors which allow us to customize the appearance.

Declaration

public EditorPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
EditorPropertiesBuilder

CurrencySymbol(String)

Specifies the currency symbol for currency textbox.

Declaration

public EditorPropertiesBuilder CurrencySymbol(string currencySymbol)

Parameters

Type	Name	Description
System.String	currencySymbol

Returns

Type	Description
EditorPropertiesBuilder

DecimalPlaces(Int32)

Specifies the number of digits that should be allowed after the decimal point.

Declaration

public EditorPropertiesBuilder DecimalPlaces(int decimals)

Parameters

Type	Name	Description
System.Int32	decimals

Returns

Type	Description
EditorPropertiesBuilder

Enabled()

Specifies the editor control state.

Declaration

public EditorPropertiesBuilder Enabled()

Returns

Type	Description
EditorPropertiesBuilder

Enabled(Boolean)

Declaration

public EditorPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
EditorPropertiesBuilder

EnablePersistence()

Specify the enablePersistence to editor to save current editor control value to browser cookies for state maintenance.

Declaration

public EditorPropertiesBuilder EnablePersistence()

Returns

Type	Description
EditorPropertiesBuilder

EnablePersistence(Boolean)

Declaration

public EditorPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
EditorPropertiesBuilder

EnableRTL()

Specifies the Right to Left Direction to editor.

Declaration

public EditorPropertiesBuilder EnableRTL()

Returns

Type	Description
EditorPropertiesBuilder

EnableRTL(Boolean)

Declaration

public EditorPropertiesBuilder EnableRTL(bool rtl)

Parameters

Type	Name	Description
System.Boolean	rtl

Returns

Type	Description
EditorPropertiesBuilder

EnableStrictMode()

When enableStrictMode true it allows the value outside of the range also but it highlights the textbox with error class,otherwise it internally changed to the correct value.

Declaration

public EditorPropertiesBuilder EnableStrictMode()

Returns

Type	Description
EditorPropertiesBuilder

EnableStrictMode(Boolean)

Declaration

public EditorPropertiesBuilder EnableStrictMode(bool strictMode)

Parameters

Type	Name	Description
System.Boolean	strictMode

Returns

Type	Description
EditorPropertiesBuilder

GroupSeparator(String)

It provides the options to get the customized character to separate the digits. If not set, the separator defined by the current culture.

Declaration

public EditorPropertiesBuilder GroupSeparator(string groupSeparator)

Parameters

Type	Name	Description
System.String	groupSeparator

Returns

Type	Description
EditorPropertiesBuilder

GroupSize(String)

Specifies the number of digits in each group to the editor.

Declaration

public EditorPropertiesBuilder GroupSize(string groupSize)

Parameters

Type	Name	Description
System.String	groupSize

Returns

Type	Description
EditorPropertiesBuilder

Height(String)

Specifies the height of the editor.

Declaration

public EditorPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
EditorPropertiesBuilder

HtmlAttributes(IDictionary<String, Object>)

It allows to define the characteristics of the Editors control. It will helps to extend the capability of an HTML element.

Declaration

public EditorPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

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

Returns

Type	Description
EditorPropertiesBuilder

IncrementStep(Double)

The Editor value increment or decrement based an incrementStep value.

Declaration

public EditorPropertiesBuilder IncrementStep(double incrementStep)

Parameters

Type	Name	Description
System.Double	incrementStep

Returns

Type	Description
EditorPropertiesBuilder

Locale(String)

Defines the localization culture for editor.

Declaration

public EditorPropertiesBuilder Locale(string localize)

Parameters

Type	Name	Description
System.String	localize

Returns

Type	Description
EditorPropertiesBuilder

MaxValue(Double)

Specifies the maximum value of the editor.

Declaration

public EditorPropertiesBuilder MaxValue(double maxValue)

Parameters

Type	Name	Description
System.Double	maxValue

Returns

Type	Description
EditorPropertiesBuilder

MinValue(Double)

Specifies the minimum value of the editor.

Declaration

public EditorPropertiesBuilder MinValue(double minValue)

Parameters

Type	Name	Description
System.Double	minValue

Returns

Type	Description
EditorPropertiesBuilder

Name(String)

Specifies the name of the editor.

Declaration

public EditorPropertiesBuilder Name(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
EditorPropertiesBuilder

NegativePattern(String)

Specifies the pattern for formatting negative values in editor.

Declaration

public EditorPropertiesBuilder NegativePattern(string negativePattern)

Parameters

Type	Name	Description
System.String	negativePattern

Returns

Type	Description
EditorPropertiesBuilder

PositivePattern(String)

Specifies the pattern for formatting positive values in editor.

Declaration

public EditorPropertiesBuilder PositivePattern(string positivePattern)

Parameters

Type	Name	Description
System.String	positivePattern

Returns

Type	Description
EditorPropertiesBuilder

ReadOnly()

Toggles the readonly state of the editor. When the Editor is readonly it doesn’t allow user interactions.

Declaration

public EditorPropertiesBuilder ReadOnly()

Returns

Type	Description
EditorPropertiesBuilder

ReadOnly(Boolean)

Declaration

public EditorPropertiesBuilder ReadOnly(bool readOnly)

Parameters

Type	Name	Description
System.Boolean	readOnly

Returns

Type	Description
EditorPropertiesBuilder

Render()

Renders the Editor instance.

Declaration

public void Render()

ShowRoundedCorner()

Specifies to Change the sharped edges into rounded corner for the Editor.

Declaration

public EditorPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
EditorPropertiesBuilder

ShowRoundedCorner(Boolean)

Declaration

public EditorPropertiesBuilder ShowRoundedCorner(bool roundedCorner)

Parameters

Type	Name	Description
System.Boolean	roundedCorner

Returns

Type	Description
EditorPropertiesBuilder

ShowSpinButton()

Specifies whether the up and down spin buttons should be displayed in editor.

Declaration

public EditorPropertiesBuilder ShowSpinButton()

Returns

Type	Description
EditorPropertiesBuilder

ShowSpinButton(Boolean)

Declaration

public EditorPropertiesBuilder ShowSpinButton(bool showSpinButton)

Parameters

Type	Name	Description
System.Boolean	showSpinButton

Returns

Type	Description
EditorPropertiesBuilder

ToHtmlString()

Represents an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

ValidateOnType()

Enables decimal separator position validation on type .

Declaration

public EditorPropertiesBuilder ValidateOnType()

Returns

Type	Description
EditorPropertiesBuilder

ValidateOnType(Boolean)

Declaration

public EditorPropertiesBuilder ValidateOnType(bool validate)

Parameters

Type	Name	Description
System.Boolean	validate

Returns

Type	Description
EditorPropertiesBuilder

ValidationMessage(Action<EditorValidationMessageBuilder>)

Set the jQuery validation error message in editor.

Declaration

public EditorPropertiesBuilder ValidationMessage(Action<EditorValidationMessageBuilder> validationMessage)

Parameters

Type	Name	Description
System.Action<EditorValidationMessageBuilder>	validationMessage

Returns

Type	Description
EditorPropertiesBuilder

ValidationMessage(Dictionary<String, Object>)

Declaration

public EditorPropertiesBuilder ValidationMessage(Dictionary<string, object> validationMessage)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	validationMessage

Returns

Type	Description
EditorPropertiesBuilder

ValidationRules(Action<EditorValidationRuleBuilder>)

Set the jQuery validation rules to the editor.

Declaration

public EditorPropertiesBuilder ValidationRules(Action<EditorValidationRuleBuilder> validationRule)

Parameters

Type	Name	Description
System.Action<EditorValidationRuleBuilder>	validationRule

Returns

Type	Description
EditorPropertiesBuilder

ValidationRules(Dictionary<String, Object>)

Declaration

public EditorPropertiesBuilder ValidationRules(Dictionary<string, object> validationRule)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	validationRule

Returns

Type	Description
EditorPropertiesBuilder

Value(Object)

Specifies the value of the editor.

Declaration

public EditorPropertiesBuilder Value(object value)

Parameters

Type	Name	Description
System.Object	value

Returns

Type	Description
EditorPropertiesBuilder

WatermarkText(String)

Specifies the watermark text to editor.

Declaration

public EditorPropertiesBuilder WatermarkText(string waterMarkText)

Parameters

Type	Name	Description
System.String	waterMarkText

Returns

Type	Description
EditorPropertiesBuilder

Width(String)

Specifies the width of the editor.

Declaration

public EditorPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
EditorPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString