C# Class XWord.XWikiRibbon

显示文件 Open project: xwiki-contrib/xwiki-office Class Usage Examples

Public Properties

Property Type Description
attachmentsGroup Microsoft.Office.Tools.Ribbon.RibbonGroup
btnAddPage Microsoft.Office.Tools.Ribbon.RibbonButton
btnDownload Microsoft.Office.Tools.Ribbon.RibbonButton
btnDownloadAndOpen Microsoft.Office.Tools.Ribbon.RibbonButton
btnEditPage Microsoft.Office.Tools.Ribbon.RibbonButton
btnNewPage Microsoft.Office.Tools.Ribbon.RibbonButton
btnPreview Microsoft.Office.Tools.Ribbon.RibbonButton
btnPublishDocument Microsoft.Office.Tools.Ribbon.RibbonButton
btnRefresh Microsoft.Office.Tools.Ribbon.RibbonButton
btnShowAttachments Microsoft.Office.Tools.Ribbon.RibbonButton
btnShowPages Microsoft.Office.Tools.Ribbon.RibbonButton
btnUpload Microsoft.Office.Tools.Ribbon.RibbonButton
btnViewActiveDocInBrowser Microsoft.Office.Tools.Ribbon.RibbonButton
btnViewInBrowser Microsoft.Office.Tools.Ribbon.RibbonButton
downloadAtt Microsoft.Office.Tools.Ribbon.RibbonButton
dropDownSaveFormat Microsoft.Office.Tools.Ribbon.RibbonDropDown
dropDownSyntax Microsoft.Office.Tools.Ribbon.RibbonDropDown
uploadAttToPage Microsoft.Office.Tools.Ribbon.RibbonButton

Private Properties

Property Type Description
ActivateXWordMenu void
Addin_ClientInstanceChanged void
Addin_DocumentChanged void
Application_DocumentBeforeSave void
InitializeComponent void
Show_ConnectionDialog void
SyncSaving_Click void
UploadAttToPage_Click void
XWikiRibbon_Load void
btnAboutXWord_Click void
btnAddPage_Click void
btnDownloadAndOpen_Click void
btnEditPage_Click void
btnNewPage_Click void
btnRefresh_Click void
btnSavePage_Click void
btnShowAttachments_Click void
btnShowPages_Click void
btnUpdateAnnotations_Click void
btnViewActiveDocInBrowser_Click void
btnViewInBrowser_Click void
button1_Click void
downloadAtt_Click void
dropDownSaveFormat_ItemsLoading void
dropDownSaveFormat_SelectionChanged void
dropDownSyntax_SelectionChanged void
toggleAnnotations_Click void
toggleWikiExplorer_Click void

Public Methods

Method Description
DisableTreeNavigationActions ( ) : void

Disables all buttons in the wiki explorer context menu.

Refresh ( object sender, EventArgs e ) : void

Refreshes the buttons from the selectionOptionsGroup according to the connection state.

SetWikiExplorerButtonState ( bool state ) : void

Sets the Wiki Explorer toggle button to the given state.

SwitchSyntax ( string toSyntax ) : void

Changes the selected item from dropDownSyntax control with the one that is labeled with toSyntax string.

SwitchToOfflineMode ( ) : void

Disables the UI groups that need a server connection.

SwitchToOnlineMode ( ) : void

Enables the UI groups that need a server connection.

XWikiRibbon ( ) : System

Default constructor. Initializes all components.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

Private Methods

Method Description
ActivateXWordMenu ( ) : void

Activates the XWord tab. This method isn't guarantted to succeed due to other user interactions in the addin.

Addin_ClientInstanceChanged ( object sender, EventArgs e ) : void
Addin_DocumentChanged ( ) : void
Application_DocumentBeforeSave ( Microsoft Doc, bool &SaveAsUI, bool &Cancel ) : void
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

Show_ConnectionDialog ( object sender, RibbonControlEventArgs e ) : void
SyncSaving_Click ( object sender, RibbonControlEventArgs e ) : void
UploadAttToPage_Click ( object sender, RibbonControlEventArgs e ) : void
XWikiRibbon_Load ( object sender, RibbonUIEventArgs e ) : void
btnAboutXWord_Click ( object sender, RibbonControlEventArgs e ) : void
btnAddPage_Click ( object sender, RibbonControlEventArgs e ) : void
btnDownloadAndOpen_Click ( object sender, RibbonControlEventArgs e ) : void
btnEditPage_Click ( object sender, RibbonControlEventArgs e ) : void
btnNewPage_Click ( object sender, RibbonControlEventArgs e ) : void
btnRefresh_Click ( object sender, RibbonControlEventArgs e ) : void

Refreshes the active document. If the document is not a wiki page no action is done.

