Back to Devexpress

ASPxHtmlEditor Properties

aspnet-devexpress-dot-web-dot-aspxhtmleditor-dot-aspxhtmleditor-dot-underscore-properties.md

latest42.9 KB
Original Source

ASPxHtmlEditor Properties

An HTML text editor control.

NameDescription
AccessibilityCompliantEnables accessibility support.
AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
ActiveViewGets or sets the editor’s active view.
Adapter protectedGets the browser-specific adapter for the control. Inherited from Control.
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AssociatedRibbonIDSpecifies the ID of an ASPxRibbon control, used as an external toolbar.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
BackColorGets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImageThis property is not in effect for the ASPxHtmlEditor class.
BackwardCompatibility staticProvides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
BorderGets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottomGets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderLeftGets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRightGets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderTopGets the settings of the web control’s top border. Inherited from ASPxWebControl.
ChildControlsCreated protectedGets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientEnabledGets or sets a value that indicates whether an ASPxHtmlEditor is enabled on the client.
ClientIDGets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protectedGets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceNameGets or sets the ASPxHtmlEditor‘s client programmatic identifier.
ClientSideEventsGets an object that lists the client-side events specific to the ASPxHtmlEditor.
ClientVisibleGets or sets a value that specifies the initial visibility state of a web control on the client.
Context protectedGets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
ContextMenuItemsGets the collection of items displayed within the editor’s context menu.
ControlsGets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
ControlStyleGets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreatedGets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl.
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePathThis property is not in effect for the ASPxHtmlEditor class. Use the StylesBase.CssFilePath property instead.
CssFilesGets a collection of items that refer to external CSS files associated with the ASPxHtmlEditor object.
CssPostfixThis property is not in effect for the ASPxHtmlEditor class. Use the StylesBase.CssPostfix property instead.
CursorGets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
CustomDialogsProvides access to custom dialogs added to the editor.
DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DisabledCssClass staticGets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyleThis property is not in effect for the ASPxHtmlEditor class.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when a control’s content is updated via a callback.
EnableCallbackCompressionGets or sets whether callback result compression is enabled.
EnabledGets or sets a value that indicates whether a web control is enabled, allowing it to respond to user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableThemingGets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. Inherited from Control.
EncodeHtmlGets or sets whether to encode editor value and content. Inherited from ASPxWebControl.
ErrorTextGets or sets the error text to be displayed within the editor’s error frame, if the editor’s validation fails.
Events protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FontGets the font properties associated with the Web server control. Inherited from WebControl.
ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
GlobalAccessibilityCompliant staticGets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts staticGets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries staticObsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft staticGets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme staticGets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme staticGets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor staticGets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont staticGets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
HasAttributesGets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protectedGets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
HeightGets or sets the height of the web server control. Inherited from ASPxWebControl.
HtmlSpecifies the HTML markup that is the ASPxHtmlEditor‘s content.
IDGets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protectedGets the character used to separate control identifiers. Inherited from Control.
ImagesProvides access to the settings that define images displayed within specific visual elements of the ASPxHtmlEditor.
ImagesEditorsProvides access to the settings that define images displayed within different editors used within the ASPxHtmlEditor control and its dialog forms.
ImagesFileManagerProvides access to the settings that define images displayed within the Image Selector and Document Selector.
InitializedGets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallbackGets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protectedGets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsTrackingViewState protectedGets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsValidGets or sets a value that indicates whether the editor’s value passes validation.
IsViewStateEnabled protectedGets a value indicating whether view state is enabled for this control. Inherited from Control.
JSPropertiesEnables you to supply any server data that can then be parsed on the client.
LoadedIndicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadViewStateByID protectedGets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
NamingContainerGets a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. Inherited from Control.
PageGets a reference to the Page instance that contains the server control. Inherited from Control.
ParentGets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentImagesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentStylesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
PartsRoundPanelObsolete. Provides access to the settings that define different part of round panel used within the ASPxHtmlEditor control.
PlaceholdersGets the collection of placeholders available in the ASPxHtmlEditor.
RenderIFrameForPopupElementsGets or sets a value that specifies whether the editor’s popup dialogs are displayed above Java applets that may present on the web page.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RibbonContextTabCategoriesGets the collection of ribbon context tab categories.
RibbonTabsProvides access to the collection of Ribbon tabs.
RightToLeftSpecifies whether to apply right-to-left representation to the control.
SaveStateToCookiesGets or sets a value that specifies whether cookies are used to persist the information about the control.
SaveStateToCookiesIDGets or sets the name (identifier) of the cookie in which the ASPxHtmlEditor’s state is persisted.
SettingsProvides access to the ASPxHtmlEditor‘s main settings.
SettingsAdaptivityProvides access to the HTML Editor layout adaptivity settings.
SettingsAudioSelectorObsolete. Provides access to settings related to the Select Audio dialog.
SettingsAudioUploadObsolete. Provides access to settings related to uploading audio files.
SettingsDialogFormElementsObsolete. Provides access to settings that relate to customization of dialog form elements.
SettingsDialogsProvides access to the built-in dialogs‘ settings.
SettingsDocumentSelectorObsolete. Provides access to settings that are related to the Document Selector dialog.
SettingsFlashSelectorObsolete. Provides access to settings related to the Select Flash dialog.
SettingsFlashUploadObsolete. Provides access to settings related to uploading flash files.
SettingsHtmlEditingProvides access to settings that relate to editing the HTML markup.
SettingsImageSelectorObsolete. Provides access to settings that are related to the Select Image dialog.
SettingsImageUploadObsolete. Provides access to settings that relate to uploading images.
SettingsLoadingPanelProvides access to the loading panel‘s settings.
SettingsPlaceholdersProvides access to the placeholders settings for the ASPxHtmlEditor.
SettingsResizeProvides access to settings that relate to sizing capabilities.
SettingsSpellCheckerProvides access to the spelling settings for checking the ASPxHtmlEditor’s content.
SettingsTextProvides access to the settings that define texts displayed in different elements (tabs) of the control.
SettingsValidationProvides access to content validation settings.
SettingsVideoSelectorObsolete. Provides access to settings related to the Select Video dialog.
SettingsVideoUploadObsolete. Provides access to settings related to uploading video files.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
ShortcutsGets the collection of shortcuts available within ASPxHtmlEditor.
SiteGets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinIDGets or sets the skin to apply to the control. Inherited from WebControl.
StyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl.
StylesProvides access to the style settings that define the appearance of the ASPxHtmlEditor ‘s different elements.
StylesButtonProvides access to the style settings that define the appearance of button elements used by the ASPxHtmlEditor control (within dialog forms, for instance).
StylesContextMenuProvides access to the style settings that define the appearance of the editor’s context menu.
StylesDialogFormProvides access to the style settings that define the appearance of the editor’s dialog forms.
StylesDocumentProvides access to the style settings that define the appearance of the document displayed by the editor’s design view area and preview area, and applied to the exported document.
StylesEditorsProvides access to the style settings that define the appearance of editor elements used by the ASPxHtmlEditor control (for instance, within dialog forms).
StylesFileManagerProvides access to the style settings that control the appearance of the Image Selector‘s elements.
StylesPasteOptionsBarProvides access to the style settings that define the appearance of the editor’s paste options bar.
StylesRoundPanelProvides access to the style settings that define the appearance of round panel controls used by the ASPxHtmlEditor control (for instance, within dialog forms).
StylesSpellCheckerProvides access to style settings of the ASPxHtmlEditor‘s built-in spell checker.
StylesStatusBarProvides access to the style settings that define the appearance of the editor’s status bar.
StylesTagInspectorProvides access to the style settings that define the appearance of the tag inspector.
StylesToolbarsProvides access to the style settings that define the appearance of toolbars.
SupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false. Inherited from WebControl.
IControlBuilderAccessor.ControlBuilderFor a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserDataFor a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindingsFor a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindingsFor a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.ExpressionsFor a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressionsFor a description of this member, see HasExpressions. Inherited from Control.
TabIndexGets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protectedGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protectedGets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TemplateControlGets or sets a reference to the template that contains this control. Inherited from Control.
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
ThemeGets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolbarModeSpecifies the type of the ASPxHtmlEditor toolbar.
ToolbarsGets the collection of toolbars in the ASPxHtmlEditor control.
ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
UniqueIDGets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewState protectedGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. Inherited from Control.
ViewStateIgnoresCase protectedGets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateModeGets or sets the view-state mode of this control. Inherited from Control.
VisibleGets or sets a value specifying the current ASPxHtmlEditor control’s visibility.
WidthGets or sets the editor’s width.

See Also

ASPxHtmlEditor Class

ASPxHtmlEditor Members

DevExpress.Web.ASPxHtmlEditor Namespace