Export (0) Print
Expand All

WebPart members

Provides the base class for creating Microsoft SharePoint Foundation Web Parts.

The WebPart type exposes the following members.

  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

  Name Description
Public property AccessKey (Inherited from WebControl.)
Protected property Adapter (Inherited from Control.)
Public property AllowClose (Inherited from WebPart.)
Public property AllowConnect Gets or sets a value that indicates whether the WebPart control allows other controls to form connections with it. (Overrides WebPart.AllowConnect.)
Public property AllowEdit Gets or sets a value indicating whether an end user can modify a WebPart control in personal view. (Overrides WebPart.AllowEdit.)
Public property AllowHide Gets or sets a value indicating whether end users are allowed to hide a WebPart control. (Overrides WebPart.AllowHide.)
Public property AllowMinimize Gets or sets whether the Web Part can be minimized. (Overrides WebPart.AllowMinimize.)
Public property AllowRemove Obsolete. Gets or sets whether the Web Part can be removed from a Web Part Page by controlling whether the IsIncluded property can be set to false.
Public property AllowZoneChange Gets or sets whether the Web Part can be moved to a different zone by controlling whether the ZoneID property can be changed. (Overrides WebPart.AllowZoneChange.)
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property Attributes (Inherited from WebControl.)
Public property AuthorizationFilter Gets or sets an arbitrary string to determine whether a Web Part is authorized to be added to a page. (Overrides WebPart.AuthorizationFilter.)
Public property BackColor (Inherited from WebControl.)
Public property BackImageUrl (Inherited from Panel.)
Public property BindingContainer (Inherited from Control.)
Public property BorderColor (Inherited from WebControl.)
Public property BorderStyle (Inherited from WebControl.)
Public property BorderWidth (Inherited from WebControl.)
Public property BrowserDesignMode Obsolete. Gets whether a Web Part is in design mode (modifying its layout or properties) in the Web browser.
Protected property CacheType Determines the type of caching being used by the Web server.
Public property Caption Obsolete. Gets or sets a string that is added following the title in the title bar of the Web Part. This property is intended for document names or other context-specific information.
Public property CatalogIconImageUrl Gets or sets the URL to an image used to represent the Web Part in a catalog. (Overrides WebPart.CatalogIconImageUrl.)
Protected property ChildControlsCreated (Inherited from Control.)
Public property ChromeState (Inherited from WebPart.)
Public property ChromeType (Inherited from WebPart.)
Protected property ClassResourcePath Gets the base path to Web Part class resources.
Public property ClientID (Inherited from Control.)
Public property ClientIDMode (Inherited from Control.)
Protected property ClientIDSeparator (Inherited from Control.)
Public property ClientName Gets the unique name of the Web Part used by the client-side Web Part Page Service Component (WPSC).
Public property ConnectErrorMessage (Inherited from WebPart.)
Public property ConnectionID Gets or sets the GUID that is used internally by the Web Part infrastructure as the unique identifier of a Web Part connection.
Public property Connections Gets or sets the connection information that is stored with a connected Web Part.
Protected property ContainerWidth Obsolete. Gets the value set by the page author as a hint to the Web Part of how wide to expect the containing Web Part zone to be.
Protected property Context (Inherited from Control.)
Public property Controls (Inherited from Part.)
Public property ControlStyle (Inherited from WebControl.)
Public property ControlStyleCreated (Inherited from WebControl.)
Public property CssClass (Inherited from WebControl.)
Public property CssStyleSheet The CSS file that needs to be registered on a page for this webpart. If this is set, CssRegistration.Register(filename) is called in this property during the OnPreRender() event. To register more Css style sheets, use CssRegistration.Register()
Public property DataItemContainer (Inherited from Control.)
Public property DataKeysContainer (Inherited from Control.)
Public property DefaultButton (Inherited from Panel.)
Public property Description Gets or sets a text description that appears when the user rests the mouse pointer on the title of a Web Part in a Web Part Page or gallery. (Overrides WebPart.Description.)
Protected property DesignMode (Inherited from Control.)
Public property DetailLink Obsolete. Gets or sets a URL to an HTML document that contains supplemental information.
Public property Dir Obsolete. Gets or sets the direction of the reading order for a Web Part's text and frame. Setting this value overrides the value specified for the System.Web.UI.Page.Culture property.
Public property Direction (Inherited from WebPart.)
Public property DisplayTitle (Inherited from WebPart.)
Public property EffectiveFrameType Obsolete. Gets the frame type that is used to render the Web Part frame at run time.
Public property EffectiveStorage Gets whether the instance of the Web Part returned is stored as personal instance or shared instance.
Public property EffectiveTitle Gets the title of specified the Web Part instance, including any disambiguation information added by the Web Part infrastructure.
Public property Enabled (Inherited from WebControl.)
Public property EnableTheming (Inherited from WebControl.)
Public property EnableViewState (Inherited from Control.)
Protected property Events (Inherited from Control.)
Public property ExportControlledProperties Obsolete. Gets or sets a value indicating whether a Web Part’s properties that are flagged as controlled properties by the Web Part developer can have their values exported in personal view.
Public property ExportMode (Inherited from WebPart.)
Public property Font (Inherited from WebControl.)
Public property ForeColor (Inherited from WebControl.)
Public property FrameState Obsolete. Gets or sets the initial state of the Web Part frame, which can be normal (expanded) or minimized.
Public property FrameType Obsolete. Gets or sets the style of the Web Part frame.
Public property GroupingText (Inherited from Panel.)
Public property HasAttributes (Inherited from WebControl.)
Protected property HasChildViewState (Inherited from Control.)
Public property HasSharedData (Inherited from WebPart.)
Public property HasUserData (Inherited from WebPart.)
Public property Height Gets or sets the fixed height for a Web Part on a Web Part Page.
Public property HelpLink Obsolete. Gets or sets a URL or file system path to a help file in HTML format.
Public property HelpMode Gets or sets the type of user interface used to display Help content for a Web Part. (Overrides WebPart.HelpMode.)
Public property HelpUrl Gets or sets a Help link. (Overrides WebPart.HelpUrl.)
Public property Hidden Gets or sets a value indicating whether the Web Part is displayed on a Web page. (Overrides WebPart.Hidden.)
Public property HorizontalAlign (Inherited from Panel.)
Public property ID Gets or sets an identifier for the Web Part. (Overrides Control.ID.)
Protected property IdSeparator (Inherited from Control.)
Public property ImportErrorMessage Error Message to use if an error occurs when a Webpart is imported. (Overrides WebPart.ImportErrorMessage.)
Protected property IsChildControlStateCleared (Inherited from Control.)
Public property IsClosed (Inherited from WebPart.)
Protected property IsEnabled (Inherited from WebControl.)
Public property IsIncluded Obsolete. Gets or sets a value indicating whether a Web Part that is added by another user or the administrator in the shared view of a Web Part page should be included in a personal view of the page.
Public property IsIncludedFilter Obsolete. Gets or sets the parameters used by the IRuntimeFilter interface to determine if the Web Part will be included on the Web Part Page.
Public property IsShared (Inherited from WebPart.)
Public property IsStandalone (Inherited from WebPart.)
Public property IsStatic (Inherited from WebPart.)
Protected property IsTrackingViewState (Inherited from Control.)
Protected property IsViewStateEnabled (Inherited from Control.)
Public property IsVisible Obsolete. Gets or sets whether the Web Part is visible.
Protected property LoadViewStateByID (Inherited from Control.)
Public property MissingAssembly Obsolete. Gets or sets the message shown to the user when importing a Web Part if the assembly for the Web Part is not installed on the target server.
Public property NamingContainer (Inherited from Control.)
Protected property OverflowAuto Gets a value indicating whether you can override the default setting for the cascading style sheet (CSS) overflow attribute when rendering the Web Part.
Public property Page (Inherited from Control.)
Public property Parent (Inherited from Control.)
Public property PartImageLarge Obsolete. Gets or sets the URL of an image file containing a 16 x 16 pixel image, typically used to depict icons.
Public property PartImageSmall Obsolete. Gets or sets the URL of an image file that appears in the title of a Web Part.
Public property PartOrder Obsolete. Gets or sets the order in which the Web Part appears within a Web Part zone.
Public property Permissions Obsolete. Gets the properties of a Web Part that can be modified currently.
Public property Qualifier Gets a unique identifier for a Web Part.
Public property RenderingCompatibility (Inherited from Control.)
Protected property SaveProperties Gets or sets a value that indicates whether the properties of a Web Part have changed and should be persisted at the end of page rendering.
Public property ScrollBars (Inherited from Panel.)
Protected property SerializeAll Gets whether a retrieved property value should be serialized for use in the client-side WPSC property collection.
Public property SerializedAttachedPropertiesShared Supports the SharePoint Foundation Web Part connection infrastructure. Not intended to be used directly from your code.
Public property SerializedAttachedPropertiesUser Supports the SharePoint Foundation Web Part connection infrastructure. Not intended to be used directly from your code.
Protected property ServerRelativeClassResourcePath Gets the server-relative path to Web Part class resources.
Protected property ShouldValidate Gets a value indicating whether the Web Part infrastructure should perform data validation of Web Part properties before setting them.
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from WebControl.)
Public property StorageKey Gets the unique identifier that is set by the Web Part infrastructure when a Web Part is added to a Web Part Zone.
Public property Style (Inherited from WebControl.)
Public property Subtitle Returns the value of the Caption property. (Overrides WebPart.Subtitle.)
Public property SupportsDisabledAttribute (Inherited from Panel.)
Public property SuppressWebPartChrome Gets or sets whether chrome is displayed for a static Web Part.
Public property TabIndex (Inherited from WebControl.)
Protected property TagKey (Inherited from WebControl.)
Protected property TagName (Inherited from WebControl.)
Public property TemplateControl (Inherited from Control.)
Public property TemplateSourceDirectory (Inherited from Control.)
Public property Title Gets or sets the title that appears in the title bar of a Web Part. (Overrides WebPart.Title.)
Public property TitleIconImageUrl Gets or sets the URL to an image used to represent the Web Part in its own title bar. (Overrides WebPart.TitleIconImageUrl.)
Public property TitleUrl Get or sets a title link. (Overrides WebPart.TitleUrl.)
Public property ToolTip (Inherited from WebControl.)
Public property UniqueID (Inherited from Control.)
Public property UnknownXmlElements Gets an UnknownXmlElementCollection object that contains XML elements from an imported SharePoint Web Part that were not mapped to a property on the Web Part.
Public property UseDefaultStyles Gets or sets whether the default font size and style are applied to the Web Part.
Public property Verbs (Inherited from WebPart.)
Protected property ViewState (Inherited from Control.)
Protected property ViewStateIgnoresCase (Inherited from Control.)
Public property ViewStateMode (Inherited from Control.)
Public property Visible (Inherited from Control.)
Public property WebBrowsableObject (Inherited from WebPart.)
Protected property WebPartManager (Inherited from WebPart.)
Protected property WebPartMenu Gets or sets the Web Part menu source that is rendered in the frame of the Web Part.
Public property Width Gets or sets the fixed width for a Web Part.
Protected property WorkItemTimeout Obsolete. NOTE: This property is now obsolete.
Public property Wrap (Inherited from Panel.)
Public property Zone (Inherited from WebPart.)
Public property ZoneID Gets or sets the Web Part zone in which to render the Web Part.
Public property ZoneIndex (Inherited from WebPart.)
Top

  Name Description
