SettingsLink Class

The SettingsLink class implements rendering for the Web Part Page menu (Modify Shared Page or Modify My Page).

System.Object

System.Web.UI.Control

  **Microsoft.SharePoint.WebPartPages.SettingsLink**

Public Constructors

The following table shows the constructors of the SettingsLink class and a brief description of each.

Name Description
SettingsLink Initializes a new instance of the SettingsLink class.
SettingsLink(String) Initializes a new instance of the SettingsLink class.

Public Methods

The following table shows the methods of the SettingsLink class and a brief description of each.

Name Description
GetDesignTimeHtml Retrieves the HTML to render the SettingsLink control in a design-time environment.
Render(System.Web.UI.HtmlTextWriter) Renders the Web Part Page menu.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Remarks

The Web Part menu implemented by the SettingsLink class will only be displayed if the user has sufficient rights to modify the page. The menu options displayed on the menu also depend on the user's permissions.

If anonymous access is turned on, the Web Part Page menu will not be rendered until the user is authenticated. In this case, the AuthenticationButton control should be added to the page.

The menu rendered by the SettingsLink class is identical to the menu rendered in the TitleBarWebPart.

Example

The following code example shows how to change the display of the Web Part Page menu.

Requirements

Namespace: Microsoft.SharePoint.WebPartPages

Platforms: Microsoft Windows Server 2003

Assembly: Microsoft SharePoint Team Services (in Microsoft.SharePoint.dll)

Security: Code Access Security