Interface IAddInHost

Office Add-In host interface.

Namespace: Quark.CMSAdapters.Core.Office.Interfaces
Assembly: Quark.CMSAdapters.Core.Office.dll
Syntax
public interface IAddInHost

Properties

ActiveDocument

Gets the active document.

Declaration
IDocument ActiveDocument { get; }
Property Value
Type Description
IDocument

The active document.

ConnectionDetails

Gets the connection information.

Declaration
string ConnectionDetails { get; }
Property Value
Type Description
System.String

The connection information.

DefaultFilePath

Gets the default save path.

Declaration
string DefaultFilePath { get; }
Property Value
Type Description
System.String

DisplayAlerts

Gets a value indicating whether to display alerts.

Declaration
bool DisplayAlerts { get; }
Property Value
Type Description
System.Boolean

true if [display alerts]; otherwise, false.

JsApiHost

Gets the JS API host application name as defined by Quark.Qcef.HostApplications.

Declaration
string JsApiHost { get; }
Property Value
Type Description
System.String

The JS API host.

LanguageSettings

Gets the language settings.

Declaration
LanguageSettings LanguageSettings { get; }
Property Value
Type Description
Microsoft.Office.Core.LanguageSettings

The language settings.

Name

Gets the name.

Declaration
string Name { get; }
Property Value
Type Description
System.String

The name.

OpenDocumentCount

Gets the open document count.

Declaration
int OpenDocumentCount { get; }
Property Value
Type Description
System.Int32

The open document count.

StatusBar

Sets the status bar.

Declaration
string StatusBar { set; }
Property Value
Type Description
System.String

The status bar.

UIManager

Gets the UI manager.

Declaration
IUIManager UIManager { get; }
Property Value
Type Description
IUIManager

The UI manager.

Methods

Add(String)

Adds document to the collection of open documents.

Declaration
void Add(string filePath)
Parameters
Type Name Description
System.String filePath

The template path.

AddDocumentInfo(String, DocumentInfo)

Adds the document information.

Declaration
void AddDocumentInfo(string filePath, DocumentInfo documentInfo)
Parameters
Type Name Description
System.String filePath

The file path.
DocumentInfo documentInfo

The document information.

ClearMissingRecentFiles()

Clears the missing recent files.

Declaration
void ClearMissingRecentFiles()

ClearRecentFile(String)

Clears the recent file.

Declaration
void ClearRecentFile(string filePath)
Parameters
Type Name Description
System.String filePath

The file path.

DeleteDocumentInfo(String, Boolean)

Deletes the document information.

Declaration
void DeleteDocumentInfo(string filePath, bool isCopy = false)
Parameters
Type Name Description
System.String filePath

The file path.
System.Boolean isCopy

if set to true indicates that file is copy of the original document.

GetDocumentInfo(String)

Gets the document information.

Declaration
DocumentInfo GetDocumentInfo(string filePath)
Parameters
Type Name Description
System.String filePath

The file path.
Returns
Type Description
DocumentInfo

IsXAAddInActive()

Determines whether XML Author addin is active.

Declaration
bool IsXAAddInActive()
Returns
Type Description
System.Boolean

true if active else false

IsXADocumentActive()

Determines whether XML Author document is active.

Declaration
bool IsXADocumentActive()
Returns
Type Description
System.Boolean

true if active else false

Open(String, Boolean)

Opens the specified file path.

Declaration
void Open(string filePath, bool readOnly = false)
Parameters
Type Name Description
System.String filePath

The file path.
System.Boolean readOnly

if set to true [is read only].

Events

DocumentChange

Occurs when document change.

Declaration
event Action DocumentChange
Event Type
Type Description
System.Action

DocumentClosing

Occurs when document is closing. Document close event is canceled if event delegate returns true value.

Declaration
event Func<IDocument, bool> DocumentClosing
Event Type
Type Description
System.Func<IDocument, System.Boolean>

DocumentOpened

Occurs when document is opened.

Declaration
event Action<IDocument> DocumentOpened
Event Type
Type Description
System.Action<IDocument>

DocumentSaved

Occurs when document is saved.

Declaration
event Action<IDocument> DocumentSaved
Event Type
Type Description
System.Action<IDocument>

NewDocument

Occurs when new document is opened.

Declaration
event Action<IDocument> NewDocument
Event Type
Type Description
System.Action<IDocument>

Shutdown

Occurs when IAddInHost is shutting down.

Declaration
event Action Shutdown
Event Type
Type Description
System.Action

Extension Methods