Skip to main content
A newer version of this page is available. .

HtmlEditorUserControl Members

Represents a user control class to be used within the ASPxHtmlEditor.

Constructors

Name Description
HtmlEditorUserControl() Initializes a new instance of the HtmlEditorUserControl class with default settings.

Properties

Name Description
Adapter protected Gets the browser-specific adapter for the control. Inherited from Control.
Application Gets the Application object for the current Web request. Inherited from UserControl.
AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AppRelativeVirtualPath Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled. Inherited from TemplateControl.
Attributes Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file. Inherited from UserControl.
AutoHandlers protected The AutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code. Inherited from TemplateControl.
BindingContainer Gets the control that contains this control’s data binding. Inherited from Control.
Cache Gets the Cache object that is associated with the application that contains the user control. Inherited from UserControl.
CachePolicy Gets a reference to a collection of caching parameters for this user control. Inherited from UserControl.
ChildControlsCreated protected Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientID Gets the user control’s identifier generated by ASP.NET.
ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protected Gets a character value representing the separator character used in the ClientID property. Inherited from Control.
Context protected Gets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
Controls Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. Inherited from Control.
DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DesignMode protected Gets a value indicating whether a control is being used on a design surface. Inherited from Control.
EnableTheming Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class. Inherited from TemplateControl.
EnableViewState Gets 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.
Events protected Gets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
HasChildViewState protected Gets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
ID Gets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protected Gets the character used to separate control identifiers. Inherited from Control.
IsChildControlStateCleared protected Gets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsPostBack Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time. Inherited from UserControl.
IsTrackingViewState protected Gets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsViewStateEnabled protected Gets a value indicating whether view state is enabled for this control. Inherited from Control.
LoadViewStateByID protected Gets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
NamingContainer Gets 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.
Page Gets a reference to the Page instance that contains the server control. Inherited from Control.
Parent Gets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
Request Gets the HttpRequest object for the current Web request. Inherited from UserControl.
Response Gets the HttpResponse object for the current Web request. Inherited from UserControl.
Server Gets the HttpServerUtility object for the current Web request. Inherited from UserControl.
Session Gets the HttpSessionState object for the current Web request. Inherited from UserControl.
Site Gets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinID Gets or sets the skin to apply to the control. Inherited from Control.
SupportAutoEvents protected Gets a value indicating whether the TemplateControl control supports automatic events. Inherited from TemplateControl.
IControlBuilderAccessor.ControlBuilder For a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserData For a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindings For a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindings For a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.Expressions For a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressions For a description of this member, see HasExpressions. Inherited from Control.
IUserControlDesignerAccessor.InnerText Gets or sets the text that appears between the opening and closing tags of a user control. Inherited from UserControl.
IUserControlDesignerAccessor.TagName Gets or sets the full tag name of the user control. Inherited from UserControl.
TemplateControl Gets or sets a reference to the template that contains this control. Inherited from Control.
TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
Trace Gets the TraceContext object for the current Web request. Inherited from UserControl.
UniqueID Gets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestMode Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewState protected Gets 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 protected Gets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateMode Gets or sets the view-state mode of this control. Inherited from Control.
Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page. Inherited from Control.

Methods

