WebPart Members

Serves as the base class for custom ASP.NET Web Parts controls, adding to the base Part class features some additional user interface (UI) properties, the ability to create connections, and personalization behavior.

The following tables list the members exposed by the WebPart type.

Protected Constructors

  Name Description
Protected method WebPart Initializes the class for use by an inherited class instance. This constructor can only be called by an inherited class.
Top

Public Properties

(see also Protected Properties )
  Name Description
Public propertyAccessKey  Gets or sets the access key that allows you to quickly navigate to the Web server control.(Inherited from WebControl.)
Public propertyAllowCloseGets or sets a value indicating whether an end user can close a WebPart control on a Web page.
Public propertyAllowConnectGets or sets a value that indicates whether the WebPart control allows other controls to form connections with it.
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.
Public propertyAllowHideGets or sets a value indicating whether end users are allowed to hide a WebPart control.
Public propertyAllowMinimizeGets or sets a value indicating whether end users can minimize a WebPart control.
Public propertyAllowZoneChangeGets or sets a value indicating whether a user can move a WebPart control between WebPartZoneBase zones.
Public propertyAppRelativeTemplateSourceDirectory  Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.)
Public propertyAttributes  Gets 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.
Public propertyBackColor  Gets or sets the background color of the Web server control.(Inherited from WebControl.)
Public propertyBackImageUrl  Gets or sets the URL of the background image for the panel control.(Inherited from Panel.)
Public propertyBindingContainer  Gets the control that contains this control's data binding.(Inherited from Control.)
Public propertyBorderColor  Gets or sets the border color of the Web control.(Inherited from WebControl.)
Public propertyBorderStyle  Gets or sets the border style of the Web server control.(Inherited from WebControl.)
Public propertyBorderWidth  Gets 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 Web Parts control in a catalog of controls.
Public propertyChromeState Overridden. Gets or sets whether a part control is in a minimized or normal state.
Public propertyChromeType Overridden. Gets or sets the type of border that frames a Web Parts control.
Public propertyClientID  Gets the server control identifier generated by ASP.NET.(Inherited from Control.)
Public propertyConnectErrorMessageGets an error message to display to users if errors occur during the connection process.
Public propertyControls  Gets a ControlCollection object that contains the child controls for a specified server control in the user interface hierarchy.(Inherited from Part.)
Public propertyControlStyle  Gets the style of the Web server control. This property is used primarily by control developers.(Inherited from WebControl.)
Public propertyControlStyleCreated  Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.(Inherited from WebControl.)
Public propertyCssClass  Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.(Inherited from WebControl.)
Public propertyDefaultButton  Gets or sets the identifier for the default button that is contained in the Panel control.(Inherited from Panel.)
Public propertyDescription Overridden. Gets or sets a brief phrase that summarizes what the part control does, for use in ToolTips and catalogs of part controls.
Public propertyDirection Overridden. Gets or sets the horizontal direction that content flows within the control.
Public propertyDisplayTitleGets a string that contains the full title text actually displayed in the title bar of a WebPart control instance.
Public propertyEnabled  Gets or sets a value indicating whether the Web server control is enabled.(Inherited from WebControl.)
Public propertyEnableTheming  Gets or sets a value indicating whether themes apply to this control.(Inherited from WebControl.)
Public propertyEnableViewState  Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.(Inherited from Control.)
Public propertyExportModeGets or sets whether all, some, or none of a WebPart control's properties can be exported.
Public propertyFont  Gets the font properties associated with the Web server control.(Inherited from WebControl.)
Public propertyForeColor  Gets or sets the foreground color (typically the color of the text) of the Web server control.(Inherited from WebControl.)
Public propertyGroupingText  Gets or sets the caption for the group of controls that is contained in the panel control.(Inherited from Panel.)
Public propertyHasAttributes  Gets a value indicating whether the control has attributes set.(Inherited from WebControl.)
Public propertyHasSharedDataGets a value that indicates whether a WebPart control has any shared personalization data associated with it.
Public propertyHasUserDataGets a value that indicates whether a WebPart control has any user personalization data associated with it.
Public propertyHeight Overridden.  
Public propertyHelpModeGets or sets the type of user interface (UI) used to display Help content for a WebPart control.
Public propertyHelpUrlGets or sets the URL to a Help file for a WebPart control.
Public propertyHiddenGets or sets a value indicating whether a WebPart control is displayed on a Web page.
Public propertyHorizontalAlign  Gets or sets the horizontal alignment of the contents within the panel.(Inherited from Panel.)
Public propertyID  Gets or sets the programmatic identifier assigned to the server control.(Inherited from Control.)
Public propertyImportErrorMessageGets or sets an error message that is used if errors occur when a WebPart control is imported.
Public propertyIsClosedGets a value that indicates whether a WebPart control is currently closed on a Web Parts page.
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.
Public propertyIsStandaloneGets a value that indicates whether a WebPart control is standalone, meaning that it is not contained within a WebPartZoneBase zone.
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.
Public propertyNamingContainer  Gets 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 propertyPage  Gets a reference to the Page instance that contains the server control.(Inherited from Control.)
Public propertyParent  Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.)
Public propertyScrollBars  Gets or sets the visibility and position of scroll bars in a Panel control.(Inherited from Panel.)
Public propertySite  Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.)
Public propertySkinID  Gets or sets the skin to apply to the control.(Inherited from WebControl.)
Public propertyStyle  Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.(Inherited from WebControl.)
Public propertySubtitleGets a string that is concatenated with the Title property value to form a complete title for a WebPart control.
Public propertyTabIndex  Gets or sets the tab index of the Web server control.(Inherited from WebControl.)
Public propertyTemplateControl  Gets or sets a reference to the template that contains this control. (Inherited from Control.)
Public propertyTemplateSourceDirectory  Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.)
Public propertyTitle Overridden. Gets or sets the title of a part control.
Public propertyTitleIconImageUrlGets or sets the URL to an image used to represent a Web Parts control in the control's title bar.
Public propertyTitleUrlGets or sets a URL to supplemental information about a WebPart control.
Public propertyToolTip  Gets or sets the text displayed when the mouse pointer hovers over the Web server control.(Inherited from WebControl.)
Public propertyUniqueID  Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.)
Public propertyVerbsGets a collection of custom verbs associated with a WebPart control.
Public propertyVisible  Gets 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 WebPart control to enable it to be edited by custom EditorPart controls.
Public propertyWidth Overridden.  
Public propertyWrap  Gets 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.
Public propertyZoneIndexGets the index position of a WebPart control within its zone.
Top

