spribbon Discussions Rss Feed

New Post: MRUSplitButton, TextBox and DropDown not working in CustomGroup

omlin — Fri, 26 Apr 2013 10:18:01 GMT

Hi jho,

Thanks for your feedback, I appreciate this :)

It's hard to say what's wrong in your case, unless you provide some code to chew on.

First things first, TextBox and DropDown can't be used with Simple template, since these are controls that have fixed size. I think I have this mentioned somewhere in documentation or in intellisense, but maybe I need to emphasize this fact, because you're not the first who stumbles on it. So you have to either create a custom template yourself or use ThreeRow.

Also it's not quite clear what you mean by "putting controls into the collection and binding them per location". Really, the code fragment would be of much help.

Best,
Andrei

New Post: MRUSplitButton, TextBox and DropDown not working in CustomGroup

jho — Fri, 26 Apr 2013 09:34:51 GMT

Hi,

I want to use MRUSplitButton, TextBox, DropDown and SplitButton in a custom group. Only the SplitButton and the usual Button works. The others aren't displayed in a custom group. As I bind them to a native group, e.g. Ribbon.ListItem.Manage, it's working. But not in mine.

I've tried the simple and the three row templates. I tried to bind it via object model (putting the controls into the collection) and binding them per location.

What did I miss? Thank you for your great job!

New Post: SharePoint 2013 support

tigrantopchyan — Sun, 21 Apr 2013 08:33:19 GMT

Hello.
Is SharePoint 2013 support planned for this library ? If yes is there work in progress ? Our team would like to support this project.

New Post: Get the resulting XML

omlin — Thu, 14 Feb 2013 20:56:08 GMT

There is no straight way to do it.
Though I can think of the following workaround:

Create RibbonCustomAction and deploy it, say, to a web.
Open up powershell and run the following script:

$w = get-spweb http://path-to-your-site
$w.UserCustomActions | Format-List > c:\temp\usercustomactions.txt

After that you can open this file in Notepad and copy the XML out of there.

New Post: Some Ribbon Templates

prg12 — Thu, 14 Feb 2013 14:45:40 GMT

Hi.

I think you need to add something like...

public static GroupTemplateDefinition[] AllTemplates

    {
        get
        {
            return new GroupTemplateDefinition[]
            {
                SimpleTemplate,
                ThreeRowTemplate,
                ##YourTemplateName##           
          };
        }
    }

New Post: Get the resulting XML

kwn34 — Mon, 11 Feb 2013 17:57:27 GMT

Hi again,

How can I get the whole XML code generated by the FluentRibbon API in my SharePoint solution ?

Thanks again :)

New Post: Transforming native-ribbon XML (SharePoint/Project Server) into c#class

kwn34 — Mon, 11 Feb 2013 16:44:38 GMT

Re,

The ribbon definition in Project Server is slightly different, so I couldn't use the StandardButtons.tt template file. I had to create a new one, specifically for Project Server.

The following code only creates the buttons of the Project Center group (hardcoded), but at least, it's a start:

<#@ template debug="true" hostSpecific="true"  language="C#" #>
<#@ output extension=".cs" encoding="UTF-8" #>
<#@ Assembly Name="System.Core.dll" #>
<#@ Assembly Name="System.Xml.dll" #>
<#@ Assembly Name="System.Xml.Linq.dll" #>
<#@ import namespace="System" #>
<#@ import namespace="System.IO" #>
<#@ import namespace="System.Diagnostics" #>
<#@ import namespace="System.Reflection" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Collections" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="System.Xml.Linq" #>

using System;
using Microsoft.SharePoint.Utilities;
using FluentRibbon.Definitions;
using FluentRibbon.Definitions.Controls;

