Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

GenericWebPart Class

Wraps server controls that are not WebPart controls so that they can appear and behave as true WebPart controls at run time.

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)
public class GenericWebPart : WebPart
<asp:GenericWebPart />

The GenericWebPart type exposes the following members.

  NameDescription
Protected methodGenericWebPartInitializes a new instance of a GenericWebPart control by passing in a reference to a control that becomes the child control.
Top
  NameDescription
Public propertyAccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected propertyAdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public propertyAllowCloseGets or sets a value indicating whether an end user can close a WebPart control on a Web page. (Inherited from WebPart.)
Public propertyAllowConnectGets or sets a value that indicates whether the WebPart control allows other controls to form connections with it. (Inherited from WebPart.)
Public propertyAllowEditGets or sets a value indicating whether an end user can modify a WebPart control through the user interface (UI) provided by one or more EditorPart controls. (Inherited from WebPart.)
Public propertyAllowHideGets or sets a value indicating whether end users are allowed to hide a WebPart control. (Inherited from WebPart.)
Public propertyAllowMinimizeGets or sets a value indicating whether end users can minimize a WebPart control. (Inherited from WebPart.)
Public propertyAllowZoneChangeGets or sets a value indicating whether a user can move a WebPart control between WebPartZoneBase zones. (Inherited from WebPart.)
Public propertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public propertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public propertyAuthorizationFilterGets or sets an arbitrary string to determine whether a WebPart control is authorized to be added to a page. (Inherited from WebPart.)
Public propertyBackColorGets or sets the background color of the Web server control. (Inherited from WebControl.)
Public propertyBackImageUrlGets or sets the URL of the background image for the panel control. (Inherited from Panel.)
Public propertyBindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public propertyBorderColorGets or sets the border color of the Web control. (Inherited from WebControl.)
Public propertyBorderStyleGets or sets the border style of the Web server control. (Inherited from WebControl.)
Public propertyBorderWidthGets or sets the border width of the Web server control. (Inherited from WebControl.)
Public propertyCatalogIconImageUrlGets or sets the URL to an image that represents a GenericWebPart control in a catalog of controls. (Overrides WebPart.CatalogIconImageUrl.)
Public propertyChildControlGets a reference to the child control that is wrapped by a GenericWebPart control at run time.
Protected propertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public propertyChromeStateGets or sets whether a part control is in a minimized or normal state. (Inherited from WebPart.)
Public propertyChromeTypeGets or sets the type of border that frames a Web Parts control. (Inherited from WebPart.)
Public propertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public propertyClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected propertyClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Public propertyConnectErrorMessageGets an error message to display to users if errors occur during the connection process. (Inherited from WebPart.)
Protected propertyContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public propertyControlsInfrastructure. Gets a ControlCollection object that contains the child controls for a specified server control in the user interface hierarchy. (Inherited from Part.)
Public propertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyControlStyleCreatedGets 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.)
Public propertyCssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public propertyDataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public propertyDataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Public propertyDefaultButtonGets or sets the identifier for the default button that is contained in the Panel control. (Inherited from Panel.)
Public propertyDescriptionGets or sets a brief phrase that summarizes what a control does, for use in ToolTips and catalogs of server controls. (Overrides WebPart.Description.)
Protected propertyDesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public propertyDirectionGets or sets the horizontal direction that content flows within the control. (Inherited from WebPart.)
Public propertyDisplayTitleGets a string that contains the full title text actually displayed in the title bar of a WebPart control instance. (Inherited from WebPart.)
Public propertyEnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public propertyEnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from 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 Control.)
Protected propertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public propertyExportModeGets or sets whether all, some, or none of a WebPart control's properties can be exported. (Inherited from WebPart.)
Public propertyFontGets the font properties associated with the Web server control. (Inherited from WebControl.)
Public propertyForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public propertyGroupingTextGets or sets the caption for the group of controls that is contained in the panel control. (Inherited from Panel.)
Public propertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected propertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public propertyHasSharedDataGets a value that indicates whether a WebPart control has any shared personalization data associated with it. (Inherited from WebPart.)
Public propertyHasUserDataGets a value that indicates whether a WebPart control has any user personalization data associated with it. (Inherited from WebPart.)
Public propertyHeightGets or sets the height (in pixels) of a control. (Overrides WebPart.Height.)
Public propertyHelpModeGets or sets the type of user interface (UI) used to display Help content for a WebPart control. (Inherited from WebPart.)
Public propertyHelpUrlGets or sets the URL to a Help file for a WebPart control. (Inherited from WebPart.)
Public propertyHiddenGets or sets a value indicating whether a WebPart control is displayed on a Web page. (Inherited from WebPart.)
Public propertyHorizontalAlignGets or sets the horizontal alignment of the contents within the panel. (Inherited from Panel.)
Public propertyIDGets or sets the ID of a control. This value is not inheritable. (Overrides Control.ID.)
Protected propertyIdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Public propertyImportErrorMessageGets or sets an error message that is used if errors occur when a WebPart control is imported. (Inherited from WebPart.)
Protected propertyIsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Public propertyIsClosedGets a value that indicates whether a WebPart control is currently closed on a Web Parts page. (Inherited from WebPart.)
Protected propertyIsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
Public propertyIsSharedGets a value that indicates whether a WebPart control is shared, meaning that it is visible to all users of a Web Parts page. (Inherited from WebPart.)
Public propertyIsStandaloneGets a value that indicates whether a WebPart control is standalone, meaning that it is not contained within a WebPartZoneBase zone. (Inherited from WebPart.)
Public propertyIsStaticGets a value that indicates whether a WebPart control is a static control, which means the control is declared in the markup of a Web Parts page and not added to the page programmatically. (Inherited from WebPart.)
Protected propertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected propertyIsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Protected propertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from 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 Control.ID property value. (Inherited from Control.)
Public propertyPageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public propertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public propertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public propertyScrollBarsGets or sets the visibility and position of scroll bars in a Panel control. (Inherited from Panel.)
Public propertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public propertySkinIDGets or sets the skin to apply to the control. (Inherited from 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 WebControl.)
Public propertySubtitleGets a string that is concatenated with the Title property value to form a complete title for a control. (Overrides WebPart.Subtitle.)
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 IsEnabled property is false. (Inherited from Panel.)
Public propertyTabIndexGets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected propertyTagKeyGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Protected propertyTagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public propertyTemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public propertyTitleGets or sets the title of a GenericWebPart control. (Overrides WebPart.Title.)
Public propertyTitleIconImageUrlGets or sets the URL to an image used to represent a GenericWebPart control in the control's own title bar. (Overrides WebPart.TitleIconImageUrl.)
Public propertyTitleUrlGets or sets a URL to supplemental information about a GenericWebPart control. (Overrides WebPart.TitleUrl.)
Public propertyToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public propertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public propertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Public propertyVerbsGets a collection of custom verbs associated with a GenericWebPart control. (Overrides WebPart.Verbs.)
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 Control.)
Protected propertyViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public propertyViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public propertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public propertyWebBrowsableObjectGets a reference to the child control, to enable the control to be edited by custom EditorPart controls. (Overrides WebPart.WebBrowsableObject.)
Protected propertyWebPartManagerGets a reference to the WebPartManager control associated with a WebPart control instance. (Inherited from WebPart.)
Public propertyWidthGets or sets the width (in pixels) of the control. (Overrides WebPart.Width.)
Public propertyWrapGets or sets a value indicating whether the content wraps within the panel. (Inherited from Panel.)
Public propertyZoneGets the WebPartZoneBase zone that currently contains a WebPart control. (Inherited from WebPart.)
Public propertyZoneIndexGets the index position of a WebPart control within its zone. (Inherited from WebPart.)
Top
  NameDescription
