Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.printing 
PrintUIOptions 
Packageflash.printing
Classpublic final class PrintUIOptions
InheritancePrintUIOptions Inheritance 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:

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);
 }

See also



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  AIR-only disablePageRange : Boolean = false
Specifies whether the page range in the print dialog is disabled (true) or the user can edit it (false).
PrintUIOptions
  AIR-only maxPage : uint = 0
The maxiumum page number the user can enter in the print dialog.
PrintUIOptions
  AIR-only minPage : uint = 0
The minimum page number a user can enter in the print dialog.
PrintUIOptions
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
Creates a new PrintUIOptions object.
PrintUIOptions
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail
AIR-only 

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.

AIR-only 

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.

AIR-only 

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
AIR-only 

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.

See also