WebPart.IsIncluded Property
NOTE: This API is now 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.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
<ObsoleteAttribute("Use IsClosed instead.")> _
<WebPartStorageAttribute(Storage := Storage.Personal)> _
Public Property IsIncluded As Boolean
Get
Set
'Usage
Dim instance As WebPart
Dim value As Boolean
value = instance.IsIncluded
instance.IsIncluded = value
[ObsoleteAttribute("Use IsClosed instead.")]
[WebPartStorageAttribute(Storage = Storage.Personal)]
public bool IsIncluded { get; set; }
Property Value
Type: System.Boolean
true if the Web Part is included; otherwise, false. The default value is true.
Remarks
This property can be personalized by individual users. Its WebPartStorageAttribute value is Storage.Personal, which specifies that the property can be stored on a per-user basis. Only users with the Personalize Web Part pages right can set this property. It can be set programmatically, or it can be set through the Web Part task pane in the personal view of the Web-based user interface, or by using a SharePoint Foundation-compatible HTML editor, such as SharePoint Designer.