GrapeCity.ActiveReports.PrintExtension.Print

Print Method

Print(SectionDocument)

Initiates the printing process for a section-based document with default settings.

Declaration

public static bool Print(this SectionDocument sectionDocument)

Parameters

Type	Name	Description
SectionDocument	sectionDocument	The section document to print.

Returns

Type	Description
bool	`true` if the printing process completes successfully; otherwise, `false`.

Remarks

This method prints the document using the default settings: showing the print dialog, showing the print progress dialog, and using the printing thread. It simplifies the printing process for common scenarios.

Examples

The following example demonstrates how to print a section document using default settings:

SectionDocument sectionDocument = new SectionDocument();
sectionDocument.Load("C:\\Report.rdf");
sectionDocument.PrintOptions.PrintPageBorder = true;
bool printSuccess = sectionDocument.Print();
if (printSuccess)
    Console.WriteLine("Printing completed successfully.");
else
    Console.WriteLine("Printing failed.");

Print(SectionDocument, bool)

Initiates the printing process for a section-based document, with an option to display the print dialog.

Declaration

public static bool Print(this SectionDocument sectionDocument, bool showPrintDialog)

Parameters

Type	Name	Description
SectionDocument	sectionDocument	The section document to be printed.
bool	showPrintDialog	Specifies whether the print dialog should be shown to the user. If `true`, the print dialog is displayed, allowing the user to select printer settings.

Returns

Type	Description
bool	`true` if the print operation completes successfully; otherwise, `false`.

Remarks

This method allows for basic customization of the printing process by controlling the visibility of the print dialog. It defaults to showing the print progress dialog and using the printing thread for the operation, simplifying the printing process for common use cases.

Examples

The following example demonstrates how to print a section document with the print dialog:

SectionDocument sectionDocument = new SectionDocument();
sectionDocument.Load("C:\\Report.rdf");
bool printSuccess = sectionDocument.Print(showPrintDialog: true);
if (printSuccess)
    Console.WriteLine("Printing completed successfully.");
else
    Console.WriteLine("Printing failed.");

Print(SectionDocument, bool, bool)

Initiates the printing process for a section-based document, with options to display the print dialog and the print progress dialog.

Declaration

public static bool Print(this SectionDocument sectionDocument, bool showPrintDialog, bool showPrintProgressDialog)

Parameters

Type	Name	Description
SectionDocument	sectionDocument	The section document to be printed.
bool	showPrintDialog	Specifies whether the print dialog should be shown to the user. If `true`, the print dialog is displayed, allowing the user to select printer settings.
bool	showPrintProgressDialog	Specifies whether the print progress dialog should be shown during the printing process. If `true`, the progress dialog is displayed, providing feedback about the printing status.

Returns

Type	Description
bool	`true` if the print operation completes successfully; otherwise, `false`.

Remarks

This method offers more control over the printing process by allowing the user to decide whether to display the print dialog and the print progress dialog. It defaults to using the printing thread for the operation, ensuring that the UI remains responsive during printing.

Examples

The following example demonstrates how to print a section document with both the print dialog and the print progress dialog displayed:

SectionDocument sectionDocument = new SectionDocument();
sectionDocument.Load("C:\\Report.rdf");
bool printSuccess = sectionDocument.Print(showPrintDialog: true, showPrintProgressDialog: true);
if (printSuccess)
    Console.WriteLine("Printing completed successfully.");
else
    Console.WriteLine("Printing failed.");

Print(SectionDocument, PrintingSettings)

Prints the section-based document using specified printing settings.

Declaration

public static bool Print(this SectionDocument sectionDocument, PrintingSettings settings)

Parameters

Type	Name	Description
SectionDocument	sectionDocument	The document to be printed.
PrintingSettings	settings	The printing settings to apply.

Returns

Type	Description
bool	`true` if the print operation was successful; otherwise, `false`.

Remarks

