Version

WebHtmlEditor Class Members

The following tables list the members exposed by WebHtmlEditor.

Public Constructors
 NameDescription
Public ConstructorWebHtmlEditor ConstructorInitializes a new instance of the WebHtmlEditor control.  
Public Fields
 NameDescription
Public FieldImageDirectoryDefaultEditor  
Public Properties
 NameDescription
Public PropertyAccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl object that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBackColorGets or sets the background color of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBackgroundImageNameGets or sets the name of the background image to display as the background of the WebHtmlEditor.  
Public PropertyBorderColorGets or sets the border color of the Web control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderStyleGets or sets the border style of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderWidthGets or sets the border width of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBottomMarginGets or sets the amount of space (in pixels) between the bottom edge of the editor and the TabStrip.  
Public PropertyBrowserTargetOverridden.   
Public PropertyButtonModeGets or sets ButtonMode value specifying the current mode of the toolbar buttons.  
Public PropertyButtonStyleGets a ButtonStyle object representing the style that will be applied to all classes derived from BaseToolbarButton on the toolbar.  
Public PropertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from System.Web.UI.Control)
Public PropertyClientIDModeGets or sets the algorithm that is used to generate the value of the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Public PropertyClientSideEventsThe ClientSideEvents object maintains the names of JavaScript functions that are to be called on the client side in response to various events that can be processed there without the need for a server post-back.  
Public PropertyColorPaletteSizeGets or sets a ColorPaletteSize value representing the color palette that the user can select from when editing HTML.  
Public PropertyControlsOverridden. Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.  
Public PropertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyControlStyleCreatedGets a value indicating whether a System.Web.UI.WebControls.Style object has been created for the System.Web.UI.WebControls.WebControl.ControlStyle property. This property is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCssClassCss class used for main html element of control.  
Public PropertyDialogStyleGets or sets a DialogStyle object representing the style that will be applied to all HtmlBoxDialog controls used by the WebHtmlEditor.  
Public PropertyDownlevelLabelRepresents the label rendered to the user if the WebHtmlEditor.DownlevelMode = DownlevelMode.Label.  
Public PropertyDownlevelModeControls whether the user sees a Label or a TextArea if their browser is incompatible with the WebHtmlEditor.  
Public PropertyDownlevelTextAreaRepresents the textarea control rendered to the user if the WebHtmlEditor.DownlevelMode = DownlevelMode.TextArea.  
Public PropertyDropDownStyleGets a Style object representing the style that will be applied to all ToolbarDropDown controls used by the WebHtmlEditor.  
Public PropertyEnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableSharePointCompatibilityGets or sets an option to render special css class which disables css selectors used by SharePoint Server 2010.  
Public PropertyEnableSpellCheckEnables spellcheck. Sets the html spellcheck attribute to the iframe or the div and relys on the spelling and grammar check of the browser.  
Public PropertyEnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableViewStateGets 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 System.Web.UI.Control)
Public PropertyExpandEffectsThe behavior of drop-down lists and dialogs at the time when they are opened.  
Public PropertyFocusControls whether or not the WebHtmlEditor receives the mouse focus when the page is loaded.  
Public PropertyFontGets the font properties associated with the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyFontFormattingListHigh-level "helper" collection which provides font formatting values to applicable ToolbarDropDown controls.  
Public PropertyFontNameListHigh-level "helper" collection which provides font name values to applicable ToolbarDropDown controls.  
Public PropertyFontSizeListHigh-level "helper" collection which provides font size values to applicable ToolbarDropDown controls.  
Public PropertyFontStyleListHigh-level "helper" collection which provides font style values to applicable ToolbarDropDown controls.  
Public PropertyForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHeightGets or sets the height of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from System.Web.UI.Control)
Public PropertyImageDirectoryOverridden. Gets or sets a virtual, relative, or absolute pathname of the directory containing all of the images used by the WebHtmlEditor.  
Public PropertyIsPostbackFromUploadGets a value specifying if the current page request was due to a postback from an HtmlBoxUpload control.  
Public PropertyJavaScriptDirectoryDirectory where client-script js files are located.  
Public PropertyLocalizationFileGets or sets a value specifying a file path to an XML file specifying localization strings.  
Public PropertyLocalizationTypeGets or sets a value which determines in what language strings are displayed  
Public PropertyMenuStyleGets a MenuStyle object representing the style that will be applied to all HtmlBoxMenu controls used by the WebHtmlEditor.  
Public PropertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same System.Web.UI.Control.ID property value. (Inherited from System.Web.UI.Control)
Public PropertyPageGets a reference to the System.Web.UI.Page instance that contains the server control. (Inherited from System.Web.UI.Control)
Public PropertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyPreviewFileNameName of file used for preview html  
Public PropertyProgressBarGets the HtmlBoxProgressBar representing the progressbar used for the WebHtmlEditor preload, if it is enabled.  
Public PropertyReadOnlyGets or sets a value which indicates whether the WebHtmlEditor should be an active HTML editor, or a read-only document viewer.  
Public PropertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from System.Web.UI.Control)
Public PropertyRightClickBehaviorGets or sets a value which indicates how the WebHtmlEditor should behave when it is right-clicked with the mouse.  
Public PropertyRightClickMenuGets an HtmlBoxMenu control representing the right-click menu displayed when the user right-clicks on the WebHtmlEditor with the mouse.  
Public PropertySection508CompliantOption to fill all alt and title attributes  
Public PropertySecureConnectionGets or sets a value which indicates if the WebHtmlEditor is being requested by a secure connection.  
Public PropertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from System.Web.UI.Control)
Public PropertySkinIDGets or sets the skin to apply to the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertySpecialCharacterListHigh-level "helper" collection which provides special character values to applicable ToolbarDialogButton controls.  
Public PropertyStartupModeGets or sets a StartupMode value indicating the startup mode of the WebHtmlEditor.  
Public PropertyStyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertySupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's System.Web.UI.WebControls.WebControl.IsEnabled property is false. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTabIndexGets or sets the tab index of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTabStripGets a HtmlBoxTabStrip object representing the tabstrip used by the WebHtmlEditor.  
Public PropertyTabStripDisplayVisibility of tab strip.  
Public PropertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyTemplateSourceDirectoryGets the virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl that contains the current server control. (Inherited from System.Web.UI.Control)
Public PropertyTextGets or sets the text displayed in the editor.  
Public PropertyTextPlainGets the value of the WebHtmlEditor.Text property stripped of any HTML tags.  
Public PropertyTextWindowGets an HtmlBoxTextWindow control representing the actual editing window of the WebHtmlEditor.  
Public PropertyTextXhtmlGets the value of the WebHtmlEditor.Text property converted to XHTML.  
Public PropertyToolbarGets an HtmlBoxToolbar control representing the toolbar.  
Public PropertyToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyTopMarginGets or sets the amount of space (in pixels) between the top edge of the editor and the toolbar.  
Public PropertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from System.Web.UI.Control)
Public PropertyUploadedFilesDirectoryGets or sets a virtual, relative, or absolute pathname of the directory where all files are uploaded.  
Public PropertyUseDefaultStylesAutomatically fill up missing style related properties of buttons and background images of toolbar.  
Public PropertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from System.Web.UI.Control)
Public PropertyViewStateModeGets or sets the view-state mode of this control. (Inherited from System.Web.UI.Control)
Public PropertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from System.Web.UI.Control)
Public PropertyWidthGets or sets the width of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Protected Properties
 NameDescription
