Share via


TaxonomyField.GetValidatedString method

Validates the field value object using logic specific to the TaxonomyField object, and returns a serialized string representation of the validated field value object.

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

Syntax

'Declaration
Public Overridable Function GetValidatedString ( _
    value As Object _
) As ClientResult(Of String)
'Usage
Dim instance As TaxonomyField
Dim value As Object
Dim returnValue As ClientResult(Of String)

returnValue = instance.GetValidatedString(value)
public virtual ClientResult<string> GetValidatedString(
    Object value
)

Parameters

Return value

Type: Microsoft.SharePoint.Client.ClientResult<String>
A string that serializes the value object.

Exceptions

Exception Condition
SPFieldValidationException

The value parameter contains a TaxonomyFieldValue object with an invalid Term GUID.

Remarks

If the AllowMultipleValues() property of the TaxonomyField object is false, the value parameter is expected to be of type TaxonomyFieldValue.

If the AllowMultipleValues() property of the TaxonomyField object is true, the value parameter is expected to be of type TaxonomyFieldValueCollection or SPFieldLookupValueCollection.

See also

Reference

TaxonomyField class

TaxonomyField members

Microsoft.SharePoint.Client.Taxonomy namespace

GetValidatedString

Microsoft.SharePoint.Client.Taxonomy

Microsoft.SharePoint