Protected Properties

  Name Description
Protected propertyAdapter  Gets the browser-specific adapter for the control.(Inherited from Control.)
Protected propertyChildControlsCreated  Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.)
Protected propertyClientIDSeparator  Gets a character value representing the separator character used in the ClientID property.(Inherited from Control.)
Protected propertyContext  Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.)
Protected propertyDesignMode  Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.)
Protected propertyEvents  Gets a list of event handler delegates for the control. This property is read-only.(Inherited from Control.)
Protected propertyHasChildViewState  Gets a value indicating whether the current server control's child controls have any saved view-state settings.(Inherited from Control.)
Protected propertyIdSeparator  Gets the character used to separate control identifiers.(Inherited from Control.)
Protected propertyIsChildControlStateCleared  Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.)
Protected propertyIsEnabled  Gets a value indicating whether the control is enabled.(Inherited from WebControl.)
Protected propertyIsTrackingViewState  Gets a value that indicates whether the server control is saving changes to its view state.(Inherited from Control.)
Protected propertyIsViewStateEnabled  Gets a value indicating whether view state is enabled for this control.(Inherited from Control.)
Protected propertyLoadViewStateByID  Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Protected propertyTagKey  Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.(Inherited from WebControl.)
Protected propertyTagName  Gets the name of the control tag. This property is used primarily by control developers.(Inherited from WebControl.)
Protected propertyViewState  Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.(Inherited from Control.)
Protected propertyViewStateIgnoresCase  Gets a value that indicates whether the StateBag object is case-insensitive.(Inherited from Control.)
Protected propertyWebPartManagerGets a reference to the WebPartManager control associated with a WebPart control instance.
Top

Public Methods

(see also Protected Methods )
  Name Description
