Click or drag to resize
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
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      CMS.Base.Web.UICMSWebControl
        CMS.Base.Web.UIInlineEditingTextBox
          CMS.Ecommerce.Web.UIPriorityInlineEdit

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class InlineEditingTextBox : CMSWebControl, 
	INamingContainer

The InlineEditingTextBox type exposes the following members.

Constructors
  NameDescription
Public methodInlineEditingTextBox
Top
Properties
  NameDescription
Public propertyAdditionalCssClass
Gets or sets the additional CSS class for control.
Public propertyDelayedReload
Forces manual postback handling in case control is used in unigrid with DelayedReload
Public propertyEnableEditingOnTextClick
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 propertyEnableEncode
Enables encoding of inline control output. By default is true.
Public propertyErrorText
Text displayed in tooltip in case of error. Set this in Update event handler in case of error.
Public propertyFormattedText
Represents text to be displayed in non-editing mode. Set this in Formatting event handler. If not defined, Text property will be used.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyMaxLength
Gets or sets the maximum number of characters allowed in the text box. Default is 200.
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Protected propertyTagKey
Gets the HtmlTextWriterTag.Div enum.
(Overrides WebControlTagKey.)
Public propertyText
Represents text to be edited. Use FormattedText property, to display different text in non-editing mode.
Public propertyUseUpdatePanel
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.
Top
Methods
  NameDescription
Protected methodCreateChildControls
Initializes a new instance of the InlineEditingTextBox class.
(Overrides ControlCreateChildControls.)
Protected methodOnFormatting
Raises the formatting event.
Protected methodOnInit
Ensures initialization of child controls.
(Overrides CMSWebControlOnInit(EventArgs).)
Protected methodOnLoad
Ensures action events.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreRender
Raises the System.Web.UI.Control.PreRender event.
(Overrides ControlOnPreRender(EventArgs).)
Protected methodOnUpdate
Raises the update event.
Public methodSwitchToEditMode
Switches control into editing mode.
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventFormatting
Formatting event. Use this event to set FormattedText property.
Public eventUpdate
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.
Top
See Also