|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The DropDownListKit class is a user space object. It acts as the container for all data that can be used to specify a drop down list for a Publish PDF.
◆ DropDownListKit() [1/2]
HPS.Publish.DropDownListKit.DropDownListKit |
( |
| ) |
|
|
inline |
◆ DropDownListKit() [2/2]
◆ Empty()
override bool HPS.Publish.DropDownListKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ GetDefault()
Creates a DropDownListKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for a button unless a setting is overridden by the DropDownListKit passed to a function.
- Returns
- A DropDownListKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Publish.DropDownListKit.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
◆ Set()
◆ SetBorder()
◆ SetBorderColor()
◆ SetBorderStyle()
◆ SetBorderThickness()
◆ SetContents()
Sets the contents of the drop down list. This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. The two arrays need to have the same size.
- Parameters
-
in_displayed_values | The values displayed in the drop down list |
in_export_values | The export values associated with the values displayed |
- Returns
- A reference to this DropDownListKit.
◆ SetCustomText()
◆ SetFillColor()
◆ SetFont() [1/3]
◆ SetFont() [2/3]
Sets a specific font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the drop down list. |
in_style | The style of font to use for the drop down list. |
- Returns
- A reference to this DropDownListKit.
◆ SetFont() [3/3]
◆ SetFontSize()
◆ SetImmediateCommit()
◆ SetLock()
◆ SetName()
◆ SetPrintability()
◆ SetSpellChecking()
◆ SetTextColor()
◆ SetTextRotation()
◆ SetTooltip()
◆ SetVisibility()
◆ Show()
◆ ShowBorder()
bool HPS.Publish.DropDownListKit.ShowBorder |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the border setting for the drop down list.
- Parameters
-
out_state | Whether the drop down list has a border. |
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
bool HPS.Publish.DropDownListKit.ShowBorderColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the border color for the drop down list.
- Parameters
-
out_color | The border color of the drop down list. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
Shows the border style for the drop down list.
- Parameters
-
out_style | The border style for the drop down list. |
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
Shows the border thickness for the drop down list.
- Parameters
-
out_thickness | The border thickness for the drop down list. |
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowContents()
bool HPS.Publish.DropDownListKit.ShowContents |
( |
out string [] |
out_displayed_values, |
|
|
out string [] |
out_export_values |
|
) |
| |
|
inline |
Shows the content setting for the drop down list
- Parameters
-
out_displayed_values | The values displayed by the drop down list |
out_export_values | The export values associated with the displayed values. |
- Returns
- true if a content setting was specified, false otherwise.
◆ ShowCustomText()
bool HPS.Publish.DropDownListKit.ShowCustomText |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the custom text setting for the drop down list.
- Parameters
-
out_state | Whether the user can enter custom text. |
- Returns
- true if a custom text setting was specified, false otherwise.
◆ ShowFillColor()
bool HPS.Publish.DropDownListKit.ShowFillColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the fill color for the drop down list.
- Parameters
-
out_color | The fill color for the drop down list. |
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
Shows the font for the drop down list.
- Parameters
-
out_type | The type of font for the drop down list. |
out_font | The built-in font for the drop down list. This is only valid if out_type is Text.Font.Type.BuiltIn. |
out_font_name | The explicit font name for the drop down list. This is only valid if out_type is Text.Font.Type.Explicit. |
out_style | The font style for the drop down list. This is only valid if out_type is Text.Font.Type.Explicit. |
- Returns
- true if a font was specified, false otherwise.
◆ ShowFontSize()
bool HPS.Publish.DropDownListKit.ShowFontSize |
( |
out int |
out_size | ) |
|
|
inline |
Shows the font size for the drop down list.
- Parameters
-
out_size | The font size for the drop down list. |
- Returns
- true if a font size was specified, false otherwise.
◆ ShowImmediateCommit()
bool HPS.Publish.DropDownListKit.ShowImmediateCommit |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the immediate commit setting for the drop down list.
- Parameters
-
out_state | Whether selected values are committed immediately. |
- Returns
- true if an immediate commit setting was specified, false otherwise.
◆ ShowLock()
bool HPS.Publish.DropDownListKit.ShowLock |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the lock setting for the drop down list.
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowName()
bool HPS.Publish.DropDownListKit.ShowName |
( |
out string |
out_name | ) |
|
|
inline |
Shows the name for the drop down list.
- Parameters
-
out_name | The name of the drop down list. |
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
bool HPS.Publish.DropDownListKit.ShowPrintability |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the printability for the drop down list.
- Parameters
-
out_state | The printability for the drop down list. |
- Returns
- true if a printability was specified, false otherwise.
◆ ShowSpellChecking()
bool HPS.Publish.DropDownListKit.ShowSpellChecking |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the spell checking setting for the drop down list.
- Parameters
-
out_state | Whether spell checking is enabled. |
- Returns
- true if a spell checking setting was specified, false otherwise.
◆ ShowTextColor()
bool HPS.Publish.DropDownListKit.ShowTextColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the text color for the drop down list.
- Parameters
-
out_color | The text color for the drop down list. |
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextRotation()
Shows the text rotation for the drop down list.
- Parameters
-
out_rotation | The text rotation for the drop down list. |
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
bool HPS.Publish.DropDownListKit.ShowTooltip |
( |
out string |
out_tooltip | ) |
|
|
inline |
Shows the tooltip for the drop down list.
- Parameters
-
out_tooltip | The tooltip text for the drop down list. |
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
bool HPS.Publish.DropDownListKit.ShowVisibility |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the visibility for the drop down list.
- Parameters
-
out_state | The visibility for the drop down list. |
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
◆ UnsetBorderColor()
Removes the border color setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetBorderStyle()
Removes the border style setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetBorderThickness()
Removes the border thickness setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetContents()
◆ UnsetCustomText()
Removes the custom text setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetEverything()
Removes all data from the drop down list.
- Returns
- A reference to this DropDownListKit.
◆ UnsetFillColor()
Removes the fill color setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetFont()
◆ UnsetFontSize()
◆ UnsetImmediateCommit()
Removes the immediate commit setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetLock()
◆ UnsetName()
◆ UnsetPrintability()
Removes the printability setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetSpellChecking()
Removes the spell checking setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetTextColor()
Removes the text color setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetTextRotation()
Removes the text rotation setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetTooltip()
◆ UnsetVisibility()
Removes the visibility setting.
- Returns
- A reference to this DropDownListKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs