flash.printing

# PrintUIOptions - AS3

Package | flash.printing
Class | public final class PrintUIOptions
Inheritance | PrintUIOptions Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The PrintUIOptions class is used to specify options for print dialogs that are displayed to the user. Create a PrintUIOptions instance, set its properties, and pass it as the `uiOptions` parameter of the `PrintJob.showPageSetupDialog()` or `PrintJob.start2()` method.

For example, the following code uses a PrintUIOptions instance to specify the min and max page numbers when the Page Setup dialog is displayed:

Copy

    import flash.printing.PrintJob;

     var myPrintJob:PrintJob = new PrintJob();
     if (myPrintJob.supportsPageSetupDialog)
     {
         var uiOpt:PrintUIOptions = new PrintUIOptions();
         uiOpt.minPage = 1;
         uiOpt.maxPage = 3;
         myPrintJob.showPageSetupDialog(uiOpt);
     }

Related API Elements

PrintJob
PrintJob.showPageSetupDialog()
PrintJob.start2()

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | disablePageRange : Boolean = false Specifies whether the page range in the print dialog is disabled (true) or the user can edit it (false). | PrintUIOptions
|  | maxPage : uint = 0 The maxiumum page number the user can enter in the print dialog. | PrintUIOptions
|  | minPage : uint = 0 The minimum page number a user can enter in the print dialog. | PrintUIOptions

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | PrintUIOptions() Creates a new PrintUIOptions object. | PrintUIOptions
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### disablePageRange

property

`public var disablePageRange:Boolean = false`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Specifies whether the page range in the print dialog is disabled (`true`) or the user can edit it (`false`). The default value is `false`, indicating that there is no restriction on editing the page range.

The default value is `false.`

### maxPage

property

`public var maxPage:uint = 0`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The maxiumum page number the user can enter in the print dialog. The default value is 0, indicating that there is no restriction on the maximum page number.

The default value is `0.`

### minPage

property

`public var minPage:uint = 0`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The minimum page number a user can enter in the print dialog. The default value is 0, indicating that there is no restriction on the minimum page number.

The default value is `0.`

Constructor Detail

### PrintUIOptions

()
Constructor

`public function PrintUIOptions()`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Creates a new PrintUIOptions object. You pass this object to the `uiOptions` parameter of the `PrintJob.showPageSetupDialog()` or `PrintJob.start2()` method.

Related API Elements

PrintJob.showPageSetupDialog()
PrintJob.start2()

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00