Share via


WebPartGalleryItem.GetPreviewHtml method

When overridden in a derived class, returns a Hypertext Markup Language (HTML) preview of the WebPart.

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

Syntax

'Declaration
Public MustOverride Function GetPreviewHtml As String
'Usage
Dim instance As WebPartGalleryItem
Dim returnValue As String

returnValue = instance.GetPreviewHtml()
public abstract string GetPreviewHtml()

Return value

Type: System.String
An HTML preview of the WebPart.

Remarks

This is an abstract method that must be inherited in order to return the HTML preview for the WebPart that the current WebPartGalleryItem represents.

See also

Reference

WebPartGalleryItem class

WebPartGalleryItem members

Microsoft.SharePoint.WebPartPages namespace