Share via


SPFieldFile.GetFieldValueForClientRender method

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 Overrides Function GetFieldValueForClientRender ( _
    item As SPItem, _
    mode As SPControlMode _
) As Object
'Usage
Dim instance As SPFieldFile
Dim item As SPItem
Dim mode As SPControlMode
Dim returnValue As Object

returnValue = instance.GetFieldValueForClientRender(item, _
    mode)
public override Object GetFieldValueForClientRender(
    SPItem item,
    SPControlMode mode
)

Parameters

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

This override returns a Dictionary<TKey, TValue> (specifically, Dictionary<string, object>) in Display mode that can be converted to JSON to be passed to the client side rendering runtime. In Edit mode, this override returns a string (possibly empty), and in all other modes it returns and empty string.

See also

Reference

SPFieldFile class

SPFieldFile members

Microsoft.SharePoint namespace