com.aspose.xps.metadata

Class Staple.StapleOption

java.lang.Object

com.aspose.xps.metadata.PrintTicketElement

com.aspose.xps.metadata.CompositePrintTicketElement

com.aspose.xps.metadata.Option

com.aspose.xps.metadata.Staple.StapleOption

All Implemented Interfaces:

IFeatureItem, IPrintTicketElementChild

Enclosing class:

Staple

public static final class Staple.StapleOption
extends Option

Describes the JobStapleAllDocuments and DocumentStaple features options.

Field Summary

Fields

Modifier and Type	Field and Description
static Staple.StapleOption	None Specifies no stapling.
static Staple.StapleOption	SaddleStitch Specifies saddle stitch stapling.
static Staple.StapleOption	StapleBottomLeft Specifies a single staple in the bottom, left corner.
static Staple.StapleOption	StapleBottomRight Specifies a single staple in the bottom, right corner.
static Staple.StapleOption	StapleDualBottom Specifies two staples along the bottom edge.
static Staple.StapleOption	StapleDualLeft Specifies two staples along the left edge.
static Staple.StapleOption	StapleDualRight Specifies two staples along the right edge.
static Staple.StapleOption	StapleDualTop Specifies two staples along the top edge
static Staple.StapleOption	StapleTopLeft Specifies a single staple in the top, left corner.
static Staple.StapleOption	StapleTopRight Specifies a single staple in the top, right corner.

Constructor Summary

Constructors

Constructor and Description
StapleOption(String optionName, Staple.IStapleOptionItem... items) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Staple.StapleOption	add(Staple.IStapleOptionItem... items) Adds an array of IStapleOptionItem instances to the feature.
Staple.StapleOption	setAngle(int angle) Sets an Angle scored property value.
Staple.StapleOption	setSheetCapacity(int sheetCapacity) Sets an SheetCapacity scored property value.

Methods inherited from class com.aspose.xps.metadata.Option

add

Methods inherited from class com.aspose.xps.metadata.PrintTicketElement

getName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.xps.metadata.IPrintTicketElementChild

getName

Field Detail

SaddleStitch

public static final Staple.StapleOption SaddleStitch

Specifies saddle stitch stapling.

StapleBottomLeft

public static final Staple.StapleOption StapleBottomLeft

Specifies a single staple in the bottom, left corner.

StapleBottomRight

public static final Staple.StapleOption StapleBottomRight

Specifies a single staple in the bottom, right corner.

StapleDualBottom

public static final Staple.StapleOption StapleDualBottom

Specifies two staples along the bottom edge.

StapleDualLeft

public static final Staple.StapleOption StapleDualLeft

Specifies two staples along the left edge.

StapleDualRight

public static final Staple.StapleOption StapleDualRight

Specifies two staples along the right edge.

StapleDualTop

public static final Staple.StapleOption StapleDualTop

Specifies two staples along the top edge

None

public static final Staple.StapleOption None

Specifies no stapling.

StapleTopLeft

public static final Staple.StapleOption StapleTopLeft

Specifies a single staple in the top, left corner.

StapleTopRight

public static final Staple.StapleOption StapleTopRight

Specifies a single staple in the top, right corner.

Constructor Detail

StapleOption

public StapleOption(String optionName,
                    Staple.IStapleOptionItem... items)

Creates a new instance.

Parameters:

optionName - An options name.

items - An arbitrary array of IStapleOptionItem instances.

Method Detail

add

public Staple.StapleOption add(Staple.IStapleOptionItem... items)

Adds an array of IStapleOptionItem instances to the feature.

Parameters:

items - An arbitrary array of IStapleOptionItem instances.

Returns:

This options instance.

setAngle

public final Staple.StapleOption setAngle(int angle)

Sets an Angle scored property value.

Parameters:

angle - An Angle scored property value.

Returns:

This option instance.

setSheetCapacity

public final Staple.StapleOption setSheetCapacity(int sheetCapacity)

Sets an SheetCapacity scored property value.

Parameters:

sheetCapacity - An SheetCapacity scored property value.

Returns:

This option instance.