"SitefinityWebApp is not defined" error in custom control

When creating a custom control or field control inheriting from a built-in one, there is a console error in the browser "SitefinityWebApp is not defined".

Aug 30, 2018
Knowledge

Title

URL Name

sitefinitywebapp-is-not-defined-in-custom-control

Article Number

000182209

Environment

Product: Sitefinity Version: 6.x, 7.x, 8.x, 9.x, 10.x, 11.x, 12.x OS: All supported OS versions Database: All supported Microsoft SQL Server versions

Question/Problem Description

When creating a custom control inheriting from build-in one, there is a console error in the browser "SitefinityWebApp is not defined".
Javascript error "SitefinityWebApp is not defined" is thrown when creating a custom control inheriting from a default one.
When a built-in content item or an item from a dynamic type is opened for edit "SitefinityWebApp is not defined" is thrown in the browser console? This leads to the inability to publish the item.

Steps to Reproduce

Clarifying Information

Error Message

ReferenceError: SitefinityWebApp is not defined

Defect Number

Enhancement Number

Cause

Cause 1. A namespace registration is missing in the JavaScript. The problem is coming from the used Descriptor Type for the client control. This can lead to not using the inherited control scripts.

Cause 2. This error can appear if there are custom implemented fields added to the content types.

Cause 3. Files are not properly loaded.

Resolution

Cause 1 resolution.
Set the correct ScriptDescriptor type.
- If there are no changes to the JavaScript specify the type of the base control
- If there are changes to the JavaScript specify the concrete type of the overriding control.

To set the type:

- Override the ScriptDescriptorType or ScriptDescriptorTypeName property of the base control, if such exists.
- If there is no such property, include the following code in the custom control:

public override IEnumerable<ScriptDescriptor> GetScriptDescriptors()
{
    var descriptors = base.GetScriptDescriptors();
    var descriptor = descriptors.Last() as ScriptControlDescriptor;
    descriptor.Type = "Telerik.Sitefinity.Security.Web.UI.UserProfileDetailWriteView"; // default control type (the inherited control type full name)
    return descriptors;
}

Cause 2 resolution: Make sure that "Build Action" for the scripts of the custom field is set to "Embedded Resource".

Cause 3 resolution: Modify the GetScriptReferences method and load the scripts based on the desired way:

When loading the files from the FileSystem use the ScriptReference overload with a single parameter:

public override IEnumerable<System.Web.UI.ScriptReference> GetScriptReferences()
{
    var scripts = new List<ScriptReference>(base.GetScriptReferences())
    {
        new ScriptReference("~/Path/To/File.js")
    };
    return scripts;
}

When loading the files as embedded resource use the ScriptReference overload with two parameters

public override IEnumerable<System.Web.UI.ScriptReference> GetScriptReferences()
        {
            var scripts = new List<ScriptReference>(base.GetScriptReferences())
            {
                new ScriptReference("SitefinityWebApp.Path.To.File.js", typeof(ClassName).Assembly.FullName)
            };
            return scripts;
        }

In this case, it is also required to register the script in the AssemblyInfo.cs file:

[assembly: WebResource("SitefinityWebApp.Path.To.File.js", "application/x-javascript")]

Workaround

Notes

Keyword Phrase

Last Modified Date

7/8/2019 6:06 AM

"SitefinityWebApp is not defined" error in custom control

Files(0)

Was this article helpful?

Was this article helpful?

"SitefinityWebApp is not defined" error in custom control

Information

Related Articles