Class PowerPointRibbon

Represents PowerPoint specific Ribbon.

Inheritance

System.Object

Ribbon

PowerPointRibbon

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.SaveDraft(IRibbonControl)

Ribbon.ShowPreferences(IRibbonControl)

Ribbon.ToggleSession(IRibbonControl)

Ribbon.GetResourceId(IRibbonControl)

Ribbon.GetVisible(String)

Ribbon.IsFile(IDocument)

Ribbon.IsReadOnlyDocument(IDocument)

Ribbon.IsServerDocument(IDocument)

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.PowerPoint

Assembly: Quark.CMSAdapters.Office.PowerPoint.dll

Syntax

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

Constructors

PowerPointRibbon()

Initializes a new instance of the PowerPointRibbon class.

Declaration

public PowerPointRibbon()

Properties

CustomTaskPanes

Gets the custom task panes.

Declaration

protected CustomTaskPaneCollection CustomTaskPanes { get; }

Property Value

Type	Description
Microsoft.Office.Tools.CustomTaskPaneCollection	The custom task panes.

Methods

ChangeAsset(IRibbonControl)

Changes the asset.

Declaration

public void ChangeAsset(IRibbonControl control)

Parameters

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

ChangePicture(IRibbonControl, ref Boolean)

Changes the picture.

Declaration

public void ChangePicture(IRibbonControl control, ref bool cancelDefault)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Boolean	cancelDefault	if set to true [cancel default].

ChangePosterImage(IRibbonControl)

Changes the poster image.

Declaration

public void ChangePosterImage(IRibbonControl control)

Parameters

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

ChangeView(IRibbonControl, ref Boolean)

Changes the view.

Declaration

public void ChangeView(IRibbonControl control, ref bool cancelDefault)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Boolean	cancelDefault	if set to true [cancel default].

DeleteSlide(IRibbonControl, ref Boolean)

Deletes the slide.

Declaration

public void DeleteSlide(IRibbonControl control, ref bool cancelDefault)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Boolean	cancelDefault	if set to true [cancel default].

DeleteSlideContextMenu(IRibbonControl, ref Boolean)

Deletes the slide context menu.

Declaration

public void DeleteSlideContextMenu(IRibbonControl control, ref bool cancelDefault)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Boolean	cancelDefault	if set to true [cancel default].

DetachMediaShapes(IRibbonControl)

Detaches linked media shapes.

Declaration

public void DetachMediaShapes(IRibbonControl control)

Parameters

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

DetachShape(IRibbonControl)

Detaches linked shape.

Declaration

public void DetachShape(IRibbonControl control)

Parameters

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

DetachSlide(IRibbonControl)

Detaches the slide.

Declaration

public void DetachSlide(IRibbonControl control)

Parameters

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

EditOriginal(IRibbonControl)

Opens the original file of the selected link.

Declaration

public void EditOriginal(IRibbonControl control)

Parameters

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

EditShapeLink(IRibbonControl)

Opens the shape link.

Declaration

public void EditShapeLink(IRibbonControl control)

Parameters

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

EditSlideLink(IRibbonControl)

Opens the slide link.

Declaration

public void EditSlideLink(IRibbonControl control)

Parameters

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

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)

HideTaskPanes(DocumentWindow)

Hides the task panes.

Declaration

public virtual void HideTaskPanes(DocumentWindow window)

Parameters

Type	Name	Description
Microsoft.Office.Interop.PowerPoint.DocumentWindow	window	The window.

InsertAudio(IRibbonControl)

Inserts the audio.

Declaration

public void InsertAudio(IRibbonControl control)

Parameters

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

InsertChart(IRibbonControl)

Inserts the chart.

Declaration

public void InsertChart(IRibbonControl control)

Parameters

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

InsertPicture(IRibbonControl)

Inserts the picture.

Declaration

public void InsertPicture(IRibbonControl control)

Parameters

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

InsertSlide(IRibbonControl)

Inserts the server slide.

Declaration

public void InsertSlide(IRibbonControl control)

Parameters

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

InsertSlideFromMenu(IRibbonControl)

Inserts the server slide from menu.

Declaration

public void InsertSlideFromMenu(IRibbonControl control)

Parameters

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

InsertTable(IRibbonControl)

Inserts the table.

