Class ExcelWorkbook

Wrapper Class for Active Document.

Inheritance

System.Object

ExcelWorkbook

Implements

IDocument

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 ExcelWorkbook : IDocument

Constructors

ExcelWorkbook(Workbook)

Initializes a new instance of the ExcelWorkbook class.

Declaration

public ExcelWorkbook(Workbook workbook)

Parameters

Type	Name	Description
Microsoft.Office.Interop.Excel.Workbook	workbook	The workbook.

Properties

CustomDocumentProperties

Gets the open XML.

Declaration

public DocumentProperties CustomDocumentProperties { get; }

Property Value

Type	Description
Microsoft.Office.Core.DocumentProperties	The open XML.

CustomXMLParts

Gets the custom XML parts.

Declaration

public CustomXMLParts CustomXMLParts { get; }

Property Value

Type	Description
Microsoft.Office.Core.CustomXMLParts	The custom XML parts.

FullName

Gets or sets the full name.

Declaration

public string FullName { get; }

Property Value

Type	Description
System.String	The full name.

Name

Gets the name.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	The name.

Path

Gets the path.

Declaration

public string Path { get; }

Property Value

Type	Description
System.String	The path.

Saved

Gets or sets a value indicating whether document is saved.

Declaration

public bool Saved { get; set; }

Property Value

Type	Description
System.Boolean	true if document is saved; otherwise, false.

WindowHandle

Gets the window handle.

Declaration

public int? WindowHandle { get; }

Property Value

Type	Description
System.Nullable<System.Int32>	The window handle.

Methods

AddCustomProperty(String, String)

Adds the custom property.

Declaration

public void AddCustomProperty(string name, string value)

Parameters

Type	Name	Description
System.String	name	The name.
System.String	value	The value.

AddDocumentInfo(DocumentInfo)

Adds the document information.

Declaration

public void AddDocumentInfo(DocumentInfo documentInfo)

Parameters

Type	Name	Description
DocumentInfo	documentInfo	The document information.

CheckIfProtected()

Checks if document is protected

Declaration

public bool CheckIfProtected()

Returns

Type	Description
System.Boolean

Close(Boolean)

Closes Active Document.

Declaration

public void Close(bool delete = false)

Parameters

Type	Name	Description
System.Boolean	delete

DeleteCustomProperty(String)

Deletes the custom property.

Declaration

public void DeleteCustomProperty(string name)

Parameters

Type	Name	Description
System.String	name	The name.

DeleteDocumentInfo()

Deletes the document information.

Declaration

public void DeleteDocumentInfo()

GetCustomProperty(String)

Gets the custom property.

Declaration

public string GetCustomProperty(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Returns

Type	Description
System.String

GetDocumentInfo()

Gets the document information.

Declaration

public DocumentInfo GetDocumentInfo()

Returns

Type	Description
DocumentInfo

GetRelations(Boolean)

Gets the relations.

Declaration

public ReferenceNode[] GetRelations(bool isSaveAs)

Parameters

Type	Name	Description
System.Boolean	isSaveAs	if set to true indicates whether copy of the document is being saved to server.

Returns

Type	Description
ReferenceNode[]

GetRenditions(SaveOptions)

Gets the renditions.

Declaration

public RenditionInfo[] GetRenditions(SaveOptions saveOptions)

Parameters

Type	Name	Description
SaveOptions	saveOptions	The save options.

Returns

Type	Description
RenditionInfo[]

Save()

Saves this instance.

Declaration

public void Save()

Save(Boolean)

Saves this instance.

Declaration

public void Save(bool restrictReadOnlyFiles = false)

Parameters

Type	Name	Description
System.Boolean	restrictReadOnlyFiles	if set to true restricts saving read only files.

SaveAs(String)

Saves current document to specified location.

Declaration

public void SaveAs(string filePath)

Parameters

Type	Name	Description
System.String	filePath

SaveCopy(String)

Saves the copy of the document.

Declaration

public void SaveCopy(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The file path.

Implements

IDocument

Extension Methods

UtilityExtensions.ToXml(Object, String)