Export (0) Print
Expand All

WebPart.FrameState property

NOTE: This API is now obsolete.

Gets or sets the initial state of the Web Part frame, which can be normal (expanded) or minimized.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

[ObsoleteAttribute("Use ChromeState instead.")]
[WebPartStorageAttribute(Storage = Storage.Personal)]
public FrameState FrameState { get; set; }

Property value

Type: Microsoft.SharePoint.WebPartPages.FrameState
A FrameState enumeration value. The default value is FrameState.Normal.

If the value of the AllowMinimize property is false, setting this property to FrameState.Minimized will not minimize the Web Part.

The FrameState 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.

Community Additions

Show:
© 2014 Microsoft