OpenDocuments.EditDocument Method

  • Article

Applies to: SharePoint Foundation 2010

Opens the specified document for editing with its associated application or with the specified editor.

expression.EditDocument(bstrDocumentLocation, varProgID)

Parameters

expression

An expression that returns an OpenDocuments object.

bstrDocumentLocation

A string that contains the URL of the document to open for editing.

varProgID

An optional string that contains the ProgID of the application with which to edit the document. If this argument is omitted, the default editor for the document is used.

Return Value

true if the document was successfully opened; otherwise false.

Example

The following example uses the EditDocument method to open a specified document for editing. The example assumes the existence of a form named frmEditDoc that has two input boxes, EditFile and FileProgID.

<SCRIPT language="JavaScript">
function EditDocWithProgID()
{
    EditDocumentButton = new ActiveXObject("SharePoint.OpenDocuments.2");

    if (EditDocumentButton)
    {
        var strDocument = document.frmEditDoc.EditFile.value;
        var varProgID = document.frmEditDoc.FileProgID.value;

        EditDocumentButton.EditDocument(strDocument, varProgID);
   }
}
</SCRIPT>