Protected PropertyAdapterGets the browser-specific adapter for the control. (Inherited from System.Web.UI.Control)
Protected PropertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from System.Web.UI.Control)
Protected PropertyClientIDSeparatorGets a character value representing the separator character used in the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Protected PropertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from System.Web.UI.Control)
Protected PropertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from System.Web.UI.Control)
Protected PropertyIdSeparatorGets the character used to separate control identifiers. (Inherited from System.Web.UI.Control)
Protected PropertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from System.Web.UI.Control)
Protected PropertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by System.Web.UI.Control.ID instead of index. (Inherited from System.Web.UI.Control)
Protected PropertyPresetMaskResourcePath (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Protected PropertyTagKeyOverridden.   
Protected PropertyTagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyViewStateGets 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 System.Web.UI.Control)
Protected PropertyViewStateIgnoresCaseGets a value that indicates whether the System.Web.UI.StateBag object is case-insensitive. (Inherited from System.Web.UI.Control)
Public Methods
 NameDescription
Public MethodAddToolbarItemHigh-level "shortcut" method to quickly create, initialize, and add an item to the toolbar.  
Public MethodApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
Public MethodClearClears the WebHtmlEditor.  
Public MethodClearStylesClears the WebHtmlEditor.  
Public MethodCloneReturns a deep copy of the current object.  
Public MethodCopyBaseAttributesCopies the properties not encapsulated by the System.Web.UI.WebControls.WebControl.Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodDataBindOverloaded. Binds a data source to the invoked server control and all its child controls. (Inherited from System.Web.UI.Control)
Public MethodDisposeOverridden. Dispose control.  
Public MethodFindByKeyOrActionFind item by Key, Type or action.  
Public MethodFindControlOverloaded. Searches the current naming container for a server control with the specified id parameter. (Inherited from System.Web.UI.Control)
Public MethodFocusControls whether or not the WebHtmlEditor receives the mouse focus when the page is loaded. (Inherited from System.Web.UI.Control)
Public MethodGetRouteUrlOverloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control)
Public MethodGetUniqueIDRelativeToReturns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control)
Public MethodHasControlsDetermines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
Public MethodLoadPresetOverloaded. Sets properties on the control that effect Appearance, Behavior, or Both, based on the information in the predefined Preset File. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Public MethodLoadSkinLoad a predefined skin XML file.  
Public MethodMergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRenderBeginTagRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRenderControlOverloaded. Outputs server control content to a provided System.Web.UI.HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from System.Web.UI.Control)
Public MethodRenderEndTagOverridden. Renders the HTML opening tag of the control into the specified writer. This method is used primarily by control developers.  
Public MethodResetOverridden. Returns the WebHtmlEditor control to it's inital state.  
Public MethodResetButtonStyleClears the ButtonStyle  
Public MethodResetClientSideEventsClears the ClientSideEvents  
Public MethodResetDialogStyleClears the DialogStyle  
Public MethodResetDropDownStyleClears the DropDownStyle  
Public MethodResetExpandEffectsClears the ClientSideEvents  
Public MethodResetMenuStyleClears the MenuStyle  
Public MethodResolveClientUrlGets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
Public MethodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
Public MethodSavePresetOverloaded. Saves the properties of a control to a file, so that they can be used by another control via the LoadPreset method. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Public MethodSaveSkinOverloaded. Save the current WebHtmlEditor configuration as an XML skin file.  
Public MethodSetRenderMethodDelegateAssigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control)
Public MethodToStringReturns a string representation this object. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Protected Methods
 NameDescription
