Provides the base class for creating Microsoft SharePoint Foundation Web Parts.
The WebPart type exposes the following members.
Properties
Top
| Name | Description | |
|---|---|---|
![]() | AccessKey | (Inherited from WebControl.) |
![]() | Adapter | (Inherited from Control.) |
![]() | AllowClose | (Inherited from WebPart.) |
![]() | AllowConnect | Gets or sets a value that indicates whether the WebPart control allows other controls to form connections with it. (Overrides WebPart |
![]() | AllowEdit | Gets or sets a value indicating whether an end user can modify a WebPart control in personal view. (Overrides WebPart |
![]() | AllowHide | Gets or sets a value indicating whether end users are allowed to hide a WebPart control. (Overrides WebPart |
![]() | AllowMinimize | Gets or sets whether the Web Part can be minimized. (Overrides WebPart |
![]() | 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. |
![]() | 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 |
![]() | AppRelativeTemplateSourceDirectory | (Inherited from Control.) |
![]() | Attributes | (Inherited from WebControl.) |
![]() | AuthorizationFilter | Gets or sets an arbitrary string to determine whether a Web Part is authorized to be added to a page. (Overrides WebPart |
![]() | BackColor | (Inherited from WebControl.) |
![]() | BackImageUrl | (Inherited from Panel.) |
![]() | BindingContainer | (Inherited from Control.) |
![]() | BorderColor | (Inherited from WebControl.) |
![]() | BorderStyle | (Inherited from WebControl.) |
![]() | BorderWidth | (Inherited from WebControl.) |
![]() | BrowserDesignMode | Obsolete. Gets whether a Web Part is in design mode (modifying its layout or properties) in the Web browser. |
![]() | CacheType | Determines the type of caching being used by the Web server. |
![]() | 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. |
![]() | CatalogIconImageUrl | Gets or sets the URL to an image used to represent the Web Part in a catalog. (Overrides WebPart |
![]() | ChildControlsCreated | (Inherited from Control.) |
![]() | ChromeState | (Inherited from WebPart.) |
![]() | ChromeType | (Inherited from WebPart.) |
![]() | ClassResourcePath | Gets the base path to Web Part class resources. |
![]() | ClientID | (Inherited from Control.) |
![]() | ClientIDSeparator | (Inherited from Control.) |
![]() | ClientName | Gets the unique name of the Web Part used by the client-side Web Part Page Service Component (WPSC). |
![]() | ConnectErrorMessage | (Inherited from WebPart.) |
![]() | ConnectionID | Gets or sets the GUID that is used internally by the Web Part infrastructure as the unique identifier of a Web Part connection. |
![]() | Connections | Gets or sets the connection information that is stored with a connected Web Part. |
![]() | 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. |
![]() | Context | (Inherited from Control.) |
![]() | Controls | (Inherited from Part.) |
![]() | ControlStyle | (Inherited from WebControl.) |
![]() | ControlStyleCreated | (Inherited from WebControl.) |
![]() | CssClass | (Inherited from WebControl.) |
![]() | CssStyleSheet | |
![]() | DefaultButton | (Inherited from Panel.) |
![]() | 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 |
![]() | DesignMode | (Inherited from Control.) |
![]() | DetailLink | Obsolete. Gets or sets a URL to an HTML document that contains supplemental information. |
![]() | 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. |
![]() | Direction | (Inherited from WebPart.) |
![]() | DisplayTitle | (Inherited from WebPart.) |
![]() | EffectiveFrameType | Obsolete. Gets the frame type that is used to render the Web Part frame at run time. |
![]() | EffectiveStorage | Gets whether the instance of the Web Part returned is stored as personal instance or shared instance. |
![]() | EffectiveTitle | Gets the title of specified the Web Part instance, including any disambiguation information added by the Web Part infrastructure. |
![]() | Enabled | (Inherited from WebControl.) |
![]() | EnableTheming | (Inherited from WebControl.) |
![]() | EnableViewState | (Inherited from Control.) |
![]() | Events | (Inherited from Control.) |
![]() | 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. |
![]() | ExportMode | (Inherited from WebPart.) |
![]() | Font | (Inherited from WebControl.) |
![]() | ForeColor | (Inherited from WebControl.) |
![]() | FrameState | Obsolete. Gets or sets the initial state of the Web Part frame, which can be normal (expanded) or minimized. |
![]() | FrameType | Obsolete. Gets or sets the style of the Web Part frame. |
![]() | GroupingText | (Inherited from Panel.) |
![]() | HasAttributes | (Inherited from WebControl.) |
![]() | HasChildViewState | (Inherited from Control.) |
![]() | HasSharedData | (Inherited from WebPart.) |
![]() | HasUserData | (Inherited from WebPart.) |
![]() | Height | Gets or sets the fixed height for a Web Part on a Web Part Page. |
![]() | HelpLink | Obsolete. Gets or sets a URL or file system path to a help file in HTML format. |
![]() | HelpMode | Gets or sets the type of user interface used to display Help content for a Web Part. (Overrides WebPart |
![]() | HelpUrl | Gets or sets a Help link. (Overrides WebPart |
![]() | Hidden | Gets or sets a value indicating whether the Web Part is displayed on a Web page. (Overrides WebPart |
![]() | HorizontalAlign | (Inherited from Panel.) |
![]() | ID | Gets or sets an identifier for the Web Part. (Overrides Control |
![]() | IdSeparator | (Inherited from Control.) |
![]() | ImportErrorMessage | (Overrides WebPart |
![]() | IsChildControlStateCleared | (Inherited from Control.) |
![]() | IsClosed | (Inherited from WebPart.) |
![]() | IsEnabled | (Inherited from WebControl.) |
![]() | 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. |
![]() | 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. |
![]() | IsShared | (Inherited from WebPart.) |
![]() | IsStandalone | (Inherited from WebPart.) |
![]() | IsStatic | (Inherited from WebPart.) |
![]() | IsTrackingViewState | (Inherited from Control.) |
![]() | IsViewStateEnabled | (Inherited from Control.) |
![]() | IsVisible | Obsolete. Gets or sets whether the Web Part is visible. |
![]() | LoadViewStateByID | (Inherited from Control.) |
![]() | 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. |
![]() | NamingContainer | (Inherited from Control.) |
![]() | 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. |
![]() | Page | (Inherited from Control.) |
![]() | Parent | (Inherited from Control.) |
![]() | PartImageLarge | Obsolete. Gets or sets the URL of an image file containing a 16 x 16 pixel image, typically used to depict icons. |
![]() | PartImageSmall | Obsolete. Gets or sets the URL of an image file that appears in the title of a Web Part. |
![]() | PartOrder | Obsolete. Gets or sets the order in which the Web Part appears within a Web Part zone. |
![]() | Permissions | Obsolete. Gets the properties of a Web Part that can be modified currently. |
![]() | Qualifier | Gets a unique identifier for a Web Part. |
![]() | 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. |
![]() | ScrollBars | (Inherited from Panel.) |
![]() | SerializeAll | Gets whether a retrieved property value should be serialized for use in the client-side WPSC property collection. |
![]() | SerializedAttachedPropertiesShared | Supports the SharePoint Foundation Web Part connection infrastructure. Not intended to be used directly from your code. |
![]() | SerializedAttachedPropertiesUser | Supports the SharePoint Foundation Web Part connection infrastructure. Not intended to be used directly from your code. |
![]() | ServerRelativeClassResourcePath | Gets the server-relative path to Web Part class resources. |
![]() | ShouldValidate | Gets a value indicating whether the Web Part infrastructure should perform data validation of Web Part properties before setting them. |
![]() | Site | (Inherited from Control.) |
![]() | SkinID | (Inherited from WebControl.) |
![]() | StorageKey | Gets the unique identifier that is set by the Web Part infrastructure when a Web Part is added to a Web Part Zone. |
![]() | Style | (Inherited from WebControl.) |
![]() | Subtitle | Returns the value of the Caption property. (Overrides WebPart |
![]() | SuppressWebPartChrome | Gets or sets whether chrome is displayed for a static Web Part. |
![]() | TabIndex | (Inherited from WebControl.) |
![]() | TagKey | (Inherited from WebControl.) |
![]() | TagName | (Inherited from WebControl.) |
![]() | TemplateControl | (Inherited from Control.) |
![]() | TemplateSourceDirectory | (Inherited from Control.) |
![]() | Title | Gets or sets the title that appears in the title bar of a Web Part. (Overrides WebPart |
![]() | TitleIconImageUrl | Gets or sets the URL to an image used to represent the Web Part in its own title bar. (Overrides WebPart |
![]() | TitleUrl | Get or sets a title link. (Overrides WebPart |
![]() | ToolTip | (Inherited from WebControl.) |
![]() | UniqueID | (Inherited from Control.) |
![]() | 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. |
![]() | UseDefaultStyles | Gets or sets whether the default font size and style are applied to the Web Part. |
![]() | Verbs | (Inherited from WebPart.) |
![]() | ViewState | (Inherited from Control.) |
![]() | ViewStateIgnoresCase | (Inherited from Control.) |
![]() | Visible | (Inherited from Control.) |
![]() | WebBrowsableObject | (Inherited from WebPart.) |
![]() | WebPartManager | (Inherited from WebPart.) |
![]() | WebPartMenu | Gets or sets the Web Part menu source that is rendered in the frame of the Web Part. |
![]() | Width | Gets or sets the fixed width for a Web Part. |
![]() | WorkItemTimeout | Obsolete. |
![]() | Wrap | (Inherited from Panel.) |
![]() | Zone | (Inherited from WebPart.) |
![]() | ZoneID | Gets or sets the Web Part zone in which to render the Web Part. |
![]() | ZoneIndex | (Inherited from WebPart.) |
Methods
Top
| Name | Description | |
|---|---|---|
![]() | AddAttributesToRender | (Inherited from Panel.) |
![]() | AddedControl | (Inherited from Control.) |
![]() | AddParsedSubObject | Used to process Web Part XML for static Web Parts. (Overrides Control |
![]() | 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. |
![]() | ApplyStyle | (Inherited from WebControl.) |
![]() | ApplyStyleSheetSkin | (Inherited from Control.) |
![]() | BuildProfileTree | (Inherited from Control.) |
![]() | CanRunAt | Obsolete. Returns a value that indicates where the implementation of a connection interface can run. |
![]() | ClearChildControlState | (Inherited from Control.) |
![]() | ClearChildState | (Inherited from Control.) |
![]() | ClearChildViewState | (Inherited from Control.) |
![]() | CopyBaseAttributes | (Inherited from WebControl.) |
![]() | CreateChildControls | (Inherited from Control.) |
![]() | CreateControlCollection | (Inherited from Control.) |
![]() | CreateControlStyle | (Inherited from Panel.) |
![]() | CreateEditorParts | (Inherited from WebPart.) |
![]() | CreateWebPartMenu | Called after the Microsoft ASP.NET Load event and used to modify or override the default menu. |
![]() | DataBind | (Inherited from Part.) |
![]() | DataBind(Boolean) | (Inherited from Control.) |
![]() | DataBindChildren | (Inherited from Control.) |
![]() | Dispose | Releases all resources used by the Web Part. (Overrides Control |
![]() | EnsureChildControls | (Inherited from Control.) |
![]() | EnsureID | (Inherited from Control.) |
![]() | EnsureInterfaces | Obsolete. Provides notification for a connectable Web Part that it should ensure all its interfaces are registered using the RegisterInterface method. |
![]() | Equals | (Inherited from Object.) |
![]() | Finalize | (Inherited from Object.) |
![]() | FindControl(String) | (Inherited from Control.) |
![]() | FindControl(String, Int32) | (Inherited from Control.) |
![]() | Focus | (Inherited from Control.) |
![]() | GetCustomBuilder | Provides the ability to associate a dynamic builder with a custom property of a Web Part. |
![]() | GetData | Obsolete. Called when the System.Web.UI.Control.PreRender event occurs to allow a Web Part to retrieve data. |
![]() | GetDesignModeState | (Inherited from Control.) |
![]() | 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. |
![]() | 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. |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetInitEventArgs | Obsolete. Returns the InitEventArgs object for the name of the interface that is passed in. |
![]() | 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. |
![]() | 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. |
![]() | GetType | (Inherited from Object.) |
![]() | HasControls | (Inherited from Control.) |
![]() | HasEvents | (Inherited from Control.) |
![]() | IsLiteralContent | (Inherited from Control.) |
![]() | LoadControlState | (Inherited from Control.) |
![]() | LoadResource | Returns a string that describes the localized name, category, and description of the specified resource. |
![]() | LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState |
![]() | MapPathSecure | (Inherited from Control.) |
![]() | MemberwiseClone | (Inherited from Object.) |
![]() | MergeStyle | (Inherited from WebControl.) |
![]() | NotifyWorkItemComplete | Obsolete. Indicates that work being performed on an external asynchronous thread that has been registered using the RegisterWorkItem method has completed. |
![]() | OnBubbleEvent | (Inherited from Control.) |
![]() | OnClosing | (Inherited from WebPart.) |
![]() | OnConnectModeChanged | (Inherited from WebPart.) |
![]() | 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 |
![]() | OnDeleting | (Inherited from WebPart.) |
![]() | OnEditModeChanged | (Inherited from WebPart.) |
![]() | OnInit | The event handler for the System.Web.UI.Control.Init event that occurs as the Web Part is being instantiated. (Overrides Control |
![]() | OnLoad | (Inherited from Control.) |
![]() | 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 |
![]() | 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 |
![]() | OpenFile | (Inherited from Control.) |
![]() | PartCacheInvalidate | Marks all the contents of the Web Part cache as outdated. |
![]() | PartCacheInvalidate(Storage) | Marks all contents of the specified storage type in the Web Part cache as outdated. |
![]() | PartCacheInvalidate(Storage, String) | Marks the specified cache entries of the specified storage type in the Web Part cache as outdated. |
![]() | PartCacheRead | Reads and returns a value from the specified location in the specified type of storage in the Web Part cache. |
![]() | PartCacheWrite | Stores the specified value of the specified type of storage in the Web Part cache. |
![]() | PartCommunicationConnect | Obsolete. Used to notify a Web Part that it has been connected to another Web Part. |
![]() | PartCommunicationInit | Obsolete. Provides a connectable Web Part with a method for firing any of its initialization events, such as the CellProviderInit or CellConsumerInit event. |
![]() | 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. |
![]() | RaiseBubbleEvent | (Inherited from Control.) |
![]() | 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. |
![]() | 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. |
![]() | RegisterWorkItem | Obsolete. Keeps track of work being done by an external thread, such as a Web Part that handles its own thread pool. |
![]() | 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. |
![]() | RemovedControl | (Inherited from Control.) |
![]() | Render | Renders the control to the specified HTML writer. This method is inherited from the System.Web.UI.Control class. (Overrides WebControl |
![]() | RenderBeginTag | (Inherited from Panel.) |
![]() | RenderChildren | (Inherited from Control.) |
![]() | RenderContents | (Inherited from WebControl.) |
![]() | RenderControl(HtmlTextWriter) | (Inherited from Control.) |
![]() | RenderControl(HtmlTextWriter, ControlAdapter) | (Inherited from Control.) |
![]() | RenderEndTag | (Inherited from Panel.) |
![]() | RenderWebPart | Renders the HTML for the body of a Web Part to the client. |
![]() | RenderWorkItemTimeout | Obsolete. Renders HTML in a Web Part when a work item has timed out. |
![]() | ReplaceTokens | Performs token replacement for a string, using the same algorithm used for URL-valued properties. |
![]() | RequiresWebPartClientScript | Indicates whether this Web Part has client-side script to register with the Web Part Page Services Component (WPSC) framework. |
![]() | ResolveAdapter | (Inherited from Control.) |
![]() | ResolveClientUrl | (Inherited from Control.) |
![]() | ResolveUrl | (Inherited from Control.) |
![]() | SaveControlState | (Inherited from Control.) |
![]() | SaveViewState | (Inherited from WebControl.) |
![]() | SetDesignModeState | (Inherited from Control.) |
![]() | SetPersonalizationDirty | (Inherited from WebPart.) |
![]() | SetRenderMethodDelegate | (Inherited from Control.) |
![]() | SetWebPartPageComponent | |
![]() | ShouldSerializeAllowConnect | Returns whether the AllowConnect property has changed from its default value. |
![]() | ShouldSerializeAllowEdit | Returns whether the AllowEdit property has changed from its default value. |
![]() | ShouldSerializeAllowHide | Returns whether the AllowHide property has changed from its default value. |
![]() | ShouldSerializeAllowMinimize | Returns whether the AllowMinimize property has changed from its default value. |
![]() | ShouldSerializeAllowRemove | Returns whether the AllowRemove property has changed from its default value. |
![]() | ShouldSerializeAllowZoneChange | Returns whether the AllowZoneChange property has changed from its default value. |
![]() | ShouldSerializeConnectionID | Returns whether the ConnectionID property has changed from its default value. |
![]() | ShouldSerializeConnections | Returns whether the Connections property has changed from its default value. |
![]() | ShouldSerializeDescription | Returns whether the Description property has changed from its default value. |
![]() | ShouldSerializeDetailLink | Returns whether the DetailLink property has changed from its default value. |
![]() | ShouldSerializeDir | Returns whether the Dir property has changed from its default value. |
![]() | ShouldSerializeExportControlledProperties | Returns whether the ExportControlledProperties property has changed from its default value. |
![]() | ShouldSerializeFrameState | Returns whether the FrameState property has changed from its default value. |
![]() | ShouldSerializeFrameType | Returns whether the FrameType property has changed from its default value. |
![]() | ShouldSerializeHeight | Returns whether the Height property has changed from its default value. |
![]() | ShouldSerializeHelpLink | Returns whether the HelpLink property has changed from its default value. |
![]() | ShouldSerializeHelpMode | Returns whether the HelpMode property has changed from its default value. |
![]() | ShouldSerializeID | Returns whether the ID property has changed from its default value. |
![]() | ShouldSerializeIsIncluded | Returns whether the IsIncluded property has changed from its default value. |
![]() | ShouldSerializeIsIncludedFilter | Returns whether the IsIncludedFilter property has changed from its default value. |
![]() | ShouldSerializeIsVisible | Returns whether the IsVisible property has changed from its default value. |
![]() | ShouldSerializeMissingAssembly | Returns whether the MissingAssembly property has changed from its default value. |
![]() | ShouldSerializePartImageLarge | Returns whether the PartImageLarge property has changed from its default value. |
![]() | ShouldSerializePartImageSmall | Returns whether the PartImageSmall property has changed from its default value. |
![]() | ShouldSerializePartOrder | Returns whether the PartOrder property has changed from its default value. |
![]() | ShouldSerializeTitle | Returns whether the Title property has changed from its default value. |
![]() | ShouldSerializeWidth | Returns whether the Width property has changed from its default value. |
![]() | ShouldSerializeZoneID | Returns whether the ZoneID property has changed from its default value. |
![]() | ToString | (Inherited from Object.) |
![]() | TrackViewState | (Inherited from WebPart.) |
Fields
Top
| Name | Description | |
|---|---|---|
![]() ![]() | LimitOneConnection | Specifies that a connectable Web Part can accept no more than one connection to another Web Part. |
![]() ![]() | UnlimitedConnections | Specifies that a connectable Web Part can accept an unlimited number of connections to another Web Part. |
Explicit Interface Implementations
Top
| Name | Description | |
|---|---|---|
![]() ![]() | IAttributeAccessor | |
![]() ![]() | IAttributeAccessor | |
![]() ![]() | IParserAccessor | (Inherited from Control.) |
![]() ![]() | IControlBuilderAccessor | (Inherited from Control.) |
![]() ![]() | IDataBindingsAccessor | (Inherited from Control.) |
![]() ![]() | IExpressionsAccessor | (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor | (Inherited from Control.) |
![]() ![]() | IDataBindingsAccessor | (Inherited from Control.) |
![]() ![]() | IExpressionsAccessor | (Inherited from Control.) |
![]() ![]() | IConnectionData | |
![]() ![]() | IConnectionData | |
![]() ![]() | ICompositeControlDesignerAccessor | (Inherited from Part.) |
![]() ![]() | IControlDesignerAccessor | (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor | (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor | (Inherited from Control.) |
.gif)
.gif)
.gif)
.gif)
.gif)
.gif)
.gif)
.gif)
.gif)
.gif)