SharePoint Troubleshooting Guide

• Mar 13, 2021
• 5 minutes to read

This document describes common issues that may occur when using DevExpress ASP.NET controls in a SharePoint environment, as well as steps required to diagnose and resolve these issues.

Note

If you encounter any issue related to DevExpress ASP.NET controls within a SharePoint environment, try reproducing this issue in a standard ASP.NET WebApplication/WebSite project. If you can reproduce it (i.e., the issue is not related to the SharePoint environment), create a new support ticket in the Support Center, and attach a standard project instead of the SharePoint solution – to help expedite processing time.

If the issue is specific to the SharePoint environment, make sure that you have successfully completed all installation steps for enabling End-User Solutions or creating Custom Solutions.

Common Issues

• Unable to install the selected version of DevExpress controls on the SharePoint 2010 server.

  Versions 13.1 (v2013 vol 1) to 17.1 (v2017 vol 1) of DevExpress ASP.NET controls only support SharePoint 2013. Starting with version 17.1 (v2017 vol 1), DevExpress ASP.NET controls support SharePoint 2013 and SharePoint 2016. Refer to the SharePoint Support topic for information on version support.

• Controls are displayed without styling and some JavaScript errors occur.

  This issue usually occurs when the ASPxHttpHandlerModule configuration element is not registered in the SharePoint site’s Web.config file (usually located in the C:\inetpub\wwwroot\wss\VirtualDirectories\80\ directory). Refer to the ASPxHttpHandlerModule help topic to learn more on why this configuration element is required, and how to register it manually.

  XML

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <configuration>
    ...
    <system.webServer>
      ...
      <modules runAllManagedModulesForAllRequests="true">
        ...
        <add type="DevExpress.Web.ASPxHttpHandlerModule, DevExpress.Web.v19.1, Version=19.1.16.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" name="ASPxHttpHandlerModule" />
      </modules>
    </system.webServer>
  </configuration>
  

• Controls are not displayed correctly in the browser.

  By default, master pages in Windows SharePoint Services 3.0 and Microsoft Office SharePoint Server (MOSS) 2007 do not have the “Doctype” directive defined. As a result, browsers operate these pages in “Quirks” mode. DevExpress ASP.NET components require all supported document types to be defined on a page/master page.

  Refer to the Customizing Master Pages in Windows SharePoint Services article to learn more on how to avoid this issue.

• A page with DevExpress ASP.NET controls fails to run, but does not display error information.

  To see detailed error information about errors (i.e., enable Debug mode), temporarily edit the SharePoint Web.config file. Below is a list of properties you will need to change.

  • configuration -> SharePoint -> SafeMode -> set the CallStack property value to true
  • configuration -> system.web -> customErrors -> set the mode property value to Off
  • configuration -> system.web -> compilation -> set the batch property value to true
  • configuration -> system.web -> compilation -> set the debug property value to true
  • configuration -> system.web -> trust -> set the level property value to full

  The code sample below illustrates edited Web.config keys.

  XML

  <configuration>
    ...
    <SharePoint>
      <SafeMode CallStack="true" ...>
      </SafeMode>
    </SharePoint>
    <system.web>
      <customErrors mode="Off" />
      <compilation batch="true" debug="true" ...>
      </compilation>
      <trust level="Full" .../>
    </system.web>
  </configuration>
  

Known Issues

• Design time issues with versions prior to 13.2 (v2013 vol 2) are as follows.

  • Controls are not properly displayed in the Design View of the SharePoint SDK.
  • The “error CS0012: The type X is defined in an assembly that is not referenced. You must add a reference to assembly Y” exception is thrown after inserting a VisualWebPart in a page.

  Note that DevExpress ASP.NET control versions prior to 13.2 (v2013 vol 2) do not fully support design time in SharePoint projects, so some design time errors may occur. As a workaround, you can do the following:

  1. Create a regular ASP.NET WebSite/WebApplication project.
  2. Create the required control markup of a regular ASP.NET WebSite/WebApplication project at design time.
  3. Copy and paste the markup and “Register” directives to the SharePoint page/WebUserControl.
  4. Add the required DevExpress references to the SharePoint project (if they have not yet been added).

  Note

  Starting with version 13.2 (v2013 vol 2), DevExpress ASP.NET controls fully support design time in SharePoint projects, so you will not encounter these issues.

• SharePoint 2013 Visual Web Part cannot be compiled.

  Refer to the Why does the ‘The specified task executable “LC.exe” could not be run’ error occur when using DevExpress ASP.NET controls in a SharePoint project? KB Article to learn more on why this issue occurs, and how to resolve it.

Additional Support

If the information above does not meet your requirements, create a new ticket in the Support Center and provide the following information.

• the SharePoint and Windows version/edition, and the .NET CLR version
• the SharePoint site’s Web.config file (usually located in the C:\inetpub\wwwroot\wss\VirtualDirectories\80\ directory)
• the SharePoint site’s LOG files (usually located in the C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions&lt;VersionNumber>\LOGS\ directory where <VersionNumber>=15 for SharePoint 2013 and <VersionNumber>=16 for SharePoint 2016). Enable the VERBOSE logging mode and follow the required steps to display detailed information about thrown errors.
• the source code for diagnosing the issue (a sample WebPart/VisualWebPart project or the problematic *.aspx, *.ascx or *.master file, without non-essential dependences)

• if this issue is browser-specific, specify the browser family and version:

  • Take a screenshot of the Help -> About … dialog;
  • Take a screenshot of the Browser/Document mode settings (Press the F12 key to invoke the Dev Toolbar (for the IE browser only)).