SPField methods

The SPField type exposes the following members.

Methods

  Name Description
Public method AnnotateField When overridden in a derived class, adds attributes to the specified XML node and assigns them values from the properties of this SPField object.
Public method Delete Deletes the field.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetCustomProperty Gets the value of custom property with the specified name.
Public method GetFieldValue Converts the specified value into a field type value.
Public method GetFieldValueAsHtml Gets the field value in HTML format in order to render the field value directly on the page.
Public method GetFieldValueAsText Gets the field value as plain text.
Public method GetFieldValueForClientRender When overridden in a derived class, converts the field type value into object for use in client Display, Edit and New item forms.
Public method GetFieldValueForEdit Gets the field value that is rendered in Edit mode in Edit and New forms.
Public method GetHashCode (Inherited from Object.)
Public method GetJsonClientFormFieldSchema When overridden in a derived class, gets an object containing information from the field's schema that is useful for client rendering of the field in forms.
Public method GetProperty Gets the value of the specified property.
Public method GetType (Inherited from Object.)
Public method GetValidatedString Validates and converts the field value into a serialized form.
Protected method HasValue Internal function used to verify whether an object is null or not.
Public method ListsFieldUsedIn Returns information about the Web sites and lists in which the current field is used.
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAdded Handles the event that occurs after a field is added.
Public method OnAddingToContentType Handles the event that occurs when a field is added to a specified content type.
Public method OnDeleting Handles the event that occurs when a field is being deleted.
Public method OnDeletingFromContentType Handles the event that occurs when a field is deleted from a specified content type.
Protected method OnInitFieldNode This member is reserved for internal use and is not intended to be used directly from your code.
Public method OnUpdated Handles the event that occurs after changes are made to a field.
Public method ParseAndSetValue When overridden in a derived class, sets the specified field item to the specified value.
Public method ParseValue When overridden in a derived class, parses a potential value of the field and returns an object that can be assigned as the value of the field.
Public method RenderFieldValueAsJson When overridden in a derived class, returns the specified value in JSON format.
Public method RevertCustomizations Reverts customizations made to the field schema.
Public method SetCustomProperty Sets a value for the specified property.
Public method ToString Returns the title of the field. (Overrides Object.ToString().)
Public method Update() Updates the database with changes that are made to the field.
Public method Update(Boolean) Updates the database with changes that are made to the field and optionally propagates the changes to lists that implement the field.
Public method ValidateAndParseValue When overridden in a derived class, validates and parses the input value and returns a valid object that can be the value of the field.
Public method ValidateParseAndSetValue Calls ValidateAndParseValue(SPListItem, String) and assigns the returned object as the value of the field.

Top

See also

Reference

SPField class

Microsoft.SharePoint namespace