WorkbookBase.SendForReview Method

Sends a workbook in an e-mail message for review to the specified recipients.

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

Syntax

'Declaration
Public Sub SendForReview ( _
    recipients As Object, _
    subject As Object, _
    showMessage As Object, _
    includeAttachment As Object _
)
public void SendForReview(
    Object recipients,
    Object subject,
    Object showMessage,
    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, you will receive an error message, and the message will not be sent.

  • subject
    Type: System.Object

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

  • showMessage
    Type: System.Object

    A value that indicates whether the message should be displayed when the method is executed. The default value 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

    A value that indicates whether the message should include an attachment or a link to a server location. The default value is true. 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 workbook in an e-mail to two recipients. The e-mail will have the default subject line and will include the workbook as an attachment. This example assumes that the recipient names resolve to valid e-mail addresses.

This example is for a document-level customization.

Private Sub WorkbookSendForReview()
    Me.SendForReview("someone@example.com", _
        "Please review this proposal.", True, True)
End Sub
private void WorkbookSendForReview()
{
    this.SendForReview("someone@example.com",
        "Please review this proposal.", true, true);
}

.NET Framework Security

See Also

Reference

WorkbookBase Class

Microsoft.Office.Tools.Excel Namespace