Custom Download File Widget

by
Odoo

14.81

v 14.0 Third Party 1
Lines of code 130
Technical Name download_file_widget
LicenseOPL-1
Also available in version v 13.0 v 10.0
You bought this module and need support? Click here!
Lines of code 130
Technical Name download_file_widget
LicenseOPL-1
Also available in version v 13.0 v 10.0

Custom Download File Widget

Widget to download a custom file from a form's view...

How to use

In your model, for example:

# -*- coding: utf-8 -*-
from io import BytesIO
from docx import Document
from odoo import api, models
class TestDownloadCustomFile(models.Model):
    _name = 'download_file_widget.test_custom_download'
    _description = 'Testing custom file download'
    @api.model
    def get_filename(self):
        return 'word_document.docx'
    @api.model
    def get_file(self):
        """ Method to create your .docx file... """
        document = Document()
        p_name = document.add_paragraph('')
        p_name.add_run('You must create your document...').bold = True
        target_stream = BytesIO()
        document.save(target_stream)
        return target_stream.getvalue()
    @api.model
    def get_content_type(self):
        return 'application/vnd.openxmlformats-officedocument.wordprocessingml.document;charset=utf-8;'
                

Or if you need an excel document, for example:

# -*- coding: utf-8 -*-
import cStringIO
import xlwt
from odoo import api, models
class TestDownloadCustomFile(models.Model):
    _name = 'download_file_widget.test_custom_download'
    _description = 'Testing custom file download'
    @api.model
    def get_filename(self):
        return 'excel_document.xls'
    @api.model
    def get_file(self):
        """ Method to create your .xls file... """
        workbook = xlwt.Workbook()
        worksheet = workbook.add_sheet('Page1')
        worksheet.write(0, 0, 'You must create your document...')
        output = cStringIO.StringIO()
        workbook.save(output)
        output.seek(0)
        data = output.read()
        output.close()
        return data
    @api.model
    def get_content_type(self):
        return 'application/vnd.ms-excel'
                

In the xml definition you should write something like that:

<?xml version="1.0" encoding="UTF-8"?>
<odoo>
    <data>
        <record id="download_file_widget_test_form_view" model="ir.ui.view">
            <field name="name">download_file_widget_test_form_view</field>
            <field name="model">download_file_widget.test_custom_download</field>
            <field name="arch" type="xml">
                <form>
                    <sheet>
                        <widget name="download_file"
                                string="Download Custom Document..."
                                model="download_file_widget.test_custom_download"
                                class="oe_read_only"
                        />
                    </sheet>
                </form>
            </field>
        </record>
        <record id="download_file_widget_test_action" model="ir.actions.act_window">
            <field name="name">Custom Download File</field>
            <field name="res_model">download_file_widget.test_custom_download</field>
            <field name="view_type">form</field>
            <field name="view_mode">form</field>
        </record>
        <menuitem name="Custom Download File"
                  id="download_file_widget_test_menu_item"
                  action="download_file_widget_test_action"
                  sequence="1"
        />
    </data>
</odoo>
                
Alejandro Cora Gonzalez
alek.cora.glez@gmail.com
Odoo Proprietary License v1.0
This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).
You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).
It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.
The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.