The version that you requested is unavailable. We've redirected you to the latest version of the help.
Version

ControlObject Class Members

The following tables list the members exposed by ControlObject.

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 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 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 PropertyControlsGets a System.Web.UI.ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from System.Web.UI.Control)
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 PropertyCssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from System.Web.UI.WebControls.WebControl)
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 PropertyFontGets the font properties associated with the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
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 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 PropertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from System.Web.UI.Control)
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 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 PropertyTemplate  
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 PropertyToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from System.Web.UI.Control)
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 PropertyFlagsStores all the ClientUIFlags into one integer, that will be passed down to the client in the Client Property Array.  
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 PropertyPropCount  
Protected PropertyStateBot  
Protected PropertyTagKeyGets the System.Web.UI.HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
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 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 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 MethodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from System.Web.UI.Control)
Public MethodEnsureTemplateOverloaded.   
Public MethodFindControlOverloaded. Overridden. 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 Overload method.  
Public MethodFocusSets input focus to a control. (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 MethodIsDirtyOverloaded. Public shortcut to check if object has had data changes  
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 MethodRenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
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 MethodSetRenderMethodDelegateAssigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control)
Public MethodSetValueOverloaded. Sets an object value so that it is maintained in viewstate  
Protected Methods
 NameDescription
Protected MethodAddAttributesToRenderAdds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
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 MethodCreateControlStyleCreates the style object that is used internally by the System.Web.UI.WebControls.WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
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 MethodEnsureFlagTo be used in EnsureFlags. This method stores the ClientUIFlag in the private flags Hashtable.  
Protected MethodEnsureFlagsTo be overriden by base controls. This is where each control can set the default values for each ClientUIFlag that should be set. TO register a flag they should call EnsureFlag(ClientUIFlags, value).  
Protected MethodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from System.Web.UI.Control)
Protected MethodGetClientPropertiesArray  
Protected MethodGetDesignModeStateGets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodGetValueOverloaded. Obtains a property value from ClientState based on the string id define as a constant in the derived class.  
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 MethodLoadClientCollectionsLoads the Collections that were sent down to the client, back into the control.  
Protected MethodLoadClientObjectsLoads the Objects that were sent down to the client, back into the control.  
Protected MethodLoadClientProperties  
Protected MethodLoadClientState  
Protected MethodLoadOccasionalProperties  
Protected MethodLoadOccasionalProperty  
Protected MethodLoadPositionalProperties  
Protected MethodLoadPositionalProperty  
Protected MethodLoadTransationList  
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 MethodOnPropertyChangeVirtual method that is called whenever a property within the object has been changed.  
Protected MethodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from System.Web.UI.Control)
Protected MethodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from System.Web.UI.Control)
Protected MethodSaveClientCollectionsSaves all Collections that should go to the client into a javascript array.  
Protected MethodSaveClientObjectsSaves all objects that should go to the client into a javascript array.  
Protected MethodSaveClientProperties  
Protected MethodSaveViewStateOverridden.   
Protected MethodSetDesignModeStateSets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodTrackViewStateCauses the control to track changes to its view state so they can be stored in the object's System.Web.UI.Control.ViewState property. (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodWriteClientOnlyProperty  
Protected MethodWriteClientState  
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 EventUnloadOccurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
See Also