Protected methodAddAttributesToRenderAdds information about the background image, alignment, wrap, and direction to the list of attributes to render. (Inherited from Panel.)
Protected methodAddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected methodAddParsedSubObjectNotifies 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.)
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 WebControl.)
Public methodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected methodBeginRenderTracingBegins design-time tracing of rendering data. (Inherited from Control.)
Protected methodBuildProfileTreeInfrastructure. 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.)
Protected methodClearCachedClientIDInfrastructure. Sets the cached ClientID value to null. (Inherited from Control.)
Protected methodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected methodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Public methodCopyBaseAttributesCopies 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.)
Protected methodCreateChildControlsCalled 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. (Overrides Control.CreateChildControls().)
Protected methodCreateControlCollectionOverrides the base method to create a read-only collection that consists of the child control wrapped by a GenericWebPart control. (Overrides Control.CreateControlCollection().)
Protected methodCreateControlStyleCreates a style object that is used internally by the Panel control to implement all style related properties. (Inherited from Panel.)
Public methodCreateEditorPartsReturns a collection of custom EditorPart controls that can be used to edit the child control of a GenericWebPart control when it is in edit mode. (Overrides WebPart.CreateEditorParts().)
Public methodDataBind()Binds a data source to the invoked server control and all its child controls. (Inherited from Part.)
Protected methodDataBind(Boolean)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.)
Protected methodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Public methodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected methodEndRenderTracingEnds design-time tracing of rendering data. (Inherited from Control.)
Protected methodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected methodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected methodFindControl(String, Int32)Infrastructure. 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.)
Public methodFocusSets input focus to a control. (Inherited from Control.)
Protected methodGetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public methodHasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected methodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected methodIsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected methodLoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected methodLoadViewStateRestores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.)
Protected methodMapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
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 WebControl.)
Protected methodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
Protected methodOnClosingEnables derived classes to provide custom handling when a WebPart control is closed on a Web Parts page. (Inherited from WebPart.)
Protected methodOnConnectModeChangedEnables derived classes to provide custom handling when a WebPart control is beginning or ending the process of connecting to other controls. (Inherited from WebPart.)
Protected methodOnDataBindingRaises the DataBinding event. (Inherited from Control.)
Protected methodOnDeletingEnables derived classes to provide custom handling when a WebPart control is permanently removed from a Web Parts page. (Inherited from WebPart.)
Protected methodOnEditModeChangedEnables derived classes to provide custom handling when a WebPart control is entering or leaving edit mode. (Inherited from WebPart.)
Protected methodOnInitRaises the Init event. (Inherited from Control.)
Protected methodOnLoadRaises the Load event. (Inherited from Control.)
Protected methodOnPreRenderRaises the PreRender event. (Inherited from Control.)
Protected methodOnUnloadRaises the Unload event. (Inherited from Control.)
Protected methodOpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected methodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected methodRemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected methodRenderDelegates rendering the contents of the control to the child control. (Overrides WebControl.Render(HtmlTextWriter).)
Public methodRenderBeginTagRenders the HTML opening tag of the Panel control to the specified writer. (Inherited from Panel.)
Protected methodRenderChildrenOutputs 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.)
Protected methodRenderContentsRenders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Public methodRenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Public methodRenderEndTagRenders the HTML closing tag of the Panel control into the specified writer. (Inherited from Panel.)
Protected methodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public methodResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public methodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected methodSaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected methodSaveViewStateSaves any state that was modified after the TrackViewState method was invoked. (Inherited from WebControl.)
Protected methodSetDesignModeStateSets design-time data for a control. (Inherited from Control.)
Protected methodSetPersonalizationDirty()Sets a flag indicating that personalization data has changed for the current WebPart control instance. (Inherited from WebPart.)
Public methodSetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public methodSetTraceData(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.)
Public methodSetTraceData(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.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateCauses the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebPart.)
Top
  NameDescription