This method decodes the provided settings to determine the configuration for the print operation, such as whether to show the print dialog, the print progress dialog, use a printing thread, and the style of the dialog.

Examples

The following example demonstrates how to print a section document with custom printing settings:

SectionDocument sectionDocument = new SectionDocument();
sectionDocument.Load("C:\\Report.rdf");
PrintingSettings settings = PrintingSettings.UseStandardDialog | PrintingSettings.ShowPrintDialog;
bool printSuccess = sectionDocument.Print(settings);
if (printSuccess)
    Console.WriteLine("Printing completed successfully with custom settings.");
else
    Console.WriteLine("Printing failed.");

Print(SectionDocument, bool, bool, bool)

Initiates the printing process for a section-based document with options for displaying print dialogs and controlling the printing execution thread.

Declaration

public static bool Print(this SectionDocument sectionDocument, bool showPrintDialog, bool showPrintProgressDialog, bool usePrintingThread)

Parameters

Type	Name	Description
SectionDocument	sectionDocument	The section document to be printed. This document contains the content and layout information for the print job.
bool	showPrintDialog	Specifies whether to display the print dialog before printing. If set to `true`, the print dialog is shown, allowing the user to select printer settings and preferences.
bool	showPrintProgressDialog	Specifies whether to display a print progress dialog during the printing process. If set to `true`, a dialog providing feedback on the printing progress is displayed to the user.
bool	usePrintingThread	Determines whether the printing process should be executed on a separate thread. If set to `true`, printing is performed on a background thread, which can help maintain UI responsiveness during the print operation.

Returns

Type	Description
bool	Returns `true` if the print operation completes successfully; otherwise, returns `false`. A return value of `false` may indicate that the user cancelled the print job or that an error occurred during printing.

Remarks

This method provides a flexible approach to printing section-based documents, allowing for user interaction through dialogs and improved application performance by optionally running the print job on a separate thread. It is part of the GrapeCity ActiveReports printing extensions and is designed to integrate seamlessly with the ActiveReports reporting components.

Examples

var doc = new SectionDocument();
doc.Load("C:\\Report.rdf");
doc.PrintOptions.PrintPageBorder = true;
doc.PrintOptions.Watermark = new WatermarkOptions
{
	Title = "Watermark",
	Angle = 45,
	Color = Color.Gray,
	Font = new Document.Drawing.Font("Arial", 72)
};
var result = doc.Print(false, true, false);

Print(PageDocument)

Initiates the printing process for a page-based document with default settings.

Declaration

public static bool Print(this PageDocument pageDocument)

Parameters

Type	Name	Description
PageDocument	pageDocument	The page document to print. This document contains the content and layout information for the print job.

Returns

Type	Description
bool	Returns `true` if the print operation completes successfully; otherwise, returns `false`. A return value of `false` may indicate that the user cancelled the print job or that an error occurred during printing.

Remarks

This method simplifies the printing process by using default settings, which include displaying the print dialog to the user, showing a print progress dialog during the printing process, and executing the print job on a separate thread to maintain UI responsiveness. It is designed for ease of use in common printing scenarios.

Examples

The following example demonstrates how to print a page document using the default settings:

var pageReport = new PageReport();
PageDocument pageDocument = new PageDocument(pageReport);
bool printSuccess = pageDocument.Print();
if (printSuccess)
	Console.WriteLine("Printing completed successfully.");
else
	Console.WriteLine("Printing failed.");

Print(PageDocument, bool)

Initiates the printing process for a page-based document, optionally displaying the print dialog.

Declaration

public static bool Print(this PageDocument pageDocument, bool showPrintDialog)

Parameters

Type	Name	Description
PageDocument	pageDocument	The PageDocument instance representing the document to be printed. This document contains the content and layout information for the print job.
bool	showPrintDialog	A bool value indicating whether the print dialog should be shown to the user before printing. If set to `true`, the print dialog is displayed, allowing the user to modify printer settings such as the printer to use, the range of pages to print, and the number of copies. If set to `false`, the document is printed directly with the current printer settings.

