HPS.Publish.TextFieldKit

class HPS.Publish.TextFieldKit : public HPS.SprocketKit 

The TextFieldKit class is a user space object. It acts as the container for all data that can be used to specify a text field for a Publish PDF.

Public Functions

override bool Empty ()

Indicates whether this TextFieldKit has any values set on it.

Return: true if no values are set on this TextFieldKit, false otherwise.

bool Equals (HPS.Publish.TextFieldKit in_kit)

Check if the source TextFieldKit is equivalent to this TextFieldKit.

Param in_kit: The source TextFieldKit to compare to this TextFieldKit.
Return: true if the objects are equivalent, false otherwise.

override HPS.Type ObjectType ()

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Publish.TextFieldKit in_kit)

Copies the source TextFieldKit into this TextFieldKit.

Param in_kit: The source TextFieldKit to copy.

HPS.Publish.TextFieldKit SetBorder (bool in_state)

Sets whether the text field has a border. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bHasBorder.

Param in_state: Whether the text field has a border.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetBorderColor (HPS.RGBColor in_color)

Sets the border color for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_sBorderColor.

Param in_color: The border color of the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetBorderStyle (HPS.Publish.Border.Style in_style)

Sets the border style for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eLineStyleBorder.

Param in_style: The border style for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)

Sets the border thickness for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eThicknessBorder.

Param in_thickness: The border thickness for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetDefaultValue (string in_value)

Sets the default value for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcDefaultValue.

Param in_value: UT8-encoded default value for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFillColor (HPS.RGBColor in_color)

Sets the fill color for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_sFillColor and implicitly sets A3DPDFTextFieldData::m_bHasFillColor to true.

Param in_color: The fill color for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFont (HPS.Publish.Text.Font.Name in_name)

Sets a builtin font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.

Param in_name: The builtin font for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFont (string in_name)

Sets a specific font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.

Param in_name: UTF8-encoded font name for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFont (string in_name, HPS.Publish.Text.Font.Style in_style)

Sets a specific font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.

Param in_name: UTF8-encoded font name for the text field.
Param in_style: The style of font to use for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetFontSize (int in_size)

Sets the font size for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_iFontSize.

Param in_size: The font size for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetLock (bool in_state)

Sets whether the text field is locked. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bIsLocked.

Param in_state: Whether the text field is locked.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetMultiline (bool in_state)

Sets whether the text field is multiline. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bMultiline.

Param in_state: Whether the text field is multiline.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetName (string in_name)

Sets the name of the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcName.

Param in_name: UTF8-encoded name of the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetPrintability (bool in_state)

Sets the printability for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eFormField.

Param in_state: The printability for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetReadOnly (bool in_state)

Sets whether the text field is read only. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bReadOnly.

Param in_state: Whether the text field can scroll.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetScrolling (bool in_state)

Sets whether the text field can scroll. This corresponds to the (inverted) value that will be passed to A3DPDFTextFieldData::m_bDoNotScroll.

Param in_state: Whether the text field can scroll.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetTextColor (HPS.RGBColor in_color)

Sets the text color for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_sTextColor.

Param in_color: The text color for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetTextJustification (HPS.Text.Justification in_justification)

Sets the text justification for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eTextAlignment.

Param in_justification: The text justification for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)

Sets the text rotation for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eTextOrientation.

Param in_rotation: The text rotation for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetTooltip (string in_tooltip)

Sets the tooltip for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcTooltip.

Param in_tooltip: UTF8-encoded tooltip text for the text field.
Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit SetVisibility (bool in_state)

Sets the visibility for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eFormField.

Param in_state: The visibility for the text field.
Return: A reference to this TextFieldKit.

void Show (out HPS.Publish.TextFieldKit out_kit)

Copies this TextFieldKit into the given TextFieldKit.

Param out_kit: The TextFieldKit to populate with the contents of this TextFieldKit.

bool ShowBorder (out bool out_state)

Shows the border setting for the text field.

Param out_state: Whether the text field has a border.
Return: true if a border setting was specified, false otherwise.

bool ShowBorderColor (out HPS.RGBColor out_color)

Shows the border color for the text field.

Param out_color: The border color of the text field.
Return: true if a border color was specified, false otherwise.

bool ShowBorderStyle (out HPS.Publish.Border.Style out_style)

Shows the border style for the text field.

Param out_style: The border style for the text field.
Return: true if a border style was specified, false otherwise.

bool ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness)

Shows the border thickness for the text field.

Param out_thickness: The border thickness for the text field.
Return: true if a border thickness was specified, false otherwise.

