ExtendedTextArea Class

Editor with syntax highlight support.

Inheritance Hierarchy

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

Namespace: CMS.ExtendedControls
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 8.2.23

Syntax

public class ExtendedTextArea : CMSTextArea

The ExtendedTextArea type exposes the following members.

Constructors

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

Methods

	Name	Description
Public method	ExtractBookmarks	Retrieves bookmarks from the editor text and stores them in the hashtables.
Public method	GetPreformattedBookmarks	Preparses the bookmarks retrieved from the text.
Protected method	GetScrollPositionValue	Gets the scroll position value (Overrides CMSTextArea.GetScrollPositionValue().)
Public method	GetValueGetterCommand	Return command which gets value of editor (handles case when SyntaxHighlighting is disabled).
Public method	GetValueSetterCommand	Return command which sets given value (general JS command) to the editor (handles case when SyntaxHighlighting is disabled).
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 CMSTextArea.OnLoad(EventArgs).)
Protected method	OnPreRender	Registers client script for generating postback events prior to rendering on the client, if AutPostBack is true. (Overrides CMSTextArea.OnPreRender(EventArgs).)
Protected method	RegisterPosition	Registers the position marker. (Inherited from CMSTextArea.)
Protected method	Render	Renders the ExtendedTextArea control to the specified HtmlTextWriter object. (Overrides CMSTextBox.Render(HtmlTextWriter).)
Public method	SetPosition	Explicitly sets the editor position

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	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
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	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
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 CoreExtensions.)
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.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	CODEMIRROR_BASE_PATH	Path to the directory that holds CodeMirror files (CSS and JS).

Properties

	Name	Description
Public property	AllowFullscreen	Determines if full screen mode is enabled
Public property	AutoSize	Gets or sets whether the editor should resize automatically when the containing window resizes.
Public property	BraceMatching	Gets or sets if braces should be automatically matched (highlights open and closing brace).
Public property	Count	Gets or sets the number of bookmarks.
Public property	DynamicBookmarks	Gets or sets if the bookmarks are refreshed dynamically during editing.
Public property	DynamicHeight	Gets or sets whether the height of the editor should be resized to fit its content dynamically.
Public property	EditorID	Gets the client ID of the syntax highlight editor object used by this control.
Public property	EditorMode	Gets or sets the text editing capabilities of this editor.
Public property	EnableAutoComplete	Gets or sets whether autocomplete is enabled. (Inherited from CMSTextBox.)
Public property	EnableFocus	Gets or sets whether the focus is enabled. (Inherited from CMSTextArea.)
Public property	EnablePositionMember	Gets or sets whether the position member is enabled.
Public property	EnableSections	Gets or sets whether the bookmarks are enabled.
Public property	EnableTabKey	Indicates if Tab key adds '\t' into the text. Default value is true.
Public property	FullScreenParentElementID	Gets or sets element's ID, which height and top position will be used in fullscreen mode.
Public property	HighlightingEnabled	Gets or sets if the highlighting is turned on or off.
Public property	HighlightMacros	Determines if macros should be highlighted.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSTextBox.)
Public property	IsMacroMixedMode	Indicates whether the editor is in pure macro editing mode (whole text is considered as macro) or mixed mode, where auto completion is fired only inside {%%} environment. This setting will influence the Insert Macro functionality when in mixed mode the brackets are inserted, whereas in the pure macro mode, the macro is inserted without brackets.
Public property	Language	Gets or sets the programming language that should be highlighted.
Public property	LineNumber	Gets or sets the total number of lines.
Public property	Lines	Gets or sets the collection of bookmark line numbers.
Public property	MacroDelimiter	Gets or sets the macro delimiter used.
Public property	MaintainScrollPositionOnPostback	Gets or sets whether the scroll position is maintained between postbacks. (Inherited from CMSTextArea.)
Public property	MarkErrors	Gets or sets whether syntactic errors should be marked in code.
Public property	Names	Gets or sets the collection of bookmark names.
Public property	ParentElementID	Gets or sets element's ID, which height will be used in autosize computing.
Public property	PositionMarker	Gets the name of the hidden field that carries a scroll position. (Inherited from CMSTextArea.)
Public property	ProcessMacroSecurity	Indicates if security parameters in macros are handled automatically. (Inherited from CMSTextBox.)
Public property	RegularExpression	Gets or sets the regular expression which is used to detect bookmarks.
Public property	ResolverName	Gets or sets the resolver which will be used in the Insert macro dialog (if allowed with ShowInsertMacro).
Protected property	ScrollPosition	Gets the scroll position to use on postback. (Inherited from CMSTextArea.)
Public property	ShowBookmarks	Gets or sets if the bookmarks panel is shown in the code editor.
Public property	ShowInsertMacro	Determines whether the button "Insert macro" is visible.
Public property	ShowLineNumbers	Gets or sets if the line numbers are displayed.
Public property	ShowToolbar	Gets or sets if the toolbar is shown in the code editor.
Public property	SingleLineMode	Determines whether the editor is in single line mode (i.e. only one line of text can be edited).
Public property	SyntaxHighlightingEnabled	Gets if syntax highlighting is enabled for this control.
Public property	TabKey	Gets or sets the key to use in tab.
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	TextMode	Gets or sets the behaviour mode (single-line, multiline, or password) of this editor control. Only TextBoxMode.MultiLine is supported (Overrides TextBox.TextMode.)
Public property	UseSmallFonts	If true, Editor is set to use small fonts (CodeMirror/css/smallfont.css class is included).
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. (Inherited from CMSTextArea.)