Public eventDataBindingOccurs when the server control binds to a data source. (Inherited from 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 Control.)
Public eventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public eventLoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public eventPreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public eventUnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Top
  NameDescription
Public Extension MethodFindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension MethodFindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension MethodFindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
  NameDescription
Explicit interface implemetationPrivate methodIAttributeAccessor.GetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodIAttributeAccessor.SetAttributeSets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodICompositeControlDesignerAccessor.RecreateChildControlsAllows the developer of a designer for a composite part control to recreate the control's child controls on the design surface. (Inherited from Part.)
Explicit interface implemetationPrivate propertyIControlBuilderAccessor.ControlBuilderFor a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.GetDesignModeStateFor a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.SetDesignModeStateFor a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.SetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlDesignerAccessor.UserDataFor a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor.DataBindingsFor a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor.HasDataBindingsFor a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor.ExpressionsFor a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor.HasExpressionsFor a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)
Explicit interface implemetationPrivate methodIParserAccessor.AddParsedSubObjectFor a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)
Top

The GenericWebPart control exists to provide a run-time wrapper for server controls that are not WebPart controls, so that such controls can be used in Web Parts pages and applications. When developers add server controls--such as user controls, ASP.NET server controls, or existing custom controls--to a WebPartZoneBase control, the GenericWebPart control automatically wraps the server controls at run time so they can exhibit the same functionality as true WebPart controls.