Name Description
AddedControl(Control, Int32) protected Called after a child control is added to the Controls collection of the Control object. Inherited from Control.
AddParsedSubObject(Object) protected Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control’s ControlCollection object. Inherited from Control.
ApplyStyleSheetSkin(Page) Applies the style properties defined in the page style sheet to the control. Inherited from Control.
BeginRenderTracing(TextWriter, Object) protected Begins design-time tracing of rendering data. Inherited from Control.
BuildProfileTree(String, Boolean) protected Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. Inherited from Control.
ClearCachedClientID() protected Sets the cached ClientID value to null. Inherited from Control.
ClearChildControlState() protected Deletes the control-state information for the server control’s child controls. Inherited from Control.
ClearChildState() protected Deletes the view-state and control-state information for all the server control’s child controls. Inherited from Control.
ClearChildViewState() protected Deletes the view-state information for all the server control’s child controls. Inherited from Control.
ClearEffectiveClientIDMode() protected Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. Inherited from Control.
Construct() protected Performs design-time logic. Inherited from TemplateControl.
CreateChildControls() protected Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. Inherited from Control.
CreateControlCollection() protected Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from Control.
CreateResourceBasedLiteralControl(Int32, Int32, Boolean) protected Accesses literal strings stored in a resource. The CreateResourceBasedLiteralControl(Int32, Int32, Boolean) method is not intended for use from within your code. Inherited from TemplateControl.
DataBind() Binds a data source to the invoked server control and all its child controls. Inherited from Control.
DataBind(Boolean) protected Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. Inherited from Control.
DataBindChildren() protected Binds a data source to the server control’s child controls. Inherited from Control.
DesignerInitialize() Performs any initialization steps on the user control that are required by RAD designers. Inherited from UserControl.
Dispose() Enables a server control to perform final clean up before it is released from memory. Inherited from Control.
EndRenderTracing(TextWriter, Object) protected Ends design-time tracing of rendering data. Inherited from Control.
EnsureChildControls() protected Determines whether the server control contains child controls. If it does not, it creates child controls. Inherited from Control.
EnsureID() protected Creates an identifier for controls that do not have an identifier assigned. Inherited from Control.
Equals(Object, Object) static Determines 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.
Eval(String, String) protected Evaluates a data-binding expression using the specified format string to display the result. Inherited from TemplateControl.
Eval(String) protected Evaluates a data-binding expression. Inherited from TemplateControl.
FindControl(String, Int32) protected Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. Inherited from Control.
FindControl(String) Searches the current naming container for a server control with the specified id parameter. Inherited from Control.
Focus() Sets input focus to a control. Inherited from Control.
FrameworkInitialize() protected Initializes the control that is derived from the TemplateControl class. Inherited from TemplateControl.
GetDesignModeState() protected Gets design-time data for a control. Inherited from Control.
GetGlobalResourceObject(String, String, Type, String) protected Gets an application-level resource object based on the specified ClassKey and ResourceKey properties, object type, and property name of the resource. Inherited from TemplateControl.
GetGlobalResourceObject(String, String) protected Gets an application-level resource object based on the specified ClassKey and ResourceKey properties. Inherited from TemplateControl.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLocalResourceObject(String, Type, String) protected Gets a page-level resource object based on the specified ResourceKey property, object type, and property name. Inherited from TemplateControl.
GetLocalResourceObject(String) protected Gets a page-level resource object based on the specified ResourceKey property. Inherited from TemplateControl.
GetRouteUrl(Object) Gets the URL that corresponds to a set of route parameters. Inherited from Control.
GetRouteUrl(String, Object) Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control.
GetRouteUrl(String, RouteValueDictionary) Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control.
GetRouteUrl(RouteValueDictionary) Gets the URL that corresponds to a set of route parameters. Inherited from Control.
GetType() Gets the Type of the current instance. Inherited from Object.
GetUniqueIDRelativeTo(Control) Returns the prefixed portion of the UniqueID property of the specified control. Inherited from Control.
HasControls() Determines if the server control contains any child controls. Inherited from Control.
HasEvents() protected Returns a value indicating whether events are registered for the control or any child controls. Inherited from Control.
InitializeAsUserControl(Page) Initializes the UserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly. Inherited from UserControl.
IsLiteralContent() protected Determines if the server control holds only literal content. Inherited from Control.
LoadControl(String) Loads a Control object from a file based on a specified virtual path. Inherited from TemplateControl.
LoadControl(Type, Object[]) Loads a Control object based on a specified type and constructor parameters. Inherited from TemplateControl.
LoadControlState(Object) protected Restores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control.
LoadTemplate(String) Obtains an instance of the ITemplate interface from an external file. Inherited from TemplateControl.
LoadViewState(Object) protected Restores the view-state information from a previous user control request that was saved by the SaveViewState() method. Inherited from UserControl.
MapPath(String) Assigns a virtual file path, either absolute or relative, to a physical file path. Inherited from UserControl.
MapPathSecure(String) protected Retrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnAbortTransaction(EventArgs) protected Raises the AbortTransaction event. Inherited from TemplateControl.
OnBubbleEvent(Object, EventArgs) protected Determines whether the event for the server control is passed up the page’s UI server control hierarchy. Inherited from Control.
OnCommitTransaction(EventArgs) protected Raises the CommitTransaction event. Inherited from TemplateControl.
OnDataBinding(EventArgs) protected Raises the DataBinding event. Inherited from Control.
OnError(EventArgs) protected Raises the Error event. Inherited from TemplateControl.
OnPreRender(EventArgs) protected Raises the PreRender event. Inherited from Control.
OnUnload(EventArgs) protected Raises the Unload event. Inherited from Control.
OpenFile(String) protected Gets a Stream used to read a file. Inherited from Control.
ParseControl(String, Boolean) Parses an input string into a Control object on the ASP.NET Web page or user control. Inherited from TemplateControl.
ParseControl(String) Parses an input string into a Control object on the Web Forms page or user control. Inherited from TemplateControl.
RaiseBubbleEvent(Object, EventArgs) protected Assigns any sources of the event and its information to the control’s parent. Inherited from Control.
ReadStringResource() Reads a string resource. The ReadStringResource() method is not intended for use from within your code. Inherited from TemplateControl.
ReadStringResource(Type) static Reads a string resource. The ReadStringResource(Type) method is not intended for use from within your code. Inherited from TemplateControl.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemovedControl(Control) protected Called after a child control is removed from the Controls collection of the Control object. Inherited from Control.
Render(HtmlTextWriter) protected Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control.
RenderChildren(HtmlTextWriter) protected Outputs the content of a server control’s children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control.
RenderControl(HtmlTextWriter, ControlAdapter) protected Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control.
RenderControl(HtmlTextWriter) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. Inherited from Control.
ResolveAdapter() protected Gets the control adapter responsible for rendering the specified control. Inherited from Control.
ResolveClientUrl(String) Gets a URL that can be used by the browser. Inherited from Control.
ResolveUrl(String) Converts a URL into one that is usable on the requesting client. Inherited from Control.
SaveControlState() protected Saves any server control state changes that have occurred since the time the page was posted back to the server. Inherited from Control.
SaveViewState() protected Saves any user control view-state changes that have occurred since the last page postback. Inherited from UserControl.
SetDesignModeState(IDictionary) protected Sets design-time data for a control. Inherited from Control.
SetRenderMethodDelegate(RenderMethod) Assigns an event handler delegate to render the server control and its content into its parent control. Inherited from Control.
SetStringResourcePointer(Object, Int32) protected Sets a pointer to a string resource. The SetStringResourcePointer(Object, Int32) method is used by generated classes and is not intended for use from within your code. Inherited from TemplateControl.
SetTraceData(Object, Object, Object) Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. Inherited from Control.
SetTraceData(Object, Object) Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. Inherited from Control.
IAttributeAccessor.GetAttribute(String) Returns the value of the specified user control attribute. Inherited from UserControl.
IAttributeAccessor.SetAttribute(String, String) Sets the value of the specified user control attribute. Inherited from UserControl.
IControlDesignerAccessor.GetDesignModeState() For a description of this member, see GetDesignModeState(). Inherited from Control.
IControlDesignerAccessor.SetDesignModeState(IDictionary) For a description of this member, see SetDesignModeState(IDictionary). Inherited from Control.
IControlDesignerAccessor.SetOwnerControl(Control) For a description of this member, see SetOwnerControl(Control). Inherited from Control.
IFilterResolutionService.CompareFilters(String, String) Returns a value that indicates whether a parent/child relationship exists between two specified device filters. Inherited from TemplateControl.
IFilterResolutionService.EvaluateFilter(String) Returns a value that indicates whether the specified filter is a type of the current filter object. Inherited from TemplateControl.
IParserAccessor.AddParsedSubObject(Object) For a description of this member, see AddParsedSubObject(Object). Inherited from Control.
TestDeviceFilter(String) Returns a Boolean value indicating whether a device filter applies to the HTTP request. Inherited from TemplateControl.
ToString() Returns a string that represents the current object. Inherited from Object.
TrackViewState() protected Causes tracking of view-state changes to the server control so they can be stored in the server control’s StateBag object. This object is accessible through the ViewState property. Inherited from Control.
TryUpdateModel<TModel>(TModel, IValueProvider) Attempts to update the model instance using values from the value provider. Inherited from UserControl.
TryUpdateModel<TModel>(TModel) Attempts to update the model instance by using the values from the data-bound control. Inherited from UserControl.
UpdateModel<TModel>(TModel, IValueProvider) Updates the specified model instance using values from the value provider of the user control. Inherited from UserControl.
UpdateModel<TModel>(TModel) Updates the model instance by using values from the data-bound control. Inherited from UserControl.
WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) protected Writes a resource string to an HtmlTextWriter control. The WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) method is used by generated classes and is not intended for use from within your code. Inherited from TemplateControl.
XPath(String, String, IXmlNamespaceResolver) protected Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result. Inherited from TemplateControl.
XPath(String, String) protected Evaluates an XPath data-binding expression using the specified format string to display the result. Inherited from TemplateControl.
XPath(String, IXmlNamespaceResolver) protected Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution. Inherited from TemplateControl.
XPath(String) protected Evaluates an XPath data-binding expression. Inherited from TemplateControl.
XPathSelect(String, IXmlNamespaceResolver) protected Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the IEnumerable interface. Inherited from TemplateControl.
XPathSelect(String) protected Evaluates an XPath data-binding expression and returns a node collection that implements the IEnumerable interface. Inherited from TemplateControl.

Events

Name Description
AbortTransaction Occurs when a user ends a transaction. Inherited from TemplateControl.
CommitTransaction Occurs when a transaction completes. Inherited from TemplateControl.
DataBinding Occurs when the server control binds to a data source. Inherited from Control.
Disposed Occurs 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 Control.
Error Occurs when an unhandled exception is thrown. Inherited from TemplateControl.
Init Occurs when the server control is initialized, which is the first step in its lifecycle. Inherited from Control.
Load Occurs when the server control is loaded into the Page object. Inherited from Control.
PreRender Occurs after the Control object is loaded but prior to rendering. Inherited from Control.
Unload Occurs when the server control is unloaded from memory. Inherited from Control.
See Also