Click or drag to resize
CMSTextArea Class
Basic multiple lines text editor.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsTextBox
        CMS.Base.Web.UICMSTextBox
          CMS.Base.Web.UICMSTextArea
            CMS.Base.Web.UIExtendedTextArea

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class CMSTextArea : CMSTextBox

The CMSTextArea type exposes the following members.

Constructors
  NameDescription
Public methodCMSTextArea
Initializes a new instance of CMSTextArea class.
Top
Properties
  NameDescription
Public propertyEnableAutoComplete
Gets or sets whether autocomplete is enabled.
(Inherited from CMSTextBox.)
Public propertyEnableFocus
Gets or sets whether the focus is enabled.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSTextBox.)
Protected propertyMacroProcessingColumnAdapter
Column adapter to be used when signing macros.
(Inherited from CMSTextBox.)
Public propertyMaintainScrollPositionOnPostback
Gets or sets whether the scroll position is maintained between postbacks.
Protected propertyPositionMarker
Gets the name of the hidden field that carries a scroll position.
Public propertyProcessMacroSecurity
Indicates if security parameters in macros are handled automatically.
(Inherited from CMSTextBox.)
Protected propertyScrollPosition
Gets the scroll position to use on postback.
Public propertyText
Gets or sets the text content of the System.Web.UI.WebControls.TextBox control. If ProcessMacroSecurity is true, macro security parameters are processed.
(Inherited from CMSTextBox.)
Public propertyValueIsMacro
If true, the value is processed as a macro (signed as a whole)
(Inherited from CMSTextBox.)
Public propertyWatermarkCssClass
The CSS class to apply to the TextBox when it has no value (e.g. the watermark text is shown).
(Inherited from CMSTextBox.)
Public propertyWatermarkText
The text to show when the control has no value.
(Inherited from CMSTextBox.)
Public propertyWrap
Gets or sets a value indicating whether the text content wraps.
(Overrides TextBoxWrap.)
Top
Methods
  NameDescription
Protected methodGetScrollPositionValue
Gets the scroll position value
Protected methodOnInit
Initializes control
(Inherited from CMSTextBox.)
Protected methodOnLoad
Retrieves scroll position markers from hidden fields.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreRender
Renders scripts and elements required for correct functionality.
(Overrides CMSTextBoxOnPreRender(EventArgs).)
Protected methodRegisterPosition
Registers the position marker.
Protected methodRender
Renders the text box control. If length exceeds MaxLength because of macros, warning icon is displayed.
(Inherited from CMSTextBox.)
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
See Also