TextEditor Members

Include Protected Members
Include Inherited Members

Defines the text editor for the user.

The TextEditor type exposes the following members.

Constructors

  Name Description
Public method TextEditor Initializes a new instance of the TextEditor class.

Top

Properties

  Name Description
Public property DynamicHeightSizing Gets or sets a value that indicates whether the height of the TextEditor can be adjusted automatically to fit the content.
Public property EditableText Gets or sets the raw HTML to display in the web browser for the user to edit.
Public property EditorHeight Gets or sets the height of the text editor.
Public property EditorWidth Gets or sets the width of the text editor.
Public property ErrorMessage Gets or sets the error message that appears above the text editor window.
Public property ErrorMessageLocId Gets or sets the localized version of ErrorMessage.
Public property ErrorMessageLocIdNum Gets or sets the localization identifier (ID) for ErrorMessage.
Public property IsValid Gets or sets a value that indicates whether the TextEditor is valid.
Public property MaxHeightSize Gets or sets the maximum number of lines that the TextEditor allows.
Public property ReadOnly Gets or sets a value that indicates whether the TextEditor is read-only.
Public property RestrictedMode Gets or sets a value that indicates whether the text editor is in restricted mode. Restricted mode does not support the Copy, Cut, Paste, or Insert Image function.
Public property SimpleTextOnly Gets or sets a value that indicates whether the TextEditor will only display text without HTML.
Public property TabIndex Gets or sets the tab index of the TextEditor.

Top

Methods

  Name Description
Public methodStatic member MakeTextSafe Cleans text according to specifications, such as removing all script and certain URLs.
Protected method OnLoad Handles the Load event. (Overrides Control.OnLoad(EventArgs).)
Protected method OnPreRender Handles the PreRender event. (Overrides Control.OnPreRender(EventArgs).)
Protected method Render Renders the TextEditor to the client. (Overrides Control.Render(HtmlTextWriter).)
Public method Validate Ensures that the text size does not exceed the maximum size limit of MaxTextSizeDefault. The Validate method removes all script from the text before validating the size.

Top

Fields

  Name Description
Protected field m_fDynamicHeightSizing Specifies whether the height of the TextEditor can be adjusted automatically to fit the content.
Protected field m_fIsValid Gets or sets a value that indicates whether the TextEditor is valid.
Protected field m_fReadOnly Specifies whether the TextEditor is read-only.
Protected field m_fSimpleTextOnly Specifies whether the TextEditor will only display text without HTML.
Protected field m_fTabIndex Specifies the tab index of the TextEditor.
Protected field m_nMaxHeightSize Specifies the maximum number of lines that the TextEditor allows.
Public fieldStatic member MaxTextSizeDefault Specifies the maximum number of characters that the TextEditor allows.
Public fieldStatic member nDefaultMaxHeightSize Specifies the default maximum number of lines that the TextEditor allows.
Public field TableWidth Specifies the width of the table that contains the TextEditor window.

Top

See Also

Reference

TextEditor Class

Microsoft.SharePoint.Portal.WebControls Namespace