Protected method AddAttributesToRender (Inherited from Panel.)
Protected method AddedControl (Inherited from Control.)
Protected method AddParsedSubObject Used to process Web Part XML for static Web Parts. (Overrides Control.AddParsedSubObject(Object).)
Public method AfterDeserialize Called after a SharePoint Web Part's properties are deserialized from the SharePoint database or from a Web Part description file (.dwp). Suggested place for SharePoint Web Part upgrade code.
Public method ApplyStyle (Inherited from WebControl.)
Public method ApplyStyleSheetSkin (Inherited from Control.)
Protected method BuildProfileTree (Inherited from Control.)
Public method CanRunAt Obsolete. Returns a value that indicates where the implementation of a connection interface can run.
Protected method ClearCachedClientID (Inherited from Control.)
Protected method ClearChildControlState (Inherited from Control.)
Protected method ClearChildState (Inherited from Control.)
Protected method ClearChildViewState (Inherited from Control.)
Protected method ClearEffectiveClientIDMode (Inherited from Control.)
Public method CopyBaseAttributes (Inherited from WebControl.)
Protected method CreateChildControls (Inherited from Control.)
Protected method CreateControlCollection (Inherited from Control.)
Protected method CreateControlStyle (Inherited from Panel.)
Public method CreateEditorParts (Inherited from WebPart.)
Public method CreateWebPartMenu Called after the Microsoft ASP.NET Load event and used to modify or override the default menu.
Public method DataBind() (Inherited from Part.)
Protected method DataBind(Boolean) (Inherited from Control.)
Protected method DataBindChildren (Inherited from Control.)
Public method Dispose Releases all resources used by the Web Part. (Overrides Control.Dispose().)
Protected method EnsureChildControls (Inherited from Control.)
Protected method EnsureID (Inherited from Control.)
Public method EnsureInterfaces Obsolete. Provides notification for a connectable Web Part that it should ensure all its interfaces are registered using the RegisterInterface method.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FindControl(String) (Inherited from Control.)
Protected method FindControl(String, Int32) (Inherited from Control.)
Public method Focus (Inherited from Control.)
Protected method GetCustomBuilder Provides the ability to associate a dynamic builder with a custom property of a Web Part.
Public method GetData Obsolete. Called when the System.Web.UI.Control.PreRender event occurs to allow a Web Part to retrieve data.
Protected method GetDesignModeState (Inherited from Control.)
Public method GetDesignTimeFooter Returns the static HTML for the footer portion of a Web Part frame to a custom designer created by deriving from System.Web.UI.ControlDesigner.
Public method GetDesignTimeHeader Returns static HTML for the header portion of a Web Part frame to a custom designer created by deriving from System.Web.UI.ControlDesigner.
Public method GetHashCode (Inherited from Object.)
Public method GetInitEventArgs Obsolete. Returns the InitEventArgs object for the name of the interface that is passed in.
Public method GetRequiresData Obsolete. The virtual method that is called by the Web Part infrastructure when the System.Web.UI.Control.PreRender event occurs to indicate that a Web Part requires data.
Public method GetRouteUrl(Object) (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary) (Inherited from Control.)
Public method GetRouteUrl(String, Object) (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary) (Inherited from Control.)
Public method GetThemedImages Returns the list of themed images which this webpart uses in CSR, possibly null
Public method GetThemedLocalizedImages Returns the list of localized themed images which this webpart uses in CSR, possibly null
Public method GetToolParts Determines which tool parts are displayed in the tool pane of the Web-based Web Part design user interface, and the order in which they are displayed.
Public method GetType (Inherited from Object.)
Public method GetUniqueIDRelativeTo (Inherited from Control.)
Public method HasControls (Inherited from Control.)
Protected method HasEvents (Inherited from Control.)
Protected method IsLiteralContent (Inherited from Control.)
Protected method LoadControlState (Inherited from Control.)
Public method LoadResource Returns a string that describes the localized name, category, and description of the specified resource.
Protected method LoadViewState Restores view-state information from a previous request that was saved with the SaveViewState() method. (Overrides WebControl.LoadViewState(Object).)
Protected method MapPathSecure (Inherited from Control.)
Protected method MemberwiseClone (Inherited from Object.)
Public method MergeStyle (Inherited from WebControl.)
Protected method NotifyWorkItemComplete Obsolete. Indicates that work being performed on an external asynchronous thread that has been registered using the RegisterWorkItem method has completed.
Protected method OnBubbleEvent (Inherited from Control.)
Protected method OnClosing (Inherited from WebPart.)
Protected method OnConnectModeChanged (Inherited from WebPart.)
Protected method OnDataBinding The event handler for the System.Web.UI.Control.DataBinding event that occurs when a Web Part is binding to a data source. (Overrides Control.OnDataBinding(EventArgs).)
Protected method OnDeleting (Inherited from WebPart.)
Protected method OnEditModeChanged (Inherited from WebPart.)
Protected method OnInit The event handler for the System.Web.UI.Control.Init event that occurs as the Web Part is being instantiated. (Overrides Control.OnInit(EventArgs).)
Protected method OnLoad (Inherited from Control.)
Protected method OnPreRender The event handler for the System.Web.UI.Control.PreRender event that occurs immediately before the Web Part is rendered to its containing Web Part Page. (Overrides Control.OnPreRender(EventArgs).)
Protected method OnUnload The event handler for the System.Web.UI.Control.Unload event, which occurs when the Web Part is being unloaded from memory. (Overrides Control.OnUnload(EventArgs).)
Protected method OpenFile (Inherited from Control.)
Public method PartCacheInvalidate() Marks all the contents of the Web Part cache as outdated.
Protected method PartCacheInvalidate(Storage) Marks all contents of the specified storage type in the Web Part cache as outdated.
Protected method PartCacheInvalidate(Storage, String) Marks the specified cache entries of the specified storage type in the Web Part cache as outdated.
Protected method PartCacheRead Reads and returns a value from the specified location in the specified type of storage in the Web Part cache.
Protected method PartCacheWrite Stores the specified value of the specified type of storage in the Web Part cache.
Public method PartCommunicationConnect Obsolete. Used to notify a Web Part that it has been connected to another Web Part.
Public method PartCommunicationInit Obsolete. Provides a connectable Web Part with a method for firing any of its initialization events, such as the CellProviderInit or CellConsumerInit event.
Public method PartCommunicationMain Obsolete. Provides a connectable Web Part with a method to fire events for any of the main events of a connectable Web Part, such as the CellReady event.
Protected method RaiseBubbleEvent (Inherited from Control.)
Protected method RegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String) Obsolete. Registers an interface from the Microsoft.SharePoint.WebPartPages.Communication namespace for a connectable Web Part.
Protected method RegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean) Obsolete. Registers an interface from the Microsoft.SharePoint.WebPartPages.Communication namespace for a connectable Web Part with the option of specifying how cross-page connections are handled.
Protected method RegisterWorkItem Obsolete. Keeps track of work being done by an external thread, such as a Web Part that handles its own thread pool.
Protected method RegisterWorkItemCallback Obsolete. Queues a Web Part work item to the thread pool, invokes the specified delegate, and specifies an object to be passed to the delegate when serviced from the thread pool.
Protected method RemovedControl (Inherited from Control.)
Protected method Render Renders the control to the specified HTML writer. This method is inherited from the System.Web.UI.Control class. (Overrides WebControl.Render(HtmlTextWriter).)
Public method RenderBeginTag (Inherited from Panel.)
Protected method RenderChildren (Inherited from Control.)
Protected method RenderContents (Inherited from WebControl.)
Public method RenderControl(HtmlTextWriter) (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public method RenderEndTag (Inherited from Panel.)
Protected method RenderWebPart Renders the HTML for the body of a Web Part to the client.
Protected method RenderWorkItemTimeout Obsolete. Renders HTML in a Web Part when a work item has timed out.
Protected method ReplaceTokens Performs token replacement for a string, using the same algorithm used for URL-valued properties.
Protected method RequiresWebPartClientScript Indicates whether this Web Part has client-side script to register with the Web Part Page Services Component (WPSC) framework.
Protected method ResolveAdapter (Inherited from Control.)
Public method ResolveClientUrl (Inherited from Control.)
Public method ResolveUrl (Inherited from Control.)
Protected method SaveControlState (Inherited from Control.)
Protected method SaveViewState (Inherited from WebControl.)
Protected method SetDesignModeState (Inherited from Control.)
Protected method SetPersonalizationDirty (Inherited from WebPart.)
Public method SetRenderMethodDelegate (Inherited from Control.)
Protected method SetWebPartPageComponent
Public method ShouldSerializeAllowConnect Returns whether the AllowConnect property has changed from its default value.
Public method ShouldSerializeAllowEdit Returns whether the AllowEdit property has changed from its default value.
Public method ShouldSerializeAllowHide Returns whether the AllowHide property has changed from its default value.
Public method ShouldSerializeAllowMinimize Returns whether the AllowMinimize property has changed from its default value.
Public method ShouldSerializeAllowRemove Returns whether the AllowRemove property has changed from its default value.
Public method ShouldSerializeAllowZoneChange Returns whether the AllowZoneChange property has changed from its default value.
Public method ShouldSerializeConnectionID Returns whether the ConnectionID property has changed from its default value.
Public method ShouldSerializeConnections Returns whether the Connections property has changed from its default value.
Public method ShouldSerializeDescription Returns whether the Description property has changed from its default value.
Public method ShouldSerializeDetailLink Returns whether the DetailLink property has changed from its default value.
Public method ShouldSerializeDir Returns whether the Dir property has changed from its default value.
Public method ShouldSerializeExportControlledProperties Returns whether the ExportControlledProperties property has changed from its default value.
Public method ShouldSerializeFrameState Returns whether the FrameState property has changed from its default value.
Public method ShouldSerializeFrameType Returns whether the FrameType property has changed from its default value.
Public method ShouldSerializeHeight Returns whether the Height property has changed from its default value.
Public method ShouldSerializeHelpLink Returns whether the HelpLink property has changed from its default value.
Public method ShouldSerializeHelpMode Returns whether the HelpMode property has changed from its default value.
Public method ShouldSerializeID Returns whether the ID property has changed from its default value.
Public method ShouldSerializeIsIncluded Returns whether the IsIncluded property has changed from its default value.
Public method ShouldSerializeIsIncludedFilter Returns whether the IsIncludedFilter property has changed from its default value.
Public method ShouldSerializeIsVisible Returns whether the IsVisible property has changed from its default value.
Public method ShouldSerializeMissingAssembly Returns whether the MissingAssembly property has changed from its default value.
Public method ShouldSerializePartImageLarge Returns whether the PartImageLarge property has changed from its default value.
Public method ShouldSerializePartImageSmall Returns whether the PartImageSmall property has changed from its default value.
Public method ShouldSerializePartOrder Returns whether the PartOrder property has changed from its default value.
Public method ShouldSerializeTitle Returns whether the Title property has changed from its default value.
Public method ShouldSerializeWidth Returns whether the Width property has changed from its default value.
Public method ShouldSerializeZoneID Returns whether the ZoneID property has changed from its default value.
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from WebPart.)
Top

  Name Description
Public event DataBinding (Inherited from Control.)
Public event Disposed (Inherited from Control.)
Public event Init (Inherited from Control.)
Public event Load (Inherited from Control.)
Public event PreRender (Inherited from Control.)
Public event Unload (Inherited from Control.)
Top

  Name Description
Public field Static member LimitOneConnection Specifies that a connectable Web Part can accept no more than one connection to another Web Part.
Public field Static member UnlimitedConnections Specifies that a connectable Web Part can accept an unlimited number of connections to another Web Part.
Top

Show:
© 2014 Microsoft