Share via


SummaryLink.Description Property

Gets or sets text that describes the SummaryLink object.

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

Syntax

'Declaration
Public Property Description As String
    Get
    Set
'Usage
Dim instance As SummaryLink
Dim value As String

value = instance.Description

instance.Description = value
public string Description { get; set; }

Property Value

Type: System.String
Text that describes the SummaryLink object.

Exceptions

Exception Condition
ArgumentException

Invalid property value. The value cannot exceed 1000 characters.

Remarks

The description text is free-form text that can be used to describe the purpose of the link. It is applicable to People links and Web page links. Before this value is set, the input is first stripped of leading and trailing whitespace. This value is available in the XSL rendering through the @Description parameter.

See Also

Reference

SummaryLink Class

SummaryLink Members

Microsoft.SharePoint.Publishing Namespace

SummaryLink