
##################
A3DPDFCheckBoxData
##################

.. c:struct:: A3DPDFCheckBoxData

   Structure to define a check box field. 
   
   
      8.0 
   
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:member:`~A3DPDFCheckBoxData.m_pcName`
   * :c:member:`~A3DPDFCheckBoxData.m_pcTooltip`
   * :c:member:`~A3DPDFCheckBoxData.m_eFormField`
   * :c:member:`~A3DPDFCheckBoxData.m_eTextOrientation`
   * :c:member:`~A3DPDFCheckBoxData.m_bIsReadOnly`
   * :c:member:`~A3DPDFCheckBoxData.m_bIsRequired`
   * :c:member:`~A3DPDFCheckBoxData.m_bIsLocked`
   * :c:member:`~A3DPDFCheckBoxData.m_bHasBorder`
   * :c:member:`~A3DPDFCheckBoxData.m_sBorderColor`
   * :c:member:`~A3DPDFCheckBoxData.m_eThicknessBorder`
   * :c:member:`~A3DPDFCheckBoxData.m_eLineStyleBorder`
   * :c:member:`~A3DPDFCheckBoxData.m_bHasFillColor`
   * :c:member:`~A3DPDFCheckBoxData.m_sFillColor`
   * :c:member:`~A3DPDFCheckBoxData.m_sTextColor`
   * :c:member:`~A3DPDFCheckBoxData.m_pcFontName`
   * :c:member:`~A3DPDFCheckBoxData.m_iFontSize`
   * :c:member:`~A3DPDFCheckBoxData.m_pcExportValue`
   * :c:member:`~A3DPDFCheckBoxData.m_bIsCheckedByDefault`
   
   



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

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


.. c:member:: A3DUTF8Char* A3DPDFCheckBoxData.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* A3DPDFCheckBoxData.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 A3DPDFCheckBoxData.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 A3DPDFCheckBoxData.m_eTextOrientation

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



.. c:member:: A3DBool A3DPDFCheckBoxData.m_bIsReadOnly

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



.. c:member:: A3DBool A3DPDFCheckBoxData.m_bIsRequired

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



.. c:member:: A3DBool A3DPDFCheckBoxData.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 A3DPDFCheckBoxData.m_bHasBorder

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



.. c:member:: A3DPDFRgbColorData A3DPDFCheckBoxData.m_sBorderColor

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



.. c:member:: A3DPDFEThicknessBorder A3DPDFCheckBoxData.m_eThicknessBorder

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



.. c:member:: A3DPDFELineStyleBorder A3DPDFCheckBoxData.m_eLineStyleBorder

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



.. c:member:: A3DBool A3DPDFCheckBoxData.m_bHasFillColor

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



.. c:member:: A3DPDFRgbColorData A3DPDFCheckBoxData.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 A3DPDFCheckBoxData.m_sTextColor

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



.. c:member:: A3DUTF8Char* A3DPDFCheckBoxData.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". 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 A3DPDFCheckBoxData.m_iFontSize

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



.. c:member:: A3DUTF8Char* A3DPDFCheckBoxData.m_pcExportValue

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUTF8Char`\ *
      
      Value used when field data is exported by Acrobat functions. 
      



.. c:member:: A3DBool A3DPDFCheckBoxData.m_bIsCheckedByDefault

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DBool`
      
      If true, this check box is checked when the PDF document is opened. 
      




