|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ TextFieldKit() [1/2]
HPS.Publish.TextFieldKit.TextFieldKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty TextFieldKit object.
◆ TextFieldKit() [2/2]
The copy constructor creates a new TextFieldKit object that contains the same settings as the source TextFieldKit.
- Parameters
-
◆ Empty()
override bool HPS.Publish.TextFieldKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
Check if the source TextFieldKit is equivalent to this TextFieldKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- Returns
- A TextFieldKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.Publish.TextFieldKit.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 text field has a border. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bHasBorder.
- Parameters
-
in_state | Whether the text field has a border. |
- Returns
- A reference to this TextFieldKit.
◆ SetBorderColor()
◆ SetBorderStyle()
◆ SetBorderThickness()
◆ SetDefaultValue()
◆ SetFillColor()
◆ SetFont() [1/3]
◆ SetFont() [2/3]
Sets a specific font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the text field. |
in_style | The style of font to use for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetFont() [3/3]
Sets a specific font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetFontSize()
◆ SetLock()
◆ SetMultiline()
Sets whether the text field is multiline. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bMultiline.
- Parameters
-
in_state | Whether the text field is multiline. |
- Returns
- A reference to this TextFieldKit.
◆ SetName()
Sets the name of the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcName.
- Parameters
-
in_name | UTF8-encoded name of the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetPrintability()
Sets the printability for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eFormField.
- Parameters
-
in_state | The printability for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetReadOnly()
Sets whether the text field is read only. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bReadOnly.
- Parameters
-
in_state | Whether the text field can scroll. |
- Returns
- A reference to this TextFieldKit.
◆ SetScrolling()
Sets whether the text field can scroll. This corresponds to the (inverted) value that will be passed to A3DPDFTextFieldData::m_bDoNotScroll.
- Parameters
-
in_state | Whether the text field can scroll. |
- Returns
- A reference to this TextFieldKit.
◆ SetTextColor()
◆ SetTextJustification()
Sets the text justification for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eTextAlignment.
- Parameters
-
in_justification | The text justification for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetTextRotation()
◆ SetTooltip()
Sets the tooltip for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcTooltip.
- Parameters
-
in_tooltip | UTF8-encoded tooltip text for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetVisibility()
◆ Show()
◆ ShowBorder()
bool HPS.Publish.TextFieldKit.ShowBorder |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the border setting for the text field.
- Parameters
-
out_state | Whether the text field has a border. |
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
bool HPS.Publish.TextFieldKit.ShowBorderColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the border color for the text field.
- Parameters
-
out_color | The border color of the text field. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
Shows the border style for the text field.
- Parameters
-
out_style | The border style for the text field. |
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
Shows the border thickness for the text field.
- Parameters
-
out_thickness | The border thickness for the text field. |
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowDefaultValue()
bool HPS.Publish.TextFieldKit.ShowDefaultValue |
( |
out string |
out_value | ) |
|
|
inline |
Shows the default value for the text field.
- Parameters
-
out_value | The default value for the text field. |
- Returns
- true if a default value was specified, false otherwise.
◆ ShowFillColor()
bool HPS.Publish.TextFieldKit.ShowFillColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the fill color for the text field.
- Parameters
-
out_color | The fill color for the text field. |
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
Shows the font for the text field.
- Parameters
-
out_type | The type of font for the text field. |
out_font | The built-in font for the text field. This is only valid if out_type is Text.Font.Type.BuiltIn. |
out_font_name | The explicit font name for the text field. This is only valid if out_type is Text.Font.Type.Explicit. |
out_style | The font style for the text field. 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.TextFieldKit.ShowFontSize |
( |
out int |
out_size | ) |
|
|
inline |
Shows the font size for the text field.
- Parameters
-
out_size | The font size for the text field. |
- Returns
- true if a font size was specified, false otherwise.
◆ ShowLock()
bool HPS.Publish.TextFieldKit.ShowLock |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the lock setting for the text field.
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowMultiline()
bool HPS.Publish.TextFieldKit.ShowMultiline |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the multiline setting for the text field.
- Parameters
-
out_state | Whether the text field is multiline. |
- Returns
- true if a multiline setting was specified, false otherwise.
◆ ShowName()
bool HPS.Publish.TextFieldKit.ShowName |
( |
out string |
out_name | ) |
|
|
inline |
Shows the name for the text field.
- Parameters
-
out_name | The name of the text field. |
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
bool HPS.Publish.TextFieldKit.ShowPrintability |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the printability for the text field.
- Parameters
-
out_state | The printability for the text field. |
- Returns
- true if a printability was specified, false otherwise.
◆ ShowReadOnly()
bool HPS.Publish.TextFieldKit.ShowReadOnly |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the read-only setting for the text field.
- Parameters
-
out_state | Whether the text field is read only. |
- Returns
- true if a scrolling setting was specified, false otherwise.
◆ ShowScrolling()
bool HPS.Publish.TextFieldKit.ShowScrolling |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the scrolling setting for the text field.
- Parameters
-
out_state | Whether the text field can scroll. |
- Returns
- true if a scrolling setting was specified, false otherwise.
◆ ShowTextColor()
bool HPS.Publish.TextFieldKit.ShowTextColor |
( |
out HPS.RGBColor |
out_color | ) |
|
|
inline |
Shows the text color for the text field.
- Parameters
-
out_color | The text color for the text field. |
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextJustification()
Shows the text justification for the text field.
- Parameters
-
out_justification | The text justification for the text field. |
- Returns
- true if a text justification was specified, false otherwise.
◆ ShowTextRotation()
Shows the text rotation for the text field.
- Parameters
-
out_rotation | The text rotation for the text field. |
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
bool HPS.Publish.TextFieldKit.ShowTooltip |
( |
out string |
out_tooltip | ) |
|
|
inline |
Shows the tooltip for the text field.
- Parameters
-
out_tooltip | The tooltip text for the text field. |
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
bool HPS.Publish.TextFieldKit.ShowVisibility |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the visibility for the text field.
- Parameters
-
out_state | The visibility for the text field. |
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
Removes the border setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetBorderColor()
Removes the border color setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetBorderStyle()
Removes the border style setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetBorderThickness()
Removes the border thickness setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetDefaultValue()
Removes the default value setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetEverything()
Removes all data from the text field.
- Returns
- A reference to this TextFieldKit.
◆ UnsetFillColor()
Removes the fill color setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetFont()
Removes the font setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetFontSize()
Removes the font size setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetLock()
Removes the lock setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetMultiline()
Removes the multiline setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetName()
Removes the name setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetPrintability()
Removes the printability setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetReadOnly()
Removes the read-only setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetScrolling()
Removes the scrolling setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetTextColor()
Removes the text color setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetTextJustification()
Removes the text justification setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetTextRotation()
Removes the text rotation setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetTooltip()
Removes the tooltip setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetVisibility()
Removes the visibility setting.
- Returns
- A reference to this TextFieldKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs