CMSTextArea Class

Basic multiple lines text editor.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.TextBox
        CMS.Base.Web.UI.CMSTextBox
          CMS.Base.Web.UI.CMSTextArea
            CMS.Base.Web.UI.ExtendedTextArea

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

Syntax

public class CMSTextArea : CMSTextBox

The CMSTextArea type exposes the following members.

Constructors

	Name	Description
Public method	CMSTextArea	Initializes a new instance of CMSTextArea class.

Properties

	Name	Description
Public property	EnableAutoComplete	Gets or sets whether autocomplete is enabled. (Inherited from CMSTextBox.)
Public property	EnableFocus	Gets or sets whether the focus is enabled.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSTextBox.)
Public property	MaintainScrollPositionOnPostback	Gets or sets whether the scroll position is maintained between postbacks.
Public property	PositionMarker	Gets the name of the hidden field that carries a scroll position.
Public property	ProcessMacroSecurity	Indicates if security parameters in macros are handled automatically. (Inherited from CMSTextBox.)
Protected property	ScrollPosition	Gets the scroll position to use on postback.
Public property	Text	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 property	ValueIsMacro	If true, the value is processed as a macro (signed as a whole) (Inherited from CMSTextBox.)
Public property	WatermarkCssClass	The CSS class to apply to the TextBox when it has no value (e.g. the watermark text is shown). (Inherited from CMSTextBox.)
Public property	WatermarkText	The text to show when the control has no value. (Inherited from CMSTextBox.)
Public property	Wrap	Gets or sets a value indicating whether the text content wraps. (Overrides TextBox.Wrap.)

Methods

	Name	Description
Protected method	GetScrollPositionValue	Gets the scroll position value
Public method	LoadSignatures	Loads extra signatures from the text. (Inherited from CMSTextBox.)
Protected method	OnInit	Initializes control (Inherited from CMSTextBox.)
Protected method	OnLoad	Retrieves scroll position markers from hidden fields. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	Renders scripts and elements required for correct functionality. (Overrides CMSTextBox.OnPreRender(EventArgs).)
Protected method	RegisterPosition	Registers the position marker.
Protected method	Render	Renders the text box control. If length exceeds MaxLength because of macros, warning icon is displayed. (Inherited from CMSTextBox.)

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