asposecloud.pdf
index
/pdf/__init__.py

 
Package Contents
       

 
Classes
       
Converter
Document
Extractor
TextEditor

 
class Converter
    Wrapper class for Aspose.PDF API.
The Aspose.PDF API let's you manipulate PDF files.
 
  Methods defined here:
__init__(self, filename)
convert(self, save_format, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
Convert a pdf file to any supported format
 
:param save_format:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
convert_to_image(self, page_number, save_format, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
Convert a page to image
 
:param page_number:
:param save_format:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

Static methods defined here:
convert_local_file(input_file, save_format, stream_out=False, output_filename=None)
Convert a local pdf file to any supported format
 
:param input_file:
:param save_format:
:param stream_out:
:param output_filename:
:return:

 
class Document
    Wrapper class for Aspose.PDF API Document Resource.
The Aspose.PDF API let's you manipulate PDF files.
 
  Methods defined here:
__init__(self, filename)
add_signature(self, post_data, page_number=None, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
Add Signature to a pdf file
 
:param page_number:
:param post_data:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
add_stamp(self, post_data, page_number, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
Add Signature to a pdf file
 
:param page_number:
:param post_data:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
append_documents(self, append_file, start_page=None, end_page=None, remote_folder='', storage_type='Aspose', storage_name=None)
Append a pdf file to base pdf
 
:param append_file:
:param start_page:
:param end_page:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
create_pdf(self, template_file, source_format, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
Create a pdf file from any supported format file e.g. html,xml,jpeg,svg,tiff
 
:param template_file:
:param source_format:
:param stream_out:
:param output_filename:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_page_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
Get count of pages in pdf file
 
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
update_form_field(self, field_name, field_type, field_value, remote_folder='', storage_type='Aspose', storage_name=None)
Update Form Field Value
 
:param fiedlname:
:param field_type:
:param field_value:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

Static methods defined here:
merge_documents(merged_filename, source_files, remote_folder='', storage_type='Aspose', storage_name=None)
Merge multiple pdf files
 
:param merged_filename:
:param source_files:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

 
class Extractor
    Wrapper class for Aspose.PDF API Extraction features.
The Aspose.PDF API let's you manipulate PDF files.
 
  Methods defined here:
__init__(self, filename)
get_image(self, page_number, image_index, save_format, width=None, height=None, remote_folder='', storage_type='Aspose', storage_name=None)
Get image from given page
 
:param page_number:
:param image_index:
:param save_format:
:param width:
:param height:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_image_count(self, page_number, remote_folder='', storage_type='Aspose', storage_name=None)
Count images on a given page
 
:param page_number:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

 
class TextEditor
    Wrapper class for Aspose.PDF API for Text Editing features.
The Aspose.PDF API let's you manipulate PDF files.
 
  Methods defined here:
__init__(self, filename)
get_fragment_count(self, page_number, remote_folder='', storage_type='Aspose', storage_name=None)
Count fragments in a pdf file on given page number
 
:param page_number:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_text(self, page_number, remote_folder='', storage_type='Aspose', storage_name=None)
Get text from give page number
 
:param page_number:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
get_text_items(self, page_number, remote_folder='', storage_type='Aspose', storage_name=None)
Get text items from given page number
 
:param page_number:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:
replace_text(self, page_number, old_text, new_text, is_reg=False, remote_folder='', storage_type='Aspose', storage_name=None)
Replace text on any given page
 
:param page_number:
:param old_text:
:param new_text:
:param is_reg:
:param remote_folder: storage path to operate
:param storage_type: type of storage e.g Aspose, S3
:param storage_name: name of storage e.g. MyAmazonS3
:return:

 
Data
        __author__ = 'AssadMahmood'

 
Author
        AssadMahmood