RichEditExtension.Open(String, String, DocumentFormat) Method

Opens a document in the specified format from a file system.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.2.dll

Declaration

C#

public static ActionResult Open(
    string extensionName,
    string filePath,
    DocumentFormat format
)

VB.NET

Public Shared Function Open(
    extensionName As String,
    filePath As String,
    format As DocumentFormat
) As ActionResult

Parameters

Name	Type	Description
extensionName	String	The RichEdit name.
filePath	String	The path to a document to open.
format	DocumentFormat	The document format.

Returns

Type	Description
ActionResult	An object that represents the result of the operation.

Remarks

Call this Open method to open a document from the server’s file system. When you open a document for the first time, the control loads it to the server’s memory and generates a DocumentId from the filePath parameter value.

If the document is already open, the method activates the document stored in the server’s memory.

Note that the Open method uses the control’s parameters stored as an additional parameter of the control’s work session to restore all the controls settings and return a relevant partial view in a controller action. It is recommended to avoid using the DocumentManager.CloseAllDocuments method that clears all the session parameters, including control settings and close only specific documents using the documents names.

Alternatively, you can open documents by passing a document name from a controller to a partial view using the View Data collection and invoking the Open method directly in the partial view.