TaxonomyField.SetFieldValueByCollection method

Sets the value of the corresponding multi-value field in the list item to the properties of the Term objects in the specified collection, in the specified language.

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

Syntax

'Declaration
Public Sub SetFieldValueByCollection ( _
    item As ListItem, _
    terms As Collection(Of Term), _
    lcid As Integer _
)
'Usage
Dim instance As TaxonomyField
Dim item As ListItem
Dim terms As Collection(Of Term)
Dim lcid As Integer

instance.SetFieldValueByCollection(item, _
    terms, lcid)

public void SetFieldValueByCollection(
    ListItem item,
    Collection<Term> terms,
    int lcid
)

Parameters

• item
  Type: Microsoft.SharePoint.Client.ListItem

  The SPListItem object whose field is to be updated.

• terms
  Type: System.Collections.ObjectModel.Collection<Term>

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

• lcid
  Type: System.Int32

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

Exceptions

Exception	Condition
ArgumentException	One or more arguments to this method are a null reference (Nothing in Visual Basic), or the TaxonomyField object does not allow multiple values.

Remarks

Each Term has a maximum of one default Label for every language in the TermStore object. For each Term, the default Label in the default language of the TermStore object is used.

The field will be assigned a TaxonomyFieldValueCollection object.

See also

Reference

TaxonomyField class

TaxonomyField members

Microsoft.SharePoint.Client.Taxonomy namespace

GetFieldValue

AllowMultipleValues

TaxonomyFieldValue

Term

Microsoft.SharePoint.Taxonomy

Microsoft.SharePoint