Staple.StapleOption
Inheritance: java.lang.Object, com.aspose.xps.metadata.PrintTicketElement, com.aspose.xps.metadata.CompositePrintTicketElement, com.aspose.xps.metadata.Option
public static final class Staple.StapleOption extends Option
Describes the JobStapleAllDocuments and DocumentStaple features options.
Constructors
| Constructor | Description |
|---|---|
| StapleOption(String optionName, Staple.IStapleOptionItem[] items) | Creates a new instance. |
Fields
| Field | Description |
|---|---|
| None | Specifies no stapling. |
| SaddleStitch | Specifies saddle stitch stapling. |
| StapleBottomLeft | Specifies a single staple in the bottom, left corner. |
| StapleBottomRight | Specifies a single staple in the bottom, right corner. |
| StapleDualBottom | Specifies two staples along the bottom edge. |
| StapleDualLeft | Specifies two staples along the left edge. |
| StapleDualRight | Specifies two staples along the right edge. |
| StapleDualTop | Specifies two staples along the top edge |
| StapleTopLeft | Specifies a single staple in the top, left corner. |
| StapleTopRight | Specifies a single staple in the top, right corner. |
Methods
| Method | Description |
|---|---|
| add(IOptionItem[] items) | Adds a list of items to the end of this option’s item list. |
| add(Staple.IStapleOptionItem[] items) | Adds an array of IStapleOptionItem instances to the feature. |
| equals(Object arg0) | |
| getClass() | |
| getName() | Gets the element name. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setAngle(int angle) | Sets an Angle scored property value. |
| setSheetCapacity(int sheetCapacity) | Sets an SheetCapacity scored property value. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
StapleOption(String optionName, Staple.IStapleOptionItem[] items)
public StapleOption(String optionName, Staple.IStapleOptionItem[] items)
Creates a new instance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| optionName | java.lang.String | An options name. |
| items | IStapleOptionItem[] | An arbitrary array of IStapleOptionItem instances. |
None
public static Staple.StapleOption None
Specifies no stapling.
SaddleStitch
public static Staple.StapleOption SaddleStitch
Specifies saddle stitch stapling.
StapleBottomLeft
public static Staple.StapleOption StapleBottomLeft
Specifies a single staple in the bottom, left corner.
StapleBottomRight
public static Staple.StapleOption StapleBottomRight
Specifies a single staple in the bottom, right corner.
StapleDualBottom
public static Staple.StapleOption StapleDualBottom
Specifies two staples along the bottom edge.
StapleDualLeft
public static Staple.StapleOption StapleDualLeft
Specifies two staples along the left edge.
StapleDualRight
public static Staple.StapleOption StapleDualRight
Specifies two staples along the right edge.
StapleDualTop
public static Staple.StapleOption StapleDualTop
Specifies two staples along the top edge
StapleTopLeft
public static Staple.StapleOption StapleTopLeft
Specifies a single staple in the top, left corner.
StapleTopRight
public static Staple.StapleOption StapleTopRight
Specifies a single staple in the top, right corner.
add(IOptionItem[] items)
public void add(IOptionItem[] items)
Adds a list of items to the end of this option’s item list. Each one must be a ScoredProperty or a Property instance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| items | IOptionItem[] | List of items to add. |
add(Staple.IStapleOptionItem[] items)
public Staple.StapleOption add(Staple.IStapleOptionItem[] items)
Adds an array of IStapleOptionItem instances to the feature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| items | IStapleOptionItem[] | An arbitrary array of IStapleOptionItem instances. |
Returns: StapleOption - This options instance.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getName()
public String getName()
Gets the element name.
Returns: java.lang.String
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAngle(int angle)
public Staple.StapleOption setAngle(int angle)
Sets an Angle scored property value.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| angle | int | An Angle scored property value. |
Returns: StapleOption - This option instance.
setSheetCapacity(int sheetCapacity)
public Staple.StapleOption setSheetCapacity(int sheetCapacity)
Sets an SheetCapacity scored property value.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sheetCapacity | int | An SheetCapacity scored property value. |
Returns: StapleOption - This option instance.
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |