Share via

Term.SetDescription method

  • Article

Sets the LCID-specific description of this Term object.

Namespace:  Microsoft.SharePoint.Client.Taxonomy
Assembly:  Microsoft.SharePoint.Client.Taxonomy (in Microsoft.SharePoint.Client.Taxonomy.dll)

Syntax

'Declaration
Public Sub SetDescription ( _
    description As String, _
    lcid As Integer _
)
'Usage
Dim instance As Term
Dim description As String
Dim lcid As Integer

instance.SetDescription(description, _
    lcid)

public void SetDescription(
    string description,
    int lcid
)

Parameters

Exceptions

Exception Condition
ArgumentOutOfRangeException

The LCID is not valid.
UnauthorizedAccessException

The current user has insufficient permissions to perform this operation.
TermStoreOperationException

This operation is invalid in the orphaned terms TermSet.The operation failed.
ArgumentException

The description is invalid.

Remarks

The description must be non-empty and cannot exceed 1000 characters, and cannot contain any of the following characters: [\t].

The current user must have TaxonomyRights.EditTerm permission to use this method. Call the CommitAll() to save this change to the database.

See also

Reference

Term class

Term members

Microsoft.SharePoint.Client.Taxonomy namespace