Click or drag to resize
SignDocRenderParameters Class
Parameters for SignDocDocument.renderPageAsImage().
Inheritance Hierarchy
SystemObject
  de.softpro.signdocsdkSignDocRenderParameters

Namespace: de.softpro.signdocsdk
Assembly: SPSignDoc_4.1_DotNetLibd (in SPSignDoc_4.1_DotNetLibd.dll) Version: 1.0.5882.21462
Syntax
public sealed class SignDocRenderParameters : IDisposable

The SignDocRenderParameters type exposes the following members.

Constructors
Methods
  NameDescription
Public methodDispose
Releases all resources used by the SignDocRenderParameters
Public methodequals
Compare against another SignDocRenderParameters object. The exact order of SignDocRenderParameters is unspecified but consistent.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodfitHeight
Set the height for automatic computation of the zoom factor to make the rendered image fit the specified height. This function overrides the zoom factor set by fitWidth(), fitRect(), and setZoom(). Throws SignDocInvalidArgumentException if the height is invalid.
Public methodfitRect
Set the width and height for automatic computation of the zoom factor to make the rendered image fit the specified width and height. This function overrides the zoom factor set by fitWidth(), fitHeight(), and setZoom(). Throws SignDocInvalidArgumentException if the width or the height is invalid.
Public methodfitWidth
Set the width for automatic computation of the zoom factor to make the rendered image fit the specified width. This function overrides the zoom factor set by fitHeight(), fitRect(), and setZoom(). Throws SignDocInvalidArgumentException if the width is invalid.
Public methodgetCompression
Get the compression method.
Public methodgetDecorations
Get the value set by setDecorations().
Public methodgetFirstPage
Get the first page number of the selected range of pages. Throws SignDocParameterNotSetException if setPage() and setPages() have not been called.
Public methodgetFitHeight
Get the height set by fitHeight(). Throws SignDocParameterNotSetException if setFitHeight() has not been called successfully.
Public methodgetFitRectHeight
Get the height set by fitRect(). Throws SignDocParameterNotSetException if setFitRect() has not been called successfully.
Public methodgetFitRectWidth
Get the width set by fitRect(). Throws SignDocParameterNotSetException if setFitRect() has not been called successfully.
Public methodgetFitWidth
Get the width set by fitWidth(). Throws SignDocParameterNotSetException if getFitWidth() has not been called successfully.
Public methodgetFormat
Get the image format.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodgetInterlacing
Get the interlacing method.
Public methodgetLastPage
Get the last page number of the selected range of pages. Throws SignDocParameterNotSetException if setPage() and setPages() have not been called.
Public methodgetPage
Get the number of the selected page. Throws SignDocParameterNotSetException if setPage() has not been called successfully or if multiple pages have been selected with setPages().
Public methodgetPixelFormat
Get the pixel format.
Public methodgetPrint
Get the value set by setPrint().
Public methodgetQuality
Get the desired quality.
Public methodgetResolutionX
Get the horizontal resolution set by setResolution(). Throws SignDocParameterNotSetException if setResolution() has not been called successfully.
Public methodgetResolutionY
Get the vertical resolution set by setResolution(). Throws SignDocParameterNotSetException if setResolution() has not been called successfully.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodgetZoom
Get the zoom factor set by setZoom(). This function does not retrieve the zoom factor to be computed for fitWidth(), fitHeight(), and fitRect(). Use SignDocDocument.computeZoom() for that. Throws SignDocParameterNotSetException if setZoom() has not been called successfully.
Public methodsetCompression
Set the compression method. The initial value is c_default.
Public methodsetDecorations
Enable rendering of decorations. The default value is false. For PDF documents, pages may optionally be rendered with decorations: An icon visualizing the signature status will be added to each signature field: - no icon (signature field not signed) - green check mark (signature is OK) - green check mark with yellow triangle (signature is OK but the certificate is not trusted or the document has been extended, ie, modified and saved incrementally after signing) - red cross (signature broken) . For TIFF documents, this value is ignored; a red cross will be displayed in signature fields if the signature is broken.
Public methodsetFormat
Set the image format. There is no initial value, ie, this function must be called. Currently, this function does not check the image format.
Public methodsetInterlacing
Set the interlacing method. Interlacing is used for progressive encoding. The initial value is i_off.
Public methodsetPage
Select the page to be rendered. There is no initial value, ie, either this function or setPages() must be called. Throws SignDocInvalidArgumentException if the page number is invalid.
Public methodsetPages
Select a range of pages to be rendered. There is no initial value, ie, either this function or setPage() must be called.
Public methodsetPixelFormat
Set the pixel format. The initial value is pf_default.
Public methodsetPrint
Enable rendering for printing. The default value is false (render for displaying).
Public methodsetQuality
Set the desired quality. This setting affects scaling of pages of TIFF documents. The initial value is q_low.
Public methodsetResolution
Set the resolution for rendering PDF documents. The values passed to this function will be ignored for TIFF documents as the resolution is computed automatically from the zoom factor and the document's resolution. If this function is not called, 96 DPI (subject to change) will be used for rendering PDF documents. Throws SignDocInvalidArgumentException if the resolution is invalid.
Public methodsetZoom
Set the zoom factor for rendering. There is no initial value, ie, this function or fitWidth() or fitHeight() or fitRect() must be called. This function overrides fitWidth(), fitHeight(), and fitRect(). Throws SignDocInvalidArgumentException if the zoom factor is invalid.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
See Also