Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

UserControl Members

UserControl overview

Public Instance Constructors

UserControl Constructor Initialize a new UserControl instance.

Public Instance Properties

Application (inherited from UserControl)Gets the Application object for the current Web request.
ApplicationContext Gets or sets the IApplicationContext that this object runs in.
AppRelativeTemplateSourceDirectory (inherited from Control)Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
AppRelativeVirtualPath (inherited from TemplateControl)Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled.
Args A convenience, case-insensitive table that may be used to e.g. pass data into SpEL expressions"/>.
Attributes (inherited from UserControl)Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.
BindingContainer (inherited from Control)Gets the control that contains this control's data binding.
BindingManager Gets the binding manager for this control.
Cache (inherited from UserControl)Gets the Cache object that is associated with the application that contains the user control.
CachePolicy (inherited from UserControl)Gets a reference to a collection of caching parameters for this user control.
ClientID (inherited from Control)Gets the server control identifier generated by ASP.NET.
Context Publish HttpContext associated with this page for convenient usage in Binding Expressions
Controller Gets or sets controller for the control.
Controls (inherited from Control)Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
EnableTheming (inherited from TemplateControl)Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class.
EnableViewState (inherited from Control)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.
ID (inherited from Control)Gets or sets the programmatic identifier assigned to the server control.
IsPostBack (inherited from UserControl)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.
Localizer Gets or sets the localizer.
MessageSource Gets or sets the local message source.
ModelPersistenceMedium Set the IModelPersistenceMedium strategy for storing model instances between requests.
NamingContainer (inherited from Control)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.
PageOverloaded. Overrides Page property to return Page instead of Page.
Parent (inherited from Control)Gets a reference to the server control's parent control in the page control hierarchy.
Request (inherited from UserControl)Gets the HttpRequest object for the current Web request.
Response (inherited from UserControl)Gets the HttpResponse object for the current Web request.
Results Gets or sets map of result names to target URLs
Server (inherited from UserControl)Gets the HttpServerUtility object for the current Web request.
Session (inherited from UserControl)Gets the HttpSessionStateobject for the current Web request.
Site (inherited from Control)Gets information about the container that hosts the current control when rendered on a design surface.
SkinID (inherited from Control)Gets or sets the skin to apply to the control.
TemplateControl (inherited from Control)Gets or sets a reference to the template that contains this control.
TemplateSourceDirectory (inherited from Control)Gets the virtual directory of the Page or UserControl that contains the current server control.
Trace (inherited from UserControl)Gets the TraceContext object for the current Web request.
UniqueID (inherited from Control)Gets the unique, hierarchically qualified identifier for the server control.
UserCulture Gets or sets user's culture
ValidationErrors Gets or sets the validation errors container.
Visible (inherited from Control)Gets or sets a value that indicates whether a server control is rendered as UI on the page.
WebNavigator Gets/Sets the navigator to be used for handling SetResult calls.

Public Instance Methods

ApplyStyleSheetSkin (inherited from Control)Applies the style properties defined in the page style sheet to the control.
DataBind (inherited from Control)Overloaded. Binds a data source to the invoked server control and all its child controls.
DesignerInitialize (inherited from UserControl)Performs any initialization steps on the user control that are required by RAD designers.
Dispose (inherited from Control)Enables a server control to perform final clean up before it is released from memory.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
FindControl (inherited from Control)Overloaded. Searches the current naming container for a server control with the specified id parameter.
Focus (inherited from Control)Sets input focus to a control.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetMessageOverloaded. Returns message for the specified resource name.
GetResourceObject Returns resource object for the specified resource name.
GetType (inherited from Object)Gets the Type of the current instance.
HasControls (inherited from Control)Determines if the server control contains any child controls.
InitializeAsUserControl (inherited from UserControl)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.
LoadTemplate (inherited from TemplateControl)Obtains an instance of the ITemplate interface from an external file.
MapPath (inherited from UserControl)Assigns a virtual file path, either absolute or relative, to a physical file path.
ParseControl (inherited from TemplateControl)Overloaded. Parses an input string into a Control object on the Web Forms page or user control.
ReadStringResource (inherited from TemplateControl)Reads a string resource. The ReadStringResource method is not intended for use from within your code.
RenderControl (inherited from Control)Overloaded. Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
ResolveClientUrl (inherited from Control)Gets a URL that can be used by the browser.
ResolveUrl (inherited from Control)Converts a URL into one that is usable on the requesting client.
SetRenderMethodDelegate (inherited from Control)Assigns an event handler delegate to render the server control and its content into its parent control.
TestDeviceFilter (inherited from TemplateControl)Returns a Boolean value indicating whether a device filter applies to the HTTP request.
ToString (inherited from Object)Returns a String that represents the current Object.
Validate Evaluates specified validators and returns True if all of them are valid.

Public Instance Events

