AbortMessage Property (PrintMessageBoxEventArgs)

Gets the message displayed if the print job is canceled.

Syntax

Visual Basic
C#

'Declaration
 
Public ReadOnly Property AbortMessage As String

'Usage
 
Dim instance As PrintMessageBoxEventArgs
Dim value As String
 
value = instance.AbortMessage

public string AbortMessage {get;}

Property Value

String with the message to display

Example

This example shows the use of the property by returning the event data for the PrintMessageBox.

private void fpSpread1_PrintMessageBox(object sender,
FarPoint.Win.Spread.PrintMessageBoxEventArgs e)
{
   if (e.BeginPrinting == true)
   {
      textBox1.Text = e.Id;
   }
   else if (e.Cancel == true)
   {
      textBox1.Text = e.AbortMessage;
   }
}

Visual Basic

Private Sub FpSpread1_PrintMessageBox(ByVal sender As Object,
ByVal e As FarPoint.Win.Spread.PrintMessageBoxEventArgs) Handles
FpSpread1.PrintMessageBox
   If e.BeginPrinting = True Then
       TextBox1.Text = e.Id
   ElseIf e.Cancel = True Then
       TextBox1.Text = e.AbortMessage
   End If
End Sub

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

PrintMessageBoxEventArgs Class
PrintMessageBoxEventArgs Members

User-Task Documentation

Printing Options