.NET Tips and Tricks

Blog archive

Guru Tip: How to Activate a SharePoint Ribbon Tab in Sandboxed Solutions

I went back to Andrei Smolin, a team leader at Add-In Express, for some more SharePoint help. I wanted to activate a Ribbon Tab using, I thought, code like this:

SPRibbon  currentRibbon = SPRibbon.GetCurrent(this.Page);
currentRibbon.MakeTabAvailable("<Tab  Id>");
currentRibbon.InitialTabId  = "<Tab Id>";

Unfortunately, I wanted to use this code in a Sandboxed solution -- something that's specifically forbidden. Andrie pointed out that my code wouldn't work very well in a farm solution, either: the tab would get selected but it wouldn't get activated.

Andrie gave me the following script, which not only bypasses the Sandbox limitation but actually activates the tab. This code works with a feature called SPRibbon and a tab with the ID AdxspRibbonTab1, so you'll need to change those two names in your code:

var ribbonReady = false;

function onBodyLoaded() {
  if (!ribbonReady) {
    if ((typeof (_ribbonReadyForInit) == 'function') &&
         _ribbonReadyForInit()) {
      ribbonReady = true;
      var control = get_SPRibbon().FindControl("AdxspRibbonTab1");
      if (control != null) {
        var tabElem = document.getElementById(control.getFullId() +
                                              "-title");
        if (tabElem && tabElem.firstChild) {
                    tabElem.firstChild.click();	
        }
      }
    }
  }
};

if (_spBodyOnLoadFunctionNames != 'undefined' && 
    _spBodyOnLoadFunctionNames != null) {
    _spBodyOnLoadFunctionNames.push("onBodyLoaded");
}
onBodyLoaded();

Posted by Peter Vogel on 05/17/2012


comments powered by Disqus

Featured

  • Creating Reactive Applications in .NET

    In modern applications, data is being retrieved in asynchronous, real-time streams, as traditional pull requests where the clients asks for data from the server are becoming a thing of the past.

  • AI for GitHub Collaboration? Maybe Not So Much

    No doubt GitHub Copilot has been a boon for developers, but AI might not be the best tool for collaboration, according to developers weighing in on a recent social media post from the GitHub team.

  • Visual Studio 2022 Getting VS Code 'Command Palette' Equivalent

    As any Visual Studio Code user knows, the editor's command palette is a powerful tool for getting things done quickly, without having to navigate through menus and dialogs. Now, we learn how an equivalent is coming for Microsoft's flagship Visual Studio IDE, invoked by the same familiar Ctrl+Shift+P keyboard shortcut.

  • .NET 9 Preview 3: 'I've Been Waiting 9 Years for This API!'

    Microsoft's third preview of .NET 9 sees a lot of minor tweaks and fixes with no earth-shaking new functionality, but little things can be important to individual developers.

  • Data Anomaly Detection Using a Neural Autoencoder with C#

    Dr. James McCaffrey of Microsoft Research tackles the process of examining a set of source data to find data items that are different in some way from the majority of the source items.

Subscribe on YouTube