GetValidatedString Method
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

SPField.GetValidatedString Method

Windows SharePoint Services 3

Used for data serialization logic and for field validation logic that is specific to a custom field type to convert the field value object into a validated, serialized string.

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

public virtual string GetValidatedString(
	Object value


Type: System.Object
An object that represents the value object to convert.

Return Value

Type: System.String
A string that serializes the value object.

In a custom type-specific class, override the GetValidatedString method to define the following kinds of logic:

  • Data-validation, for example, to throw an exception in server-side code if the field is required.

  • Pre-update data processing, for example, to filter out bad data but not fail validation.

  • Serialization, for example, to convert a field value object into string format.

© 2016 Microsoft