Packages

 

com.groupdocs.signature

Class Signature

  • All Implemented Interfaces:
    com.aspose.ms.System.IDisposable


    public class Signature
    extends Object
    implements com.aspose.ms.System.IDisposable

    Represents main class that controls document signing process.

    • Field Detail

      • SearchCompleted

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessCompleteEventHandler> SearchCompleted
        Occurs when signature search process completed.
      • SearchProgress

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessProgressEventHandler> SearchProgress
        Occurs when signature search process progress changed.
      • SearchStarted

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessStartEventHandler> SearchStarted
        Occurs when signature search process started.
      • SignCompleted

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessCompleteEventHandler> SignCompleted
        Occurs when document signinig process completed.
      • SignProgress

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessProgressEventHandler> SignProgress
        Occurs when document signinig process progress changed.
      • SignStarted

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessStartEventHandler> SignStarted
        Occurs when document signinig process started.
      • VerifyCompleted

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessCompleteEventHandler> VerifyCompleted
        Occurs when signature verification process completed.
      • VerifyProgress

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessProgressEventHandler> VerifyProgress
        Occurs when signature verification process progress changed.
      • VerifyStarted

        public final com.groupdocs.signature.handler.events.ProcessEvents<ProcessStartEventHandler> VerifyStarted
        Occurs when signature verification process started.
    • Method Detail

      • dispose

        public final void dispose()

        Implement IDisposable interface to clean up internal resources

        Specified by:
        dispose in interface com.aspose.ms.System.IDisposable
      • generatePreview

        public final void generatePreview(PreviewOptions previewOptions)
                                   throws Exception

        Generates document pages preview.

        Parameters:
        previewOptions - The preview options.
        Throws:
        Exception
      • getDocumentInfo

        public final IDocumentInfo getDocumentInfo()
                                            throws Exception

        Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height.

        Returns:
        Information about document.
        Throws:
        Exception
      • sign

        public final void sign(OutputStream document,
                List<SignOptions> signOptionsList)
                        throws Exception

        Signs document with collection of SignOptions and saves result to a stream.

        Parameters:
        document - The output document stream.
        signOptionsList - The list of signature options.
        Throws:
        Exception
      • sign

        public final void sign(OutputStream document,
                SignOptions signOptions)
                        throws Exception

        Signs document with SignOptions and saves result to a stream.

        Parameters:
        document - The output document stream.
        signOptions - The signature options.
        Throws:
        Exception
      • sign

        public final void sign(String filePath,
                List<SignOptions> signOptionsList)
                        throws Exception

        Signs document with collection of SignOptions and saves result to specified file path.

        Parameters:
        filePath - The output file path.
        signOptionsList - The list of signature options.
        Throws:
        Exception
      • sign

        public final void sign(String filePath,
                List<SignOptions> signOptionsList,
                SaveOptions saveOptions)
                        throws Exception

        Signs document with collection of SignOptions and saves result to specified file path with predefined SaveOptions.

        Parameters:
        filePath - The output file path.
        signOptionsList - The list of signature options.
        saveOptions - The save options.
        Throws:
        Exception
      • sign

        public final void sign(String filePath,
                SignOptions signOptions)
                        throws Exception

        Signs document with SignOptions and saves result to specified file path.

        Parameters:
        filePath - The output file path.
        signOptions - The signature options.
        Throws:
        Exception
      • sign

        public final void sign(String filePath,
                SignOptions signOptions,
                SaveOptions saveOptions)
                        throws Exception

        Signs document with SignOptions and saves result to specified file path with predefined SaveOptions.

        Parameters:
        filePath - The output file path.
        signOptions - The signature options.
        saveOptions - The save options.
        Throws:
        Exception
      • verify

        public final VerificationResult verify(List<VerifyOptions> verifyOptionsList)
                                        throws Exception

        Verifies the document signatures with list of VerifyOptions data.

        Parameters:
        verifyOptionsList - The signature verification options collection. Instance of VerifyOptionsCollection.
        Returns:
        Returns instance of VerificationResult. Property VerificationResult.IsValid returns true if verification process was successful.
        Throws:
        Exception
      • verify

        public final VerificationResult verify(VerifyOptions verifyOptions)
                                        throws Exception

        Verifies the document signatures with given VerifyOptions data.

        Parameters:
        verifyOptions - The signature verification options.
        Returns:
        Returns instance of VerificationResult. Property VerificationResult.IsValid returns true if verification process was successful.
        Throws:
        Exception