namespace FluentRibbonExtension.Libraries
{
    /// <summary>
    /// This library contains control definitions
    /// </summary>
    public class ControlLibraryExtension : FluentRibbon.Libraries.ControlLibrary
    {
        /// <summary>
        /// OOTB SharePoint ribbon buttons.
        /// </summary>
        public class ProjectServerButtons
        {
            public class ProjectCenter {
<#
        
List<XElement> tabElements = new List<XElement>();

Func<XAttribute, string> GetValueFromAttribute = a => a == null ? String.Empty : a.Value;

XDocument doc = XDocument.Load(@"C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\PWARibbon\listtemplates\pwaribbon.xml");
XDocument resx = XDocument.Load(@"C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\Resources\pwafeatures.resx");
XNamespace spns = XNamespace.Get("http://schemas.microsoft.com/sharepoint/");

var root = doc.Element(spns + "Elements"); // single node

// récupération d'un noeud CustomAction spécifique.
XElement projectCenterNode = (from x in root.Elements(spns + "CustomAction")
                                where x.Attribute("Id").Value == "Ribbon.ContextualTabs.ProjectCenter"
                                select x).FirstOrDefault();

// ici, on est sur un noeud custom action.
var commandUIDefinitions = projectCenterNode.Element(spns + "CommandUIExtension").Element(spns + "CommandUIDefinitions");
XElement projectCenter_ContextualTabs = (from x2 in commandUIDefinitions.Elements(spns + "CommandUIDefinition")
                                            where x2.Attribute("Location").Value == "Ribbon.ContextualTabs._children"
                                            select x2).FirstOrDefault();
var groups = projectCenter_ContextualTabs.Element(spns + "ContextualGroup").Element(spns + "Tab").Element(spns + "Groups");

var groupsElements = new List<XElement>();
groupsElements.AddRange(groups.Elements());
foreach (XElement groupElement in groupsElements)
{
    var groupValue = groupElement.Attribute("Id").Value;
    var groupName = groupValue.Substring(groupValue.LastIndexOf(".") + 1);
    var ctrl = groupElement.Element(spns + "Controls");
    foreach (XElement controlElement in groupElement.Element(spns + "Controls").Elements())
    {
        if (controlElement.Name.LocalName != "Button") continue;
        
        var controlValue = GetValueFromAttribute(controlElement.Attribute("Id"));
        var controlName = controlValue.Substring(controlValue.LastIndexOf(".") + 1);
        if (controlValue.StartsWith(groupValue + "."))
            controlName = controlValue.Substring(groupValue.Length + 1).Replace(".", "_");

        var controlText = GetValueFromAttribute(controlElement.Attribute("LabelText"));

        string controlTitle = controlName;
        if (controlText.StartsWith("$Resources:core,"))
        {
            var resourceName = controlText.Substring("$Resources:core,".Length).Trim().TrimEnd(';').ToLower();
            var element = resx
                .Element("root")
                .Elements("data")
                .FirstOrDefault(e => e.Attribute("name").Value.ToLower() == resourceName);

            if (element != null)
                controlTitle = element.Element("value").Value;
        }

        var controlTooltipTitle = GetValueFromAttribute(controlElement.Attribute("ToolTipTitle"));
        var controlTooltipDescription = GetValueFromAttribute(controlElement.Attribute("ToolTipDescription"));

        var controlImage16 = GetValueFromAttribute(controlElement.Attribute("Image16by16"));
        var controlImage32 = GetValueFromAttribute(controlElement.Attribute("Image32by32"));

        var imageX = GetValueFromAttribute(controlElement.Attribute("Image32by32Left"));
        var imageY = GetValueFromAttribute(controlElement.Attribute("Image32by32Top"));
        string xyImageText = string.Empty;
        if (!String.IsNullOrEmpty(imageX))
            xyImageText = ",\r\n\t\t\t\t\t\t\tX = " + -Convert.ToInt32(imageX) / 32 + ",\r\n\t\t\t\t\t\t\tY = " + -Convert.ToInt32(imageY) / 32;

#>
                /// <summary>
                /// Button, which will appear identical to the standard '<#=controlTitle#>' button, but with custom javascript attached to it.
                /// </summary>
                /// <param name="javascript">Javascript code, which will be executed, when the button is clicked.</param>
                public static ButtonDefinition <#=groupName#>_<#=controlName#>(string javascript)
                {
                    return <#=groupName#>_<#=controlName#>(javascript, 1033);
                }
                /// <summary>
                /// Button, which will look exactly like the standard '<#=controlTitle#>' button, but with custom javascript attached to it
                /// </summary>
                /// <param name="javascript">Javascript code, which will be executed, when the button is clicked.</param>
                /// <param name="lcid">Locale id for the current site. If not specified, english locale (1033) will be used.</param>
                public static ButtonDefinition <#=groupName#>_<#=controlName#>(string javascript, int lcid)
                {
                    string id = GetRandom().Next(100, 999).ToString();
            
                    var definition = new ButtonDefinition()
                    {
                        Id = "Button" + id,
                        Title = SPUtility.GetLocalizedString("<#=controlText#>", "core", (uint)lcid),
                        Image = new ImageDefinition()
                        {
                            Url16 = "<#=controlImage16#>",
                            Url32 = "<#=controlImage32#>"<#=xyImageText#>
                        },
                        ToolTip = new ToolTipDefinition()
                        {
                            Title = SPUtility.GetLocalizedString("<#=controlTooltipTitle#>", "core", (uint)lcid),
                            Description = SPUtility.GetLocalizedString("<#=controlTooltipDescription#>", "core", (uint)lcid)
                        },
                        CommandJavaScript = javascript
                    };

                    if (definition.Image.Url16.ToLowerInvariant().Contains("$resources"))
                        definition.Image.Url16 = SPUtility.GetLocalizedString(definition.Image.Url16, "core", (uint)lcid);
                    if (definition.Image.Url32.ToLowerInvariant().Contains("$resources"))
                        definition.Image.Url32 = SPUtility.GetLocalizedString(definition.Image.Url32, "core", (uint)lcid);

                    return definition;
                }
<#

    }
}

#>
            }
        }
    }
}

