DocumentBase.SendForReview Method

  • Article

Sends the document in an e-mail message for review by the specified recipients.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
Public Sub SendForReview ( _
    ByRef recipients As Object, _
    ByRef subject As Object, _
    ByRef showMessage As Object, _
    ByRef includeAttachment As Object _
)

public void SendForReview(
    ref Object recipients,
    ref Object subject,
    ref Object showMessage,
    ref Object includeAttachment
)

Parameters

  • recipients
    Type: System.Object%

    The people to whom to send the message. These can be unresolved names and aliases in an e-mail phone book or full e-mail addresses. Separate multiple recipients with a semicolon (;). If left blank and ShowMessage is false, an exception is thrown and the message is not sent.

  • subject
    Type: System.Object%

    The subject of the message. If left blank, the subject will be: Please review "filename".

  • showMessage
    Type: System.Object%

    true to display the message before sending; otherwise, false. The default is true. If set to false, the message is automatically sent to the recipients without first showing the message to the sender.

  • includeAttachment
    Type: System.Object%

    true to include the document as an attachment; false to send a link to the document at a server location. If set to false, the document must be stored at a shared location.

Remarks

This method starts a collaborative review cycle. Use the EndReview method to end a review cycle.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Examples

The following code example uses the SendForReview method to send the document to a full e-mail address as an attachment. To use this example, run it from the ThisDocument class in a document-level project.

Private Sub DocumentSendForReview()
    Me.SendForReview("someone@example.com", _
        "Please Review this document.", False, True)
End Sub

private void DocumentSendForReview()
{
    object recipients = "someone@example.com";
    object subject = "Please Review this document.";
    object showMessage = false;
    object includeAttachment = true;

    this.SendForReview(ref recipients, ref subject, ref showMessage,
        ref includeAttachment);
}

.NET Framework Security

See Also

Reference

DocumentBase Class

Microsoft.Office.Tools.Word Namespace