TaxonomyField.SetFieldValueByTermCollection 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 SetFieldValueByTermCollection ( _
item As ListItem, _
terms As TermCollection, _
lcid As Integer _
)
'Usage
Dim instance As TaxonomyField
Dim item As ListItem
Dim terms As TermCollection
Dim lcid As Integer
instance.SetFieldValueByTermCollection(item, _
terms, lcid)
public void SetFieldValueByTermCollection(
ListItem item,
TermCollection terms,
int lcid
)
Parameters
item
Type: Microsoft.SharePoint.Client.ListItemThe SPListItem object whose field is to be updated.
terms
Type: Microsoft.SharePoint.Client.Taxonomy.TermCollectionThe collection of Term object whose properties are to be used to update the field value.
lcid
Type: System.Int32The 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 is used.
The field will be assigned a TaxonomyFieldValueCollection object.