Hope it helps !

New Post: Transforming native-ribbon XML (SharePoint/Project Server) into c#class

kwn34 — Mon, 11 Feb 2013 10:00:32 GMT

Hi omlin,

Thanks a lot, I'm not familiar with this at all, but I'll look into it. It seems fairly "understandable", so I think I won't struggle too much on this.
I'll post the template for SP 2013 & PS 2013 when I'm done.

New Post: Transforming native-ribbon XML (SharePoint/Project Server) into c#class

omlin — Mon, 11 Feb 2013 09:47:36 GMT

Simple T4 transformation can be used for that purpose. I.e. you can examine StandardButtons.tt included into Fluent Ribbon API.

New Post: Transforming native-ribbon XML (SharePoint/Project Server) into c#class

kwn34 — Mon, 11 Feb 2013 09:37:59 GMT

Hello all,

I reckon that a specific tool is used to transform native-ribbon XML into a c# class (i.e. StandardButtons.cs), but I don't know which one. Maybe someone can enlighten me about this ?

My goal is simply to generate a C# class (namely ProjectServerButtons.cs) that would be Project Server specific. And since I'm working with SP2013/PS2013, I would be able to generate C# classes for each version (SP2010, PS2010, SP2013 and PS2013).

Cheers,
looking forwards to hearing from you very soon!

New Post: CheckBox control

kwn34 — Fri, 08 Feb 2013 15:04:00 GMT

Hi,
I'm currently experiencing the same issue on my checkbox control. I'm trying to make it work, but no luck for the moment. I'll keep you posted

New Post: CheckBox control

prg12 — Fri, 08 Feb 2013 14:46:58 GMT

