DocumentManager.FindDocument(String) Method
Finds a document by its identifier.
Namespace: DevExpress.Web.Office
Assembly: DevExpress.Web.v19.2.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
documentId | String | A string value specifying the document identifier. |
Returns
Type | Description |
---|---|
IDocumentInfo | A IDocumentInfo object defining the found document. |
Remarks
The method returns an IDocumentInfo class instance that you can use to access information about the target document and operate it on the local web-server.
Note
If you use an office document state provider in your web application, the returned IDocumentInfo object can only be used to close the target document using the IDocumentInfo.Close method. This behavior is caused by the fact that this method’s overload does not download the target document to the local web-server. Call this method’s overload with the loadRemoteState parameter set to true to download the target document’s and access all the IDocumentInfo object’s members.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FindDocument(String) method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.