Share via


WebPart.HelpMode property

Gets or sets the type of user interface used to display Help content for a Web Part.

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

Syntax

'Declaration
<WebPartStorageAttribute(Storage.Shared)> _
Public Overrides Property HelpMode As WebPartHelpMode
    Get
    Set
'Usage
Dim instance As WebPart
Dim value As WebPartHelpMode

value = instance.HelpMode

instance.HelpMode = value
[WebPartStorageAttribute(Storage.Shared)]
public override WebPartHelpMode HelpMode { get; set; }

Property value

Type: System.Web.UI.WebControls.WebParts.WebPartHelpMode
A WebPartHelpMode enumeration value. The default is Modeless.

Remarks

Use this property to control how a browser displays Help content for a Web Part when a user clicks Help on the Web Part menu. Set the property with a HelpMode enumeration value. Help modes are described in the following table.

Help mode

Browser behavior

Modal

Opens a separate browser window. The user must close the window before returning to the Web Parts page.

Modeless

Opens a separate browser window. The user does not have to close the window before returning to the Web Parts page.

Navigate

Replaces the Web Parts page in the browser window.

See also

Reference

WebPart class

WebPart members

Microsoft.SharePoint.WebPartPages namespace