PrintDocument

WidgetReferences
[Handler(PrintDocument.IHandler)] public class PrintDocument : Widget
Represents a document that can be printed
Remarks: A print document uses the Graphics to render its output via the PrintPage event.

Constructors

PrintDocument

#
public PrintDocument()
Initializes a new instance of the PrintDocument class with custom drawn content only.

PrintDocument

#
public PrintDocument(Control control)
Initializes a new instance of the PrintDocument class with the specified control as the print content.

Fields

PrintedEvent

#
public const string PrintedEvent = "PrintDocument.Printed"
Identifier for handlers when attaching the Printed event

PrintingEvent

#
public const string PrintingEvent = "PrintDocument.Printing"
Identifier for handlers when attaching the Printing event

PrintPageEvent

#
public const string PrintPageEvent = "PrintDocument.PrintPage"
Identifier for handlers when attaching the PrintPage event

Properties

ControlObject

public object ControlObject { get; }
Gets the instance of the platform-specific object
inherited fromWidget
Remarks: This can sometimes be useful to get the platform-specific object. Some handlers may not have any backing object for its functionality, so this may be null. It is more preferred to use the Widget.Handler and cast that to the platform-specific handler class which can give you additional methods and helpers to do common tasks. For example, the Application object's handler for OS X has a AddFullScreenMenuItem property to specify if you want full screen support in your app.

Handler

public object Handler { get; }
Gets the platform-specific handler for this widget
inherited fromWidget

IsDisposed

public bool IsDisposed { get; }
Gets or sets a value indicating whether this Widget has been disposed.
inherited fromWidget
Remarks: When the widget is disposed, it can no longer be used.
true if this instance has been disposed; otherwise, false.

Name

#
public string Name { get; set; }
Gets or sets the name of the document to show in the printer queue

NativeHandle

public nint NativeHandle { get; }
Gets the native platform-specific handle for integration purposes
inherited fromWidget

PageCount

#
public virtual int PageCount { get; set; }
Gets or sets the total number of pages available to be printed in this document.
Remarks: This must be set to the number of pages your document contains before printing or showing the print dialog.
The page count.

Platform

public Platform Platform { get; }
Gets the platform that was used to create the Widget.Handler for this widget
inherited fromWidget
Remarks: This gets set to the current Platform.Instance during the construction of the object

PrintSettings

#
public PrintSettings PrintSettings { get; set; }
Gets or sets the print settings for the document when printing.
Remarks: You can adjust the settings using the PrintDialog, or use PrintDialog.ShowDialog(Control, PrintDocument) to allow the user to adjust the settings before printing.
The print settings.

Properties

public PropertyStore Properties { get; }
Gets the dictionary of properties for this widget
inherited fromWidget

Style

public string Style { get; set; }
Gets or sets the style of this widget
inherited fromWidget
Remarks: Styles allow you to attach custom platform-specific logic to a widget. In your platform-specific assembly, use Add{H} to add the style logic with the same id.
// in your UI
var control = new Button { Style = "mystyle" };

// in your platform assembly
using Eto.Mac.Forms.Controls;

Styles.AddHandler<ButtonHandler>("mystyle", handler => {
	// this is where you can use handler.Control to set properties, handle events, etc.
	handler.Control.BezelStyle = NSBezelStyle.SmallSquare;
});

Methods

Dispose

protected virtual void Dispose(bool disposing)
Handles the disposal of this widget
inherited fromWidget
disposing (bool)True if the caller called Widget.Dispose() manually, false if being called from a finalizer

GetCallback

#
protected override object GetCallback()
Gets an instance of an object used to perform callbacks to the widget from handler implementations

Initialize

protected void Initialize()
Initializes the widget handler
inherited fromWidget
Remarks: This is typically called from the constructor after all of the logic is completed to construct the object. If your handler interface has the AutoInitializeAttribute set to false, then you are responsible for calling this method in your constructor after calling the creation method on your custom handler.

OnStyleChanged

protected virtual void OnStyleChanged(EventArgs e)
Handles when the Widget.Style is changed.
inherited fromWidget

Print

#
public void Print()
Prints this document immediately using the current PrintSettings

ToString

public override string ToString()
Gets a string that represents the current object with its ID if specified.
inherited fromWidget
A string value indicating the type and ID (if specified) of this widget.
Object.ToString

Events