Public methodApplyStyle  Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.)
Public methodApplyStyleSheetSkin  Applies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Public methodCopyBaseAttributes  Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.)
Public methodCreateEditorParts Returns a collection of custom EditorPart controls that can be used to edit a WebPart control when it is in edit mode.
Public methodDataBind  Overloaded. (Inherited from Part.)
Public methodDispose  Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Public methodEquals  Overloaded. Determines whether two Object instances are equal. (Inherited from Object.)
Public methodFindControl  Overloaded. Searches the current naming container for the specified server control. (Inherited from Control.)
Public methodFocus  Sets input focus to a control. (Inherited from Control.)
Public methodGetHashCode  Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.)
Public methodGetType  Gets the Type of the current instance. (Inherited from Object.)
Public methodHasControls  Determines if the server control contains any child controls. (Inherited from Control.)
Public methodMergeStyle  Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.)
Public methodStaticReferenceEquals  Determines whether the specified Object instances are the same instance. (Inherited from Object.)
Public methodRenderBeginTag  Renders the HTML opening tag of the Panel control to the specified writer. (Inherited from Panel.)
Public methodRenderControl  Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Public methodRenderEndTag  Renders the HTML closing tag of the Panel control into the specified writer. (Inherited from Panel.)
Public methodResolveClientUrl  Gets a URL that can be used by the browser. (Inherited from Control.)
Public methodResolveUrl  Converts a URL into one that is usable on the requesting client. (Inherited from Control.)
Public methodSetPersonalizationDirty Overloaded. Sets a flag indicating that personalization data has changed for a Web Parts control or a server control placed in a WebPartZoneBase zone.
Public methodSetRenderMethodDelegate  Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public methodToString  Returns a String that represents the current Object. (Inherited from Object.)
Top

Protected Methods

  Name Description
Protected methodAddAttributesToRender  Adds information about the background image, alignment, wrap, and direction to the list of attributes to render. (Inherited from Panel.)
Protected methodAddedControl  Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected methodAddParsedSubObject  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.)
Protected methodBuildProfileTree  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 methodClearChildControlState  Deletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected methodClearChildState  Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearChildViewState  Deletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected methodCreateChildControls  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.)
Protected methodCreateControlCollection  Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected methodCreateControlStyle  Creates a style object that is used internally by the Panel control to implement all style related properties. (Inherited from Panel.)
Protected methodDataBind  Overloaded. Binds a data source to the invoked server control and all its child controls. (Inherited from Control.)
Protected methodDataBindChildren  Binds a data source to the server control's child controls. (Inherited from Control.)
Protected methodEnsureChildControls  Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected methodEnsureID  Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Protected methodFinalize  Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Protected methodFindControl  Overloaded. Searches the current naming container for the specified server control. (Inherited from Control.)
Protected methodGetDesignModeState  Gets design-time data for a control. (Inherited from Control.)
Protected methodHasEvents  Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected methodIsLiteralContent  Determines if the server control holds only literal content. (Inherited from Control.)
Protected methodLoadControlState  Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected methodLoadViewState  Restores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.)
Protected methodMapPathSecure  Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected methodMemberwiseClone  Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnBubbleEvent  Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
Protected methodOnClosing Enables derived classes to provide custom handling when a WebPart control is closed on a Web Parts page.
Protected methodOnConnectModeChanged Enables derived classes to provide custom handling when a WebPart control is beginning or ending the process of connecting to other controls.
Protected methodOnDataBinding  Raises the DataBinding event. (Inherited from Control.)
Protected methodOnDeleting Enables derived classes to provide custom handling when a WebPart control is permanently removed from a Web Parts page.
Protected methodOnEditModeChanged Enables derived classes to provide custom handling when a WebPart control is entering or leaving edit mode.
Protected methodOnInit  Raises the Init event. (Inherited from Control.)
Protected methodOnLoad  Raises the Load event. (Inherited from Control.)
Protected methodOnPreRender  Raises the PreRender event. (Inherited from Control.)
Protected methodOnUnload  Raises the Unload event. (Inherited from Control.)
Protected methodOpenFile  Gets a Stream used to read a file. (Inherited from Control.)
Protected methodRaiseBubbleEvent  Assigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected methodRemovedControl  Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected methodRender  Renders the control to the specified HTML writer. (Inherited from WebControl.)
Protected methodRenderChildren  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.)
Protected methodRenderContents  Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodRenderControl  Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Protected methodResolveAdapter  Gets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Protected methodSaveControlState  Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected methodSaveViewState  Saves any state that was modified after the TrackViewState method was invoked. (Inherited from WebControl.)
Protected methodSetDesignModeState  Sets design-time data for a control. (Inherited from Control.)
Protected methodSetPersonalizationDirty Overloaded. Sets a flag indicating that personalization data has changed for a Web Parts control or a server control placed in a WebPartZoneBase zone.
Protected methodTrackViewState Overridden.  
Top

Public Events

  Name Description
Public eventDataBinding  Occurs when the server control binds to a data source.(Inherited from Control.)
Public eventDisposed  Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.(Inherited from Control.)
Public eventInit  Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.)
Public eventLoad  Occurs when the server control is loaded into the Page object.(Inherited from Control.)
Public eventPreRender  Occurs after the Control object is loaded but prior to rendering.(Inherited from Control.)
Public eventUnload  Occurs when the server control is unloaded from memory.(Inherited from Control.)
Top

See Also

Community Additions

ADD
Show: