Class Document

Inheritance

Object

Document

Implements

IWebObject

IPlugin

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Web.AjaxMethods

Assembly: SuperOffice.CRMWeb.dll

Syntax

[SoWebObject("Document")]
public class Document : IWebObject, IPlugin

Constructors

Document()

Declaration

public Document()

Methods

CheckoutAndOpenDocumentWithTrayApp(Int32)

Declaration

public bool CheckoutAndOpenDocumentWithTrayApp(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
Boolean

CheckOutDocument(Int32)

Declaration

public static ReturnInfo CheckOutDocument(int docId)

Parameters

Type	Name	Description
Int32	docId

Returns

Type	Description
ReturnInfo

DeleteDocument(Int32)

Declaration

public void DeleteDocument(int documentId)

Parameters

Type	Name	Description
Int32	documentId

DeleteTempDocument(String)

Declaration

public void DeleteTempDocument(string name)

Parameters

Type	Name	Description
String	name

DownloadCurrentDocument()

Declaration

public string DownloadCurrentDocument()

Returns

Type	Description
String

DownloadDocument(Int32)

Declaration

public string DownloadDocument(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
String

DownloadDocumentFile(Int32)

Declaration

public string DownloadDocumentFile(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
String

DownloadDocumentTemplate(Int32, Int32)

Declaration

public string DownloadDocumentTemplate(int documentTemplateId, int languageLCID)

Parameters

Type	Name	Description
Int32	documentTemplateId
Int32	languageLCID

Returns

Type	Description
String

DownloadReadOnlyDocumentFile(Int32)

Declaration

public string DownloadReadOnlyDocumentFile(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
String

ExecuteDocumentCommand(Int32, String)

Declaration

public static ReturnInfo ExecuteDocumentCommand(int docId, string command)

Parameters

Type	Name	Description
Int32	docId
String	command

Returns

Type	Description
ReturnInfo

GetCheckOutState(Int32)

Declaration

public static CheckoutInfo GetCheckOutState(int docId)

Parameters

Type	Name	Description
Int32	docId

Returns

Type	Description
CheckoutInfo

GetCreateDocumentCallback(Int32)

Declaration

public static string GetCreateDocumentCallback(int docTemplateId)

Parameters

Type	Name	Description
Int32	docTemplateId

Returns

Type	Description
String

GetDocumentTableRightsReason(Int32)

Declaration

public static string GetDocumentTableRightsReason(int docId)

Parameters

Type	Name	Description
Int32	docId

Returns

Type	Description
String

GetDocumentTemplateProperties(Int32, Int32)

Declaration

public StringDictionary GetDocumentTemplateProperties(int documentTemplateId, int languageLCID)

Parameters

Type	Name	Description
Int32	documentTemplateId
Int32	languageLCID

Returns

Type	Description
StringDictionary

GetPreferredOpenScript()

Declaration

public string GetPreferredOpenScript()

Returns

Type	Description
String

IsTrayAppConnected()

Declaration

public static bool IsTrayAppConnected()

Returns

Type	Description
Boolean

OpenDocument(Int32, String, Boolean)

Declaration

public string OpenDocument(int documentId, string archiveControlId, bool useSuperStateCopy)

Parameters

Type	Name	Description
Int32	documentId
String	archiveControlId
Boolean	useSuperStateCopy

Returns

Type	Description
String

OpenDocumentWithTrayApp(Int32)

Declaration

public bool OpenDocumentWithTrayApp(int documentId)

Parameters

Type	Name	Description
Int32	documentId

Returns

Type	Description
Boolean

SaveDocumentTemplateStream(Int32, String, String, Int32)

Declaration

public TemplateInfo SaveDocumentTemplateStream(int documentTemplateId, string base64content, string languageCode = "", int pluginId = -1)

Parameters

Type	Name	Description
Int32	documentTemplateId
String	base64content
String	languageCode
Int32	pluginId

Returns

Type	Description
TemplateInfo

SetCurrentContactPerson(Int32)

Declaration

public void SetCurrentContactPerson(int documentId)

Parameters

Type	Name	Description
Int32	documentId

UndoCheckOutDocument(Int32)

Declaration

public static ReturnInfo UndoCheckOutDocument(int docId)

Parameters

Type	Name	Description
Int32	docId

Returns

Type	Description
ReturnInfo

Implements

IWebObject

SuperOffice.Factory.IPlugin