Class ExcelRibbon

Represents Excel specific Ribbon.

Inheritance

System.Object

Ribbon

ExcelRibbon

Implements

Microsoft.Office.Core.IRibbonExtensibility

Inherited Members

Ribbon.CancelCheckout(IRibbonControl)

Ribbon.Checkout(IRibbonControl)

Ribbon.GetAddInVersion(IRibbonControl)

Ribbon.GetConnectionInfo(IRibbonControl)

Ribbon.GetCopyrightInfo(IRibbonControl)

Ribbon.GetCustomUI(String)

Ribbon.GetDescription(IRibbonControl, ResourceManager)

Ribbon.GetLogOffButtonLabel(IRibbonControl)

Ribbon.GetVisible(IRibbonControl)

Ribbon.Invalidate()

Ribbon.InvalidateControl(String)

Ribbon.IsValidDocument(IRibbonControl)

Ribbon.NewDocumentFromDocument(IRibbonControl)

Ribbon.NewDocumentFromTemplate(IRibbonControl)

Ribbon.OnBackstageShow(Object)

Ribbon.Open(IRibbonControl)

Ribbon.Save(IRibbonControl)

Ribbon.SaveDraft(IRibbonControl)

Ribbon.ShowPreferences(IRibbonControl)

Ribbon.ToggleSession(IRibbonControl)

Ribbon.GetResourceId(IRibbonControl)

Ribbon.GetVisible(String)

Ribbon.IsFile(IDocument)

Ribbon.IsReadOnlyDocument(IDocument)

Ribbon.IsServerDocument(IDocument)

Ribbon.OnDocumentClose(IDocument, Boolean)

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Quark.CMSAdapters.Office.Excel

Assembly: Quark.CMSAdapters.Office.Excel.dll

Syntax

[ComVisible(true)]
public class ExcelRibbon : Ribbon, IRibbonExtensibility

Constructors

ExcelRibbon()

Initializes a new instance of the ExcelRibbon class.

Declaration

public ExcelRibbon()

Methods

CopyToServerClipboard(IRibbonControl)

Copies the selected component to server clipboard.

Declaration

public void CopyToServerClipboard(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Export(IRibbonControl)

Exports the specified control.

Declaration

public void Export(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

GetExportMenuLabel(IRibbonControl)

Gets the export menu label.

Declaration

public string GetExportMenuLabel(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.String

GetImage(IRibbonControl, ResourceManager)

Gets the image.

Declaration

public override Bitmap GetImage(IRibbonControl control, ResourceManager resourceManager = null)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Resources.ResourceManager	resourceManager	The resource manager.

Returns

Type	Description
System.Drawing.Bitmap

Overrides

Ribbon.GetImage(IRibbonControl, ResourceManager)

GetLabel(IRibbonControl, ResourceManager)

Gets the label.

Declaration

public override string GetLabel(IRibbonControl control, ResourceManager resourceManager = null)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Resources.ResourceManager	resourceManager	The resource manager.

Returns

Type	Description
System.String

Overrides

Ribbon.GetLabel(IRibbonControl, ResourceManager)

HasLinks(IRibbonControl)

Determines whether selected component has links.

Declaration

public bool HasLinks(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean

HasModifiedLinks(IRibbonControl)

Determines whether selected component is modified.

Declaration

public bool HasModifiedLinks(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean	true if selected component is modified; otherwise, false.

HasUnModifiedLinks(IRibbonControl)

Determines whether selected component is not modified.

Declaration

public bool HasUnModifiedLinks(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean	true if selected component is not modified; otherwise, false.

IsExportAsTableEnabled(IRibbonControl)

Determines whether control to export as table is enabled.

Declaration

public bool IsExportAsTableEnabled(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean

IsToggleTaskPaneEnabled(IRibbonControl)

Determines whether control to toggle task pane is enabled.

Declaration

public bool IsToggleTaskPaneEnabled(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean

IsValidComponent(IRibbonControl)

Determines whether the specified control is valid component.

Declaration

public bool IsValidComponent(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean

LoadImage(String, ResourceManager)

Loads the image.

Declaration

public override IPictureDisp LoadImage(string imageName, ResourceManager resourceManager = null)

Parameters

Type	Name	Description
System.String	imageName	Name of the image.
System.Resources.ResourceManager	resourceManager	The resource manager.

Returns

Type	Description
stdole.IPictureDisp

Overrides

Ribbon.LoadImage(String, ResourceManager)

MarkComponentStatus(IRibbonControl)

Marks the component status.

Declaration

public void MarkComponentStatus(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

PushUpdates(IRibbonControl)

Pushes the updates.

Declaration

public void PushUpdates(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

RefreshTaskPane(Workbook)

Refreshes the task pane.

Declaration

public void RefreshTaskPane(Workbook workbook)

Parameters

Type	Name	Description
Microsoft.Office.Interop.Excel.Workbook	workbook	The workbook.

ReloadTaskPane(Workbook)

Reloads the task pane.

Declaration

public void ReloadTaskPane(Workbook workbook)

Parameters

Type	Name	Description
Microsoft.Office.Interop.Excel.Workbook	workbook

ReloadTaskPanes()

Reloads the task panes.

Declaration

public void ReloadTaskPanes()

Ribbon_Load(IRibbonUI)

Ribbon load handler.

Declaration

public override void Ribbon_Load(IRibbonUI ribbonUI)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonUI	ribbonUI	The ribbon UI.

Overrides

Ribbon.Ribbon_Load(IRibbonUI)

SaveAs(IRibbonControl)

Saves the specified control.

Declaration

public override bool SaveAs(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean

Overrides

Ribbon.SaveAs(IRibbonControl)

SaveRevision(IRibbonControl)

Saves the revision.

Declaration

public override bool SaveRevision(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean

Overrides

Ribbon.SaveRevision(IRibbonControl)

ShowLinks(IRibbonControl)

Shows the links.

Declaration

public void ShowLinks(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

SwitchBranch(IRibbonControl)

Switches the branch.

Declaration

public override bool SwitchBranch(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Returns

Type	Description
System.Boolean

Overrides

Ribbon.SwitchBranch(IRibbonControl)

ToggleTaskPane(IRibbonControl)

Toggles the task pane.

Declaration

public void ToggleTaskPane(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

UpdateComponents(IRibbonControl)

Updates the components.

Declaration

public void UpdateComponents(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.

Implements

Microsoft.Office.Core.IRibbonExtensibility

Extension Methods

UtilityExtensions.ToXml(Object, String)