Problems with Custom Field Type list view rendering in 2013

Question

I'm upgrading an existing 2010 Custom Field Type to work with 2013. Where possible I'm attempting to re-use code from the 2010 version, to avoid duplicate work.

The main problem I'm coming across appears to be a couple of either misunderstandings or bugs with the List View rendering in 2013:

XSL

The existing XSL stylesheet (from 2010) appears to be entirely ignored (both header and Text_body modes). When I manually move it from the 14 folder to 15 it's processed (I know this because an error is thrown if it's invalid), but still not used.

I've attempted to use this with both CAMLRendering set to TRUE and FALSE.

CAML

When using CAMLRendering TRUE, the DisplayPattern for the body is used in most instances, but appears to be ignored when viewing anything after the first page.

I've confirmed this by viewing the inplview.aspx calls: On the first page the response array contains the CAML-output values as expected, but on the second they're empty strings.

General info

• The actual field's data is empty, as the values are generated b the CAML/XSL.
• The CFT is an actual working product on both 2007 and 2010, using CAML and XSL respectively.
• Using SPField.JSLink isn't currently an option, due to internal constraints.

Are there any workarounds to these problems? Are these known issues/bugs? I know this is really two questions, but they're closely bound to one another.

NB: This is a cross-post from MSDN: Problems with Custom Field Type list view rendering

I'd rather get the answer here, but I'm hoping one of the MS folks will offer something useful over there. If one is answered in one place I'll add it into the other too.

Answer 1

The CAML issue with paging appears to be related to the SPField.JSLink being defined:

When it is defined, the CAML output is correct (but HTML encoded by default, e.g. < becomes <).

When it isn't defined, only the first page receives the CAML output (unencoded).

Given the lack of response from MS on MSDN, I'm guessing this is a case of the Custom Field Type rendering not being backwards compatible again. :/ Oh well.

Answer 2

Custom Fields working with SP 2010 can easily be used with SharePoint 2013, although it is poorly documented. It took me some time to figure out.

All you need to change in your code is SharePoint DLL references: version 12 => 14.

Regarding CAMLRendering; Most likely you shouldn't enable it - it is used for Header Render Patterns only.

SOLUTION - LIST VIEW:

1) In SP 2013, create a new list and add your Custom Fields. Agreed, they currently don't render as expected.

2) Browse to your list - you should see the List View Web Part.

3) Set the page in edit mode

4) Open the WebPart properties panel for your List View WebPart

5) Expand "Miscellaneous" and check "Server render".

6) Click OK and reload the page

That's it - now the List View will use your XSL to render the display value.

This is equivalent to the following change in your XML definition for your view (usually defined in AllItems.aspx):

<WebPartPages:XsltListViewWebPart runat="server" ..... ServerRender="True" ... >

The attribute can also be modified through code: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.webpartpages.xsltlistviewwebpart.serverrender.aspx

SOLUTION - VIEW/CREATE/EDIT ITEM:

Create a new item - you will see the Web Part used for displaying, creating and editing items.

1) Set the page in edit mode

2) Open the WebPart properties panel for your Create Item Web Part

3) Expand "Miscellaneous", find "CSR Render Mode" and select "Server Render (ServerRender)"

4) Click OK and reload the page

That's it - your Custom Field is now rendered as expected when adding new items.

NOTICE: You'll have to do the exact same thing for all pages modifying or displaying your items - usually: DispForm.aspx, EditForm.aspx, NewForm.aspx. They use the same WebPart but in different control modes.

This is equivalent to the following change in your XML definition for your view/create/edit pages (usually defined in DispForm.aspx, EditForm.aspx, NewForm.aspx, as mentioned above):

<WebPartPages:ListFormWebPart runat="server" __MarkupType="xmlmarkup" WebPart="true" __WebPartId="{98AD2213-2FDA-4AD1-9AF8-7545F66257C3}" >
<WebPart xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/WebPart/v2">
  <Title>Test</Title>
  ...
  <ControlMode xmlns="http://schemas.microsoft.com/WebPart/v2/ListForm">New</ControlMode>
  ...
  <CSRRenderMode xmlns="http://schemas.microsoft.com/WebPart/v2/ListForm">ServerRender</CSRRenderMode>
</WebPart>
</WebPartPages:ListFormWebPart>

The attribute can also be modified through code: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.webpartpages.listformwebpart.csrrendermode.aspx