C# Class XWord.XWikiAddIn

Mostra file Open project: xwiki-contrib/xwiki-office Class Usage Examples

Public Properties

Property	Type	Description
cookies	List
currentLocalFilePath	string
currentPageFullName	string
panes	XWikiNavigationPane>.Dictionary
password	string
serverURL	string
username	string
wiki	XWiki.Model.Wiki

Public Methods

Method	Description
HasVisibleWikiExplorer ( ) : bool	Specifies if the addin has WikiEx
HideTaskPanes ( ) : void	Hides all WikiExploer taskpanes in the addin.
InitializeAddin ( ) : void	Makes the login to the server, using the ConnectionSettingsForm or the last stored credentials. Adds the taskpanes.
ReinforceApplicationOptions ( ) : void	Sets the application(Word) options.
ShowTaskPanes ( ) : void	Shows all WikiExplorer taskpanes in the addin.
ToggleActiveTaskPane ( bool newState ) : void	Shows or hides the active Wiki Explorer.
ToggleTaskPanes ( ) : void	Hides/Shows the Wiki Explorer taskpanes.

Private Methods

Method	Description
AddTaskPane ( Microsoft.Office.Interop.Word doc ) : void	Adds a custom task pane to the addin's taskpanes collection. The task pane is assigned to the given document's active window.
AddTaskPanes ( ) : void	Adds a XWiki task pane to each opened document.
Application_DocumentBeforeClose ( Microsoft doc, bool &cancel ) : void	Event triggered before closing a document.
Application_DocumentChange ( ) : void	Event triggered when the active document changes. This event is triggered every time you switch to a different document window. It does NOT refer to content changing.
Application_DocumentOpen ( Microsoft Doc ) : void	Event triggered when a document is openend.
BeginInitialization ( ) : void
BindToData ( ) : void
EndInitialization ( ) : void
FinishInitialization ( ) : void
GetActiveWikiExplorer ( ) : Microsoft.Office.Tools.CustomTaskPane
GetWikiExplorer ( Microsoft.Office.Interop.Word document ) : Microsoft.Office.Tools.CustomTaskPane
Initialize ( ) : void
InitializeCachedData ( ) : void
InitializeComponents ( ) : void
InitializeControls ( ) : void
InitializeData ( ) : void
InitializeDataBindings ( ) : void
InitializeEventsHandlers ( ) : void
InternalStartup ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
IsCached ( string MemberName ) : bool
LoadCredentials ( ) : bool	Loads the last used credentials of the user.
NeedsFill ( string MemberName ) : bool
OnShutdown ( ) : void
RemoveAllTaskPanes ( ) : void	Removes all XWiki task panes. RemoveTaskPane
RemoveOrphans ( ) : void	Removes all task pane instances that not longer have an existing window.
RemoveTaskPane ( Microsoft.Office.Interop.Word doc ) : void	Removes all XWiki task panes from the given document.
SetFolderSuffix ( XOfficeCommonSettings settings ) : void
ShowConnectToServerUI ( ) : bool
ShowTaskPanes ( bool visible ) : void	Hides all WikiExplorers in all documents
StartCaching ( string MemberName ) : void
StopCaching ( string MemberName ) : void
ThisAddIn_NewDocument ( Microsoft Doc ) : void	Event triggered when a new document is created.
ThisAddIn_Shutdown ( object sender, System e ) : void	Event triggered before closing the addin.
ThisAddIn_Startup ( object sender, System e ) : void	Event triggered when a new word instance is starting.
UpdateWikiExplorerButtonState ( ) : void
XWikiAddIn ( )
XWikiAddIn_ClientInstanceChanged ( object sender, EventArgs e ) : void
XWikiAddIn_LoginFailed ( ) : void
XWikiAddIn_LoginSuccessul ( ) : void
timer_Elapsed ( object sender, System.Timers.ElapsedEventArgs e ) : void	Executes when the specified amount of time has passed.
wikiExplorer_VisibleChanged ( object sender, EventArgs e ) : void

Method Details

HasVisibleWikiExplorer() public method

Specifies if the addin has WikiEx

public HasVisibleWikiExplorer ( ) : bool
return	bool

HideTaskPanes() public method

Hides all WikiExploer taskpanes in the addin.

public HideTaskPanes ( ) : void
return	void

InitializeAddin() public method

Makes the login to the server, using the ConnectionSettingsForm or the last stored credentials. Adds the taskpanes.

public InitializeAddin ( ) : void
return	void

ReinforceApplicationOptions() public method

Sets the application(Word) options.

public ReinforceApplicationOptions ( ) : void
return	void

ShowTaskPanes() public method

Shows all WikiExplorer taskpanes in the addin.

public ShowTaskPanes ( ) : void
return	void

ToggleActiveTaskPane() public method

Shows or hides the active Wiki Explorer.

public ToggleActiveTaskPane ( bool newState ) : void
newState	bool	The new state of the pane. TRUE for visible, FALSE for hidden.
return	void

ToggleTaskPanes() public method

Hides/Shows the Wiki Explorer taskpanes.

public ToggleTaskPanes ( ) : void
return	void

Property Details

cookies public_oe static_oe property

A list of the web client's cookies.

public static List cookies
return	List

currentLocalFilePath public_oe property

Specifies the path to the active document.

public string currentLocalFilePath
return	string

currentPageFullName public_oe property

Specifies the full name of the currently edited page(if any).

public string currentPageFullName
return	string

panes public_oe property

Collection containing all custom task panes in all opened Word instances.

public Dictionary panes
return	XWikiNavigationPane>.Dictionary

password public_oe property

The password used to connect to the server.

public string password
return	string

serverURL public_oe property

The url of the server that the user is currently connected to.

public string serverURL
return	string

username public_oe property

The username used to connect to the server.

public string username
return	string

wiki public_oe property

Object containing the structure(Spaces,Pages,Attachment names) of the wiki the use is connected to.

public Wiki,XWiki.Model wiki
return	XWiki.Model.Wiki