PrintDocumentInfo Class

Definition

[Android.Runtime.Register("android/print/PrintDocumentInfo", DoNotGenerateAcw=true)]
public sealed class PrintDocumentInfo : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/print/PrintDocumentInfo", DoNotGenerateAcw=true)>]
type PrintDocumentInfo = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance

Object

Object

PrintDocumentInfo

Attributes

RegisterAttribute

Implements

IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

This class encapsulates information about a document for printing purposes. This meta-data is used by the platform and print services, components that interact with printers. For example, this class contains the number of pages contained in the document it describes and this number of pages is shown to the user allowing them to select the range to print. Also a print service may optimize the printing process based on the content type, such as document or photo.

Instances of this class are created by the printing application and passed to the PrintDocumentAdapter.LayoutResultCallback#onLayoutFinished( PrintDocumentInfo, boolean) PrintDocumentAdapter.LayoutResultCallback.onLayoutFinished( PrintDocumentInfo, boolean) callback after successfully laying out the content which is performed in PrintDocumentAdapter#onLayout(PrintAttributes, PrintAttributes, android.os.CancellationSignal, PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle) PrintDocumentAdapter.onLayout(PrintAttributes, PrintAttributes, android.os.CancellationSignal, PrintDocumentAdapter.LayoutResultCallback, android.os.Bundle).

An example usage looks like this:

. . .

            public void onLayout(PrintAttributes oldAttributes, PrintAttributes newAttributes,
                    CancellationSignal cancellationSignal, LayoutResultCallback callback,
                    Bundle metadata) {

                   // Assume the app defined a LayoutResult class which contains
                   // the layout result data and that the content is a document.
                   LayoutResult result = doSomeLayoutWork();

                   PrintDocumentInfo info = new PrintDocumentInfo
                           .Builder("printed_file.pdf")
                           .setContentType(PrintDocumentInfo.CONTENT_TYPE_DOCUMENT)
                           .setPageCount(result.getPageCount())
                           .build();

                  callback.onLayoutFinished(info, result.getContentChanged());
              }

              . . .

</p>

Java documentation for android.print.PrintDocumentInfo.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Fields

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to