A3DPDFButtonData

struct A3DPDFButtonData

Structure to define a button 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_eLayoutTextIcon
• m_eHighlightingMode
• m_pcLabel
• m_pImage

Variables

A3DUTF8Char *A3DPDFButtonData.m_pcName

A3DUTF8Char*

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

A3DUTF8Char *A3DPDFButtonData.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 A3DPDFButtonData.m_eFormField

A3DPDFEFormField

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

A3DPDFETextOrientation A3DPDFButtonData.m_eTextOrientation

A3DPDFETextOrientation

Orientation of the text inside the field.

A3DBool A3DPDFButtonData.m_bIsReadOnly

A3DBool

Defines if the field is editable.

A3DBool A3DPDFButtonData.m_bIsRequired

A3DBool

Defines if the field is required.

A3DBool A3DPDFButtonData.m_bIsLocked

A3DBool

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

A3DBool A3DPDFButtonData.m_bHasBorder

A3DBool

If true, there is a border around the field.

A3DPDFRgbColorData A3DPDFButtonData.m_sBorderColor

A3DPDFRgbColorData

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

A3DPDFEThicknessBorder A3DPDFButtonData.m_eThicknessBorder

A3DPDFEThicknessBorder

Thickness of the border.

A3DPDFELineStyleBorder A3DPDFButtonData.m_eLineStyleBorder

A3DPDFELineStyleBorder

Line style of the border.

A3DBool A3DPDFButtonData.m_bHasFillColor

A3DBool

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

A3DPDFRgbColorData A3DPDFButtonData.m_sFillColor

A3DPDFRgbColorData

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

A3DPDFRgbColorData A3DPDFButtonData.m_sTextColor

A3DPDFRgbColorData

Color of the text.

A3DUTF8Char *A3DPDFButtonData.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". 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 A3DPDFButtonData.m_iFontSize

A3DInt32

Size of the font.

A3DPDFELayoutTextIcon A3DPDFButtonData.m_eLayoutTextIcon

A3DPDFELayoutTextIcon

Position of the label of the button relative to its icon.

A3DPDFELinkHighlightMode A3DPDFButtonData.m_eHighlightingMode

A3DPDFELinkHighlightMode

Highlighting mode (the visual effect that shall be used when the mouse button is pressed or held down inside its active area).

A3DUTF8Char *A3DPDFButtonData.m_pcLabel

A3DUTF8Char*

Label of the button.

A3DPDFImage *A3DPDFButtonData.m_pImage

A3DPDFImage*

The image to store on the button as icon.