Share via


SPField.Description Property

Gets or sets the description for a field.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
<ClientCallableAttribute> _
Public Property Description As String
    Get
    Set
'Usage
Dim instance As SPField
Dim value As String

value = instance.Description

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

Property Value

Type: System.String
A string that contains the description.

Remarks

The value that is returned can vary depending on the current thread's Thread.CurrentUICulture property. For more information, see the DescriptionResource property.

See Also

Reference

SPField Class

SPField Members

Microsoft.SharePoint Namespace

DescriptionResource