InlineEditingTextBox Class

Control used for inline editing a value, for example in unigrid. Best way to use it in columns that have sorting enabled is to place parent unigrid inside update panel and reload unigrid's data after successful update of edited value.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.Base.Web.UI.InlineEditingTextBox
          CMS.Ecommerce.Web.UI.PriorityInlineEdit

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 12.0.0

Syntax

public class InlineEditingTextBox : CMSWebControl, 
	INamingContainer

The InlineEditingTextBox type exposes the following members.

Constructors

	Name	Description
Public method	InlineEditingTextBox

Properties

	Name	Description
Public property	AdditionalCssClass	Gets or sets the additional CSS class for control.
Public property	DelayedReload	Forces manual postback handling in case control is used in unigrid with DelayedReload
Public property	EnableEditingOnTextClick	If true edit mode can be reached by clicking the formatted text, otherwise the formatted text is not clickable and it's necessary to call SwitchToEditMode() method explicitly.
Public property	EnableEncode	Enables encoding of inline control output. By default is true.
Public property	ErrorText	Text displayed in tooltip in case of error. Set this in Update event handler in case of error.
Public property	FormattedText	Represents text to be displayed in non-editing mode. Set this in Formatting event handler. If not defined, Text property will be used.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	MaxLength	Gets or sets the maximum number of characters allowed in the text box. Default is 200.
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Protected property	TagKey	Gets the HtmlTextWriterTag.Div enum. (Overrides WebControl.TagKey.)
Public property	Text	Represents text to be edited. Use FormattedText property, to display different text in non-editing mode.
Public property	UseUpdatePanel	Gets or sets a value indicating whether to use update panel. It is recommended to set it to true only in columns that have sorting disabled. Setting this to true, will speed up inline editing because of less data needed to be transfered during post back. Default value is false.

Methods

	Name	Description
Protected method	CreateChildControls	Initializes a new instance of the InlineEditingTextBox class. (Overrides Control.CreateChildControls().)
Protected method	OnFormatting	Raises the formatting event.
Protected method	OnInit	Ensures initialization of child controls. (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnLoad	Ensures action events. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	Raises the System.Web.UI.Control.PreRender event. (Overrides Control.OnPreRender(EventArgs).)
Protected method	OnUpdate	Raises the update event.
Public method	SwitchToEditMode	Switches control into editing mode.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	Formatting	Formatting event. Use this event to set FormattedText property.
Public event	Update	Update event. Use this event to save edited data, set ErrorText property in case of error and reload unigrid's data in case of using InlineEditingTextBox in columns that have sorting enabled.