asposecloud.words
index
/words/__init__.py

 
Package Contents
       

 
Classes
       
Builder
Converter
Document
Extractor
MailMerge

 
class Builder
     Methods defined here:
__init__(self, filename)
insert_watermark_image(self, image_file, angle, remote_folder='', storage_type='Aspose', storage_name=None)
:param image_file:
:param angle:
: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:
insert_watermark_text(self, text, angle, remote_folder='', storage_type='Aspose', storage_name=None)
:param text:
:param angle:
: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, old_text, new_text, match_case=False, match_whole_word=False, remote_folder='', storage_type='Aspose', storage_name=None)
:param old_text:
:param new_text:
:param match_case:
:param match_whole_word:
: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 Converter
     Methods defined here:
__init__(self, filename)
convert(self, save_format, stream_out=False, output_filename=None, remote_folder='', storage_type='Aspose', storage_name=None)
: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)
:param input_file:
:param save_format:
:param stream_out:
:param output_filename:
:return:

 
class Document
     Methods defined here:
__init__(self, filename)
append_document(self, doc_list, remote_folder='', storage_type='Aspose', storage_name=None)
:param doc_list:
: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:
delete_property(self, property_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param property_name:
: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_bookmark(self, bookmark_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param bookmark_name:
: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_bookmarks(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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_bookmarks_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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_document_info(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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_hyperlink(self, hyperlink_index, remote_folder='', storage_type='Aspose', storage_name=None)
:param hyperlink_index:
: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_hyperlinks(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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_hyperlinks_count(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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_setup(self, section_id, remote_folder='', storage_type='Aspose', storage_name=None)
:param section_id:
:param remote_folder:
:param storage_type:
:param storage_name:
:return:
get_properties(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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_property(self, property_name, remote_folder='', storage_type='Aspose', storage_name=None)
:param property_name:
: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:
remove_header_footer(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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:
save_as(self, options_xml, remote_folder='', storage_type='Aspose', storage_name=None)
:param options_xml:
:param remote_folder:
:param storage_type:
:param storage_name:
:return:
set_property(self, property_name, property_value, remote_folder='', storage_type='Aspose', storage_name=None)
:param property_name:
:param property_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:
split_document(self, from_page, to_page, save_format='pdf', remote_folder='', storage_type='Aspose', storage_name=None)
:param from_page:
:param to_page:
:param save_format:
:param remote_folder:
:param storage_type:
:param storage_name:
:return:
update_bookmark(self, bookmark_name, bookmark_text, remote_folder='', storage_type='Aspose', storage_name=None)
:param bookmark_name:
:param bookmark_text:
: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_page_setup(self, section_id, options_xml, remote_folder='', storage_type='Aspose', storage_name=None)
:param section_id:
:param options_xml
:param remote_folder:
:param storage_type:
:param storage_name:
:return:

 
class Extractor
     Methods defined here:
__init__(self, filename)
convert_drawing_object(self, object_index, render_format, remote_folder='', storage_type='Aspose', storage_name=None)
:param object_index:
:param render_format:
: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_drawing_object_list(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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_data(self, image_index, image_format, remote_folder='', storage_type='Aspose', storage_name=None)
:param image_index:
:param image_format:
: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_ole_data(self, ole_index, ole_format, remote_folder='', storage_type='Aspose', storage_name=None)
:param ole_index:
:param ole_format:
: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_paragraph(self, para_id, remote_folder='', storage_type='Aspose', storage_name=None)
:param para_id
: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_paragraph_run(self, para_id, run_index, remote_folder='', storage_type='Aspose', storage_name=None)
:param para_id
:param run_index
: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_paragraph_run_font(self, para_id, run_index, remote_folder='', storage_type='Aspose', storage_name=None)
:param para_id
:param run_index
: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_paragraphs(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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_section(self, section_id, remote_folder='', storage_type='Aspose', storage_name=None)
:param section_id
: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_sections(self, remote_folder='', storage_type='Aspose', storage_name=None)
: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, remote_folder='', storage_type='Aspose', storage_name=None)
: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:
get_drawing_object(object_uri, output_path, remote_folder='', storage_type='Aspose', storage_name=None)
:param object_uri:
:param output_path:
: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 MailMerge
     Methods defined here:
__init__(self, filename)
execute(self, str_xml, with_regions=False, remote_folder='', storage_type='Aspose', storage_name=None)
:param str_xml:
:param with_regions:
: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:
execute_template(self, str_xml, with_regions=False, remote_folder='', storage_type='Aspose', storage_name=None)
:param str_xml:
:param with_regions:
: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