The following table compares and contrasts GenericWebPart controls and WebPart controls.

GenericWebPart control

WebPart control

Exists to equip server controls that are not WebPart controls with Web Parts functionality, so that any ASP.NET, custom, or user control can participate in Web Parts applications.

Exists to create custom ASP.NET controls that have native Web Parts functionality built in. This includes personalization, connections, import and export, and drag-and-drop capabilities.

Is never declared in the markup of a page. It exists only to wrap server controls at run time, and to give the wrapped control (or child control) the full functionality of a WebPart control.

Can be declared in the markup of a page at design time, like an ASP.NET server control, except that it is declared in a WebPartZoneBase zone.

Includes and integrates its child control into the Web Parts personalization process so that it can act as a true WebPart control. This occurs automatically, which makes it simple for developers to use server controls and user controls in Web Parts applications.

Is automatically included in the Web Parts personalization process.

Can be accessed programmatically at run time (by using the GetGenericWebPart method and passing to it the child server control), like a true WebPart control or a standard ASP.NET control.

Can be accessed programmatically at run time, like a standard ASP.NET control.

Users benefit from the GenericWebPart control because it provides a consistent user experience. Any server control can be made to function like a WebPart control, and will have the same consistent user interface (UI) elements such as verbs, icons, a title, and a header. Developers benefit from the GenericWebPart control because it enables them to reuse existing user controls and server controls within Web Parts applications.

NoteNote

When you create Web Parts pages, you do not have to do anything to enable an existing user control or custom control to be wrapped with the GenericWebPart control. Simply add your server or user control to a WebPartZoneBase zone, either programmatically or by declaring it in the page's markup, and the Web Parts control set automatically wraps your control with a GenericWebPart object at run time.

Because server controls that are placed in WebPartZoneBase zones are wrapped with a GenericWebPart control at run time, developers can use ordinary server and user controls exactly as if they were WebPart controls. Note that, if you declare custom controls that inherit from the base Control class within a WebPartZone, these controls cannot support the use of the intrinsic WebPart properties. Thus, you cannot declare the IWebPart properties on such controls, including properties such as the Title property and the Description property. In contrast, other types of server controls (such as WebPart controls, user controls, and custom controls that inherit from WebControl) can declare these properties, because they support the use of expando properties.

Expando properties are actually strings that can be added to a class dynamically as a property, by means of the IAttributeAccessor interface. Controls that implement this interface, including the WebControl class and its children, can use expando properties. Because the base Control class does not support expando properties, when a custom control that inherits from the Control class is placed in a WebPartZone and wrapped with a GenericWebPart control at run time, the Web Parts control set cannot dynamically add the intrinsic IWebPart properties to the custom control. You have two choices in this case. You can use the custom control without the IWebPart properties, or you can implement the IWebPart interface in the custom control, enabling it to use the properties.