Returns

Type	Description
bool	A bool value indicating the success of the print operation. Returns `true` if the print operation completes successfully; otherwise, returns `false`. A return value of `false` may indicate that the user cancelled the print job or that an error occurred during the printing process.

Remarks

This method provides a simplified interface for printing page-based documents, with an option to display the print dialog for user interaction. It defaults to showing the print progress dialog and executing the print job on a separate thread to maintain UI responsiveness. This method is part of the GrapeCity ActiveReports printing extensions and is designed to integrate seamlessly with ActiveReports reporting components.

Examples

The following example demonstrates how to print a page document with the print dialog displayed:

var pageReport = new PageReport();
PageDocument pageDocument = new PageDocument(pageReport);
bool printSuccess = pageDocument.Print(showPrintDialog: true);
if (printSuccess)
	Console.WriteLine("Printing completed successfully.");
else
	Console.WriteLine("Printing failed.");

Print(PageDocument, bool, bool)

Initiates the printing process for a page-based document, with options to display the print dialog and the print progress dialog.

Declaration

public static bool Print(this PageDocument pageDocument, bool showPrintDialog, bool showPrintProgressDialog)

Parameters

Type	Name	Description
PageDocument	pageDocument	The PageDocument instance representing the document to be printed. This document contains the content and layout information for the print job.
bool	showPrintDialog	A bool value indicating whether the print dialog should be shown to the user before printing. If set to `true`, the print dialog is displayed, allowing the user to modify printer settings such as the printer to use, the range of pages to print, and the number of copies. If set to `false`, the document is printed directly with the current printer settings.
bool	showPrintProgressDialog	A bool value indicating whether the print progress dialog should be shown during the printing process. If set to `true`, the progress dialog is displayed, providing feedback about the printing status to the user.

Returns

Type	Description
bool	A bool value indicating the success of the print operation. Returns `true` if the print operation completes successfully; otherwise, returns `false`. A return value of `false` may indicate that the user cancelled the print job or that an error occurred during the printing process.

Remarks

This method provides a simplified interface for printing page-based documents, offering control over the display of the print dialog and the print progress dialog. It defaults to executing the print job on a separate thread to maintain UI responsiveness. This method is part of the GrapeCity ActiveReports printing extensions and is designed to integrate seamlessly with ActiveReports reporting components.

Examples

The following example demonstrates how to print a page document with both the print dialog and the print progress dialog displayed:

var pageReport = new PageReport();
PageDocument pageDocument = new PageDocument(pageReport);
bool printSuccess = pageDocument.Print(showPrintDialog: true, showPrintProgressDialog: true);
if (printSuccess)
	Console.WriteLine("Printing completed successfully.");
else
	Console.WriteLine("Printing failed.");

Print(PageDocument, bool, bool, bool)

Initiates the printing process for a page-based document, providing options to display the print dialog, the print progress dialog, and to execute the printing on a new thread.

Declaration

public static bool Print(this PageDocument pageDocument, bool showPrintDialog, bool showPrintProgressDialog, bool usePrintingThread)

Parameters

Type	Name	Description
PageDocument	pageDocument	The PageDocument instance to be printed. This document contains the content and layout information for the print job.
bool	showPrintDialog	Specifies whether the print dialog should be shown to the user. If set to `true`, the print dialog allows the user to modify printer settings such as the printer to use, the range of pages to print, and the number of copies. If `false`, the document is printed directly with the current printer settings without user interaction.
bool	showPrintProgressDialog	Specifies whether the print progress dialog should be displayed during the printing process. If set to `true`, the progress dialog provides feedback about the printing status to the user. If `false`, no progress dialog is shown.
bool	usePrintingThread	Determines whether the printing process should be executed on a new thread. Using a separate thread for printing can help maintain UI responsiveness during the print job. If set to `true`, the printing is performed on a new thread; if `false`, it is performed on the current thread.

Returns