Protected MethodAddAttributesToRenderOverridden.   
Protected MethodAddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's System.Web.UI.ControlCollection object. (Inherited from System.Web.UI.Control)
Protected MethodBuildProfileTreeGathers information about the server control and delivers it to the System.Web.UI.Page.Trace property to be displayed when tracing is enabled for the page. (Inherited from System.Web.UI.Control)
Protected MethodClearCachedClientIDSets the cached System.Web.UI.Control.ClientID value to a null reference (Nothing in Visual Basic). (Inherited from System.Web.UI.Control)
Protected MethodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearEffectiveClientIDModeSets the System.Web.UI.Control.ClientIDMode property of the current control instance and of any child controls to System.Web.UI.ClientIDMode.Inherit. (Inherited from System.Web.UI.Control)
Protected MethodCreateControlCollectionCreates a new System.Web.UI.ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from System.Web.UI.Control)
Protected MethodCreateControlStyleOverridden. Documentation stub  
Protected MethodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from System.Web.UI.Control)
Protected MethodFindControlInPageFind child or descendant control in the Page object. (Inherited from Infragistics.WebUI.WebControls.WebControlBase)
Protected MethodGetDesignModeStateGets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from System.Web.UI.Control)
Protected MethodIsLiteralContentDetermines if the server control holds only literal content. (Inherited from System.Web.UI.Control)
Protected MethodLoadViewStateOverridden.   
Protected MethodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from System.Web.UI.Control)
Protected MethodOnDataBindingRaises the System.Web.UI.Control.DataBinding event. (Inherited from System.Web.UI.Control)
Protected MethodOnInitOverridden.   
Protected MethodOnLoadOverridden.   
Protected MethodOnPreRenderOverridden.   
Protected MethodOnTextChanged  
Protected MethodOnToolbarClick  
Protected MethodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from System.Web.UI.Control)
Protected MethodRenderOverridden.   
Protected MethodRenderContentsOverridden.   
Protected MethodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from System.Web.UI.Control)
Protected MethodSaveViewStateOverridden.   
Protected MethodSetDesignModeStateSets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodTrackViewStateOverridden.   
Public Events
 NameDescription
Public EventDataBindingOccurs when the server control binds to a data source. (Inherited from System.Web.UI.Control)
Public EventDisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from System.Web.UI.Control)
Public EventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control)
Public EventLoadOccurs when the server control is loaded into the System.Web.UI.Page object. (Inherited from System.Web.UI.Control)
Public EventPreRenderOccurs after the System.Web.UI.Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control)
Public EventTextChangedOccurs when the content of the WebHtmlEditor is changed upon server postback.  
Public EventToolbarClickRaised when a postback is raised by a toolbar button click.  
Public EventUnloadOccurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
See Also