ASPxWebControlBase Members
Represents the base class for all server controls.Constructors
| Name | Description |
|---|---|
| ASPxWebControlBase() | Initializes a new instance of the ASPxWebControlBase class with default settings. |
Properties
| Name | Description |
|---|---|
| AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl. |
| Adapter protected | Gets the browser-specific adapter for the control. Inherited from Control. |
| AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control. |
| Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl. |
| BackColor | Gets or sets the background color of the Web server control. Inherited from WebControl. |
| BindingContainer | Gets the control that contains this control’s data binding. Inherited from Control. |
| BorderColor | Gets or sets the border color of the Web control. Inherited from WebControl. |
| BorderStyle | Gets or sets the border style of the Web server control. Inherited from WebControl. |
| BorderWidth | Gets or sets the border width of the Web server control. Inherited from WebControl. |
| ChildControlsCreated protected | Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control. |
| ClientID | Gets the 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 the web control’s collection of child controls. |
| ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl. |
| ControlStyleCreated | Gets 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. |
| CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl. |
| 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. |
| DisabledCssClass static | Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl. |
| Enabled | Gets or sets a value indicating whether the Web server control is enabled. Inherited from WebControl. |
| EnableTheming | Gets or sets a value indicating whether themes apply to this control. Inherited from WebControl. |
| 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. |
| Font | Gets the font properties associated with the Web server control. Inherited from WebControl. |
| ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl. |
| HasAttributes | Gets a value indicating whether the control has attributes set. Inherited from WebControl. |
| HasChildViewState protected | Gets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control. |
| Height | Gets or sets the height of the Web server control. Inherited from WebControl. |
| 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. |
| Initialized | Gets a value indicating whether the web control has been initialized. |
| IsChildControlStateCleared protected | Gets a value indicating whether controls contained within this control have control state. Inherited from Control. |
| 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. |
| Loaded | Indicates whether a web control has been loaded into the Page object. |
| 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. |
| 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 WebControl. |
| Style | Gets 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. |
| SupportsDisabledAttribute |
Gets 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.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. |
| TabIndex | Gets or sets the tab index of the Web server control. Inherited from WebControl. |
| TagKey protected | Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl. |
| TagName protected | Gets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl. |
| 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. |
| ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl. |
| 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. |
| Width | Gets or sets the width of the Web server control. Inherited from WebControl. |
Methods
| Name | Description |
|---|---|
| AddAttributesToRender(HtmlTextWriter) protected | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. Inherited from WebControl. |
| 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. |
| ApplyStyle(Style) | Copies 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 WebControl. |
| 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. |
| CopyBaseAttributes(WebControl) | Copies the properties not encapsulated by the 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 WebControl. |
| CreateControlCollection() protected | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from Control. |
| CreateControlStyle() protected | Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. Inherited from WebControl. |
| 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. |
| 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. |
| 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. |
| 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. |
| GetDesignModeState() protected | Gets design-time data for a control. Inherited from Control. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| 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. |
| IsEnabled() | Returns a value that specifies whether a web control is enabled. |
| IsLiteralContent() protected | Determines if the server control holds only literal content. Inherited from Control. |
| IsVisible() | Returns a value that specifies whether the current web control is displayed. |
| LoadControlState(Object) protected | Restores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control. |
| LoadViewState(Object) protected | Restores view-state information from a previous request that was saved with the SaveViewState() method. Inherited from WebControl. |
| 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. |
| MergeStyle(Style) | Copies 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 WebControl. |
| 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. |
| OnDataBinding(EventArgs) protected | Raises the DataBinding 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. |
| RaiseBubbleEvent(Object, EventArgs) protected | Assigns any sources of the event and its information to the control’s parent. Inherited from Control. |
| 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. |
| RenderBeginTag(HtmlTextWriter) | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| 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. |
| RenderContents(HtmlTextWriter) protected | Renders the contents of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| 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. |
| RenderEndTag(HtmlTextWriter) | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| 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. |
| 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 state that was modified after the TrackViewState() method was invoked. Inherited from WebControl. |
| 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. |
| 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) | Gets an attribute of the Web control with the specified name. Inherited from WebControl. |
| IAttributeAccessor.SetAttribute(String, String) | Sets an attribute of the Web control to the specified name and value. Inherited from WebControl. |
| 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. |
| IParserAccessor.AddParsedSubObject(Object) | For a description of this member, see AddParsedSubObject(Object). Inherited from Control. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
| TrackViewState() protected | Causes the control to track changes to its view state so they can be stored in the object’s ViewState property. Inherited from WebControl. |
Events
| Name | Description |
|---|---|
| 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. |
| 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