Type	Description
bool	Returns `true` if the print operation completes successfully; otherwise, returns `false`. A return value of `false` may indicate that the user cancelled the print job or that an error occurred during the printing process.

Remarks

This method is designed to provide a flexible and user-friendly interface for printing page-based documents within the GrapeCity ActiveReports framework. It allows for customization of the printing process through various parameters, catering to different user preferences and requirements.

Examples

var report = new PageReport(new FileInfo(@"C:\Report.rdlx"));
var doc = report.Document;
doc.PrintOptions.Watermark = new WatermarkOptions
{
	Title = "Watermark",
	Angle = 45,
	Color = Color.Red,
	Font = new Font("Arial", 72),
	DrawOver = true
};
var result = doc.Print(false, true, false);

Print(PageDocument, PrintingSettings)

Initiates the printing process for a page-based document, allowing for detailed control over the printing settings.

Declaration

public static bool Print(this PageDocument pageDocument, PrintingSettings printingSettings)

Parameters

Type	Name	Description
PageDocument	pageDocument	The PageDocument instance representing the document to be printed. This document contains the content and layout information for the print job.
PrintingSettings	printingSettings	A PrintingSettings enumeration that specifies the printing options such as whether to show the print dialog, the print progress dialog, use a printing thread, and the style of the dialog. This allows for granular control over the printing process.

Returns

Type	Description
bool	A bool value indicating the success of the print operation. Returns `true` if the print operation completes successfully; otherwise, returns `false`. A return value of `false` may indicate that the user cancelled the print job or that an error occurred during the printing process.

Remarks

This method provides an advanced interface for printing page-based documents within the GrapeCity ActiveReports framework, leveraging the PrintingSettings enumeration to customize the printing experience. It is designed to cater to various printing preferences and scenarios, offering flexibility in how the print job is executed.

Examples

The following example demonstrates how to print a page document with customized printing settings:

var pageReport = new PageReport();
PageDocument pageDocument = new PageDocument(pageReport);
PrintingSettings settings = PrintingSettings.UseStandardDialog | PrintingSettings.ShowPrintDialog;
bool printSuccess = pageDocument.Print(settings);
if (printSuccess)
    Console.WriteLine("Printing completed successfully.");
else
	Console.WriteLine("Printing failed.");

Print(PageDocument, PrinterSettings)

Initiates the printing process for a page-based document using specified printer settings.

Declaration

public static bool Print(this PageDocument pageDocument, PrinterSettings printerSettings)

Parameters

Type	Name	Description
PageDocument	pageDocument	The PageDocument instance representing the document to be printed. This document contains the content and layout information for the print job.
PrinterSettings	printerSettings	An instance of PrinterSettings that specifies the settings to be used for the print job, including whether to show the print dialog, the print progress dialog, whether to use a printing thread, and details about the printer configuration.

Returns

Type	Description
bool	A bool value indicating the success of the print operation. Returns `true` if the print operation completes successfully; otherwise, returns `false`. A return value of `false` may indicate that the user cancelled the print job or that an error occurred during the printing process.

Remarks

This method provides a flexible interface for printing page-based documents within the GrapeCity ActiveReports framework, leveraging the PrinterSettings class to customize the printing experience. It allows for detailed control over the printing process, catering to various user preferences and scenarios.

Examples

The following example demonstrates how to print a page document with custom printer settings:

var pageReport = new PageReport();
PageDocument pageDocument = new PageDocument(pageReport);
PrinterSettings printerSettings = new PrinterSettings
{
    ShowPrintDialog = true,
    ShowPrintProgressDialog = true,
    UsePrintingThread = true,
    UseStandardDialog = true
};
bool printSuccess = pageDocument.Print(printerSettings);
if (printSuccess)
    Console.WriteLine("Printing completed successfully.");
else
	Console.WriteLine("Printing failed.");

Exceptions

Type	Condition
ArgumentNullException	Thrown when `printerSettings` is null.