Back to Devexpress

HtmlEditorSettings Members

aspnetmvc-devexpress-dot-web-dot-mvc-dot-htmleditorsettings-dot-underscore-members.md

latest21.1 KB
Original Source

HtmlEditorSettings Members

Contains the HtmlEditor extension settings.

Constructors

NameDescription
HtmlEditorSettings()Initializes a new instance of the HtmlEditorSettings class with default settings.

Properties

NameDescription
AccessibilityCompliantEnables accessibility support.
AccessKeyGets or sets the access key that allows you to quickly navigate to the ASP.NET MVC extension. Inherited from SettingsBase.
ActiveViewGets or sets the editor’s active view.
AssociatedRibbonNameGets or sets the name of the Ribbon that the HtmlEditor is associated with.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from SettingsBase.
CallbackRouteValuesDefines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks.
ClientEnabledGets or sets a value that indicates whether the editor is enabled on the client.
ClientSideEventsGets an object that lists the client-side events specific to the HtmlEditor.
ClientVisibleGets or sets a value that specifies the initial visibility state of an HtmlEditor on the client.
ContextMenuItemsGets the collection of items displayed within the editor’s context menu.
ControlStyleProvides access to the style settings declared at the root level of the HtmlEditor’s wrapped web server control.
CssFilesGets a collection of items that refer to external CSS files associated with the HtmlEditor.
CustomDataActionRouteValuesDefines the custom callback routing logic by specifying the names of a Controller and an Action which should handle custom data callbacks initiated by the MVCxClientHtmlEditor.PerformDataCallback method.
CustomDialogsProvides access to custom dialogs added to the HtmlEditor.
CustomJSPropertiesEnables you to get server-side data on the client.
DocumentSelectorFileUploadingObsolete. Enables you to perform server-side processing of file upload operations initiated within the HtmlEditor’s built-in Document Selector.
DocumentSelectorFolderCreatingObsolete. Enables you to perform server-side processing of folder creation operations, initiated within the HtmlEditor’s built-in Document Selector.
DocumentSelectorItemDeletingObsolete. Enables you to perform server-side processing of file/folder deletion operations initiated within the HtmlEditor’s built-in Document Selector.
DocumentSelectorItemMovingObsolete. Enables you to perform server-side processing of file/folder move operations initiated within the HtmlEditor’s built-in Document Selector.
DocumentSelectorItemRenamingObsolete. Enables you to perform server-side processing of file/folder rename operations initiated within the HtmlEditor’s built-in Document Selector.
EnableCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when an editor’s content is updated via a callback.
EnabledGets or sets a value that indicates whether the MVC Extension is enabled, allowing it to respond to end-user interactions. Inherited from SettingsBase.
EnableThemingGets or sets a value indicating whether themes apply to this extension. Inherited from SettingsBase.
EncodeHtmlGets or sets whether to encode editor value and content. Inherited from SettingsBase.
ExportRouteValuesDefines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks related to exporting content.
HeightGets or sets the height of the extension. Inherited from SettingsBase.
HtmlGets or sets the HTML markup specifying the HtmlEditor’s content.
ImagesProvides access to the settings that define images for various HtmlEditor elements.
ImagesEditorsProvides access to the settings that define images displayed within different editors used within the HtmlEditor and its dialog forms.
ImageSelectorFileUploadingObsolete. Enables you to perform server-side processing of file upload operations initiated within the HtmlEditor’s Select Image dialog.
ImageSelectorFolderCreatingObsolete. Enables you to perform server-side processing of folder creation operations, initiated within the HtmlEditor’s Select Image dialog.
ImageSelectorItemDeletingObsolete. Enables you to perform server-side processing of file/folder deletion operations initiated within the HtmlEditor’s Select Image dialog.
ImageSelectorItemMovingObsolete. Enables you to perform server-side processing of file/folder move operations initiated within the HtmlEditor’s Select Image dialog.
ImageSelectorItemRenamingObsolete. Enables you to perform server-side processing of file/folder rename operations initiated within the HtmlEditor’s Select Image dialog.
ImagesFileManagerProvides access to the settings that define images displayed within the FileManager’s elements.
InitEnables you to perform custom actions when an extension is initialized. Inherited from SettingsBase.
IsValidGets or sets a value that indicates whether the editor’s value passes validation.
NameSpecifies the unique identifier name for the extension. Inherited from SettingsBase.
PartsRoundPanelObsolete. Provides access to the settings that define different parts of the round panel used within the HtmlEditor’s dialogs.
PlaceholdersGets the collection of placeholders available in the HtmlEditor.
PreRenderAllows custom processing to be implemented before the extension is rendered to the page. Inherited from SettingsBase.
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.
RibbonContextTabCategoriesGets the collection of ribbon context tab categories.
RibbonTabsProvides access to the collection of UrlDocument$16848#Ribbon.Visual Elements tabs.
RightToLeftSpecifies whether to apply right-to-left representation to the extension.
RtfContentPastingProcessedRaised when the copied/cut RTF content is processed on the server.
SaveStateToCookiesGets or sets a value that specifies whether cookies are used to persist information about the HtmlEditor’s state.
SaveStateToCookiesIDGets or sets the name (identifier) of the cookie in which the HtmlEditor’s state is persisted.
SettingsProvides access to the HtmlEditor’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.
SettingsDialogFormElementsProvides access to settings relating to the 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.
SettingsFormsProvides access to settings that are related to customized built-in dialog forms (UserControls) stored within a web site.
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 are related to uploading images.
SettingsLoadingPanelProvides access to the loading panel’s settings.
SettingsPlaceholdersProvides access to placeholder settings.
SettingsResizeProvides access to settings that are related to the HTMLEditor’s sizing capabilities.
SettingsSpellCheckerProvides access to the spelling settings for checking the HtmlEditor’s content.
SettingsTextProvides access to the settings that define texts displayed in different elements (tabs) of the HtmlEditor.
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.
SkinIDGets or sets the skin to apply to the control. Inherited from SettingsBase.
SpellCheckerCustomDictionaryLoadingThis event occurs when a custom spell check dictionary is being loaded into a session.
SpellCheckerWordAddedAllows you to perform custom actions when a new word is added to a custom dictionary.
StyleGets a collection of all cascading style sheet (CSS) properties applied to an extension. Inherited from SettingsBase.
StylesProvides access to the style settings that control the appearance of the extension’s visual elements.
StylesButtonProvides access to the style settings that define the appearance of button elements used by the HtmlEditor (for instance, within its dialog forms).
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.
StylesEditorsProvides access to the style settings that define the appearance of editor elements used by the HtmlEditor (for instance, within its dialog forms).
StylesFileManagerProvides access to the style settings that define the appearance of File Manager elements used by the HtmlEditor (within the Select Image dialog).
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 panels used by the HtmlEditor (for instance, within its dialog forms).
StylesSpellCheckerProvides access to the style settings that define the appearance of elements used within the built-in Spell Checker’s dialog forms.
StylesStatusBarProvides access to the style settings that define the appearance of the editor’s status bar.
StylesToolbarsProvides access to the style settings that define the appearance of toolbars.
TabIndexGets or sets the tab index of the control element of the web page. Inherited from SettingsBase.
ThemeGets or sets the name of the theme to be applied to the extension. Inherited from SettingsBase.
ToolbarModeSpecifies the type of the HtmlEditor toolbar.
ToolbarsGets the collection of toolbars in the HtmlEditor.
ToolTipGets or sets a UI element’s tooltip text. Inherited from SettingsBase.
WidthGets or sets the width of the extension. Inherited from SettingsBase.

Methods

NameDescription
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ToString()Returns a string that represents the current object. Inherited from Object.

See Also

HtmlEditorSettings Class

DevExpress.Web.Mvc Namespace