ExportImageSaveOptions
Inheritance: java.lang.Object, com.groupdocs.signature.options.saveoptions.SaveOptions, com.groupdocs.signature.options.saveoptions.imagessaveoptions.ImageSaveOptions
public class ExportImageSaveOptions extends ImageSaveOptions
Save options for exporting documents to image.
Constructors
| Constructor | Description |
|---|---|
| ExportImageSaveOptions() | Initializes a new instance of ExportAsImageSaveOptions class with default values. |
| ExportImageSaveOptions(int fileFormat) | Initializes a new instance of ExportAsImageSaveOptions class with specified file format. |
Methods
| Method | Description |
|---|---|
| getPageNumber() | Gets or sets document page number for export. |
| setPageNumber(Integer value) | Gets or sets document page number for export. |
| getExportAllPages() | Flag to export each page. |
| setExportAllPages(boolean value) | Flag to export each page. |
| getPagesSetup() | Options to specify pages to be signed. |
| setPagesSetup(PagesSetup value) | Options to specify pages to be signed. |
| getPageColumns() | Gets or sets number of columns for exported images. |
| setPageColumns(int value) | Gets or sets number of columns for exported images. |
| getBorder() | Gets or sets the image border settings. |
| setBorder(Border value) | Gets or sets the image border settings. |
| getTiffMultipage() | Put document pages on different frames in Tiff image. |
| setTiffMultipage(boolean value) | Put document pages on different frames in Tiff image. |
| toString() | Override string conversion. |
ExportImageSaveOptions()
public ExportImageSaveOptions()
Initializes a new instance of ExportAsImageSaveOptions class with default values.
ExportImageSaveOptions(int fileFormat)
public ExportImageSaveOptions(int fileFormat)
Initializes a new instance of ExportAsImageSaveOptions class with specified file format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileFormat | int | Output image file format. |
getPageNumber()
public final Integer getPageNumber()
Gets or sets document page number for export. Minimal value is 1.
Returns: java.lang.Integer
setPageNumber(Integer value)
public final void setPageNumber(Integer value)
Gets or sets document page number for export. Minimal value is 1.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer |
getExportAllPages()
public final boolean getExportAllPages()
Flag to export each page.
Returns: boolean
setExportAllPages(boolean value)
public final void setExportAllPages(boolean value)
Flag to export each page.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getPagesSetup()
public final PagesSetup getPagesSetup()
Options to specify pages to be signed.
Returns: PagesSetup
setPagesSetup(PagesSetup value)
public final void setPagesSetup(PagesSetup value)
Options to specify pages to be signed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PagesSetup |
getPageColumns()
public final int getPageColumns()
Gets or sets number of columns for exported images. Use this property if you need put images in a row.
Returns: int
setPageColumns(int value)
public final void setPageColumns(int value)
Gets or sets number of columns for exported images. Use this property if you need put images in a row.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getBorder()
public final Border getBorder()
Gets or sets the image border settings. By default this value is not set.
Returns: Border
setBorder(Border value)
public final void setBorder(Border value)
Gets or sets the image border settings. By default this value is not set.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Border |
getTiffMultipage()
public final boolean getTiffMultipage()
Put document pages on different frames in Tiff image.
Returns: boolean
setTiffMultipage(boolean value)
public final void setTiffMultipage(boolean value)
Put document pages on different frames in Tiff image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
toString()
public String toString()
Override string conversion.
Returns: java.lang.String -