WebPart properties
The WebPart type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AccessKey | (Inherited from WebControl.) |
.gif "Protected property") |
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.AllowConnect.) |
|
AllowEdit | Gets or sets a value indicating whether an end user can modify a WebPart control in personal view. (Overrides WebPart.AllowEdit.) |
|
AllowHide | Gets or sets a value indicating whether end users are allowed to hide a WebPart control. (Overrides WebPart.AllowHide.) |
|
AllowMinimize | Gets or sets whether the Web Part can be minimized. (Overrides WebPart.AllowMinimize.) |
|
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.AllowZoneChange.) |
|
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.AuthorizationFilter.) |
|
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.CatalogIconImageUrl.) |
|
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.) |
|
ClientIDMode | (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 | 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() |
|
DataItemContainer | (Inherited from Control.) |
|
DataKeysContainer | (Inherited from Control.) |
|
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.Description.) |
|
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.HelpMode.) |
|
HelpUrl | Gets or sets a Help link. (Overrides WebPart.HelpUrl.) |
|
Hidden | Gets or sets a value indicating whether the Web Part is displayed on a Web page. (Overrides WebPart.Hidden.) |
|
HorizontalAlign | (Inherited from Panel.) |
|
ID | Gets or sets an identifier for the Web Part. (Overrides Control.ID.) |
|
IdSeparator | (Inherited from Control.) |
|
ImportErrorMessage | Error Message to use if an error occurs when a Webpart is imported. (Overrides WebPart.ImportErrorMessage.) |
|
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. |
|
RenderingCompatibility | (Inherited from Control.) |
|
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.Subtitle.) |
|
SupportsDisabledAttribute | (Inherited from Panel.) |
|
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.Title.) |
|
TitleIconImageUrl | Gets or sets the URL to an image used to represent the Web Part in its own title bar. (Overrides WebPart.TitleIconImageUrl.) |
|
TitleUrl | Get or sets a title link. (Overrides WebPart.TitleUrl.) |
|
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.) |
|
ViewStateMode | (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. NOTE: This property is now 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.) |
Top
Explicit interface implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private property") |
IControlBuilderAccessor.ControlBuilder | (Inherited from Control.) |
|
IDataBindingsAccessor.DataBindings | (Inherited from Control.) |
|
IExpressionsAccessor.Expressions | (Inherited from Control.) |
|
IDataBindingsAccessor.HasDataBindings | (Inherited from Control.) |
|
IExpressionsAccessor.HasExpressions | (Inherited from Control.) |
|
IControlDesignerAccessor.UserData | (Inherited from Control.) |
Top