SPField.GetJsonClientFormFieldSchema method

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.

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

Syntax

'Declaration
Public Overridable Function GetJsonClientFormFieldSchema ( _
    mode As SPControlMode _
) As Dictionary(Of String, Object)
'Usage
Dim instance As SPField
Dim mode As SPControlMode
Dim returnValue As Dictionary(Of String, Object)

returnValue = instance.GetJsonClientFormFieldSchema(mode)

public virtual Dictionary<string, Object> GetJsonClientFormFieldSchema(
    SPControlMode mode
)

Parameters

• mode
  Type: Microsoft.SharePoint.WebControls.SPControlMode

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

Return value

Type: System.Collections.Generic.Dictionary<String, Object>
The field schema information needed for client rendering. For example, the default implementation includes information about whether the field is hidden and read only.

See also

Reference

SPField class

SPField members

Microsoft.SharePoint namespace