DocumentManager.FindDocument(String, Boolean) Method

Finds a document by its identifier

Namespace: DevExpress.Web.Office

Assembly: DevExpress.Web.v21.1.dll

Declaration

public static IDocumentInfo FindDocument(
    string documentId,
    bool loadRemoteState = false
)

Parameters

Name Type Description
documentId String

A string value specifying the document identifier

Optional Parameters

Name Type Default Description
loadRemoteState Boolean

False

true, to upload the target document to the local web-server; otherwise false

Returns

Type Description
IDocumentInfo

A IDocumentInfo object defining the found document.

Remarks

IMPORTANT

This overload is used only for scalable applications that use office document state providers. Call this method’s overload with the single documentId parameter if you do not install the office document state providers.

The method with the loadRemoteState parameter set to true loads the target document from an external storage to the local web-server. This allows you to access all members of the returned IDocumentInfo object. Note, that the operation’s performance is related to the target document’s size: the larger the document’s size, the worse the performance.

The method with the loadRemoteState parameter set to false returns the IDocumentInfo instance of the target document that is not downloaded to the local web-server. The method does not spend time on downloading the target document, but you can only use the returned IDocumentInfo object to close the target document by calling the IDocumentInfo.Close method.

See Also