Declaration

public void InsertTable(IRibbonControl control)

Parameters

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

InsertVideo(IRibbonControl)

Inserts the video.

Declaration

public void InsertVideo(IRibbonControl control)

Parameters

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

InvalidateTaskPaneControl(Boolean)

Invalidates the task pane control.

Declaration

public virtual void InvalidateTaskPaneControl(bool checkForUpdates = false)

Parameters

Type	Name	Description
System.Boolean	checkForUpdates

IsActivePresentationAvailable(IRibbonControl)

Determines whether active presentation is available and View be Normal, Outline, Slide/Slide sorter view.

Declaration

public bool IsActivePresentationAvailable(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control

Returns

Type	Description
System.Boolean

IsActiveSlideAvailable(IRibbonControl)

Determines whether active slide is available.

Declaration

public bool IsActiveSlideAvailable(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control

Returns

Type	Description
System.Boolean

IsAnyMediaShapeLinked(IRibbonControl)

Determines whether any linked Media shape is selected.

Declaration

public bool IsAnyMediaShapeLinked(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if any linked Media shape is selected; otherwise, false.

IsAnyShapeLinked(IRibbonControl)

Determines whether any linked shape is selected.

Declaration

public bool IsAnyShapeLinked(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if any linked shape is selected; otherwise, false.

IsAnySlideLinked(IRibbonControl)

Determines whether any linked slide is selected.

Declaration

public bool IsAnySlideLinked(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if any linked slide is selected; otherwise, false.

IsLinkedAudioShape(IRibbonControl)

Determines whether linked audio shape is selected.

Declaration

public bool IsLinkedAudioShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if linked audio shape is selected; otherwise, false.

IsLinkedChartShape(IRibbonControl)

Determines whether linked Chart shape is selected.

Declaration

public bool IsLinkedChartShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if linked Chart shape is selected; otherwise, false.

IsLinkedMediaShape(IRibbonControl)

Determines whether linked Media shape is selected.

Declaration

public bool IsLinkedMediaShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if linked Media shape is selected; otherwise, false.

IsLinkedPictureShape(IRibbonControl)

Determines whether linked Picture shape is selected.

Declaration

public bool IsLinkedPictureShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if linked Picture shape is selected; otherwise, false.

IsLinkedShape(IRibbonControl)

Determines whether selected shape is linked.

Declaration

public bool IsLinkedShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if selected shape is linked; otherwise, false.

IsLinkedSlide(IRibbonControl)

Determines whether selected slide is linked.

Declaration

public bool IsLinkedSlide(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if selected slide is linked; otherwise, false.

IsLinkedTableShape(IRibbonControl)

Determines whether linked Table shape is selected.

Declaration

public bool IsLinkedTableShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if linked Table shape is selected; otherwise, false.

IsLinkedVideoShape(IRibbonControl)

Determines whether linked video shape is selected.

Declaration

public bool IsLinkedVideoShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if linked video shape is selected; otherwise, false.

IsLockedSlideReference(IRibbonControl)

Determines whether the selected slide is linked to server reference when locking enabled.

Declaration

public bool IsLockedSlideReference(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean

IsNewWindowOfPresentation()

Checks if the window opened is a new window of an existing presentation.

Declaration

public bool IsNewWindowOfPresentation()

Returns

Type	Description
System.Boolean

IsNotIndirectLinkedShape(IRibbonControl)

Determines whether selected shape is not an Indirect link.

Declaration

public bool IsNotIndirectLinkedShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if selected shape is not an Indirect link; otherwise, false.

IsNotLinkedShape(IRibbonControl)

Determines whether selected shape is not linked.

Declaration

public bool IsNotLinkedShape(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if selected shape is not linked; otherwise, false.

IsNotLockedSlideReference(IRibbonControl)

Determines whether the selected slide is not linked to server reference when locking enabled.

Declaration

public bool IsNotLockedSlideReference(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean

IsShapeLinkExportedFromLocalFile(IRibbonControl)

Determines whether shape link exported from local file.

Declaration

public bool IsShapeLinkExportedFromLocalFile(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean	true if shape link exported from local file; otherwise, false.

IsTaskPaneEnabled(IRibbonControl)

Checks if smart content task pane should be enabled.

Declaration

public bool IsTaskPaneEnabled(IRibbonControl control)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	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)

OnDocumentClose(IDocument, ref Boolean)

Called when save to server and close the document.

Declaration

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

Parameters

Type	Name	Description
IDocument	document	The document.
System.Boolean	cancelDefault	if set to true [cancel default].

Overrides

Ribbon.OnDocumentClose(IDocument, ref Boolean)

OnPresentationCloseFinal(Presentation)

Called when presentation is closed.

Declaration

protected virtual void OnPresentationCloseFinal(Presentation presentation)

Parameters

Type	Name	Description
Microsoft.Office.Interop.PowerPoint.Presentation	presentation	The presentation.

PasteFromServer(IRibbonControl)

Paste data from server clipboard.

Declaration

public void PasteFromServer(IRibbonControl control)

Parameters

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

Publish(IRibbonControl)

Publishes the specified control.

Declaration

public void Publish(IRibbonControl control)

Parameters

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

RefreshChartData(IRibbonControl, ref Boolean)

Refreshes the chart data.

Declaration

public void RefreshChartData(IRibbonControl control, ref bool cancelDefault)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Boolean	cancelDefault	if set to true [cancel default].

RefreshLinkTaskPane(DocumentWindow)

Refreshes the link task pane.

Declaration

public void RefreshLinkTaskPane(DocumentWindow window)

Parameters

Type	Name	Description
Microsoft.Office.Interop.PowerPoint.DocumentWindow	window	The window.

ReloadLinkTaskPane(DocumentWindow)

Reloads the task pane.

Declaration

public void ReloadLinkTaskPane(DocumentWindow window)

Parameters

Type	Name	Description
Microsoft.Office.Interop.PowerPoint.DocumentWindow	window

ReloadLinkTaskPanes()

Reloads the task panes.

Declaration

public void ReloadLinkTaskPanes()

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)

Save(IRibbonControl)

Saves the specified control.

Declaration

public override bool Save(IRibbonControl control)

Parameters

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

Returns

Type	Description
System.Boolean

Overrides

Ribbon.Save(IRibbonControl)

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)

SelectChartData(IRibbonControl, ref Boolean)

Selects the chart data.

Declaration

public void SelectChartData(IRibbonControl control, ref bool cancelDefault)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Boolean	cancelDefault	if set to true [cancel default].

ShowHideLinkTaskPane(DocumentWindow, Boolean)

Shows the hide link task pane.

Declaration

public void ShowHideLinkTaskPane(DocumentWindow window, bool visible)

Parameters

Type	Name	Description
Microsoft.Office.Interop.PowerPoint.DocumentWindow	window	The window.
System.Boolean	visible	if set to true [visible].

ShowShapeLink(IRibbonControl)

Shows the shape link in task pane.

Declaration

public void ShowShapeLink(IRibbonControl control)

Parameters

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

ShowSlideLink(IRibbonControl)

Shows the slide link in task pane.

Declaration

public void ShowSlideLink(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)

ToggleReferenceTaskPane(IRibbonControl)

Toggles the reference task pane.

Declaration

public void ToggleReferenceTaskPane(IRibbonControl control)

Parameters

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

UpdateAll(IRibbonControl)

Updates all server items.

Declaration

public void UpdateAll(IRibbonControl control)

Parameters

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

UpdateLink(IRibbonControl, ref Boolean)

Updates the link.

Declaration

public void UpdateLink(IRibbonControl control, ref bool cancelDefault)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Boolean	cancelDefault	if set to true [cancel default].

UpdateShape(IRibbonControl)

Updates the shape.

Declaration

public void UpdateShape(IRibbonControl control)

Parameters

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

UpdateSlide(IRibbonControl)

Updates the slide.

Declaration

public void UpdateSlide(IRibbonControl control)

Parameters

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

ViewLinks(IRibbonControl, ref Boolean)

Views the links.

Declaration

public void ViewLinks(IRibbonControl control, ref bool cancelDefault)

Parameters

Type	Name	Description
Microsoft.Office.Core.IRibbonControl	control	The control.
System.Boolean	cancelDefault	if set to true [cancel default].

Implements

Microsoft.Office.Core.IRibbonExtensibility

Extension Methods

UtilityExtensions.ToXml(Object, String)