REFERENCE MANUAL
The SignatureFieldKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this SignatureFieldKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.SignatureFieldKit in_kit) |
Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Publish.SignatureFieldKit in_kit) |
Copies the source SignatureFieldKit into this SignatureFieldKit. More... | |
HPS.Publish.SignatureFieldKit | SetBorder (bool in_state) |
Sets whether the signature field has a border. More... | |
HPS.Publish.SignatureFieldKit | SetBorderColor (HPS.RGBColor in_color) |
Sets the border color for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetBorderStyle (HPS.Publish.Border.Style in_style) |
Sets the border style for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetBorderThickness (HPS.Publish.Border.Thickness in_thickness) |
Sets the border thickness for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetFillColor (HPS.RGBColor in_color) |
Sets the fill color for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetFont (HPS.Publish.Text.Font.Name in_name) |
Sets a builtin font for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetFont (string in_name, HPS.Publish.Text.Font.Style in_style) |
Sets a specific font for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetFont (string in_name) |
Sets a specific font for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetFontSize (int in_size) |
Sets the font size for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetLock (bool in_state) |
Sets whether the signature field is locked. More... | |
HPS.Publish.SignatureFieldKit | SetName (string in_name) |
Sets the name of the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetPrintability (bool in_state) |
Sets the printability for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetTextColor (HPS.RGBColor in_color) |
Sets the text color for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetTextRotation (HPS.Publish.Text.Rotation in_rotation) |
Sets the text rotation for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetTooltip (string in_tooltip) |
Sets the tooltip for the signature field. More... | |
HPS.Publish.SignatureFieldKit | SetVisibility (bool in_state) |
Sets the visibility for the signature field. More... | |
void | Show (out HPS.Publish.SignatureFieldKit out_kit) |
Copies this SignatureFieldKit into the given SignatureFieldKit. More... | |
bool | ShowBorder (out bool out_state) |
Shows the border setting for the signature field. More... | |
bool | ShowBorderColor (out HPS.RGBColor out_color) |
Shows the border color for the signature field. More... | |
bool | ShowBorderStyle (out HPS.Publish.Border.Style out_style) |
Shows the border style for the signature field. More... | |
bool | ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness) |
Shows the border thickness for the signature field. More... | |
bool | ShowFillColor (out HPS.RGBColor out_color) |
Shows the fill color for the signature field. More... | |
bool | ShowFont (out HPS.Publish.Text.Font.Type out_type, out HPS.Publish.Text.Font.Name out_name, out string out_font_name, out HPS.Publish.Text.Font.Style out_style) |
Shows the font for the signature field. More... | |
bool | ShowFontSize (out int out_size) |
Shows the font size for the signature field. More... | |
bool | ShowLock (out bool out_state) |
Shows the lock setting for the signature field. More... | |
bool | ShowName (out string out_name) |
Shows the name for the signature field. More... | |
bool | ShowPrintability (out bool out_state) |
Shows the printability for the signature field. More... | |
bool | ShowTextColor (out HPS.RGBColor out_color) |
Shows the text color for the signature field. More... | |
bool | ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation) |
Shows the text rotation for the signature field. More... | |
bool | ShowTooltip (out string out_tooltip) |
Shows the tooltip for the signature field. More... | |
bool | ShowVisibility (out bool out_state) |
Shows the visibility for the signature field. More... | |
SignatureFieldKit () | |
The default constructor creates an empty SignatureFieldKit object. More... | |
SignatureFieldKit (HPS.Publish.SignatureFieldKit in_kit) | |
The copy constructor creates a new SignatureFieldKit object that contains the same settings as the source SignatureFieldKit. More... | |
HPS.Publish.SignatureFieldKit | UnsetBorder () |
Removes the border setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetBorderColor () |
Removes the border color setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetBorderStyle () |
Removes the border style setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetBorderThickness () |
Removes the border thickness setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetEverything () |
Removes all data from the signature field. More... | |
HPS.Publish.SignatureFieldKit | UnsetFillColor () |
Removes the fill color setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetFont () |
Removes the font setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetFontSize () |
Removes the font size setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetLock () |
Removes the lock setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetName () |
Removes the name setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetPrintability () |
Removes the printability setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetTextColor () |
Removes the text color setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetTextRotation () |
Removes the text rotation setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetTooltip () |
Removes the tooltip setting. More... | |
HPS.Publish.SignatureFieldKit | UnsetVisibility () |
Removes the visibility setting. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.Publish.SignatureFieldKit | GetDefault () |
Creates a SignatureFieldKit which contains the default settings. More... | |
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 | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.Publish.SignatureFieldKit.SignatureFieldKit | ( | ) |
The default constructor creates an empty SignatureFieldKit object.
HPS.Publish.SignatureFieldKit.SignatureFieldKit | ( | HPS.Publish.SignatureFieldKit | in_kit | ) |
The copy constructor creates a new SignatureFieldKit object that contains the same settings as the source SignatureFieldKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_signature_field_kit" kindref="compound">SignatureFieldKit</ref> to copy. |
|
virtual |
Indicates whether this SignatureFieldKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Publish.SignatureFieldKit.Equals | ( | HPS.Publish.SignatureFieldKit | in_kit | ) |
Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_signature_field_kit" kindref="compound">SignatureFieldKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_signature_field_kit" kindref="compound">SignatureFieldKit</ref>. |
|
static |
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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.Publish.SignatureFieldKit.Set | ( | HPS.Publish.SignatureFieldKit | in_kit | ) |
Copies the source SignatureFieldKit into this SignatureFieldKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_signature_field_kit" kindref="compound">SignatureFieldKit</ref> to copy. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetBorder | ( | bool | in_state | ) |
Sets whether the signature field has a border.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#abadaf28f1b3cdd678be2e69ef365ae5b">A3DPDFDigitalSignatureData::m_bHasBorder</ulink>.
in_state | Whether the signature field has a border. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetBorderColor | ( | HPS.RGBColor | in_color | ) |
Sets the border color for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#a7843f39c7a4d73a8dc7b613471ce9e17">A3DPDFDigitalSignatureData::m_sBorderColor</ulink>.
in_color | The border color of the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetBorderStyle | ( | HPS.Publish.Border.Style | in_style | ) |
Sets the border style for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#a3786ac114f201d2c00f24353199ac643">A3DPDFDigitalSignatureData::m_eLineStyleBorder</ulink>.
in_style | The border style for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetBorderThickness | ( | HPS.Publish.Border.Thickness | in_thickness | ) |
Sets the border thickness for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#ad54bdb93311e12493a2753a4941cc231">A3DPDFDigitalSignatureData::m_eThicknessBorder</ulink>.
in_thickness | The border thickness for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFillColor | ( | HPS.RGBColor | in_color | ) |
Sets the fill color for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#aef88100e02a1001b0e6d6356e62cb5e3">A3DPDFDigitalSignatureData::m_sFillColor</ulink> and implicitly sets <ulink url="">A3DPDFDigitalSignatureData::m_bHasFillColor</ulink> to true.
in_color | The fill color for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFont | ( | HPS.Publish.Text.Font.Name | in_name | ) |
Sets a builtin font for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#afa2cd0f88515d0726e7c116a8704bc92">A3DPDFDigitalSignatureData::m_pcFontName</ulink>.
in_name | The builtin font for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFont | ( | string | in_name, |
HPS.Publish.Text.Font.Style | in_style | ||
) |
Sets a specific font for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#afa2cd0f88515d0726e7c116a8704bc92">A3DPDFDigitalSignatureData::m_pcFontName</ulink>.
in_name | UTF8-encoded font name for the signature field. |
in_style | The style of font to use for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFont | ( | string | in_name | ) |
Sets a specific font for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#afa2cd0f88515d0726e7c116a8704bc92">A3DPDFDigitalSignatureData::m_pcFontName</ulink>.
in_name | UTF8-encoded font name for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFontSize | ( | int | in_size | ) |
Sets the font size for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#afd1b0da01c65ea2a096f3832859781e8">A3DPDFDigitalSignatureData::m_iFontSize</ulink>.
in_size | The font size for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetLock | ( | bool | in_state | ) |
Sets whether the signature field is locked.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#af9052704838668b16253398b462b7d30">A3DPDFDigitalSignatureData::m_bIsLocked</ulink>.
in_state | Whether the signature field is locked. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetName | ( | string | in_name | ) |
Sets the name of the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#a7a508638a8d84d5e7326afdd2eb74165">A3DPDFDigitalSignatureData::m_pcName</ulink>.
in_name | UTF8-encoded name of the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetPrintability | ( | bool | in_state | ) |
Sets the printability for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#ad4b94ff3bb207077a28bb86ed0a7988f">A3DPDFDigitalSignatureData::m_eFormField</ulink>.
in_state | The printability for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetTextColor | ( | HPS.RGBColor | in_color | ) |
Sets the text color for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#ae3f0f8b50cf34d0d52e593d516d30ad1">A3DPDFDigitalSignatureData::m_sTextColor</ulink>.
in_color | The text color for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetTextRotation | ( | HPS.Publish.Text.Rotation | in_rotation | ) |
Sets the text rotation for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#a999498d09b28aed0d38aae2ad82ac127">A3DPDFDigitalSignatureData::m_eTextOrientation</ulink>.
in_rotation | The text rotation for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetTooltip | ( | string | in_tooltip | ) |
Sets the tooltip for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#a09b9f1bdf1a93bec885753651a768f31">A3DPDFDigitalSignatureData::m_pcTooltip</ulink>.
in_tooltip | UTF8-encoded tooltip text for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetVisibility | ( | bool | in_state | ) |
Sets the visibility for the signature field.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_digital_signature_data.html#ad4b94ff3bb207077a28bb86ed0a7988f">A3DPDFDigitalSignatureData::m_eFormField</ulink>.
in_state | The visibility for the signature field. |
void HPS.Publish.SignatureFieldKit.Show | ( | out HPS.Publish.SignatureFieldKit | out_kit | ) |
Copies this SignatureFieldKit into the given SignatureFieldKit.
out_kit | The <ref refid="class_h_p_s_1_1_publish_1_1_signature_field_kit" kindref="compound">SignatureFieldKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_signature_field_kit" kindref="compound">SignatureFieldKit</ref>. |
bool HPS.Publish.SignatureFieldKit.ShowBorder | ( | out bool | out_state | ) |
Shows the border setting for the signature field.
out_state | Whether the signature field has a border. |
bool HPS.Publish.SignatureFieldKit.ShowBorderColor | ( | out HPS.RGBColor | out_color | ) |
Shows the border color for the signature field.
out_color | The border color of the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowBorderStyle | ( | out HPS.Publish.Border.Style | out_style | ) |
Shows the border style for the signature field.
out_style | The border style for the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowBorderThickness | ( | out HPS.Publish.Border.Thickness | out_thickness | ) |
Shows the border thickness for the signature field.
out_thickness | The border thickness for the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowFillColor | ( | out HPS.RGBColor | out_color | ) |
Shows the fill color for the signature field.
out_color | The fill color for the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowFont | ( | out HPS.Publish.Text.Font.Type | out_type, |
out HPS.Publish.Text.Font.Name | out_name, | ||
out string | out_font_name, | ||
out HPS.Publish.Text.Font.Style | out_style | ||
) |
Shows the font for the signature field.
out_type | The type of font for the signature field. |
out_font_name | The explicit font name for the signature field. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>. |
out_style | The font style for the signature field. This is only valid if out_type is <ref refid="class_h_p_s_1_1_publish_1_1_text_1_1_font_1a68f12b037c449c0d4bd5bf6724117a01a9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Text::Font::Type::Explicit</ref>. |
bool HPS.Publish.SignatureFieldKit.ShowFontSize | ( | out int | out_size | ) |
Shows the font size for the signature field.
out_size | The font size for the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowLock | ( | out bool | out_state | ) |
Shows the lock setting for the signature field.
bool HPS.Publish.SignatureFieldKit.ShowName | ( | out string | out_name | ) |
Shows the name for the signature field.
out_name | The name of the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowPrintability | ( | out bool | out_state | ) |
Shows the printability for the signature field.
out_state | The printability for the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowTextColor | ( | out HPS.RGBColor | out_color | ) |
Shows the text color for the signature field.
out_color | The text color for the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowTextRotation | ( | out HPS.Publish.Text.Rotation | out_rotation | ) |
Shows the text rotation for the signature field.
out_rotation | The text rotation for the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowTooltip | ( | out string | out_tooltip | ) |
Shows the tooltip for the signature field.
out_tooltip | The tooltip text for the signature field. |
bool HPS.Publish.SignatureFieldKit.ShowVisibility | ( | out bool | out_state | ) |
Shows the visibility for the signature field.
out_state | The visibility for the signature field. |
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetBorder | ( | ) |
Removes the border setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetBorderColor | ( | ) |
Removes the border color setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetBorderStyle | ( | ) |
Removes the border style setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetEverything | ( | ) |
Removes all data from the signature field.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetFillColor | ( | ) |
Removes the fill color setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetFont | ( | ) |
Removes the font setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetFontSize | ( | ) |
Removes the font size setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetLock | ( | ) |
Removes the lock setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetName | ( | ) |
Removes the name setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetPrintability | ( | ) |
Removes the printability setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetTextColor | ( | ) |
Removes the text color setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetTextRotation | ( | ) |
Removes the text rotation setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetTooltip | ( | ) |
Removes the tooltip setting.
HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetVisibility | ( | ) |
Removes the visibility setting.