As an example of how controls that inherit from WebControl can use the IWebPart properties, if you declare an ASP.NET Calendar control in the markup of a page (within a WebPartZoneBase zone) at design time, even though this control does not inherit from the WebPart class and does not natively contain WebPart members, you can still treat it exactly like a WebPart control. You can declare WebPart properties on the calendar control, such as Title, Description, and others. At run time, you can use the GetGenericWebPart method, which returns the GenericWebPart control that is dynamically wrapping the calendar control, and work with it programmatically exactly as you would with a WebPart control, with access to all the same properties, events, and methods.

The GenericWebPart control has a critical property that allows you to access its underlying server control: the ChildControl property. This property allows developers to programmatically access the server control. The ChildControl property is also used by the WebPartManager control to access personalization data from the child control, and to perform authorization, if the AuthorizationFilter property is set.

The GenericWebPart control has several other properties, all of which override properties inherited from the base WebPart class. As noted, you can use these properties with any child control, so that it can behave as a WebPart control. One important property is the ExportMode property; it determines whether all the exportable properties, or only those marked as non-sensitive, can be exported. The UI-oriented properties inherited from the WebPart class, such as CatalogIconImageUrl, Description, Height, Title, TitleUrl, and Width, can be set in the declarative markup for any server control that is placed in a WebPartZoneBase zone.

Important methods in the GenericWebPart class include the CreateControlCollection method, which creates the collection of controls (including child controls) associated with a GenericWebPart control, and the Render method, which delegates all rendering to the wrapped child controls. The constructors on the GenericWebPart class are protected and are intended either for internal use or for extensibility scenarios.

There are some additional helpful insights for working with GenericWebPart controls. If you want to set default values for the overridden properties in the GenericWebPart class, your user control or custom server control can implement the IWebPart and IWebActionable interfaces, and override their members. At run time, the GenericWebPart control will get its values for the implemented properties from the child control that implements the interfaces. If your control defines any of its properties as personalizable (by using the Personalizable metadata attribute), the GenericWebPart control automatically enables those properties for personalization at run time, just like the personalizable properties on a WebPart control.

If you want to provide Web Parts editing features for your control, you can implement the IWebEditable interface. At run time, when the CreateEditorParts method is called, the GenericWebPart control's code for the WebBrowsableObject property will call into the same property in the child control, and use the child control's implementation to create associated custom EditorPart controls.

Notes to Inheritors

There are few occasions where it is necessary to inherit from the GenericWebPart class. One such case would be if a developer wants to implement some custom action in the constructor when a GenericWebPart control is created. For example, you might want to store the child control somewhere other than the control collection within the GenericWebPart class. If you inherit from the GenericWebPart class, you also need to inherit from the WebPartManager class and override its CreateWebPart method to enable it to create your custom control.

TopicLocation
How to: Export Web Parts Control SettingsBuilding ASP .NET Web Applications
How to: Treat a User Control as a Web Parts ControlBuilding ASP .NET Web Applications
How to: Treat a User Control as a Web Parts ControlBuilding ASP .NET Web Applications
How to: Export Web Parts Control SettingsBuilding ASP .NET Web Applications

The following code example demonstrates how the GenericWebPart control automatically wraps a server control that is not a WebPart control at run time.

The first part of the code example contains a Web Parts page with two WebPartZone controls. Within each zone is a standard ASP.NET server control. Because the controls are in a WebPartZone zone, they will be automatically wrapped with a GenericWebPart control when the page is compiled. So, you can declare WebPart class properties on these controls. After you load the page in a browser, if you click the Display All Property Values button, the details for each control are displayed in a label. To show how the GenericWebPart control works, the Calendar control in the first zone has some of the GenericWebPart properties set in the declarative markup of the .aspx page, whereas the BulletedList control does not. After you load the page, note the differences in the property values for the two controls, and that both have a parent GenericWebPart control.