AbortTransaction (inherited from TemplateControl)Occurs when a user ends a transaction.
CommitTransaction (inherited from TemplateControl)Occurs when a transaction completes.
DataBinding (inherited from Control)Occurs when the server control binds to a data source.
DataBindingsInitialized This event is raised after BindingManager as been initialized.
DataBound This event is raised after all controls have been populated with values from the data model.
DataUnbound This event is raised after data model has been populated with values from web controls.
Disposed (inherited from Control)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.
Error (inherited from TemplateControl)Occurs when an unhandled exception is thrown.
Init (inherited from Control)Occurs when the server control is initialized, which is the first step in its lifecycle.
InitializeControls This event is raised before Load event and should be used to initialize controls as necessary.
Load (inherited from Control)Occurs when the server control is loaded into the Page object.
PreLoadViewState PreLoadViewState event.
PreRender (inherited from Control)Occurs after the Control object is loaded but prior to rendering.
Unload (inherited from Control)Occurs when the server control is unloaded from memory.

Protected Instance Properties

Adapter (inherited from Control)Gets the browser-specific adapter for the control.
AutoHandlers (inherited from TemplateControl)Obsolete. 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.
ChildControlsCreated (inherited from Control)Gets a value that indicates whether the server control's child controls have been created.
ClientIDSeparator (inherited from Control)Gets a character value representing the separator character used in the ClientID property.
DesignMode (inherited from Control)Gets a value indicating whether a control is being used on a design surface.
Events (inherited from Control)Gets a list of event handler delegates for the control. This property is read-only.
HasChildViewState (inherited from Control)Gets a value indicating whether the current server control's child controls have any saved view-state settings.
IdSeparator (inherited from Control)Gets the character used to separate control identifiers.
IsChildControlStateCleared (inherited from Control)Gets a value indicating whether controls contained within this control have control state.
IsTrackingViewState (inherited from Control)Gets a value that indicates whether the server control is saving changes to its view state.
IsViewStateEnabled (inherited from Control)Gets a value indicating whether view state is enabled for this control.
LoadViewStateByID (inherited from Control)Gets a value indicating whether the control participates in loading its view state by ID instead of index.
SharedState Returns a thread-safe dictionary that contains state that is shared by all instances of this control.
SupportAutoEvents (inherited from TemplateControl)Gets a value indicating whether the TemplateControl control supports automatic events.
ViewState (inherited from Control)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.
ViewStateIgnoresCase (inherited from Control)Gets a value that indicates whether the StateBag object is case-insensitive.

Protected Instance Methods

