
###################
A3DPDFTextFieldData
###################

.. c:struct:: A3DPDFTextFieldData

   Structure to define a text field.
   
   
      7.2
   
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:member:`~A3DPDFTextFieldData.m_pcName`
   * :c:member:`~A3DPDFTextFieldData.m_pcTooltip`
   * :c:member:`~A3DPDFTextFieldData.m_eFormField`
   * :c:member:`~A3DPDFTextFieldData.m_eTextOrientation`
   * :c:member:`~A3DPDFTextFieldData.m_bIsReadOnly`
   * :c:member:`~A3DPDFTextFieldData.m_bIsRequired`
   * :c:member:`~A3DPDFTextFieldData.m_bIsLocked`
   * :c:member:`~A3DPDFTextFieldData.m_bHasBorder`
   * :c:member:`~A3DPDFTextFieldData.m_sBorderColor`
   * :c:member:`~A3DPDFTextFieldData.m_eThicknessBorder`
   * :c:member:`~A3DPDFTextFieldData.m_eLineStyleBorder`
   * :c:member:`~A3DPDFTextFieldData.m_bHasFillColor`
   * :c:member:`~A3DPDFTextFieldData.m_sFillColor`
   * :c:member:`~A3DPDFTextFieldData.m_sTextColor`
   * :c:member:`~A3DPDFTextFieldData.m_pcFontName`
   * :c:member:`~A3DPDFTextFieldData.m_iFontSize`
   * :c:member:`~A3DPDFTextFieldData.m_eTextAlignment`
   * :c:member:`~A3DPDFTextFieldData.m_pcDefaultValue`
   * :c:member:`~A3DPDFTextFieldData.m_bCheckSpelling`
   * :c:member:`~A3DPDFTextFieldData.m_bIsMultiLine`
   * :c:member:`~A3DPDFTextFieldData.m_bDoNotScroll`
   * :c:member:`~A3DPDFTextFieldData.m_bAllowRichText`
   * :c:member:`~A3DPDFTextFieldData.m_pcRichTextValue`
   
   



.. rst-class:: kind-group kind-variable

.. rubric:: Variables
   :class: kind-group-title


.. c:member:: A3DUTF8Char* A3DPDFTextFieldData.m_pcName

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*
      
      Name of the field (it serves as the field identifier, it should be unique in the document).
      



.. c:member:: A3DUTF8Char* A3DPDFTextFieldData.m_pcTooltip

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*
      
      Displayed text that the hesitant user may find helpful in filling in the form field.
      
      Tooltips appear when the pointer hovers briefly over the form field.
      



.. c:member:: A3DPDFEFormField A3DPDFTextFieldData.m_eFormField

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFEFormField`
      
      Specifies whether the form field can be seen, either on screen or in print.
      



.. c:member:: A3DPDFETextOrientation A3DPDFTextFieldData.m_eTextOrientation

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFETextOrientation`
      
      Orientation of the text inside the field.
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bIsReadOnly

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      Defines if the field is editable.
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bIsRequired

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      Defines if the field is required.
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bIsLocked

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      If locked, prevents any further changes to any form field properties (in Acrobat 'Properties' dialog box).
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bHasBorder

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      If true, there is a border around the field.
      



.. c:member:: A3DPDFRgbColorData A3DPDFTextFieldData.m_sBorderColor

      .. rst-class:: sig-pretty-signature
      
         | :c:struct:`~A3DPDFRgbColorData`
      
      Color of the border of the field (if any).
      



.. c:member:: A3DPDFEThicknessBorder A3DPDFTextFieldData.m_eThicknessBorder

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFEThicknessBorder`
      
      Thickness of the border.
      



.. c:member:: A3DPDFELineStyleBorder A3DPDFTextFieldData.m_eLineStyleBorder

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFELineStyleBorder`
      
      Line style of the border.
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bHasFillColor

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      If true, the following field (m_sFillColor) is used.
      



.. c:member:: A3DPDFRgbColorData A3DPDFTextFieldData.m_sFillColor

      .. rst-class:: sig-pretty-signature
      
         | :c:struct:`~A3DPDFRgbColorData`
      
      Color which the inside of the field will be filled with (if m_bHasFillColor is true).
      



.. c:member:: A3DPDFRgbColorData A3DPDFTextFieldData.m_sTextColor

      .. rst-class:: sig-pretty-signature
      
         | :c:struct:`~A3DPDFRgbColorData`
      
      Color of the text.
      



.. c:member:: A3DUTF8Char* A3DPDFTextFieldData.m_pcFontName

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*
      
      
      ::
      
                                                         Font name of the text.
      
      It should be the name of the font as appearing in Acrobat font list, with style separated with a comma. For example, 'Calibri Bold Italic' should be specified as "Calibri,BoldItalic". For rich texts (if m_bAllowRichText is true), it is particularly important to specify the font name as defined in system folder, including spaces. For example, SegoeUI font should really be specifuy for rich texts as 'Segoe UI'. Also, specific values exist for Adobe default fonts: eTimesRoman is "TiRo" ; eTimesItalic is "TiIt" ; eTimesBold is "TiBo" ; eTimesBoldItalic is "TiBI" ; eHelvetica is "Helv" ; eHelveticaOblique is "HeOb" ; eHelveticaBold is "HeBo" ; eHelveticaBoldOblique is "HeBO" ; eCourier is "Cour" ; eCourierOblique is "CoOb" ; eCourierBold is "CoBo" ; eCourierBoldOblique is "CoBO".
      



.. c:member:: A3DInt32 A3DPDFTextFieldData.m_iFontSize

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DInt32`
      
      Size of the font.
      



.. c:member:: A3DPDFETextAlignment A3DPDFTextFieldData.m_eTextAlignment

      .. rst-class:: sig-pretty-signature
      
         | :c:enum:`~A3DPDFETextAlignment`
      
      Alignment of the text inside the text field.
      



.. c:member:: A3DUTF8Char* A3DPDFTextFieldData.m_pcDefaultValue

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*
      
      Default text field content.
      
      This is the text value to be used, but also the default value to which the field reverts when a reset-form action is executed. The default value can be in xml format for rich text.
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bCheckSpelling

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      Defines if the text entered in the field must be spell-checked.
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bIsMultiLine

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      Defines if the text field is multi line.
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bDoNotScroll

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      Defines if the text field is scrollable or not.
      



.. c:member:: A3DBool A3DPDFTextFieldData.m_bAllowRichText

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      If set, the value of this field shall be a rich text string.
      



.. c:member:: A3DUTF8Char* A3DPDFTextFieldData.m_pcRichTextValue

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ \*
      
      If m_bAllowRichText is true, this value defines the field content in xml format following rich text conventions specified for the XML Forms Architecture (XFA) specification.
      




