.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
The page you are viewing does not exist in the .NET Standard 2.0+ platform documentation. This link will take you to the parent topic of the current section.
.NET Core 3.0+
The page you are viewing does not exist in the .NET Core 3.0+ platform documentation. This link will take you to the parent topic of the current section.

BaseXafPage Methods

An abstract ancestor for classes that implement Web Forms pages used in ASP.NET XAF applications.
Name Description
AddContentTemplate(String, ITemplate) protected Called during page initialization to create a collection of content (from content controls) that is handed to a master page, if the current page or master page refers to a master page. Inherited from Page.
AddedControl(Control, Int32) protected Called after a child control is added to the Controls collection of the Control object. Inherited from Control.
AddOnPreRenderCompleteAsync(BeginEventHandler, EndEventHandler) Registers beginning and ending event handler delegates that do not require state information for an asynchronous page. Inherited from Page.
AddOnPreRenderCompleteAsync(BeginEventHandler, EndEventHandler, Object) Registers beginning and ending event handler delegates for an asynchronous page. Inherited from Page.
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.
AddWrappedFileDependencies(Object) protected Adds a list of dependent files that make up the current page. This method is used internally by the ASP.NET page framework and is not intended to be used directly from your code. Inherited from Page.
ApplyStyleSheetSkin(Page) Applies the style properties defined in the page style sheet to the control. Inherited from Control.
AspCompatBeginProcessRequest(HttpContext, AsyncCallback, Object) protected Initiates a request for Active Server Page (ASP) resources. This method is provided for compatibility with legacy ASP applications. Inherited from Page.
AspCompatEndProcessRequest(IAsyncResult) protected Terminates a request for Active Server Page (ASP) resources. This method is provided for compatibility with legacy ASP applications. Inherited from Page.
AsyncPageBeginProcessRequest(HttpContext, AsyncCallback, Object) protected Begins processing an asynchronous page request. Inherited from Page.
AsyncPageEndProcessRequest(IAsyncResult) protected Ends processing an asynchronous page request. Inherited from Page.
BeginRenderTracing(TextWriter, Object) protected Begins design-time tracing of rendering data. Inherited from Control.
BeginUpdate() Prevents the BaseXafPage's control from being updated until the BaseXafPage.EndUpdate method is called.
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.
CreateHtmlTextWriter(TextWriter) protected Creates an HtmlTextWriter object to render the page's content. Inherited from Page.
CreateHtmlTextWriterFromType(TextWriter, Type) static Creates a specified HtmlTextWriter object to render the page's content. Inherited from Page.
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 of the instance of the Page class that is required by RAD designers. This method is used only at design time. Inherited from Page.
DeterminePostBackMode() protected Returns a NameValueCollection of data posted back to the page using either a POST or a GET command. Inherited from Page.
DeterminePostBackModeUnvalidated() protected Returns a name-value collection of data that was posted to the page using either a POST or a GET command, without performing ASP.NET request validation on the request. Inherited from Page.
Dispose() Disposes the BaseXafPage object.
EndRenderTracing(TextWriter, Object) protected Ends design-time tracing of rendering data. Inherited from Control.
EndUpdate()
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) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Eval(String) protected Evaluates a data-binding expression. Inherited from TemplateControl.
Eval(String, String) protected Evaluates a data-binding expression using the specified format string to display the result. Inherited from TemplateControl.
ExecuteRegisteredAsyncTasks() Starts the execution of an asynchronous task. Inherited from Page.
FindControl(String) Searches the page naming container for a server control with the specified identifier. Inherited from Page.
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.
Focus() Sets input focus to a control. Inherited from Control.
FrameworkInitialize() protected Initializes the control tree during page generation based on the declarative nature of the page. Inherited from Page.
GetContainers() Provides access to a Template's Action Containers in an ASP.NET application.
GetDataItem() Gets the data item at the top of the data-binding context stack. Inherited from Page.
GetDesignModeState() protected Gets design-time data for a control. Inherited from Control.
GetGlobalResourceObject(String, String) protected Gets an application-level resource object based on the specified ClassKey and ResourceKey properties. Inherited from TemplateControl.
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.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLocalResourceObject(String) protected Gets a page-level resource object based on the specified ResourceKey property. Inherited from TemplateControl.
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.
GetPostBackClientEvent(Control, String) Gets a reference that can be used in a client event to post back to the server for the specified control and with the specified event arguments. Inherited from Page.
GetPostBackClientHyperlink(Control, String) Gets a reference, with javascript: appended to the beginning of it, that can be used in a client event to post back to the server for the specified control and with the specified event arguments. Inherited from Page.
GetPostBackEventReference(Control) Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified Control object. Inherited from Page.
GetPostBackEventReference(Control, String) Returns a string that can be used in a client event to cause postback to the server. The reference string is defined by the specified control that handles the postback and a string argument of additional event information. Inherited from Page.
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.
GetScrollableControlID()
GetTestControls()
GetType() Gets the Type of the current instance. Inherited from Object.
GetTypeHashCode() Retrieves a hash code that is generated by Page objects that are generated at run time. This hash code is unique to the Page object's control hierarchy. Inherited from Page.
GetUniqueIDRelativeTo(Control) Returns the prefixed portion of the UniqueID property of the specified control. Inherited from Control.
GetUpdatePanels()
GetValidators(String) Returns a collection of control validators for a specified validation group. Inherited from Page.
GetWrappedFileDependencies(String[]) protected Returns a list of physical file names that correspond to a list of virtual file locations. Inherited from Page.
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.
InitOutputCache(Int32, String, String, String, OutputCacheLocation, String) protected Initializes the output cache for the current page request. Inherited from Page.
InitOutputCache(Int32, String, String, OutputCacheLocation, String) protected Initializes the output cache for the current page request. Inherited from Page.
InitOutputCache(OutputCacheParameters) protected Initializes the output cache for the current page request based on an OutputCacheParameters object. Inherited from Page.
IsClientScriptBlockRegistered(String) Determines whether the client script block with the specified key is registered with the page. Inherited from Page.
IsLiteralContent() protected Determines if the server control holds only literal content. Inherited from Control.
IsStartupScriptRegistered(String) Determines whether the client startup script is registered with the Page object. Inherited from Page.
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.
LoadPageStateFromPersistenceMedium() protected Loads any saved view-state information to the Page object. Inherited from Page.
LoadTemplate(String) Obtains an instance of the ITemplate interface from an external file. Inherited from TemplateControl.
LoadViewState(Object) protected Restores view-state information from a previous page request that was saved by the SaveViewState() method. Inherited from Control.
MapPath(String) Retrieves the physical path that a virtual path, either absolute or relative, or an application-relative path maps to. Inherited from Page.
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.
OnInitComplete(EventArgs) protected Raises the InitComplete event after page initialization. Inherited from Page.
OnLoad(EventArgs) protected Raises the Load event. Inherited from Control.
OnPreLoad(EventArgs) protected Raises the PreLoad event after postback data is loaded into the page server controls but before the OnLoad(EventArgs) event. Inherited from Page.
OnPreRender(EventArgs) protected Raises the PreRender event. Inherited from Control.
OnPreRenderComplete(EventArgs) protected Raises the PreRenderComplete event after the OnPreRenderComplete(EventArgs) event and before the page is rendered. Inherited from Page.
OnSaveStateComplete(EventArgs) protected Raises the SaveStateComplete event after the page state has been saved to the persistence medium. Inherited from Page.
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) Parses an input string into a Control object on the Web Forms page or user control. Inherited from TemplateControl.
ParseControl(String, Boolean) Parses an input string into a Control object on the ASP.NET Web page or user control. Inherited from TemplateControl.
ProcessRequest(HttpContext) Sets the intrinsic server objects of the Page object, such as the Context, Request, Response, and Application properties. Inherited from Page.
RaiseBubbleEvent(Object, EventArgs) protected Assigns any sources of the event and its information to the control's parent. Inherited from Control.
RaisePostBackEvent(IPostBackEventHandler, String) protected Notifies the server control that caused the postback that it should handle an incoming postback event. Inherited from Page.
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.
Register(IViewDependentControl)
RegisterActionContainers(IEnumerable<IActionContainer>)
RegisterArrayDeclaration(String, String) Declares a value that is declared as an ECMAScript array declaration when the page is rendered. Inherited from Page.
RegisterAsyncTask(PageAsyncTask) Registers a new asynchronous task with the page. Inherited from Page.
RegisterClientScriptBlock(String, String) Emits client-side script blocks to the response. Inherited from Page.
RegisterHiddenField(String, String) Allows server controls to automatically register a hidden field on the form. The field will be sent to the Page object when the HtmlForm server control is rendered. Inherited from Page.
RegisterOnSubmitStatement(String, String) Allows a page to access the client OnSubmit event. The script should be a function call to client code registered elsewhere. Inherited from Page.
RegisterPanel(XafUpdatePanel)
RegisterRequiresControlState(Control) Registers a control as one whose control state must be persisted. Inherited from Page.
RegisterRequiresPostBack(Control) Registers a control as one that requires postback handling when the page is posted back to the server. Inherited from Page.
RegisterRequiresRaiseEvent(IPostBackEventHandler) Registers an ASP.NET server control as one requiring an event to be raised when the control is processed on the Page object. Inherited from Page.
RegisterRequiresViewStateEncryption() Registers a control with the page as one requiring view-state encryption. Inherited from Page.
RegisterStartupScript(String, String) Emits a client-side script block in the page response. Inherited from Page.
RegisterTestControl(ITestable)
RegisterViewStateHandler() Causes page view state to be persisted, if called. Inherited from Page.
RemovedControl(Control) protected Called after a child control is removed from the Controls collection of the Control object. Inherited from Control.
Render(HtmlTextWriter) protected Initializes the HtmlTextWriter object and calls on the child controls of the Page to render. Inherited from Page.
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) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. Inherited from Control.
RenderControl(HtmlTextWriter, ControlAdapter) protected Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control.
RequiresControlState(Control) Determines whether the specified Control object is registered to participate in control state management. Inherited from Page.
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.
SavePageStateToPersistenceMedium(Object) protected Saves any view-state and control-state information for the page. Inherited from Page.
SaveViewState() protected Saves any server control view-state changes that have occurred since the time the page was posted back to the server. Inherited from Control.
SetCaption(String)
SetDesignModeState(IDictionary) protected Sets design-time data for a control. Inherited from Control.
SetFocus(String) Sets the browser focus to the control with the specified identifier. Inherited from Page.
SetFocus(Control) Sets the browser focus to the specified control. Inherited from Page.
SetRenderMethodDelegate(RenderMethod) Assigns an event handler delegate to render the server control and its content into its parent control. Inherited from Control.
SetStatus(ICollection<String>)
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) Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. 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.
SetupCurrentTheme() static
SetView(View) Adds the View.Control of the specified View to a Template's View site.
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) Updates the specified model instance using values from the data-bound control. Inherited from Page.
TryUpdateModel<TModel>(TModel, IValueProvider) Updates the model instance using values from the specified value provider. Inherited from Page.
UnregisterActionContainers(IEnumerable<IActionContainer>)
UnregisterPanel(XafUpdatePanel)
UnregisterRequiresControlState(Control) Stops persistence of control state for the specified control. Inherited from Page.
UpdateModel<TModel>(TModel) Updates the specified model instance using values from the data-bound control. Inherited from Page.
UpdateModel<TModel>(TModel, IValueProvider) Updates the specified model instance using values from a specified value provider. Inherited from Page.
Validate() Instructs any validation controls included on the page to validate their assigned information. Inherited from Page.
Validate(String) Instructs the validation controls in the specified validation group to validate their assigned information. Inherited from Page.
VerifyRenderingInServerForm(Control) Confirms that an HtmlForm control is rendered for the specified ASP.NET server control at run time. Inherited from Page.
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) protected Evaluates an XPath data-binding expression. 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, 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, IXmlNamespaceResolver) protected Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution. 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.
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.
See Also