.. include:: ../../Includes.txt

.. _link:

====
Link
====


======================================================= =========== ============ ==== ====
Property                                                Data type   Default      Plus Mvc
======================================================= =========== ============ ==== ====
:ref:`link.fieldLink`                                   Field name               Yes  Yes
:ref:`link.fieldMessage`                                Field name               Yes  Yes
:ref:`link.generateRTF`                                 Boolean     0            Yes  No
:ref:`link.generateRTFButtonIf`                         String                   Yes  No
:ref:`link.link`                                        String                   Yes  Yes
:ref:`link.message`                                     String                   Yes  Yes
:ref:`link.saveFileRTF`                                 String                   Yes  No
:ref:`link.tableName.fieldName`                         String                   Yes  No
:ref:`link.templateRTF`                                 String                   Yes  No
======================================================= =========== ============ ==== ====



.. _link.fieldLink:

fieldLink
=========

.. container:: table-row

    Property
        fieldLink
       
    Data type
      Field name
                 
    Description
      Sets the attribute ``link`` with the content of the field whose name is
      given by fieldName.
  

.. _link.fieldMessage:

fieldMessage
============
   
.. container:: table-row

    Property
        fieldMessage
   
    Data type
        fieldName
                
    Description
        Sets the attribute ``message`` with the content of the field whose name
        is given by fieldName.
    
  
.. _link.generateRTF:

generateRTF
===========

.. container:: table-row

    Property
        generateRTF
        
    Data type
        Boolean
         
    Description
        Sets the RTF generator.
       
    Default
        0

.. _link.generateRTFButtonIf:

generateRTFButtonIf
===================

.. container:: table-row

    Property
        generateRTFButtonIf
 
    Data type
        String
         
    Description
        If the condition is true, the button to generate the RTF is displayed.
        (see :ref:`general.cutIf` for details on the condition).
               

.. _link.link:

link
====

.. container:: table-row

    Property
        link
       
    Data type
        String
       
    Description
        The string will be used for the link instead of the field value.
   

.. _link.message:

message
=======

.. container:: table-row

    Property
        message

    Data type
        String  
       
    Description
        Message associated with the link.
   
    

.. _link.saveFileRTF:

saveFileRTF
===========

.. container:: table-row

    Property
        saveFileRTF
        
    Data type
        String
         
    Description
        Name under which the generated file will be saved. Field markers
        ###tableName.fieldName### or ###fieldName### (for aliases) can be
        used.
  

.. _link.tableName.fieldName:

tableName.fieldName
===================

.. container:: table-row

    Property
        tableName.fieldName
    
    Data type
        String
         
    Description
        String can be string1->string2 or NL-> string2
             
        In a RTF document, if the field marker ``###tableName.fieldName###``
        exists ``string1`` will be replaced by ``string2`` where ``string1`` 
        can be NL (for the ASCII character LF).
             
        It may be useful when one wants to input data in a textarea and
        display them in one line with a given separator in the file.
   

  
.. _link.templateRTF:

templateRTF
===========

.. container:: table-row

    Property
        templateRTF
        
    Data type
        String   
        
    Description
        Defines the template to be used by the RTF generator. Field markers
        ``###tableName.fieldName###`` or ``###fieldName###`` (for aliases) can be
        used.