Class AddInHost

Wrapper Class for AddInHost.

Inheritance

System.Object

AddInHost

Implements

IAddInHost

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

Assembly: Quark.CMSAdapters.Office.Excel.dll

Syntax

public class AddInHost : IAddInHost

Constructors

AddInHost()

Initializes a new instance of the AddInHost class.

Declaration

public AddInHost()

Properties

ActiveDocument

Gets or sets the active document.

Declaration

public IDocument ActiveDocument { get; }

Property Value

Type	Description
IDocument	The active document.

Application

Gets the application.

Declaration

public Application Application { get; }

Property Value

Type	Description
Microsoft.Office.Interop.Excel.Application	The application.

ConnectionDetails

Gets the connection information.

Declaration

public string ConnectionDetails { get; }

Property Value

Type	Description
System.String	The connection information.

DefaultFilePath

Gets the default save path.

Declaration

public string DefaultFilePath { get; }

Property Value

Type	Description
System.String

DisplayAlerts

Gets a value indicating whether to display alerts.

Declaration

public 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

public string JsApiHost { get; }

Property Value

Type	Description
System.String	The JS API host.

LanguageSettings

Gets the language settings.

Declaration

public LanguageSettings LanguageSettings { get; }

Property Value

Type	Description
Microsoft.Office.Core.LanguageSettings	The language settings.

Name

Gets the name.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	The name.

OpenDocumentCount

Gets the open document count.

Declaration

public int OpenDocumentCount { get; }

Property Value

Type	Description
System.Int32	The open document count.

StatusBar

Gets or sets the status bar.

Declaration

public string StatusBar { set; }

Property Value

Type	Description
System.String	The status bar.

UIManager

Gets the UI manager.

Declaration

public IUIManager UIManager { get; }

Property Value

Type	Description
IUIManager	The UI manager.

Methods

Add(String)

Adds document to the collection of open documents.

Declaration

public void Add(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The template path.

AddDocumentInfo(String, DocumentInfo)

Adds the document information.

Declaration

public 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

public void ClearMissingRecentFiles()

ClearRecentFile(String)

Clears the recent file.

Declaration

public void ClearRecentFile(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The file path.

DeleteDocumentInfo(String, Boolean)

Deletes the document information.

Declaration

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

GetCustomProperty(String, String)

Gets the custom property value.

Declaration

public string GetCustomProperty(string filePath, string propertyName)

Parameters

Type	Name	Description
System.String	filePath	The file path.
System.String	propertyName	Name of the property.

Returns

Type	Description
System.String

GetDocumentInfo(String)

Gets the document information.

Declaration

public 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

public bool IsXAAddInActive()

Returns

Type	Description
System.Boolean	true if active else false

IsXADocumentActive()

Determines whether XML Author document is active.

Declaration

public bool IsXADocumentActive()

Returns

Type	Description
System.Boolean	true if active else false

Open(String, Boolean)

Opens the specified file path.

Declaration

public void Open(string filePath, bool readOnly)

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 eventHandler

Declaration

public event Action DocumentChange

Event Type

Type	Description
System.Action

DocumentClosing

Occurs when [document closing].

Declaration

public event Func<IDocument, bool> DocumentClosing

Event Type

Type	Description
System.Func<IDocument, System.Boolean>

DocumentOpened

Occurs when [document opened].

Declaration

public event Action<IDocument> DocumentOpened

Event Type

Type	Description
System.Action<IDocument>

DocumentSaved

Occurs when document is saved.

Declaration

public event Action<IDocument> DocumentSaved

Event Type

Type	Description
System.Action<IDocument>

NewDocument

Occurs when [document opened].

Declaration

public event Action<IDocument> NewDocument

Event Type

Type	Description
System.Action<IDocument>

Shutdown

Occurs when [shutdown].

Declaration

public event Action Shutdown

Event Type

Type	Description
System.Action

Implements

IAddInHost

Extension Methods

UtilityExtensions.ToXml(Object, String)