TaxonomyField.SetFieldValueByTerm method

Sets the value of the corresponding field in the list item to the properties of the specified Term in the specified language.

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

Syntax

'Declaration
Public Sub SetFieldValueByTerm ( _
    item As ListItem, _
    term As Term, _
    lcid As Integer _
)
'Usage
Dim instance As TaxonomyField
Dim item As ListItem
Dim term As Term
Dim lcid As Integer

instance.SetFieldValueByTerm(item, term, _
    lcid)

public void SetFieldValueByTerm(
    ListItem item,
    Term term,
    int lcid
)

Parameters

• item
  Type: Microsoft.SharePoint.Client.ListItem

  The SPListItem object whose field is to be updated.

• term
  Type: Microsoft.SharePoint.Client.Taxonomy.Term

  The Term object whose properties are used to update the field value.

• lcid
  Type: System.Int32

  The language code identifier (LCID) of the language of the default Label to use.

Exceptions

Exception	Condition
ArgumentException	One or more arguments to this method are a null reference (Nothing in Visual Basic).

Remarks

A Term has a maximum of one default Label for every new language in the TermStore object. The default Label used by this method is The default Label of the Term in the language specified by the lcid parameter, if one exists, otherwise the default language of the TermStore is used.

If the AllowMultipleValues() property is true, the field will be assigned a TaxonomyFieldValueCollection object. Otherwise, it will be assigned a TaxonomyFieldValue object.

See also

Reference

TaxonomyField class

TaxonomyField members

Microsoft.SharePoint.Client.Taxonomy namespace

GetFieldValue

TaxonomyFieldValue

Term

Microsoft.SharePoint.Taxonomy

Microsoft.SharePoint