.. include:: headings.inc



.. _MessageParameters:

==========================================================================================================================================
|phoenix_title|  **MessageParameters**
==========================================================================================================================================

Class representing message parameters.          

An object of this class may be passed to :meth:`FileType.GetOpenCommand`   and :meth:`~MessageParameters.GetPrintCommand`  if more than the file name needs to be specified.           




|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **MessageParameters**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/MessageParameters_inheritance.png" alt="Inheritance diagram of MessageParameters" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="MessageParameters.html" title="Class representing message parameters." alt="" coords="7,5,148,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~MessageParameters.__init__`                                              Trivial default constructor.
:meth:`~MessageParameters.GetFileName`                                           Return the filename.
:meth:`~MessageParameters.GetMimeType`                                           Return the ``MIME`` type.
:meth:`~MessageParameters.GetParamValue`                                         Overridable method for derived classes. Returns empty string by default.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~MessageParameters.FileName`                                              See :meth:`~MessageParameters.GetFileName`
:attr:`~MessageParameters.MimeType`                                              See :meth:`~MessageParameters.GetMimeType`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: MessageParameters(object)

   Class representing message parameters.
   
   **Possible constructors**::

       MessageParameters()
       
       MessageParameters(filename, mimetype='')
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self)`
      
      Trivial default constructor.                   
      
      
      
      
      **~~~**

      
      **__init__** `(self, filename, mimetype='')`
      
      Constructor taking a filename and a mime type.                  
      
      
      :param `filename`: 
      :type `filename`: string
      :param `mimetype`: 
      :type `mimetype`: string
      
      
      
      
      
      
      **~~~**






   .. method:: GetFileName(self)

      Return the filename.                  

      :rtype: `string`








   .. method:: GetMimeType(self)

      Return the ``MIME`` type.                  

      :rtype: `string`








   .. method:: GetParamValue(self, name)

      Overridable method for derived classes. Returns empty string by default.                  


      :param `name`: 
      :type `name`: string




      :rtype: `string`








   .. attribute:: FileName

      See :meth:`~MessageParameters.GetFileName`


   .. attribute:: MimeType

      See :meth:`~MessageParameters.GetMimeType`