AbortMessage Property (PrintInfo)

Visual Basic
C#

'Declaration
 
Public Property AbortMessage As String

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

public string AbortMessage {get; set;}

Property Value

String containing the message to display

This property specifies the text to display in an abort dialog box that lets the user cancel printing. The abort dialog box appears if the user chooses the Cancel button in a print dialog while printing. When the abort dialog box appears, the PrintAbort event occurs.

If you do not provide a message, the Spread component does not display the abort dialog box.

You can supply your own message box instead of the built-in message box using the PrintMessageBox event.

This example shows how to define the settings for displaying dialogs for the end users.

C#

// Define the printer settings
FarPoint.Win.Spread.PrintInfo printset = new FarPoint.Win.Spread.PrintInfo();
printset.ShowPrintDialog = true;
printset.AbortMessage = "Do you want to cancel the printing?";
printset.Preview = true;

// Assign the printer settings to the sheet and print it
fpSpread1.Sheets[0].PrintInfo = printset;
fpSpread1.PrintSheet(0);

Visual Basic

' Define the printer settings
Dim printset As New FarPoint.Win.Spread.PrintInfo()
printset.ShowPrintDialog = True
printset.AbortMessage = "Do you want to cancel the printing?"
printset.Preview = True

' Assign the printer settings to the sheet and print it
FpSpread1.Sheets(0).PrintInfo = printset
FpSpread1.PrintSheet(0)

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

Reference

PrintInfo Class
PrintInfo Members
PrintAbort Event
PrintMessageBox Event

User-Task Documentation

Displaying Dialogs for Users