Interface IDocument

Word Document Interface.

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

Properties

FullName

Gets or sets the full name.

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

The full name.

Name

Gets the name.

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

The name.

Path

Gets the path.

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

The path.

Saved

Gets or sets a value indicating whether document is saved.

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

true if document is saved; otherwise, false.

WindowHandle

Gets the window handle.

Declaration
int? WindowHandle { get; }
Property Value
Type Description
System.Nullable<System.Int32>

The window handle.

Methods

AddCustomProperty(String, String)

Adds the custom property.

Declaration
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
void AddDocumentInfo(DocumentInfo documentInfo)
Parameters
Type Name Description
DocumentInfo documentInfo

The document information.

CheckIfProtected()

Checks if the document is private

Declaration
bool CheckIfProtected()
Returns
Type Description
System.Boolean

Close(Boolean)

Closes Active Document.

Declaration
void Close(bool delete = false)
Parameters
Type Name Description
System.Boolean delete

if set to true [delete].

DeleteCustomProperty(String)

Deletes the custom property.

Declaration
void DeleteCustomProperty(string name)
Parameters
Type Name Description
System.String name

The name.

DeleteDocumentInfo()

Deletes the document information.

Declaration
void DeleteDocumentInfo()

GetCustomProperty(String)

Gets the custom property value.

Declaration
string GetCustomProperty(string name)
Parameters
Type Name Description
System.String name

The name.
Returns
Type Description
System.String

GetDocumentInfo()

Gets the document information.

Declaration
DocumentInfo GetDocumentInfo()
Returns
Type Description
DocumentInfo

GetRelations(Boolean)

Gets the relations.

Declaration
ReferenceNode[] GetRelations(bool isSaveAs = false)
Parameters
Type Name Description
System.Boolean isSaveAs

if set to true indicates that copy of the document is being saved to server.
Returns
Type Description
ReferenceNode[]

GetRenditions(SaveOptions)

Gets the renditions.

Declaration
RenditionInfo[] GetRenditions(SaveOptions saveOptions)
Parameters
Type Name Description
SaveOptions saveOptions

The save options.
Returns
Type Description
RenditionInfo[]

Save()

Saves this instance.

Declaration
void Save()

SaveAs(String)

Saves current document to specified location.

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

SaveCopy(String)

Saves a copy of the document to a file.

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

The file path.

Extension Methods