<%@ Page Language="C#" 
  Codefile="genericwebpart.cs" 
  Inherits="genericwebpart_sample" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>GenericWebPart Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:WebPartManager ID="WebPartManager1" runat="server">
      </asp:WebPartManager>
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:Calendar ID="Calendar1" runat="server"
            Title="My Calendar"
            Description="A calendar used as a GenericWebPart control."
            CatalogIconImageUrl="MyCatalogIcon.gif"
            TitleIconimageUrl ="MyTitleIcon.gif"
            TitleUrl="MyInfoUrl.htm" 
            Width="250"/>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:WebPartZone ID="WebPartZone2" runat="server">
        <ZoneTemplate>
          <asp:BulletedList ID="BulletedList1" 
            Runat="server"
            DisplayMode="HyperLink">
            <asp:ListItem Value="http://msdn.microsoft.com">
              MSDN
            </asp:ListItem>
            <asp:ListItem Value="http://www.asp.net">
              ASP.NET
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
              MSN
            </asp:ListItem>
          </asp:BulletedList>        
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <asp:Button ID="Button1" width="200"
        runat="server" 
        Text="Display All Property Values" OnClick="Button1_Click" /> 
      <br />
      <asp:Label ID="Label2" runat="server" Text="" />
      <br />   
      <asp:Label ID="Label3" runat="server" Text="" />
    </form>
</body>
</html>

The second part of the code example shows a partial class that accesses some properties of the GenericWebPart control programmatically. Notice that in the Page_Load method, the GetGenericWebPart method is used to retrieve the run-time instance of the GenericWebPart control that wraps a server control. This approach of getting a reference to the parent GenericWebPart control enables you to work programmatically with an ordinary server or user control as if it were a WebPart control at run time.

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class genericwebpart_sample : System.Web.UI.Page
{
  GenericWebPart calendarPart;
  GenericWebPart listPart;

  protected void Page_Load(Object sender, EventArgs e)
  {
    calendarPart = WebPartManager1.GetGenericWebPart(Calendar1);
    listPart = WebPartManager1.GetGenericWebPart(BulletedList1);

    if (!IsPostBack)
    {
      Label2.Text = String.Empty;
      Label3.Text = String.Empty;
    }
  }

  protected void Button1_Click(object sender, EventArgs e)
  {

    Label2.Text =
      @"<h3>Calendar GenericWebPart Properties</h3>" +
      "<em>Title: </em>" + calendarPart.Title +
      "<br />" +
      "<em>CatalogIconImageUrl:  </em>" + calendarPart.CatalogIconImageUrl +
      "<br />" +
      "<em>TitleUrl: </em>" + calendarPart.TitleUrl +
      "<br />" +
      "<em>Decription: </em>" + calendarPart.Description +
      "<br />" +
      "<em>TitleIconImageUrl: </em>" + calendarPart.TitleIconImageUrl +
      "<br />" +
      "<em>ChildControl ID: </em>" + calendarPart.ChildControl.ID +
      "<br />" +
      "<em>ChildControl Type: </em>" + calendarPart.ChildControl.GetType().Name +
      "<br />" +
      "<em>GenericWebPart ID: </em>" + calendarPart.ID +
      "<br />" +
      "<em>GenericWebPart Type: </em>" + calendarPart.GetType().Name +
      "<br />" +
      "<em>GenericWebPart Parent ID: </em>" + calendarPart.Parent.ID;

    Label3.Text =
      @"<h3>BulletedList GenericWebPart Properties</h3>" +
      "<em>Title: </em>" + listPart.Title +
      "<br />" +
      "<em>CatalogIconImageUrl:  </em>" + listPart.CatalogIconImageUrl +
      "<br />" +
      "<em>TitleUrl: </em>" + listPart.TitleUrl +
      "<br />" +
      "<em>Decription: </em>" + listPart.Description +
      "<br />" +
      "<em>TitleIconImageUrl: </em>" + listPart.TitleIconImageUrl +
      "<br />" +
      "<em>ChildControl ID: </em>" + listPart.ChildControl.ID +
      "<br />" +
      "<em>ChildControl Type: </em>" + listPart.ChildControl.GetType().Name +
      "<br />" +
      "<em>GenericWebPart ID: </em>" + listPart.ID +
      "<br />" +
      "<em>GenericWebPart Type: </em>" + listPart.GetType().Name +
      "<br />" +
      "<em>GenericWebPart Parent ID: </em>" + listPart.Parent.ID;
  }

}

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.