Sitecore bug solution: Media Library item Title meta info field not working

-

The problem

We have found that a number of Sitecore versions (at minimum up to 7.2) have a problem with defining the Title field (used for onhover's) of Media items such as images.
Even though Sitecore has a Title field on media library items (metadata), it is not rendered correctly. We tested this on multiple sitecore environments with these scenarios:

  • using the sc:image fieldrenderer
  • rich text field using an inclosed image from the media library

I opened up a ticket with Sitecore and they acknowledged the problem as a bug and will take this up with their patching and version releases.

In the meanwhile you can

As a workaround, you can do the following:

To resolve this issue in the <sc:image> XSL Extension Control

You can override the <processor type="Sitecore.Pipelines.RenderField.GetImageFieldValue, Sitecore.Kernel" /> processor in the <renderField> pipeline.

You should create your own class.
For example:

1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class GetImageFieldValue
    {
        protected virtual ImageRenderer CreateRenderer()
        {
            return new ImageRenderer();
        }

        public void Process(RenderFieldArgs args)
        {
            if (args.FieldTypeKey == "image")
            {
                ImageRenderer renderer = this.CreateRenderer();
                renderer.Item = args.Item;
                renderer.FieldName = args.FieldName;
                renderer.FieldValue = args.FieldValue;
                renderer.Parameters = args.Parameters;
                //
                if (!args.Parameters.Keys.Contains("title"))
                {
                    Field innerField = args.Item.Fields[args.FieldName];
                    ImageField imageField = new ImageField(innerField, args.FieldValue);
                    if (imageField.MediaItem != null)
                        renderer.Parameters.Add("title", imageField.MediaItem.Fields["title"].Value);
                }
                //
                args.WebEditParameters.AddRange(args.Parameters);
                RenderFieldResult result = renderer.Render();
                args.Result.FirstPart = result.FirstPart;
                args.Result.LastPart = result.LastPart;
                args.DisableWebEditContentEditing = true;
                args.DisableWebEditFieldWrapping = true;
                args.WebEditClick = "return Sitecore.WebEdit.editControl($JavascriptParameters, 'webedit:chooseimage')";
            }
        }
    }


Build the solution and move the .dll file to the /Website/bin folder. 
Change the <processor type="Sitecore.Pipelines.RenderField.GetImageFieldValue, Sitecore.Kernel" /> processor.
 Example:
   <processor type="Namespace.YourProcessorClass, AssemblylName" />

To resolve this issue in the Rich Text field

You can override  <CodeBeside Type="Sitecore.Shell.Controls.RichTextEditor.InsertImage.InsertImageForm,Sitecore.Client"/>  in the InsertImage.xml file (Website\sitecore\shell\Controls\Rich Text Editor\InsertImage).
You should create your own class and inherit it from the Sitecore.Shell.Controls.RichTextEditor.InsertImage.InsertImageForm class.
Override the OnOk method.
Example:

1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
protected override void OnOK(object sender, EventArgs args)
        {
            Assert.ArgumentNotNull(sender, "sender");
            Assert.ArgumentNotNull(args, "args");
            string str = this.Filename.Value;
            if (str.Length == 0)
            {
                SheerResponse.Alert("Select a media item.", new string[0]);
            }
            else
            {
                Item root = this.DataContext.GetRoot();
                if (root != null)
                {
                    Item rootItem = root.Database.GetRootItem();
                    if ((rootItem != null) && (root.ID != rootItem.ID))
                    {
                        str = FileUtil.MakePath(root.Paths.Path, str, '/');
                    }
                }
                MediaItem item = this.DataContext.GetItem(str);
                if (item == null)
                {
                    SheerResponse.Alert("The media item could not be found.", new string[0]);
                }
                else if (!(MediaManager.GetMedia(MediaUri.Parse((Item)item)) is ImageMedia))
                {
                    SheerResponse.Alert("The selected item is not an image. Select an image to continue.", new string[0]);
                }
                else
                {
                    MediaUrlOptions shellOptions = MediaUrlOptions.GetShellOptions();
                    string text = !string.IsNullOrEmpty(HttpContext.Current.Request.Form["AlternateText"]) ? HttpContext.Current.Request.Form["AlternateText"] : item.Alt;
                    Tag image = new Tag("img");
                    this.SetDimensions(item, shellOptions, image);
                    image.Add("Src", MediaManager.GetMediaUrl(item, shellOptions));
                    image.Add("Alt", StringUtil.EscapeQuote(text));
                    //
                    if (!string.IsNullOrEmpty(item.Title))
                        image.Add("Title", StringUtil.EscapeQuote(item.Title));
                    //
                    if (this.Mode == "webedit")
                    {
                        SheerResponse.SetDialogValue(StringUtil.EscapeJavascriptString(image.ToString()));
                        base.OnOK(sender, args);
                    }
                    else
                    {
                        SheerResponse.Eval("scClose(" + StringUtil.EscapeJavascriptString(image.ToString()) + ")");
                    }
                }
            }
        }

Also you should copy the SetDimensions method from the InsertImageForm class.
Example:

1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
private void SetDimensions(MediaItem item, MediaUrlOptions options, Tag image)
        {
            Assert.ArgumentNotNull(item, "item");
            Assert.ArgumentNotNull(options, "options");
            Assert.ArgumentNotNull(image, "image");
            NameValueCollection form = HttpContext.Current.Request.Form;
            if ((!string.IsNullOrEmpty(form["Width"]) && (form["Width"] != item.InnerItem["Width"])) && (form["Height"] != item.InnerItem["Height"]))
            {
                int num;
                int num2;
                if (int.TryParse(form["Width"], out num))
                {
                    options.Width = num;
                    image.Add("width", num.ToString());
                }
                if (int.TryParse(form["Height"], out num2))
                {
                    options.Height = num2;
                    image.Add("height", num2.ToString());
                }
            }
            else
            {
                image.Add("width", item.InnerItem["Width"]);
                image.Add("height", item.InnerItem["Height"]);
            }
        }

Build the solution and move the .dll file to the /Website/bin folder. Change <CodeBeside Type="Sitecore.Shell.Controls.RichTextEditor.InsertImage.InsertImageForm,Sitecore.Client"/> in the InsertImage.xml file.
 Example:
   <CodeBeside="Namespace.YourProcessorClass, AssemblylName" />

Hope this helps any of you who might currently be facing this problem !
And a big thanks to Support for acknowledging this problem !

Comments

Post a Comment

Popular posts from this blog

Stupid exception: Device is not ready – System.IOException .net

-
When installing a Sitecore implementation from an development server environment to my laptop I ran into an absolutely stupid error. And it's great to have this kind of errors pop up from time to time even if you have been in the development world for so long and are still unable to fix it immediately. So, what error did I get? Device is not ready – System.IOException .net That is right... Nothing at all related to Sitecore. But then you start to doubt that as my stacktrace showed to Lucene [IOException: The device is not ready. ] System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath) +1091 System.IO.Directory.InternalCreateDirectory(String fullPath, String path, Object dirSecurityObj, Boolean checkHost) +1413 System.IO.Directory.InternalCreateDirectoryHelper(String path, Boolean checkHost) +92 Sitecore.IO.FileUtil.EnsureFolder(String path) +128 Sitecore.ContentSearch.LuceneProvider.LuceneIndex.CreateDirectory(String folder) +100 Sitecore.Co...
Read more

Date Ranges in C#

-
DateRange utility class Throughout development there are a number of typical things that tend to recur. One of these is implementing a means to display start and end dates for News, Events, Symposiums, Lives etc etc Writing a little class that manages printing these dates seemed like a necessary task that just had to be done in order to make this tedious task be a thing of the past. Therefore I created my "DateRange" class (what's in a name) that should handle this entirely for you. The Idea The intriquities of displaying a datetime range should be an abstraction. You should only need to worry about passing the correct dates (start and end - if applicable) to the Utility class combined with an optional formatting. The class can be entirely configured through use of Enumerations for all the separate settings such as DayFormat etc. An additional class was used to implement this utility, the StringValue attribute class. You can easily use thie class to a...
Read more

Sitecore 8.2 in-depth preview + 8.3 update info and Sitecore Ecommerce information

-
Image
During the last Sitecore User group session here in Belgium, Ryan Donovan was featured as the central speaker. The following two topics were on the agenda: Sitecore Commerce An in-depth information on 8.2 and 8.3 I was impressed by the drive behind Ryan and his team(s). It emphasized the drive that is pushing Sitecore forward. Sitecore is putting a lot of effort in producing well hardened and tested product releases that bring new features and rich applications. Sitecore Commerce Previous Sitecore commerce solutions were structured around either SCpbCS and SCpbMD. However, the vNext commerce product has been newly developed from the ground up. Previously, the commerce solution focussed itself around the architecture of Commerce Server to provide and API, manage the products and to derive the entire feature set from. With this Commerce vNext solution, Sitecore has set forward the aspiration to become one of the market leaders in commerce. The fist aim is to focu...
Read more