// Private Methods (1)
/// <summary>
/// Adds the contextual tab.
/// </summary>
private void AddContextualTab()
{
SPRibbon spRibbon = SPRibbon.GetCurrent(Page);
if (spRibbon == null)
{
return;
}
var ribbonExtensions = new XmlDocument();
ribbonExtensions.LoadXml(_contextualTab.Replace("{title}", DisplayTitle));
spRibbon.RegisterDataExtension(ribbonExtensions.FirstChild, "Ribbon.ContextualTabs._children");
ribbonExtensions.LoadXml(_contextualTabTemplate);
spRibbon.RegisterDataExtension(ribbonExtensions.FirstChild, "Ribbon.Templates._children");
spRibbon.Minimized = false;
spRibbon.CommandUIVisible = true;
if (!spRibbon.IsTabAvailable(MANAGE_TAB))
{
spRibbon.MakeTabAvailable(MANAGE_TAB);
}
}
/// <summary>
/// Builds and adds the custom ribbon tab
/// </summary>
protected virtual void AddRibbonTab()
{
try {
// Gets the current instance of the ribbon on the page and replaces it with the custom ribbon.
Ribbon = SPRibbon.GetCurrent(this.Page);
XmlDocument ribbonExtensions = new XmlDocument();
Stream stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(string.Format("{0}.{1}.xml", RIBBON_XML_FILE_LOCATION, "SPAtab"));
XmlTextReader mainTab = new XmlTextReader(stream);
ribbonExtensions.Load(mainTab);
Ribbon.RegisterDataExtension(ribbonExtensions.FirstChild, "Ribbon.Tabs._children");
// Adds the custom tab
stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(string.Format("{0}.{1}.xml", RIBBON_XML_FILE_LOCATION, "SPAcontextualtab"));
XmlTextReader contextualTab = new XmlTextReader(stream);
ribbonExtensions.Load(contextualTab);
Ribbon.RegisterDataExtension(ribbonExtensions.FirstChild, "Ribbon.Templates._children");
Ribbon.CommandUIVisible = true;
if (!Ribbon.IsTabAvailable(RIBBON_INITIAL_TAB_ID))
{
Ribbon.MakeTabAvailable(RIBBON_INITIAL_TAB_ID);
}
} catch (Exception ex) {
SPA.Error.WriteError(ex);
}
}
private void AddRibbonTab()
{
// Gets the current instance of the ribbon on the page.
SPRibbon ribbon = SPRibbon.GetCurrent(this.Page);
//Prepares an XmlDocument object used to load the ribbon
XmlDocument ribbonExtensions = new XmlDocument();
//WorkPlanner Tab
ribbonExtensions.LoadXml(Properties.Resources.txtBuildTeamTab);
ribbon.RegisterDataExtension(ribbonExtensions.FirstChild,
"Ribbon.Tabs._children");
//Load the custom templates and register the ribbon.
ribbonExtensions.LoadXml(Properties.Resources.txtBuildTeamRibbonTemplate);
ribbon.RegisterDataExtension(ribbonExtensions.FirstChild,
"Ribbon.Templates._children");
ribbon.Minimized = false;
ribbon.CommandUIVisible = true;
const string initialTabId = "Ribbon.BuildTeam";
if (!ribbon.IsTabAvailable(initialTabId))
{
ribbon.MakeTabAvailable(initialTabId);
}
ribbon.InitialTabId = initialTabId;
if (bCanEditTeam != "true")
{
if (sDisable != "")
{
ribbon.TrimById("Ribbon.BuildTeam.ResourceGroup");
}
ribbon.TrimById("Ribbon.BuildTeam.StandardGroup.SaveCloseButton");
}
else if (sDisable != "")
{
ribbon.TrimById("Ribbon.BuildTeam.ResourceGroup");
ribbon.TrimById("Ribbon.BuildTeam.TeamGroup.AddToTeam");
ribbon.TrimById("Ribbon.BuildTeam.TeamGroup.RemoveFromTeam");
}
}
public static void AddRibbonButtonsToPage(List <ListMetadataAction> ribbonBtns, Page page)
{
// Gets the current instance of the ribbon on the page.
SPRibbon ribbon = SPRibbon.GetCurrent(page);
XmlDocument ribbonExtensions = new XmlDocument();
//Load the contextual tab XML and register the ribbon.
ribbonExtensions.LoadXml(string.Format(Constants.Ribbon.VIEW_TAB_TEMPLATE,
string.Join("", ribbonBtns.Select(b => b.GetButtonAsXml()))));
ribbon.RegisterDataExtension(ribbonExtensions.FirstChild, "Ribbon.Tabs._children");
//Load the custom templates and register the ribbon.
ribbonExtensions.LoadXml(Constants.Ribbon.CONTEXTUAL_TAB_TEMPLATE);
ribbon.RegisterDataExtension(ribbonExtensions.FirstChild, "Ribbon.Templates._children");
ribbon.Minimized = false;
ribbon.CommandUIVisible = true;
const string initialTabId = "Ribbon.RosterTab";
if (!ribbon.IsTabAvailable(initialTabId))
{
ribbon.MakeTabAvailable(initialTabId);
}
ribbon.InitialTabId = initialTabId;
// REGISTER COMMANDS
var commands = new List <IRibbonCommand>();
// register the command at the ribbon. Include the callback to the server to generate the xml
ribbonBtns.ToList().ForEach(b => {
commands.Add(new SPRibbonCommand(b.GetCommandName(), b.Command, "true"));
});
//Register initialize function
var manager = new SPRibbonScriptManager();
var methodInfo = typeof(SPRibbonScriptManager).GetMethod("RegisterInitializeFunction", BindingFlags.Instance | BindingFlags.NonPublic);
methodInfo.Invoke(manager, new object[] {
page, "InitPageComponent", "/_layouts/15/Roster.Presentation/js/PageComponent.js", false, "Roster.PageComponent.initialize()"
});
// Register ribbon scripts
manager.RegisterGetCommandsFunction(page, "getGlobalCommands", commands);
manager.RegisterCommandEnabledFunction(page, "commandEnabled", commands);
manager.RegisterHandleCommandFunction(page, "handleCommand", commands);
}
/// <summary>
/// Registers the ribbon.
/// </summary>
private void RegisterRibbon()
{
var xmlDocument = new XmlDocument();
SPRibbon spRibbon = SPRibbon.GetCurrent(Page);
xmlDocument.LoadXml(Resources.AssignmentPlanner_ContextualTab);
spRibbon.RegisterDataExtension(xmlDocument.FirstChild, "Ribbon.Tabs._children");
xmlDocument.LoadXml(Resources.AssignmentPlanner_ContextualTabTemplate);
spRibbon.RegisterDataExtension(xmlDocument.FirstChild, "Ribbon.Templates._children");
spRibbon.Minimized = false;
spRibbon.CommandUIVisible = true;
if (!spRibbon.IsTabAvailable(INITIAL_TAB_ID))
{
spRibbon.MakeTabAvailable(INITIAL_TAB_ID);
}
spRibbon.InitialTabId = INITIAL_TAB_ID;
}
protected override void OnPreRender(EventArgs e)
{
base.OnPreRender(e);
SPRibbon ribbon = SPRibbon.GetCurrent(this.Page);
//Prepares an XmlDocument object used to load the ribbon
XmlDocument ribbonExtensions = new XmlDocument();
//WorkPlanner Tab
ribbonExtensions.LoadXml(Properties.Resources.txtMyTimesheetWork_Ribbon);
ribbon.RegisterDataExtension(ribbonExtensions.FirstChild,
"Ribbon.Tabs._children");
ribbonExtensions.LoadXml(Properties.Resources.txtMyTimesheetWork_ViewRibbon);
ribbon.RegisterDataExtension(ribbonExtensions.FirstChild,
"Ribbon.Tabs._children");
ribbonExtensions.LoadXml(Properties.Resources.txtMyTimesheet_Template);
ribbon.RegisterDataExtension(ribbonExtensions.FirstChild,
"Ribbon.Templates._children");
ribbon.Minimized = false;
ribbon.CommandUIVisible = true;
const string initialTabId = "Ribbon.MyTimesheetWorkTab";
if (!ribbon.IsTabAvailable(initialTabId))
{
ribbon.MakeTabAvailable(initialTabId);
}
if (!ribbon.IsTabAvailable("Ribbon.MyTimesheetWorkViewsTab"))
{
ribbon.MakeTabAvailable("Ribbon.MyTimesheetWorkViewsTab");
}
ribbon.InitialTabId = initialTabId;
var manager = new SPRibbonScriptManager();
var methodInfo = typeof(SPRibbonScriptManager).GetMethod("RegisterInitializeFunction", BindingFlags.Instance | BindingFlags.NonPublic);
methodInfo.Invoke(manager, new object[] { Page, "InitPageComponent", "/_layouts/epmlive/MyTimesheetWorkContextualTabPageComponent.js", false, "MyTimesheetWorkPageComponent.PageComponent.initialize()" });
var commands = new List <IRibbonCommand>();
//commands.Add(new SPRibbonCommand("Ribbon.MyTimesheetWork.AddWork", "alert('d');", "true"));
manager.RegisterGetCommandsFunction(Page, "getGlobalCommands", commands);
manager.RegisterCommandEnabledFunction(Page, "commandEnabled", commands);
manager.RegisterHandleCommandFunction(Page, "handleCommand", commands);
//if(!ribbon.IsTabAvailable("Ribbon.Project"))
// ribbon.MakeTabAvailable("Ribbon.Project");
//if(!ribbon.IsTabAvailable("Ribbon.WorkViews"))
// ribbon.MakeTabAvailable("Ribbon.WorkViews");
if (Request["nonwork"] == "true")
{
ribbon.TrimById("Ribbon.MyTimesheetWorkViews.AllWork");
ribbon.TrimById("Ribbon.MyTimesheetWork.ActionsGroup.Search");
}
else
{
bool bDisable = BShowAllWork();
if (!bDisable)
{
ribbon.TrimById("Ribbon.MyTimesheetWorkViews.AllWork");
}
}
}
protected override void OnPreRender(EventArgs e)
{
try
{
if (this.Page == null)
{
return;
}
if (SPContext.Current == null)
{
return;
}
SPRibbon currentRibbon = SPRibbon.GetCurrent(this.Page);
WorkBox workBox = null;
// If we're looking at a modal dialog box then we want to
// leave workBox == null so that no further action is taken:
if (Request.QueryString["IsDlg"] == null || Request.QueryString["IsDlg"] != "1")
{
workBox = WorkBox.GetIfWorkBox(SPContext.Current);
}
if (workBox != null)
{
//OK so we are looking at a work box.
isWorkBox = true;
SPWeb workBoxWeb = workBox.Web;
if (!currentRibbon.IsTabAvailable("WorkBoxFramework.Ribbon.WorkBox"))
{
currentRibbon.MakeTabAvailable("WorkBoxFramework.Ribbon.WorkBox");
}
// Now let's register the commands for the tasks flyout button:
// Inspired by blogs:
// http://www.sharepointnutsandbolts.com/2010/02/ribbon-customizations-dropdown-controls.html
// http://patrickboom.wordpress.com/2010/05/25/adding-a-custom-company-menu-tab-with-dynamic-menu-on-the-ribbon/
// http://www.wictorwilen.se/Post/Creating-a-SharePoint-2010-Ribbon-extension-part-2.aspx
WBLogging.DEBUG.Monitorable("About to do various for Tasks flyout menu:");
ScriptLink.RegisterScriptAfterUI(this.Page, "SP.Core.js", false, false);
ScriptLink.RegisterScriptAfterUI(this.Page, "CUI.js", false, false);
ScriptLink.RegisterScriptAfterUI(this.Page, "core.js", true, false);
ScriptLink.RegisterScriptAfterUI(this.Page, "SP.Ribbon.js", false, false);
ScriptLink.RegisterScriptAfterUI(this.Page, "SP.Runtime.js", false, false);
ScriptLink.RegisterScriptAfterUI(this.Page, "SP.js", false, false);
//ScriptLink.RegisterScriptAfterUI(this.Page, "WorkBoxFramework/PageComponent.js", false, true);
var commands = new List <IRibbonCommand>();
// register the command at the ribbon. Include the callback to the server to generate the xml
commands.Add(new SPRibbonCommand("WorkBoxFramework.Command.PopulateDynamicTasks", "if (wbf_callCount==0) WorkBoxFramework_getDynamicTasksMenu('',''); wbf_callCount++; if (wbf_callCount > 1000) wbf_menuXml = WorkBoxFramework_errorMenuXml('Timeout'); if (wbf_menuXml != '') properties.PopulationXML = wbf_menuXml;"));
commands.Add(new SPRibbonCommand("WorkBoxFramework.Command.PopulateDynamicTemplates", "if (wbf_callCount==0) WorkBoxFramework_getDynamicTasksMenu('',''); wbf_callCount++; if (wbf_callCount > 1000) wbf_menu2Xml = WorkBoxFramework_errorMenuXml('Timeout'); if (wbf_menu2Xml != '') properties.PopulationXML = wbf_menu2Xml;"));
// commands.Add(new SPRibbonCommand("PopulateDynamicTasksCommand", "properties.PopulationXML = errorMenuXml();"));
//commands.Add(new SPRibbonCommand("PopulateDynamicTasksCommand", "alert('Callaa to Popdyn'); if (menuXml == '') { CreateServerMenu('',''); } else { properties.PopulationXML = menuXml; }"));
// commands.Add(new SPRibbonCommand("PopulateDynamicTasksCommand", "alert('Call to Popdyn: ' + menuXml); properties.PopulationXML = menuXml;"));
//Register various:
var manager = new SPRibbonScriptManager();
// Register ribbon scripts
manager.RegisterGetCommandsFunction(Page, "getGlobalCommands", commands);
manager.RegisterCommandEnabledFunction(Page, "commandEnabled", commands);
manager.RegisterHandleCommandFunction(Page, "handleCommand", commands);
WBLogging.DEBUG.Monitorable("Registered ribbon scripts");
//Register initialize function
var methodInfo = typeof(SPRibbonScriptManager).GetMethod("RegisterInitializeFunction", BindingFlags.Instance | BindingFlags.NonPublic);
methodInfo.Invoke(manager, new object[] { Page, "InitPageComponent", "/_layouts/WorkBoxFramework/PageComponent.js", false, "WorkBoxFramework.PageComponent.initialize()" });
// register the client callbacks so that the JavaScript can call the server.
ClientScriptManager cm = this.Page.ClientScript;
String cbReference = cm.GetCallbackEventReference(this, "arg", "WorkBoxFramework_receiveTasksMenu", "", "WorkBoxFramework_processCallBackError", false);
String callbackScript = "function WorkBoxFramework_getDynamicTasksMenu(arg, context) {" + cbReference + "; }";
WBLogging.DEBUG.Monitorable("Creating the call back function WorkBoxFramework_getDynamicTasksMenu to call: \n" + callbackScript);
cm.RegisterClientScriptBlock(this.GetType(), "WorkBoxFramework_getDynamicTasksMenu", callbackScript, true);
// Now let's check or set the last visited Guid:
WBUser user = new WBUser(workBox);
UserProfile profile = user.Profile;
// SPSite _site = SPContext.Current.Site;
// SPServiceContext _serviceContext = SPServiceContext.GetContext(_site);
// UserProfileManager _profileManager = new UserProfileManager(_serviceContext);
// UserProfile profile = _profileManager.GetUserProfile(true);
scriptForSettingGlobalVariables = makeScriptForSettingWorkBoxVariables(workBox, user, profile);
UserProfileValueCollection lastVisitedGuidUserProfileValueCollection = profile[WorkBox.USER_PROFILE_PROPERTY__WORK_BOX_LAST_VISITED_GUID];
bool needsUpdating = false;
if (lastVisitedGuidUserProfileValueCollection == null || lastVisitedGuidUserProfileValueCollection.Count == 0)
{
needsUpdating = true;
}
else
{
Guid lastGuid = new Guid(lastVisitedGuidUserProfileValueCollection.Value.ToString());
if (!lastGuid.Equals(workBoxWeb.ID))
{
needsUpdating = true;
}
}
if (needsUpdating)
{
workBoxWeb.AllowUnsafeUpdates = true;
string currentGuidString = workBoxWeb.ID.ToString();
lastVisitedGuidUserProfileValueCollection.Clear();
lastVisitedGuidUserProfileValueCollection.Add(currentGuidString);
// OK now we're going to make sure that this work box is the latest on the list of recently visited work boxes:
WBLogging.WorkBoxes.Verbose("Updating the list of recently visited work boxes - as we've just come to this work box");
UserProfileValueCollection workBoxesRecentlyVisited = profile[WorkBox.USER_PROFILE_PROPERTY__MY_RECENTLY_VISITED_WORK_BOXES];
//string mostRecentWorkBoxDetails = workBoxWeb.Title + "|" + workBoxWeb.Url + "|" + workBox.UniqueID + "|" + workBoxWeb.ID.ToString() + "|" + DateTime.Now.Ticks;
WBLink mostRecentWorkBoxDetails = new WBLink(workBox, true);
WBLogging.WorkBoxes.Verbose("The most recent work box details are: " + mostRecentWorkBoxDetails);
List <String> newList = new List <String>();
newList.Add(mostRecentWorkBoxDetails.ToString());
if (workBoxesRecentlyVisited.Value != null)
{
string[] recentWorkBoxes = workBoxesRecentlyVisited.Value.ToString().Split(';');
int totalLength = 0;
foreach (string recentWorkBox in recentWorkBoxes)
{
if (totalLength >= 3000)
{
break;
}
if (!recentWorkBox.Contains(currentGuidString))
{
newList.Add(recentWorkBox);
totalLength += recentWorkBox.Length + 1;
}
}
}
profile[WorkBox.USER_PROFILE_PROPERTY__MY_RECENTLY_VISITED_WORK_BOXES].Value = WBUtils.JoinUpToLimit(";", newList, 3100);
profile.Commit();
workBoxWeb.AllowUnsafeUpdates = false;
}
}
else
{
scriptForSettingGlobalVariables = makeScriptForSettingNonWorkBoxVariables(SPContext.Current.Web);
if (currentRibbon.IsTabAvailable("WorkBoxFramework.Ribbon.WorkBox"))
{
currentRibbon.TrimById("WorkBoxFramework.Ribbon.WorkBox");
}
}
// currentRibbon.MakeContextualGroupInitiallyVisible("WorkBoxFramework.Ribbon.ContextualGroup", string.Empty);
}
catch (Exception exception)
{
// If this isn't working - let's just do nothing so that at least the SharePoint site is visible.
scriptForSettingGlobalVariables = "<!-- Exception thrown in MaybeShowWorkBoxRibbonTools \n\n" + exception.Message + "\n\n" + exception.StackTrace + "\n\n-->";
}
}