Class Ribbon

Represents IRibbonExtensibility implementation.

Inheritance

System.Object

Ribbon

ExcelRibbon

PowerPointRibbon

Implements

Microsoft.Office.Core.IRibbonExtensibility

Inherited Members

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.Core.Office

Assembly: Quark.CMSAdapters.Core.Office.dll

Syntax

[ComVisible(true)]
public class Ribbon : IRibbonExtensibility

Constructors

Ribbon()

Initializes a new instance of the Ribbon class.

Declaration

public Ribbon()

Methods

CancelCheckout(IRibbonControl)

Cancels the checkout.

Declaration

public void CancelCheckout(IRibbonControl control)

Parameters

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

Checkout(IRibbonControl)

Checkouts the specified control.

Declaration

public void Checkout(IRibbonControl control)

Parameters

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

GetAddInVersion(IRibbonControl)

Gets the add in version.

Declaration

public string GetAddInVersion(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.String

GetConnectionInfo(IRibbonControl)

Gets the connection information.

Declaration

public string GetConnectionInfo(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.String

GetCopyrightInfo(IRibbonControl)

Gets the copyright information.

Declaration

public string GetCopyrightInfo(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.String

GetCustomUI(String)

Gets the custom UI.

Declaration

public virtual string GetCustomUI(string ribbonID)

Parameters

Type	Name	Description
System.String	ribbonID	The ribbon identifier.

Returns

Type	Description
System.String

GetDescription(IRibbonControl, ResourceManager)

Gets the description.

Declaration

public virtual string GetDescription(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

GetImage(IRibbonControl, ResourceManager)

Gets the image.

Declaration

public virtual 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

GetLabel(IRibbonControl, ResourceManager)

Gets the label.

Declaration

public virtual 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

GetLogOffButtonLabel(IRibbonControl)

Gets the log off button label.

Declaration

public string GetLogOffButtonLabel(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.String

GetResourceId(IRibbonControl)

Gets the resource identifier.

Declaration

protected string GetResourceId(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.String

GetVisible(IRibbonControl)

Gets the visible state.

Declaration

public bool GetVisible(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean

GetVisible(String)

Gets the visible state.

Declaration

protected bool GetVisible(string controlId)

Parameters

Type	Name	Description
System.String	controlId	The control identifier.

Returns

Type	Description
System.Boolean

Invalidate()

Invalidates ribbon instance.

Declaration

public void Invalidate()

InvalidateControl(String)

Invalidates the control.

Declaration

public void InvalidateControl(string controlID)

Parameters

Type	Name	Description
System.String	controlID	The control identifier.

IsFile(IDocument)

Determines whether the specified document is file.

Declaration

protected bool IsFile(IDocument document = null)

Parameters

Type	Name	Description
IDocument	document	The document.

Returns

Type	Description
System.Boolean	true if the specified document is file; otherwise, false.

IsReadOnlyDocument(IDocument)

Determines whether the specified document is read only.

Declaration

protected bool IsReadOnlyDocument(IDocument document = null)

Parameters

Type	Name	Description
IDocument	document	The document.

Returns

Type	Description
System.Boolean	true if the specified document is read only; otherwise, false.

IsServerDocument(IDocument)

Determines whether the specified document is server document.

Declaration

protected bool IsServerDocument(IDocument document = null)

Parameters

Type	Name	Description
IDocument	document	The document.

Returns

Type	Description
System.Boolean	true if the specified document is server document; otherwise, false.

IsValidDocument(IRibbonControl)

Determines whether active document is a valid document.

Declaration

public bool IsValidDocument(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if active document is not server document; otherwise, false.

LoadImage(String, ResourceManager)

Loads the image.

Declaration

public virtual 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

NewDocumentFromDocument(IRibbonControl)

News the document.

Declaration

public void NewDocumentFromDocument(IRibbonControl control)

Parameters

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

NewDocumentFromTemplate(IRibbonControl)

News the document.

Declaration

public void NewDocumentFromTemplate(IRibbonControl control)

Parameters

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

OnBackstageShow(Object)

Called when backstage is shown.

Declaration

public void OnBackstageShow(object control)

Parameters

Type	Name	Description
System.Object	control	The control.

OnDocumentClose(IDocument, ref Boolean)

Called when document is closed.

Declaration

protected virtual void OnDocumentClose(IDocument document, ref bool cancelDefault)

Parameters

Type	Name	Description
IDocument	document	The document.
System.Boolean	cancelDefault	if set to true cancels default action.

Open(IRibbonControl)

Opens the specified control.

Declaration

public void Open(IRibbonControl control)

Parameters

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

Ribbon_Load(IRibbonUI)

Ribbon_s the load.

Declaration

public virtual void Ribbon_Load(IRibbonUI ribbonUI)

Parameters

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

Save(IRibbonControl)

Saves the specified control.

Declaration

public virtual bool Save(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean

SaveAs(IRibbonControl)

Saves the specified control.

Declaration

public virtual bool SaveAs(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean

SaveDraft(IRibbonControl)

Saves the draft.

Declaration

public void SaveDraft(IRibbonControl control)

Parameters

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

SaveRevision(IRibbonControl)

Saves the revision.

Declaration

public virtual bool SaveRevision(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean

ShowPreferences(IRibbonControl)

Shows the preferences.

Declaration

public void ShowPreferences(IRibbonControl control)

Parameters

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

SwitchBranch(IRibbonControl)

Switches the branch.

Declaration

public virtual bool SwitchBranch(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean

ToggleSession(IRibbonControl)

News the document.

Declaration

public void ToggleSession(IRibbonControl control)

Parameters

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

Implements

Microsoft.Office.Core.IRibbonExtensibility

Extension Methods

UtilityExtensions.ToXml(Object, String)

See Also

Microsoft.Office.Core.IRibbonExtensibility