# A3DPDFTextFieldData

struct `A3DPDFTextFieldData`

  Structure to define a text field.

  > 7.2

  ## Index

  Variables

  - `m_pcName`
  - `m_pcTooltip`
  - `m_eFormField`
  - `m_eTextOrientation`
  - `m_bIsReadOnly`
  - `m_bIsRequired`
  - `m_bIsLocked`
  - `m_bHasBorder`
  - `m_sBorderColor`
  - `m_eThicknessBorder`
  - `m_eLineStyleBorder`
  - `m_bHasFillColor`
  - `m_sFillColor`
  - `m_sTextColor`
  - `m_pcFontName`
  - `m_iFontSize`
  - `m_eTextAlignment`
  - `m_pcDefaultValue`
  - `m_bCheckSpelling`
  - `m_bIsMultiLine`
  - `m_bDoNotScroll`
  - `m_bAllowRichText`
  - `m_pcRichTextValue`

Variables

A3DUTF8Char *`A3DPDFTextFieldData.``m_pcName`
  `A3DUTF8Char`*

  Name of the field (it serves as the field identifier, it should be unique in the document).

A3DUTF8Char *`A3DPDFTextFieldData.``m_pcTooltip`
  `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.

A3DPDFEFormField `A3DPDFTextFieldData.``m_eFormField`
  `A3DPDFEFormField`

  Specifies whether the form field can be seen, either on screen or in print.

A3DPDFETextOrientation `A3DPDFTextFieldData.``m_eTextOrientation`
  `A3DPDFETextOrientation`

  Orientation of the text inside the field.

A3DBool `A3DPDFTextFieldData.``m_bIsReadOnly`
  `A3DBool`

  Defines if the field is editable.

A3DBool `A3DPDFTextFieldData.``m_bIsRequired`
  `A3DBool`

  Defines if the field is required.

A3DBool `A3DPDFTextFieldData.``m_bIsLocked`
  `A3DBool`

  If locked, prevents any further changes to any form field properties (in Acrobat ‘Properties’ dialog box).

A3DBool `A3DPDFTextFieldData.``m_bHasBorder`
  `A3DBool`

  If true, there is a border around the field.

A3DPDFRgbColorData `A3DPDFTextFieldData.``m_sBorderColor`
  `A3DPDFRgbColorData`

  Color of the border of the field (if any).

A3DPDFEThicknessBorder `A3DPDFTextFieldData.``m_eThicknessBorder`
  `A3DPDFEThicknessBorder`

  Thickness of the border.

A3DPDFELineStyleBorder `A3DPDFTextFieldData.``m_eLineStyleBorder`
  `A3DPDFELineStyleBorder`

  Line style of the border.

A3DBool `A3DPDFTextFieldData.``m_bHasFillColor`
  `A3DBool`

  If true, the following field (m_sFillColor) is used.

A3DPDFRgbColorData `A3DPDFTextFieldData.``m_sFillColor`
  `A3DPDFRgbColorData`

  Color which the inside of the field will be filled with (if m_bHasFillColor is true).

A3DPDFRgbColorData `A3DPDFTextFieldData.``m_sTextColor`
  `A3DPDFRgbColorData`

  Color of the text.

A3DUTF8Char *`A3DPDFTextFieldData.``m_pcFontName`
  `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”.

A3DInt32 `A3DPDFTextFieldData.``m_iFontSize`
  `A3DInt32`

  Size of the font.

A3DPDFETextAlignment `A3DPDFTextFieldData.``m_eTextAlignment`
  `A3DPDFETextAlignment`

  Alignment of the text inside the text field.

A3DUTF8Char *`A3DPDFTextFieldData.``m_pcDefaultValue`
  `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.

A3DBool `A3DPDFTextFieldData.``m_bCheckSpelling`
  `A3DBool`

  Defines if the text entered in the field must be spell-checked.

A3DBool `A3DPDFTextFieldData.``m_bIsMultiLine`
  `A3DBool`

  Defines if the text field is multi line.

A3DBool `A3DPDFTextFieldData.``m_bDoNotScroll`
  `A3DBool`

  Defines if the text field is scrollable or not.

A3DBool `A3DPDFTextFieldData.``m_bAllowRichText`
  `A3DBool`

  If set, the value of this field shall be a rich text string.

A3DUTF8Char *`A3DPDFTextFieldData.``m_pcRichTextValue`
  `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.

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Exchange in your own language, or choose a sample question below to start a conversation:

What is HOOPS Exchange?
What are the latest release notes for HOOPS Exchange?
How do I start evaluating HOOPS Exchange?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...