Share via


WorkbookBase.Routed Property

Gets a value that indicates whether the workbook has been routed to the next recipient.

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 ReadOnly Property Routed As Boolean
public bool Routed { get; }

Property Value

Type: System.Boolean
true if the workbook has been routed to the next recipient; false if the workbook needs to be routed.

Remarks

If the workbook was not routed to the current recipient, this property is always false (for example, if the document has no routing slip, or if a routing slip was just created).

Examples

The following code example checks the value of the Routed property to determine whether the workbook has been routed. If the workbook has not been routed, then the example sets the HasRoutingSlip property to true, sets the Subject property to a subject line for the routing slip, and then uses the RoutingSlip property to adjust the delivery type, message, and the recipients. Finally, the example calls the Route method to route the workbook.

This example is for a document-level customization.

Private Sub RouteWorkbook()
    If Not Me.Routed Then 
        Me.HasRoutingSlip = True 
        Me.Subject = "Here is the forecast spreadsheet." 

        Dim routingSlip As Excel.RoutingSlip = Me.RoutingSlip
        routingSlip.Delivery = Excel.XlRoutingSlipDelivery.xlOneAfterAnother
        routingSlip.Message = "Please review and provide your feedback."
        routingSlip.Recipients = New String() _
            {"Don Hall", "Sydney Higa", "Ron Gabel"}
        Me.Route()
    End If 
End Sub
private void RouteWorkbook()
{
    if (!this.Routed)
    {
        this.HasRoutingSlip = true;
        this.Subject = "Here is the forecast spreadsheet.";

        Excel.RoutingSlip routingSlip = this.RoutingSlip;
        routingSlip.Delivery = Excel.XlRoutingSlipDelivery.xlOneAfterAnother;
        routingSlip.Message = "Please review and provide your feedback.";
        routingSlip.set_Recipients(0,
            new string[] { "Don Hall", "Sydney Higa", "Ron Gabel" });
        this.Route();
    }
}

.NET Framework Security

See Also

Reference

WorkbookBase Class

Microsoft.Office.Tools.Excel Namespace