btnSavePage_Click ( object sender, RibbonControlEventArgs e ) : void
btnShowAttachments_Click ( object sender, RibbonControlEventArgs e ) : void
btnShowPages_Click ( object sender, RibbonControlEventArgs e ) : void
btnUpdateAnnotations_Click ( object sender, RibbonControlEventArgs e ) : void
btnViewActiveDocInBrowser_Click ( object sender, RibbonControlEventArgs e ) : void
btnViewInBrowser_Click ( object sender, RibbonControlEventArgs e ) : void
button1_Click ( object sender, RibbonControlEventArgs e ) : void
downloadAtt_Click ( object sender, RibbonControlEventArgs e ) : void
dropDownSaveFormat_ItemsLoading ( object sender, RibbonControlEventArgs e ) : void
dropDownSaveFormat_SelectionChanged ( object sender, RibbonControlEventArgs e ) : void
dropDownSyntax_SelectionChanged ( object sender, RibbonControlEventArgs e ) : void
toggleAnnotations_Click ( object sender, RibbonControlEventArgs e ) : void
toggleWikiExplorer_Click ( object sender, RibbonControlEventArgs e ) : void

Method Details

DisableTreeNavigationActions() public method

Disables all buttons in the wiki explorer context menu.
public DisableTreeNavigationActions ( ) : void
return void

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources should be disposed; otherwise, false.
return void

Refresh() public method

Refreshes the buttons from the selectionOptionsGroup according to the connection state.
public Refresh ( object sender, EventArgs e ) : void
sender object
e EventArgs
return void

SetWikiExplorerButtonState() public method

Sets the Wiki Explorer toggle button to the given state.
public SetWikiExplorerButtonState ( bool state ) : void
state bool The state of the button.
return void

SwitchSyntax() public method

Changes the selected item from dropDownSyntax control with the one that is labeled with toSyntax string.
public SwitchSyntax ( string toSyntax ) : void
toSyntax string Existing item in dropDownSyntax to be selected.
return void

SwitchToOfflineMode() public method

Disables the UI groups that need a server connection.
public SwitchToOfflineMode ( ) : void
return void

SwitchToOnlineMode() public method

Enables the UI groups that need a server connection.
public SwitchToOnlineMode ( ) : void
return void

XWikiRibbon() public method

Default constructor. Initializes all components.
public XWikiRibbon ( ) : System
return System

Property Details

attachmentsGroup public_oe property

Group containing the buttons for handling attachments.
public Microsoft.Office.Tools.Ribbon.RibbonGroup attachmentsGroup
return Microsoft.Office.Tools.Ribbon.RibbonGroup

btnAddPage public_oe property

Button used to add the a new page to the wiki.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnAddPage
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnDownload public_oe property

Button used to donwload the selected attachment.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnDownload
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnDownloadAndOpen public_oe property

Downloads and opens the selected attachement with the assigned application.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnDownloadAndOpen
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnEditPage public_oe property

Edit the selected page with Word.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnEditPage
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnNewPage public_oe property

Button used to create a new page.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnNewPage
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnPreview public_oe property

public Microsoft.Office.Tools.Ribbon.RibbonButton btnPreview
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnPublishDocument public_oe property

Button used to save/publish the active document to the wiki.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnPublishDocument
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnRefresh public_oe property

public Microsoft.Office.Tools.Ribbon.RibbonButton btnRefresh
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnShowAttachments public_oe property

Button used to show the attachments of a page in Wiki Exploerer.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnShowAttachments
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnShowPages public_oe property

Button used to show the pages of a space in Wiki Explorer.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnShowPages
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnUpload public_oe property

Button used to upload the active document to the seleted page.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnUpload
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnViewActiveDocInBrowser public_oe property

public Microsoft.Office.Tools.Ribbon.RibbonButton btnViewActiveDocInBrowser
return Microsoft.Office.Tools.Ribbon.RibbonButton

btnViewInBrowser public_oe property

Button used to view the selected page in the default browser.
public Microsoft.Office.Tools.Ribbon.RibbonButton btnViewInBrowser
return Microsoft.Office.Tools.Ribbon.RibbonButton

downloadAtt public_oe property

Button used to upload the download the selected attachment.
public Microsoft.Office.Tools.Ribbon.RibbonButton downloadAtt
return Microsoft.Office.Tools.Ribbon.RibbonButton

dropDownSaveFormat public_oe property

Contains a list with the html formats that Word can use to save the local wiki pages.
public Microsoft.Office.Tools.Ribbon.RibbonDropDown dropDownSaveFormat
return Microsoft.Office.Tools.Ribbon.RibbonDropDown

dropDownSyntax public_oe property

public Microsoft.Office.Tools.Ribbon.RibbonDropDown dropDownSyntax
return Microsoft.Office.Tools.Ribbon.RibbonDropDown

uploadAttToPage public_oe property

Button used to upload the active document to the selected page.
public Microsoft.Office.Tools.Ribbon.RibbonButton uploadAttToPage
return Microsoft.Office.Tools.Ribbon.RibbonButton