|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ButtonKit class is a user space object. It acts as the container for all data that can be used to specify a button for a Publish PDF.
◆ ButtonKit() [1/2]
HPS.Publish.ButtonKit.ButtonKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty ButtonKit object.
◆ ButtonKit() [2/2]
The copy constructor creates a new ButtonKit object that contains the same settings as the source ButtonKit.
- Parameters
-
◆ Empty()
override bool HPS.Publish.ButtonKit.Empty |
( |
| ) |
|
|
inlinevirtual |
Indicates whether this ButtonKit has any values set on it.
- Returns
- true if no values are set on this ButtonKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
Check if the source ButtonKit is equivalent to this ButtonKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
Creates a ButtonKit 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 ButtonKit passed to a function.
- Returns
- A ButtonKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Publish.ButtonKit.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()
Sets whether the button has a border. This corresponds to the value that will be passed to A3DPDFButtonData::m_bHasBorder.
- Parameters
-
in_state | Whether the button has a border. |
- Returns
- A reference to this ButtonKit.
◆ SetBorderColor()
Sets the border color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sBorderColor.
- Parameters
-
in_color | The border color of the button. |
- Returns
- A reference to this ButtonKit.
◆ SetBorderStyle()
◆ SetBorderThickness()
Sets the border thickness for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eThicknessBorder.
- Parameters
-
in_thickness | The border thickness for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetFillColor()
◆ SetFont() [1/3]
Sets a builtin font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.
- Parameters
-
in_name | The builtin font for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetFont() [2/3]
Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the button. |
in_style | The style of font to use for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetFont() [3/3]
Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetFontSize()
Sets the font size for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_iFontSize.
- Parameters
-
in_size | The font size for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetHighlighting()
◆ SetIconImage()
Sets the icon image for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pImage.
- Parameters
-
in_image | The icon image for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetLabel()
Sets the label for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcLabel.
- Parameters
-
in_label | UTF8-encoded label for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetLabelPosition()
Sets the label position for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLayoutTextIcon.
- Parameters
-
in_position | The label position for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetLock()
Sets whether the button is locked. This corresponds to the value that will be passed to A3DPDFButtonData::m_bIsLocked.
- Parameters
-
in_state | Whether the button is locked. |
- Returns
- A reference to this ButtonKit.
◆ SetName()
Sets the name of the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcName.
- Parameters
-
in_name | UTF8-encoded name of the button. |
- Returns
- A reference to this ButtonKit.
◆ SetPrintability()
Sets the printability for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField.
- Parameters
-
in_state | The printability for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetTextColor()
Sets the text color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sTextColor.
- Parameters
-
in_color | The text color for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetTextRotation()
◆ SetTooltip()
Sets the tooltip for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcTooltip.
- Parameters
-
in_tooltip | UTF8-encoded tooltip text for the button. |
- Returns
- A reference to this ButtonKit.
◆ SetVisibility()
Sets the visibility for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField.
- Parameters
-
in_state | The visibility for the button. |
- Returns
- A reference to this ButtonKit.
◆ Show()
◆ ShowBorder()
bool HPS.Publish.ButtonKit.ShowBorder |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the border setting for the button.
- Parameters
-
out_state | Whether the button has a border. |
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
bool HPS.Publish.ButtonKit.ShowBorderColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the border color for the button.
- Parameters
-
out_color | The border color of the button. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
Shows the border style for the button.
- Parameters
-
out_style | The border style for the button. |
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
Shows the border thickness for the button.
- Parameters
-
out_thickness | The border thickness for the button. |
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowFillColor()
bool HPS.Publish.ButtonKit.ShowFillColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the fill color for the button.
- Parameters
-
out_color | The fill color for the button. |
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
Shows the font for the button.
- Parameters
-
out_type | The type of font for the button. |
out_font | The built-in font for the button. This is only valid if out_type is Text.Font.Type.BuiltIn. |
out_font_name | The explicit font name for the button. This is only valid if out_type is Text.Font.Type.Explicit. |
out_style | The font style for the button. 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.ButtonKit.ShowFontSize |
( |
out int |
out_size | ) |
|
|
inline |
Shows the font size for the button.
- Parameters
-
out_size | The font size for the button. |
- Returns
- true if a font size was specified, false otherwise.
◆ ShowHighlighting()
Shows the highlighting mode for the button.
- Parameters
-
out_mode | The highlighting mode for the button. |
- Returns
- true if a highlighting mode was specified, false otherwise.
◆ ShowIconImage()
Shows the icon image for the button.
- Parameters
-
out_image | The icon image for the button. |
- Returns
- true if an icon image was specified, false otherwise.
◆ ShowLabel()
bool HPS.Publish.ButtonKit.ShowLabel |
( |
out string |
out_label | ) |
|
|
inline |
Shows the label for the button.
- Parameters
-
out_label | The label for the button. |
- Returns
- true if a label was specified, false otherwise.
◆ ShowLabelPosition()
Shows the label position for the button.
- Parameters
-
out_position | The label position for the button. |
- Returns
- true if a label position was specified, false otherwise.
◆ ShowLock()
bool HPS.Publish.ButtonKit.ShowLock |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the lock setting for the button.
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowName()
bool HPS.Publish.ButtonKit.ShowName |
( |
out string |
out_name | ) |
|
|
inline |
Shows the name for the button.
- Parameters
-
out_name | The name of the button. |
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
bool HPS.Publish.ButtonKit.ShowPrintability |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the printability for the button.
- Parameters
-
out_state | The printability for the button. |
- Returns
- true if a printability was specified, false otherwise.
◆ ShowTextColor()
bool HPS.Publish.ButtonKit.ShowTextColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the text color for the button.
- Parameters
-
out_color | The text color for the button. |
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextRotation()
Shows the text rotation for the button.
- Parameters
-
out_rotation | The text rotation for the button.r |
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
bool HPS.Publish.ButtonKit.ShowTooltip |
( |
out string |
out_tooltip | ) |
|
|
inline |
Shows the tooltip for the button.
- Parameters
-
out_tooltip | The tooltip text for the button. |
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
bool HPS.Publish.ButtonKit.ShowVisibility |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the visibility for the button.
- Parameters
-
out_state | The visibility for the button. |
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
Removes the border setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetBorderColor()
Removes the border color setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetBorderStyle()
Removes the border style setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetBorderThickness()
Removes the border thickness setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetEverything()
Removes all data from the button.
- Returns
- A reference to this ButtonKit.
◆ UnsetFillColor()
Removes the fill color setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetFont()
Removes the font setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetFontSize()
Removes the font size setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetHighlighting()
Removes the highlighting mode setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetIconImage()
Removes the icon image setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetLabel()
Removes the label setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetLabelPosition()
Removes the label position setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetLock()
Removes the lock setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetName()
Removes the name setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetPrintability()
Removes the printability setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetTextColor()
Removes the text color setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetTextRotation()
Removes the text rotation setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetTooltip()
Removes the tooltip setting.
- Returns
- A reference to this ButtonKit.
◆ UnsetVisibility()
Removes the visibility setting.
- Returns
- A reference to this ButtonKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs