
Static Public Member Functions | |
static HPS.Publish.SignatureFieldKit | GetDefault () |
static bool | operator!= (HPS.Publish.SignatureFieldKit a, HPS.Publish.SignatureFieldKit b) |
static bool | operator== (HPS.Publish.SignatureFieldKit a, HPS.Publish.SignatureFieldKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The SignatureFieldKit class is a user space object. It acts as the container for all data that can be used to specify a signature field for a Publish PDF.
Constructor & Destructor Documentation
◆ SignatureFieldKit() [1/2]
|
inline |
The default constructor creates an empty SignatureFieldKit object.
◆ SignatureFieldKit() [2/2]
|
inline |
The copy constructor creates a new SignatureFieldKit object that contains the same settings as the source SignatureFieldKit.
- Parameters
-
in_kit The source SignatureFieldKit to copy.
Member Function Documentation
◆ Empty()
|
inlinevirtual |
Indicates whether this SignatureFieldKit has any values set on it.
- Returns
- true if no values are set on this SignatureFieldKit, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit.
- Parameters
-
in_kit The source SignatureFieldKit to compare to this SignatureFieldKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
inlinestatic |
Creates a SignatureFieldKit 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 SignatureFieldKit passed to a function.
- Returns
- A SignatureFieldKit with the default settings.
◆ 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()
|
inline |
Copies the source SignatureFieldKit into this SignatureFieldKit.
- Parameters
-
in_kit The source SignatureFieldKit to copy.
◆ SetBorder()
|
inline |
Sets whether the signature field has a border. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_bHasBorder.
- Parameters
-
in_state Whether the signature field has a border.
- Returns
- A reference to this SignatureFieldKit.
◆ SetBorderColor()
|
inline |
Sets the border color for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sBorderColor.
- Parameters
-
in_color The border color of the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetBorderStyle()
|
inline |
Sets the border style for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eLineStyleBorder.
- Parameters
-
in_style The border style for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetBorderThickness()
|
inline |
Sets the border thickness for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eThicknessBorder.
- Parameters
-
in_thickness The border thickness for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetFillColor()
|
inline |
Sets the fill color for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sFillColor and implicitly sets A3DPDFDigitalSignatureData::m_bHasFillColor to true.
- Parameters
-
in_color The fill color for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetFont() [1/3]
|
inline |
Sets a builtin font for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.
- Parameters
-
in_name The builtin font for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetFont() [2/3]
|
inline |
Sets a specific font for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.
- Parameters
-
in_name UTF8-encoded font name for the signature field. in_style The style of font to use for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetFont() [3/3]
|
inline |
Sets a specific font for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.
- Parameters
-
in_name UTF8-encoded font name for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetFontSize()
|
inline |
Sets the font size for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_iFontSize.
- Parameters
-
in_size The font size for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetLock()
|
inline |
Sets whether the signature field is locked. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_bIsLocked.
- Parameters
-
in_state Whether the signature field is locked.
- Returns
- A reference to this SignatureFieldKit.
◆ SetName()
|
inline |
Sets the name of the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcName.
- Parameters
-
in_name UTF8-encoded name of the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetPrintability()
|
inline |
Sets the printability for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eFormField.
- Parameters
-
in_state The printability for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetTextColor()
|
inline |
Sets the text color for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sTextColor.
- Parameters
-
in_color The text color for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetTextRotation()
|
inline |
Sets the text rotation for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eTextOrientation.
- Parameters
-
in_rotation The text rotation for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetTooltip()
|
inline |
Sets the tooltip for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcTooltip.
- Parameters
-
in_tooltip UTF8-encoded tooltip text for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ SetVisibility()
|
inline |
Sets the visibility for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eFormField.
- Parameters
-
in_state The visibility for the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ Show()
|
inline |
Copies this SignatureFieldKit into the given SignatureFieldKit.
- Parameters
-
out_kit The SignatureFieldKit to populate with the contents of this SignatureFieldKit.
◆ ShowBorder()
|
inline |
Shows the border setting for the signature field.
- Parameters
-
out_state Whether the signature field has a border.
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
|
inline |
Shows the border color for the signature field.
- Parameters
-
out_color The border color of the signature field.
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
|
inline |
Shows the border style for the signature field.
- Parameters
-
out_style The border style for the signature field.
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
|
inline |
Shows the border thickness for the signature field.
- Parameters
-
out_thickness The border thickness for the signature field.
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowFillColor()
|
inline |
Shows the fill color for the signature field.
- Parameters
-
out_color The fill color for the signature field.
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
|
inline |
Shows the font for the signature field.
- Parameters
-
out_type The type of font for the signature field. out_font The built-in font for the signature field. This is only valid if out_type is Text.Font.Type.BuiltIn. out_font_name The explicit font name for the signature field. This is only valid if out_type is Text.Font.Type.Explicit. out_style The font style for the signature field. This is only valid if out_type is Text.Font.Type.Explicit.
- Returns
- true if a font was specified, false otherwise.
◆ ShowFontSize()
|
inline |
Shows the font size for the signature field.
- Parameters
-
out_size The font size for the signature field.
- Returns
- true if a font size was specified, false otherwise.
◆ ShowLock()
|
inline |
Shows the lock setting for the signature field.
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowName()
|
inline |
Shows the name for the signature field.
- Parameters
-
out_name The name of the signature field.
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
|
inline |
Shows the printability for the signature field.
- Parameters
-
out_state The printability for the signature field.
- Returns
- true if a printability was specified, false otherwise.
◆ ShowTextColor()
|
inline |
Shows the text color for the signature field.
- Parameters
-
out_color The text color for the signature field.
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextRotation()
|
inline |
Shows the text rotation for the signature field.
- Parameters
-
out_rotation The text rotation for the signature field.
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
|
inline |
Shows the tooltip for the signature field.
- Parameters
-
out_tooltip The tooltip text for the signature field.
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
|
inline |
Shows the visibility for the signature field.
- Parameters
-
out_state The visibility for the signature field.
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
|
inline |
Removes the border setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetBorderColor()
|
inline |
Removes the border color setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetBorderStyle()
|
inline |
Removes the border style setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetBorderThickness()
|
inline |
Removes the border thickness setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetEverything()
|
inline |
Removes all data from the signature field.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetFillColor()
|
inline |
Removes the fill color setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetFont()
|
inline |
Removes the font setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetFontSize()
|
inline |
Removes the font size setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetLock()
|
inline |
Removes the lock setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetName()
|
inline |
Removes the name setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetPrintability()
|
inline |
Removes the printability setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetTextColor()
|
inline |
Removes the text color setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetTextRotation()
|
inline |
Removes the text rotation setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetTooltip()
|
inline |
Removes the tooltip setting.
- Returns
- A reference to this SignatureFieldKit.
◆ UnsetVisibility()
|
inline |
Removes the visibility setting.
- Returns
- A reference to this SignatureFieldKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_publish/source/cs/HPS.Publish.cs