bool ShowDefaultValue (out string out_value)

Shows the default value for the text field.

Param out_value: The default value for the text field.
Return: true if a default value was specified, false otherwise.

bool ShowFillColor (out HPS.RGBColor out_color)

Shows the fill color for the text field.

Param out_color: The fill color for the text field.
Return: true if a fill color was specified, false otherwise.

bool ShowFont (out HPS.Publish.Text.Font.Type out_type, out HPS.Publish.Text.Font.Name out_font, out string out_font_name, out HPS.Publish.Text.Font.Style out_style)

Shows the font for the text field.

Param out_type: The type of font for the text field.
Param out_font: The built-in font for the text field. This is only valid if out_type is Text.Font.Type.BuiltIn.
Param out_font_name: The explicit font name for the text field. This is only valid if out_type is Text.Font.Type.Explicit.
Param out_style: The font style for the text field. This is only valid if out_type is Text.Font.Type.Explicit.
Return: true if a font was specified, false otherwise.

bool ShowFontSize (out int out_size)

Shows the font size for the text field.

Param out_size: The font size for the text field.
Return: true if a font size was specified, false otherwise.

bool ShowLock (out bool out_state)

Shows the lock setting for the text field.

Return: true if a lock setting was specified, false otherwise.

bool ShowMultiline (out bool out_state)

Shows the multiline setting for the text field.

Param out_state: Whether the text field is multiline.
Return: true if a multiline setting was specified, false otherwise.

bool ShowName (out string out_name)

Shows the name for the text field.

Param out_name: The name of the text field.
Return: true if a name was specified, false otherwise.

bool ShowPrintability (out bool out_state)

Shows the printability for the text field.

Param out_state: The printability for the text field.
Return: true if a printability was specified, false otherwise.

bool ShowReadOnly (out bool out_state)

Shows the read-only setting for the text field.

Param out_state: Whether the text field is read only.
Return: true if a scrolling setting was specified, false otherwise.

bool ShowScrolling (out bool out_state)

Shows the scrolling setting for the text field.

Param out_state: Whether the text field can scroll.
Return: true if a scrolling setting was specified, false otherwise.

bool ShowTextColor (out HPS.RGBColor out_color)

Shows the text color for the text field.

Param out_color: The text color for the text field.
Return: true if a text color was specified, false otherwise.

bool ShowTextJustification (out HPS.Text.Justification out_justification)

Shows the text justification for the text field.

Param out_justification: The text justification for the text field.
Return: true if a text justification was specified, false otherwise.

bool ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation)

Shows the text rotation for the text field.

Param out_rotation: The text rotation for the text field.
Return: true if a rotation was specified, false otherwise.

bool ShowTooltip (out string out_tooltip)

Shows the tooltip for the text field.

Param out_tooltip: The tooltip text for the text field.
Return: true if a tooltip was specified, false otherwise.

bool ShowVisibility (out bool out_state)

Shows the visibility for the text field.

Param out_state: The visibility for the text field.
Return: true if a visibility was specified, false otherwise.

TextFieldKit (): The default constructor creates an empty TextFieldKit object.

TextFieldKit (HPS.Publish.TextFieldKit in_kit)

The copy constructor creates a new TextFieldKit object that contains the same settings as the source TextFieldKit.

Param in_kit: The source TextFieldKit to copy.

HPS.Publish.TextFieldKit UnsetBorder ()

Removes the border setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetBorderColor ()

Removes the border color setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetBorderStyle ()

Removes the border style setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetBorderThickness ()

Removes the border thickness setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetDefaultValue ()

Removes the default value setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetEverything ()

Removes all data from the text field.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetFillColor ()

Removes the fill color setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetFont ()

Removes the font setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetFontSize ()

Removes the font size setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetLock ()

Removes the lock setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetMultiline ()

Removes the multiline setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetName ()

Removes the name setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetPrintability ()

Removes the printability setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetReadOnly ()

Removes the read-only setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetScrolling ()

Removes the scrolling setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetTextColor ()

Removes the text color setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetTextJustification ()

Removes the text justification setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetTextRotation ()

Removes the text rotation setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetTooltip ()

Removes the tooltip setting.

Return: A reference to this TextFieldKit.

HPS.Publish.TextFieldKit UnsetVisibility ()

Removes the visibility setting.

Return: A reference to this TextFieldKit.

Public Static Functions

HPS.Publish.TextFieldKit GetDefault ()

Creates a TextFieldKit 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 text field unless a setting is overridden by the TextFieldKit passed to a function.

Return: A TextFieldKit with the default settings.