SPField.GetFieldValueForClientRender method

When overridden in a derived class, converts the field type value into object for use in client Display, Edit and New item forms.

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

Syntax

'Declaration
Public Overridable Function GetFieldValueForClientRender ( _
    item As SPItem, _
    mode As SPControlMode _
) As Object
'Usage
Dim instance As SPField
Dim item As SPItem
Dim mode As SPControlMode
Dim returnValue As Object

returnValue = instance.GetFieldValueForClientRender(item, _
    mode)

public virtual Object GetFieldValueForClientRender(
    SPItem item,
    SPControlMode mode
)

Parameters

• item
  Type: Microsoft.SharePoint.SPItem

  An object containing a value of for this type of field.

• mode
  Type: Microsoft.SharePoint.WebControls.SPControlMode

  A value that specifies whether the returned object should be suitable for the Display form, or Edit form, or New form.

Return value

Type: System.Object
An object containing a representation of the field value used for client rendering in the form designated by mode.

Remarks

Override this method to provide, for example, a JSON array of selected values for a SPFieldMultiChoice field.

See also

Reference

SPField class

SPField members

Microsoft.SharePoint namespace