Share via


SPContentType.Description Property

Gets or sets a string that contains a description of the content type.

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

Syntax

'Declaration
<ClientCallableConstraintAttribute(Type := ClientCallableConstraintType.NotNull)> _
<ClientCallableAttribute> _
Public Property Description As String
    Get
    Set
'Usage
Dim instance As SPContentType
Dim value As String

value = instance.Description

instance.Description = value
[ClientCallableConstraintAttribute(Type = ClientCallableConstraintType.NotNull)]
[ClientCallableAttribute]
public string Description { get; set; }

Property Value

Type: System.String
Text describing the content type. The default value is String.Empty.

Exceptions

Exception Condition
ArgumentNullException

You are not permitted to set the property to a a null reference (Nothing in Visual Basic) value.

Remarks

The content type’s description is displayed in the user interface. The description can help a user who is creating a new list to decide whether the content type is appropriate for the list.

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

See Also

Reference

SPContentType Class

SPContentType Members

Microsoft.SharePoint Namespace

DescriptionResource