Hi.
My check box is disabled :(
Did I miss something?

My code:

new GroupDefinition()

                    {
                        Id = "OptionControlGroup",
                        Title = "Option",
                        Template = GroupTemplateLibrary.ThreeRowTemplate,
                        Controls = new ControlDefinition[]
                        {
                            new CheckBoxDefinition()
                            {
                                Id = "ChBox",
                                Title = "Checkbox1",                                    
                                CommandJavaScript = "alert('test')"
                            }
                        }

                    }

New Post: CheckBox control

prg12 — Fri, 08 Feb 2013 13:23:36 GMT

Hi.

Thanks for the great work!!!
I need to use checkbox control, so I will implement code and send feedback (maybe) today later.

Thanks again.

New Post: CheckBox control

omlin — Fri, 08 Feb 2013 12:17:41 GMT

Hi kwn34,

I'm sure it was on schedule, but it seems I forgot about it while implemented some other controls :)
Thus thank you very much for your contribution!

I will include the code into FluentRibbon API, test it, create some examples, update the documentation and then you'll be able to download the modified version from the 1.5 planning release page.
But I'm afraid this might take some time, so please use your code for a while.

Thanks again and good luck with your projects!

New Post: CheckBox control

kwn34 — Fri, 08 Feb 2013 11:16:10 GMT

I've coded it myslef, here's the code:

CheckBoxDefinition.cs :

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Linq;

namespace FluentRibbon.Definitions.Controls
{
    /// <summary>
    /// Simple button. Does not have inner controls.
    /// </summary>
    public class CheckBoxDefinition : ControlDefinition
    {
        internal override string Tag
        {
            get { return "CheckBox"; }
        }


        internal override void AddAttributes(XElement controlElement)
        {
            base.AddAttributes(controlElement);

            controlElement.Add(new XAttribute("LabelText", this.Title));

            if (this.ToolTip != null && !String.IsNullOrEmpty(this.ToolTip.Title))
            {
                controlElement.Add(new XAttribute("ToolTipTitle", this.ToolTip.Title));
                controlElement.Add(new XAttribute("ToolTipDescription", this.ToolTip.Description));
                controlElement.Add(new XAttribute("ToolTipHelpKeyWord", this.ToolTip.HelpKeyWord));
                controlElement.Add(new XAttribute("ToolTipShortcutKey", this.ToolTip.ShortcutKey));
            }

            if (!String.IsNullOrEmpty(this.CommandJavaScript) && controlElement.Attribute("Command") == null)
                controlElement.Add(new XAttribute("Command", this.FullId + "Command"));

        }

        internal override void Validate()
        {
            base.Validate();
            ValidationHelper.Current.CheckNotNull(this, "Title");
        }

        /// <summary>
        /// Displayable title for control. Required.
        /// </summary>
        public string Title;

        /// <summary>
        /// Control description
        /// </summary>
        [Obsolete("Description is dummy property, which never gets displayed. Use Tooltip.Description instead.")]
        public string Description = string.Empty;

        /// <summary>
        /// ToolTip
        /// </summary>
        public ToolTipDefinition ToolTip;

        /// <summary>
        /// Javascript will be run when button is pressed.
        /// Required for all types of buttons.
        /// By default, button does nothing.
        /// </summary>
        public string CommandJavaScript = string.Empty;

        /// <summary>
        /// Javascript to determine, if control is enabled or disabled.
        /// By default it is "true" (button is always enabled).
        /// </summary>
        public string CommandEnableJavaScript = "true";

    }
}

New Post: CheckBox control

kwn34 — Fri, 08 Feb 2013 10:21:47 GMT

Hi there,

First of all, thanks for the great work on this project !

I have noticed that the CheckBox control has not been implemented in the FluentRibbon API. Is it on the agenda ? Could you give me some advice as for implementing this ?

Thanks again,
Kind regards

New Post: MenuSection with fluentribbon

LLoyd_Bee — Thu, 07 Feb 2013 06:58:09 GMT

OK thanks !

Do you want me to create an issue for this ?

New Post: MenuSection with fluentribbon

omlin — Wed, 06 Feb 2013 21:51:35 GMT

You're right, it's not possible yet.
I will try to include this capability into the next release.

New Post: Adding to existing group/tab

omlin — Wed, 06 Feb 2013 21:48:03 GMT

Please refer to my sample projects (see "Source Code" tab), there are plenty of examples of this kind of stuff there.

For example, in Feature receiver of the FluentRibbon.Elementary project I'm adding a sample button to List Tools -> Items -> Manage.

New Post: Problem with SplitButton!!

omlin — Wed, 06 Feb 2013 21:40:52 GMT

Hi haniar,

You have syntax errors in your javascript for CommandJavaScript and CommandEnableJavaScript properties.
Also, "javascript:" is not necessary there.

So, i.e. you should have something like this:

CommandEnableJavaScript = "alert('Hallo 0');",
CommandJavaScript = "alert('Hallo 1');",