private void OnReturnRibbonAndInitialTab(DataQueryResult res)
{
PMetrics.PerfMark(PMarker.perfCUIRibbonInitStart);
RibbonBuildContext rbc = (RibbonBuildContext)res.ContextData;
// Apply any extensions to the data.
res.QueryData = ApplyDataExtensions(res.QueryData);
Utility.EnsureCSSClassOnElement(Placeholder, "loaded");
JSObject templates = DataNodeWrapper.GetFirstChildNodeWithName(res.QueryData, DataNodeWrapper.TEMPLATES);
if (!CUIUtility.IsNullOrUndefined(templates))
{
TemplateManager.Instance.LoadTemplates(templates);
}
Ribbon = BuildRibbon(res.QueryData, rbc);
Ribbon.RibbonBuilder = this;
BuildClient.OnComponentCreated(Ribbon, Ribbon.Id);
if (RibbonBuildOptions.Minimized)
{
Ribbon.MinimizedInternal = true;
}
else
{
Ribbon.MinimizedInternal = false;
Tab firstTab = (Tab)Ribbon.GetChild(rbc.InitialTabId);
if (!CUIUtility.IsNullOrUndefined(firstTab))
{
// We need this in order to set the "ChangedByUser" property of the first
// TabSwitch command that comes out of the ribbon correctly.
firstTab.SelectedByUser = RibbonBuildOptions.InitialTabSelectedByUser;
Ribbon.MakeTabSelectedInternal(firstTab);
}
}
Ribbon.ClientID = RibbonBuildOptions.ClientID;
bool shouldAttach = !RibbonBuildOptions.Minimized && RibbonBuildOptions.AttachToDOM;
if (shouldAttach)
{
// Scale the ribbon to the scaling index that matches the ribbon that was
// rendered by the server. This sets the in memory Ribbon structure to match
// what was rendered by the server. This is needed so that Ribbon.AttachInternal()
// will work properly.
if (!((RibbonBuildOptions)Options).Minimized)
{
// We subtract one from this scaling index because internally
// this scaling index is an entry into an array of "<ScaleStep>" so
// the MaxSize for all the groups is actually index "-1" and the first
// step is index 0.
Ribbon.ScaleIndex(rbc.InitialScalingIndex - 1);
}
Ribbon.AttachInternal(true);
// Attach to the QAT and Jewel
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowQATId))
{
Ribbon.BuildAndSetQAT(RibbonBuildOptions.ShowQATId, true, DataSource);
}
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowJewelId))
{
Ribbon.BuildAndSetJewel(RibbonBuildOptions.ShowJewelId, true, DataSource);
}
#if DEBUG
// Validate that the server rendered ribbon is identical to the client rendered one
// for this tab.
if (Options.ValidateServerRendering)
{
RibbonBuilder rb2 = new RibbonBuilder(this.RibbonBuildOptions,
this.Placeholder,
null);
DataSource ds = new DataSource(this.DataSource.DataUrl,
this.DataSource.Version,
this.DataSource.Lcid);
rb2.DataSource = ds;
SPRibbon r2 = rb2.BuildRibbon(res.QueryData, rbc);
r2.Id += "-client";
r2.ClientID = RibbonBuildOptions.ClientID + "-client";
r2.RibbonBuilder = this;
if (!RibbonBuildOptions.Minimized)
{
r2.Minimized = false;
}
// Clone all the peripheral sections for the client-rendering version
Div p_qrc = (Div)Browser.Document.GetById(RibbonBuildOptions.ClientID + "-" + RibbonPeripheralSection.QATRowCenter);
Div p_qrr = (Div)Browser.Document.GetById(RibbonBuildOptions.ClientID + "-" + RibbonPeripheralSection.QATRowRight);
Div p_trl = (Div)Browser.Document.GetById(RibbonBuildOptions.ClientID + "-" + RibbonPeripheralSection.TabRowLeft);
Div p_trr = (Div)Browser.Document.GetById(RibbonBuildOptions.ClientID + "-" + RibbonPeripheralSection.TabRowRight);
Div hiddenClonedPeripherals = new Div();
hiddenClonedPeripherals.Style.Display = "none";
Browser.Document.Body.AppendChild(hiddenClonedPeripherals);
Div clone;
if (null != p_qrc)
{
clone = (Div)p_qrc.CloneNode(true);
clone.Id = clone.Id.Replace(RibbonBuildOptions.ClientID, r2.ClientID);
hiddenClonedPeripherals.AppendChild(clone);
}
if (null != p_qrr)
{
clone = (Div)p_qrr.CloneNode(true);
clone.Id = clone.Id.Replace(RibbonBuildOptions.ClientID, r2.ClientID);
hiddenClonedPeripherals.AppendChild(clone);
}
if (null != p_trl)
{
clone = (Div)p_trl.CloneNode(true);
clone.Id = clone.Id.Replace(RibbonBuildOptions.ClientID, r2.ClientID);
hiddenClonedPeripherals.AppendChild(clone);
}
if (null != p_trr)
{
clone = (Div)p_trr.CloneNode(true);
clone.Id = clone.Id.Replace(RibbonBuildOptions.ClientID, r2.ClientID);
hiddenClonedPeripherals.AppendChild(clone);
}
r2.MakeTabSelectedInternal((Tab)r2.GetChild(rbc.InitialTabId));
r2.RefreshInternal();
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowQATId))
{
r2.BuildAndSetQAT(RibbonBuildOptions.ShowQATId, false, ds);
}
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowJewelId))
{
r2.BuildAndSetJewel(RibbonBuildOptions.ShowJewelId, false, ds);
}
r2.ScaleIndex(rbc.InitialScalingIndex - 1);
r2.CompleteConstruction();
// If this returns a message it means that it found some inconsistencies
// between the DOM Nodes
CompareNodes(Ribbon.ElementInternal, r2.ElementInternal);
}
#endif
}
else
{
// Do the minimum amount of work necessary in order to be able to
// get the outer ribbon element and to be able to attach the Jewel and QAT.
Ribbon.EnsureDOMElement();
// Build the QAT and Jewel after the ribbon so that the placeholders
// will have been created within the ribbon via Ribbon.RefreshInternal()
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowQATId))
{
Ribbon.BuildAndSetQAT(RibbonBuildOptions.ShowQATId, false, DataSource);
}
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowJewelId))
{
Ribbon.BuildAndSetJewel(RibbonBuildOptions.ShowJewelId, false, DataSource);
}
// Remove anything else that is in the placeholder in case there is a temporary
// animated gif or a static ribbon in there while the ribbon is loading.
// We're doing this the slow way since partners might have a reference to this node
Utility.RemoveChildNodesSlow(Placeholder);
Placeholder.AppendChild(Ribbon.ElementInternal);
}
Ribbon.Scale();
OnRootBuilt(Ribbon);
BuildClient.OnComponentBuilt(Ribbon, Ribbon.Id);
if (RibbonBuildOptions.LaunchedByKeyboard)
{
Ribbon.SetFocusOnRibbon();
}
PMetrics.PerfMark(PMarker.perfCUIRibbonInitPercvdEnd);
}
private void OnReturnRibbonAndInitialTab(DataQueryResult res)
{
PMetrics.PerfMark(PMarker.perfCUIRibbonInitStart);
RibbonBuildContext rbc = (RibbonBuildContext)res.ContextData;
// Apply any extensions to the data.
res.QueryData = ApplyDataExtensions(res.QueryData);
Utility.EnsureCSSClassOnElement(Placeholder, "loaded");
JSObject templates = DataNodeWrapper.GetFirstChildNodeWithName(res.QueryData, DataNodeWrapper.TEMPLATES);
if (!CUIUtility.IsNullOrUndefined(templates))
TemplateManager.Instance.LoadTemplates(templates);
Ribbon = BuildRibbon(res.QueryData, rbc);
Ribbon.RibbonBuilder = this;
BuildClient.OnComponentCreated(Ribbon, Ribbon.Id);
if (RibbonBuildOptions.Minimized)
{
Ribbon.MinimizedInternal = true;
}
else
{
Ribbon.MinimizedInternal = false;
Tab firstTab = (Tab)Ribbon.GetChild(rbc.InitialTabId);
if (!CUIUtility.IsNullOrUndefined(firstTab))
{
// We need this in order to set the "ChangedByUser" property of the first
// TabSwitch command that comes out of the ribbon correctly.
firstTab.SelectedByUser = RibbonBuildOptions.InitialTabSelectedByUser;
Ribbon.MakeTabSelectedInternal(firstTab);
}
}
Ribbon.ClientID = RibbonBuildOptions.ClientID;
bool shouldAttach = !RibbonBuildOptions.Minimized && RibbonBuildOptions.AttachToDOM;
if (shouldAttach)
{
// Scale the ribbon to the scaling index that matches the ribbon that was
// rendered by the server. This sets the in memory Ribbon structure to match
// what was rendered by the server. This is needed so that Ribbon.AttachInternal()
// will work properly.
if (!((RibbonBuildOptions)Options).Minimized)
{
// We subtract one from this scaling index because internally
// this scaling index is an entry into an array of "<ScaleStep>" so
// the MaxSize for all the groups is actually index "-1" and the first
// step is index 0.
Ribbon.ScaleIndex(rbc.InitialScalingIndex - 1);
}
Ribbon.AttachInternal(true);
// Attach to the QAT and Jewel
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowQATId))
Ribbon.BuildAndSetQAT(RibbonBuildOptions.ShowQATId, true, DataSource);
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowJewelId))
Ribbon.BuildAndSetJewel(RibbonBuildOptions.ShowJewelId, true, DataSource);
#if DEBUG
// Validate that the server rendered ribbon is identical to the client rendered one
// for this tab.
if (Options.ValidateServerRendering)
{
RibbonBuilder rb2 = new RibbonBuilder(this.RibbonBuildOptions,
this.Placeholder,
null);
DataSource ds = new DataSource(this.DataSource.DataUrl,
this.DataSource.Version,
this.DataSource.Lcid);
rb2.DataSource = ds;
SPRibbon r2 = rb2.BuildRibbon(res.QueryData, rbc);
r2.Id += "-client";
r2.ClientID = RibbonBuildOptions.ClientID + "-client";
r2.RibbonBuilder = this;
if (!RibbonBuildOptions.Minimized)
r2.Minimized = false;
// Clone all the peripheral sections for the client-rendering version
Div p_qrc = (Div)Browser.Document.GetById(RibbonBuildOptions.ClientID + "-" + RibbonPeripheralSection.QATRowCenter);
Div p_qrr = (Div)Browser.Document.GetById(RibbonBuildOptions.ClientID + "-" + RibbonPeripheralSection.QATRowRight);
Div p_trl = (Div)Browser.Document.GetById(RibbonBuildOptions.ClientID + "-" + RibbonPeripheralSection.TabRowLeft);
Div p_trr = (Div)Browser.Document.GetById(RibbonBuildOptions.ClientID + "-" + RibbonPeripheralSection.TabRowRight);
Div hiddenClonedPeripherals = new Div();
hiddenClonedPeripherals.Style.Display = "none";
Browser.Document.Body.AppendChild(hiddenClonedPeripherals);
Div clone;
if (null != p_qrc)
{
clone = (Div)p_qrc.CloneNode(true);
clone.Id = clone.Id.Replace(RibbonBuildOptions.ClientID, r2.ClientID);
hiddenClonedPeripherals.AppendChild(clone);
}
if (null != p_qrr)
{
clone = (Div)p_qrr.CloneNode(true);
clone.Id = clone.Id.Replace(RibbonBuildOptions.ClientID, r2.ClientID);
hiddenClonedPeripherals.AppendChild(clone);
}
if (null != p_trl)
{
clone = (Div)p_trl.CloneNode(true);
clone.Id = clone.Id.Replace(RibbonBuildOptions.ClientID, r2.ClientID);
hiddenClonedPeripherals.AppendChild(clone);
}
if (null != p_trr)
{
clone = (Div)p_trr.CloneNode(true);
clone.Id = clone.Id.Replace(RibbonBuildOptions.ClientID, r2.ClientID);
hiddenClonedPeripherals.AppendChild(clone);
}
r2.MakeTabSelectedInternal((Tab)r2.GetChild(rbc.InitialTabId));
r2.RefreshInternal();
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowQATId))
r2.BuildAndSetQAT(RibbonBuildOptions.ShowQATId, false, ds);
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowJewelId))
r2.BuildAndSetJewel(RibbonBuildOptions.ShowJewelId, false, ds);
r2.ScaleIndex(rbc.InitialScalingIndex - 1);
r2.CompleteConstruction();
// If this returns a message it means that it found some inconsistencies
// between the DOM Nodes
CompareNodes(Ribbon.ElementInternal, r2.ElementInternal);
}
#endif
}
else
{
// Do the minimum amount of work necessary in order to be able to
// get the outer ribbon element and to be able to attach the Jewel and QAT.
Ribbon.EnsureDOMElement();
// Build the QAT and Jewel after the ribbon so that the placeholders
// will have been created within the ribbon via Ribbon.RefreshInternal()
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowQATId))
Ribbon.BuildAndSetQAT(RibbonBuildOptions.ShowQATId, false, DataSource);
if (!string.IsNullOrEmpty(RibbonBuildOptions.ShowJewelId))
Ribbon.BuildAndSetJewel(RibbonBuildOptions.ShowJewelId, false, DataSource);
// Remove anything else that is in the placeholder in case there is a temporary
// animated gif or a static ribbon in there while the ribbon is loading.
// We're doing this the slow way since partners might have a reference to this node
Utility.RemoveChildNodesSlow(Placeholder);
Placeholder.AppendChild(Ribbon.ElementInternal);
}
Ribbon.Scale();
OnRootBuilt(Ribbon);
BuildClient.OnComponentBuilt(Ribbon, Ribbon.Id);
if (RibbonBuildOptions.LaunchedByKeyboard)
Ribbon.SetFocusOnRibbon();
PMetrics.PerfMark(PMarker.perfCUIRibbonInitPercvdEnd);
}