AddedControl Injects dependencies into control before adding it.
AddParsedSubObject (inherited from Control)Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
BindFormData Bind data from model to form.
BuildProfileTree (inherited from Control)Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
ClearChildControlState (inherited from Control)Deletes the control-state information for the server control's child controls.
ClearChildState (inherited from Control)Deletes the view-state and control-state information for all the server control's child controls.
ClearChildViewState (inherited from Control)Deletes the view-state information for all the server control's child controls.
Construct (inherited from TemplateControl)Performs design-time logic.
CreateBindingManager Creates a new IBindingContainer instance.
CreateChildControls (inherited from Control)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.
CreateControlCollection (inherited from Control)Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
CreateResourceBasedLiteralControl (inherited from TemplateControl)Accesses literal strings stored in a resource. The CreateResourceBasedLiteralControl method is not intended for use from within your code.
CreateSharedStateKey Creates a key for shared state, taking into account whether this page belongs to a process or not.
CreateValidatorParameters Creates the validator parameters.
DataBind (inherited from Control)Overloaded. Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
DataBindChildren (inherited from Control)Binds a data source to the server control's child controls.
EnsureChildControls (inherited from Control)Determines whether the server control contains child controls. If it does not, it creates child controls.
EnsureID (inherited from Control)Creates an identifier for controls that do not have an identifier assigned.
Eval (inherited from TemplateControl)Overloaded. Evaluates a data-binding expression.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
FindControl (inherited from Control)Overloaded. 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 method.
FrameworkInitialize (inherited from TemplateControl)Initializes the control that is derived from the TemplateControl class.
GetBindingManagerKey Returns the key to be used for looking up a cached BindingManager instance in SharedState.
GetControllerReturns the controller stored by SetController.
GetDesignModeState (inherited from Control)Gets design-time data for a control.
GetGlobalResourceObject (inherited from TemplateControl)Overloaded. Gets an application-level resource object based on the specified ClassKey and ResourceKey properties.
GetLocalResourceObject (inherited from TemplateControl)Overloaded. Gets a page-level resource object based on the specified ResourceKey property.
GetResultUrlOverloaded. Returns a redirect url string that points to the TargetPage defined by this result evaluated using this Page for expression
HasEvents (inherited from Control)Returns a value indicating whether events are registered for the control or any child controls.
InitializeDataBindings Initializes the data bindings.
InitializeMessageSource Initializes local message source
InitializeModel Initializes data model when the page is first loaded.
InitializeNavigationSupport Ensure, that WebNavigator is set to a valid instance.
IsLiteralContent (inherited from Control)Determines if the server control holds only literal content.
LoadControlOverloaded. Obtains a UserControl object from a user control file and injects dependencies according to Spring config file.
LoadControlState (inherited from Control)Restores control-state information from a previous page request that was saved by the SaveControlState method.
LoadModel Loads the saved data model on postback.
LoadModelFromPersistenceMedium Retrieves data model from a persistence store.
LoadPostData This method is called during a postback if this control has been visible when being rendered to the client.
LoadViewState (inherited from UserControl)Restores the view-state information from a previous user control request that was saved by the SaveViewState method.
MapPathSecure (inherited from Control)Retrieves the physical path that a virtual path, either absolute or relative, maps to.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
OnAbortTransaction (inherited from TemplateControl)Raises the AbortTransaction event.
OnBubbleEvent (inherited from Control)Determines whether the event for the server control is passed up the page's UI server control hierarchy.
OnCommitTransaction (inherited from TemplateControl)Raises the CommitTransaction event.
OnDataBinding (inherited from Control)Raises the DataBinding event.
OnDataBindingsInitialized Raises the DataBindingsInitialized event.
OnDataBound Raises DataBound event.
OnDataUnbound Raises DataBound event.
OnError (inherited from TemplateControl)Raises the Error event.
OnInit Initializes user control.
OnInitializeControls Raises InitializeControls event.
OnLoad First unbinds data from the controls into a data model and then raises Load event in order to execute all associated handlers.
OnPreLoadViewState Raises the PreLoadViewState event after page initialization.
OnPreRender Binds data from the data model into controls and raises PreRender event afterwards.
OnUnload (inherited from Control)Raises the Unload event.
OpenFile (inherited from Control)Gets a Stream used to read a file.
RaiseBubbleEvent (inherited from Control)Assigns any sources of the event and its information to the control's parent.
RaisePostDataChangedEvent When implemented by a class, signals the server control object to notify the ASP.NET application that the state of the control has changed.
RemovedControl (inherited from Control)Called after a control is removed from the Controls collection of another control.
Render (inherited from Control)Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
RenderChildren (inherited from Control)Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
RenderControl (inherited from Control)Overloaded. Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
ResolveAdapter (inherited from Control)Gets the control adapter responsible for rendering the specified control.
SaveControlState (inherited from Control)Saves any server control state changes that have occurred since the time the page was posted back to the server.
SaveModel Returns a model object that should be saved.
SaveModelToPersistenceMedium Saves data model to a persistence store.
SaveViewState (inherited from UserControl)Saves any user control view-state changes that have occurred since the last page postback.
SetControllerStores the controller to be returned by Controller property.
SetDesignModeState (inherited from Control)Sets design-time data for a control.
SetResultOverloaded. Redirects user to a URL mapped to specified result name.
SetStringResourcePointer (inherited from TemplateControl)Sets a pointer to a string resource. The SetStringResourcePointer method is used by generated classes and is not intended for use from within your code.
TrackViewState (inherited from Control)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.
UnbindFormData Unbind data from form to model.
WriteUTF8ResourceString (inherited from TemplateControl)Writes a resource string to an HtmlTextWriter control. The WriteUTF8ResourceString method is used by generated classes and is not intended for use from within your code.
XPath (inherited from TemplateControl)Overloaded. Evaluates an XPath data-binding expression.
XPathSelect (inherited from TemplateControl)Overloaded. Evaluates an XPath data-binding expression and returns a node collection that implements the IEnumerable interface.

Explicit Interface Implementations

IAttributeAccessor.GetAttribute (inherited from UserControl) 
IAttributeAccessor.SetAttribute (inherited from UserControl) 
IControlDesignerAccessor.GetDesignModeState (inherited from Control) 
IControlDesignerAccessor.SetDesignModeState (inherited from Control) 
IControlDesignerAccessor.SetOwnerControl (inherited from Control) 
IFilterResolutionService.CompareFilters (inherited from TemplateControl) 
IFilterResolutionService.EvaluateFilter (inherited from TemplateControl) 
IParserAccessor.AddParsedSubObject (inherited from Control) 
IPostBackDataHandler.LoadPostData This method is called during a postback if this control has been visible when being rendered to the client.
IPostBackDataHandler.RaisePostDataChangedEvent When implemented by a class, signals the server control object to notify the ASP.NET application that the state of the control has changed.
ISupportsWebDependencyInjection.DefaultApplicationContext Holds the default ApplicationContext to be used during DI.

See Also

UserControl Class | Spring.Web.UI Namespace