Skip to main content

Sitecore bug 502996 - Checkbox Rendering Parameter is taking value from standard values if not checked

 The Problem

In a recent project based on Sitecore 10.1.4, I encountered an intriguing issue with Sitecore’s rendering parameters. Specifically, I was working with a rendering parameter template that included Checkbox fields. The standard values for these fields were set to “checked” 

Observed Behavior

When reading these values for a page rendering, I noticed the following behavior:

  • Unchecking the Checkbox: The value remained “1”.
  • Unchecking the Checkbox and adding another rendering parameter with a value: The checkbox value became null (as expected).

This led me to question why the checkbox value remained “1” when unchecked, unless a value was added to the one of the rendering parameter field.


The Analysis

Upon further investigation and raising a support ticket with Sitecore, it was confirmed that this behavior is indeed a bug in the current Sitecore version. The checkbox rendering parameter appears to read from the standard value if unchecked, which is not the expected behavior.

Sitecore’s Response and Workaround

Sitecore Support provided the following insights and workaround:

Issue Definition: The false value for a boolean rendering parameter is retrieved as null.

Workaround: Consider the parameter value as true if it is present and equals “1”.

Sitecore has acknowledged the issue and registered a bug for the current version. To track the future status of this bug report, you can use reference number 502996. 


Conclusion

While this bug is being addressed, the suggested workaround is to treat the checkbox parameter value as true if it is present and equals “1”. This ensures that your rendering logic remains consistent until a permanent fix is released. I created a reusable utility in my solution to fetch checkbox type rendering parameter field values from the query parameter passed by the rendering. This method takes in the field name for the checkbox type rendering parameter field and returns it value  - 

public static bool GetCheckboxValueFromRawRenderingParameters(string fieldName)

{

    var rawRenderingParameters = RenderingContext.Current.Rendering?.Properties?.Where(i => i.Key.Equals("Parameters")).FirstOrDefault().Value?.Split('&');

    if (rawRenderingParameters.Any() && rawRenderingParameters.Contains(fieldName))

    {

        if (rawRenderingParameters.Contains($"{fieldName}=1"))

        {

            return true;

        }

        else

        {

            return false;

        }

    }

    else

    {

        var standardValue = RenderingContext.Current.Rendering.GetStandardValue();

        if (standardValue != null

            && standardValue.Fields[fieldName] != null)

        {

            return standardValue.Fields[fieldName].Value.ToBool();

        }

    }

    return false;

}


If you encounter similar issues or have further questions, consider reaching out to Sitecore Support for assistance.


Labels:

Comments

Post a Comment

POPULAR POSTS

Sitecore PowerShell Script to create all language versions for an item from en version

  We have lots of media items and our business wants to copy the data from en version of media item to all other language versions defined in System/Languages. This ensures that media is available in all the languages. So, we created the below powershell script to achieve the same -  #Get all language versions defined in System/Languages $languages = Get-ChildItem /sitecore/System/Languages -recurse | Select $_.name | Where-Object {$_.name -ne "en"} | Select Name #Ensuring correct items are updated by comparing the template ID  $items = Get-ChildItem -Path "/sitecore/media library/MyProjects" -Recurse | Where-Object {'<media item template id>' -contains $_.TemplateID} #Bulk update context to improve performance New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext) { foreach($item in $items){    foreach($language in $languages){ $languageVersion = Get-Item -Path $item.Paths.Path -Language $language.Name #Check if language versi...
Post a Comment
Read more

Export Sitecore media library files to zip using SPE

If you ever require to export Sitecore media files to zip (may be to optimize them), SPE (Sitecore Powershell Extension) has probably the easiest way to do this for you. It's as easy as the below 3 steps -  1. Right click on your folder (icons folder in snap)>Click on Scripts> Click on Download 2. SPE will start zipping all the media files placed within this folder. 3. Once zipping is done, you will see the Download option in the next screen. Click Download Zip containing the media files within is available on your local machine. You can play around with the images now. Hope this helps!! Like and Share ;)
Post a Comment
Read more

Make Sitecore instance faster using Roslyn Compiler

When we install the Sitecore instance on local, the first load is slow. After each code deploy also, it takes a while for the Sitecore instance to load and experience editor to come up. For us, the load time for Sitecore instance on local machines was around 4 minutes. We started looking for ways to minimize it and found that if we update our Web.config to use Roslyn compiler and include the relevant Nugets into the project, our load times will improve. We followed the simple steps - Go to the Project you wish to add the NuGet package and right click the project and click 'Manage NuGet Packages'. Make sure your 'Package Source' is set to nuget.org and go to the 'Browse' Tab and search Microsoft.CodeDom.Providers.DotNetCompilerPlatform. Install whichever version you desire, make sure you note which version you installed. You can learn more about it  here . After installation, deploy your project, make sure the Microsoft.CodeDom.Providers.DotNetCompilerPlatform.d...
1 comment
Read more

Experience of a first time Sitecore MVP

The Journey I have been working in Sitecore for almost 10 years now. When I was a beginner in Sitecore, I was highly impressed by the incredible community support. In fact, my initial Sitecore learning path was entirely based on community written blogs on Sitecore. During a discussion with my then technology lead Neeraj Gulia , he proposed the idea that I should start giving back to developer community whenever I get chance. Just like I have been helped by many developers via online blogs, stackoverflow etc., I should also try to help others. Fast forward a few years and I met  Nehemiah Jeyakumar  (now an MVP). He had a big archive of his technical notes in the form Sitecore blogs. I realized my first blog dont have to be perfect and it can be as simple as notes to a specific problem for reference in future. That's when I probably created my first blog post on Sitecore. At that time, I didn't knew about the Sitecore MVP program. Over the years, I gained more confidence to writ...
2 comments
Read more

Clean Coding Principles in CSharp

A code shall be easy to read and understand. In this post, I am outlining basic principles  about clean coding after researching through expert recommended books, trainings and based on my experience. A common example to start with is a variable declaration like - int i  The above statement did not clarify the purpose of variable i. However,  the same variable can be declared as -  int pageNumber The moment we declared the variable as int pageNumber, our brain realized that the variable is going to store the value for number of pages. We have set the context in our brain now and it is ready to understand what the code is going to do next with these page numbers. This is one of the basic advantages of clean coding. Reasons for clean coding -  • Reading clean code is easier - Every code is revisited after certain amount of time either by the same or different developer who created it. In both the cases, if the code is unclean, its difficult to understand and u...
Post a Comment
Read more