Share via


WebPart.EffectiveFrameType property

NOTE: This API is now obsolete.

Gets the frame type that is used to render the Web Part frame at run time.

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

Syntax

'Declaration
<ObsoleteAttribute("Use WebPartZone.GetEffectiveChromeType() instead.")> _
Public ReadOnly Property EffectiveFrameType As FrameType
    Get
'Usage
Dim instance As WebPart
Dim value As FrameType

value = instance.EffectiveFrameType
[ObsoleteAttribute("Use WebPartZone.GetEffectiveChromeType() instead.")]
public FrameType EffectiveFrameType { get; }

Property value

Type: Microsoft.SharePoint.WebPartPages.FrameType
One of the FrameType enumeration values. The default is FrameType.Standard.

Remarks

This property is only available at run time. When the FrameType value of a Web Part is set to Default, the value of the EffectiveFrameType property will be FrameType.Standard , unless the value of the FrameType property of the WebPartZone that contains the Web Part has been set, in which case the EffectiveFrameType property will reflect that value.

The values of the EffectiveFrameType, ContainerWidth, and Permissions properties can change just before the Render event in ASP.NET is called. This is because the ZoneID property may have changed, which affects the values of these properties. These properties are guaranteed to have their final values, taking into account any needed zone changes, when the Web Part's RenderWebPart method is called.

See also

Reference

WebPart class

WebPart members

Microsoft.SharePoint.WebPartPages namespace