Inheritance diagram for HPS.Publish.SignatureFieldKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.SignatureFieldKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.SignatureFieldKit in_kit)
 
HPS.Publish.SignatureFieldKit SetBorder (bool in_state)
 
HPS.Publish.SignatureFieldKit SetBorderColor (HPS.RGBColor in_color)
 
HPS.Publish.SignatureFieldKit SetBorderStyle (HPS.Publish.Border.Style in_style)
 
HPS.Publish.SignatureFieldKit SetBorderThickness (HPS.Publish.Border.Thickness in_thickness)
 
HPS.Publish.SignatureFieldKit SetFillColor (HPS.RGBColor in_color)
 
HPS.Publish.SignatureFieldKit SetFont (HPS.Publish.Text.Font.Name in_name)
 
HPS.Publish.SignatureFieldKit SetFont (string in_name, HPS.Publish.Text.Font.Style in_style)
 
HPS.Publish.SignatureFieldKit SetFont (string in_name)
 
HPS.Publish.SignatureFieldKit SetFontSize (int in_size)
 
HPS.Publish.SignatureFieldKit SetLock (bool in_state)
 
HPS.Publish.SignatureFieldKit SetName (string in_name)
 
HPS.Publish.SignatureFieldKit SetPrintability (bool in_state)
 
HPS.Publish.SignatureFieldKit SetTextColor (HPS.RGBColor in_color)
 
HPS.Publish.SignatureFieldKit SetTextRotation (HPS.Publish.Text.Rotation in_rotation)
 
HPS.Publish.SignatureFieldKit SetTooltip (string in_tooltip)
 
HPS.Publish.SignatureFieldKit SetVisibility (bool in_state)
 
void Show (out HPS.Publish.SignatureFieldKit out_kit)
 
bool ShowBorder (out bool out_state)
 
bool ShowBorderColor (out HPS.RGBColor out_color)
 
bool ShowBorderStyle (out HPS.Publish.Border.Style out_style)
 
bool ShowBorderThickness (out HPS.Publish.Border.Thickness out_thickness)
 
bool ShowFillColor (out HPS.RGBColor out_color)
 
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)
 
bool ShowFontSize (out int out_size)
 
bool ShowLock (out bool out_state)
 
bool ShowName (out string out_name)
 
bool ShowPrintability (out bool out_state)
 
bool ShowTextColor (out HPS.RGBColor out_color)
 
bool ShowTextRotation (out HPS.Publish.Text.Rotation out_rotation)
 
bool ShowTooltip (out string out_tooltip)
 
bool ShowVisibility (out bool out_state)
 
 SignatureFieldKit ()
 
 SignatureFieldKit (HPS.Publish.SignatureFieldKit in_kit)
 
HPS.Publish.SignatureFieldKit UnsetBorder ()
 
HPS.Publish.SignatureFieldKit UnsetBorderColor ()
 
HPS.Publish.SignatureFieldKit UnsetBorderStyle ()
 
HPS.Publish.SignatureFieldKit UnsetBorderThickness ()
 
HPS.Publish.SignatureFieldKit UnsetEverything ()
 
HPS.Publish.SignatureFieldKit UnsetFillColor ()
 
HPS.Publish.SignatureFieldKit UnsetFont ()
 
HPS.Publish.SignatureFieldKit UnsetFontSize ()
 
HPS.Publish.SignatureFieldKit UnsetLock ()
 
HPS.Publish.SignatureFieldKit UnsetName ()
 
HPS.Publish.SignatureFieldKit UnsetPrintability ()
 
HPS.Publish.SignatureFieldKit UnsetTextColor ()
 
HPS.Publish.SignatureFieldKit UnsetTextRotation ()
 
HPS.Publish.SignatureFieldKit UnsetTooltip ()
 
HPS.Publish.SignatureFieldKit UnsetVisibility ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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]

HPS.Publish.SignatureFieldKit.SignatureFieldKit ( )
inline

The default constructor creates an empty SignatureFieldKit object.

◆ SignatureFieldKit() [2/2]

HPS.Publish.SignatureFieldKit.SignatureFieldKit ( HPS.Publish.SignatureFieldKit  in_kit)
inline

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

Parameters
in_kitThe source SignatureFieldKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Publish.SignatureFieldKit.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()

bool HPS.Publish.SignatureFieldKit.Equals ( HPS.Publish.SignatureFieldKit  in_kit)
inline

Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit.

Parameters
in_kitThe source SignatureFieldKit to compare to this SignatureFieldKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.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()

override HPS.Type HPS.Publish.SignatureFieldKit.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()

void HPS.Publish.SignatureFieldKit.Set ( HPS.Publish.SignatureFieldKit  in_kit)
inline

Copies the source SignatureFieldKit into this SignatureFieldKit.

Parameters
in_kitThe source SignatureFieldKit to copy.

◆ SetBorder()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetBorder ( bool  in_state)
inline

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

Parameters
in_stateWhether the signature field has a border.
Returns
A reference to this SignatureFieldKit.

◆ SetBorderColor()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetBorderColor ( HPS.RGBColor  in_color)
inline

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

Parameters
in_colorThe border color of the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetBorderStyle()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetBorderStyle ( HPS.Publish.Border.Style  in_style)
inline

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

Parameters
in_styleThe border style for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetBorderThickness()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetBorderThickness ( HPS.Publish.Border.Thickness  in_thickness)
inline

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

Parameters
in_thicknessThe border thickness for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetFillColor()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFillColor ( HPS.RGBColor  in_color)
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_colorThe fill color for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetFont() [1/3]

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFont ( HPS.Publish.Text.Font.Name  in_name)
inline

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

Parameters
in_nameThe builtin font for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetFont() [2/3]

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

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

Parameters
in_nameUTF8-encoded font name for the signature field.
in_styleThe style of font to use for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetFont() [3/3]

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFont ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded font name for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetFontSize()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetFontSize ( int  in_size)
inline

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

Parameters
in_sizeThe font size for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetLock()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetLock ( bool  in_state)
inline

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

Parameters
in_stateWhether the signature field is locked.
Returns
A reference to this SignatureFieldKit.

◆ SetName()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetName ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetPrintability()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetPrintability ( bool  in_state)
inline

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

Parameters
in_stateThe printability for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetTextColor()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetTextColor ( HPS.RGBColor  in_color)
inline

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

Parameters
in_colorThe text color for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetTextRotation()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetTextRotation ( HPS.Publish.Text.Rotation  in_rotation)
inline

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

Parameters
in_rotationThe text rotation for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetTooltip()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetTooltip ( string  in_tooltip)
inline

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

Parameters
in_tooltipUTF8-encoded tooltip text for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ SetVisibility()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.SetVisibility ( bool  in_state)
inline

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

Parameters
in_stateThe visibility for the signature field.
Returns
A reference to this SignatureFieldKit.

◆ Show()

void HPS.Publish.SignatureFieldKit.Show ( out HPS.Publish.SignatureFieldKit  out_kit)
inline

Copies this SignatureFieldKit into the given SignatureFieldKit.

Parameters
out_kitThe SignatureFieldKit to populate with the contents of this SignatureFieldKit.

◆ ShowBorder()

bool HPS.Publish.SignatureFieldKit.ShowBorder ( out bool  out_state)
inline

Shows the border setting for the signature field.

Parameters
out_stateWhether the signature field has a border.
Returns
true if a border setting was specified, false otherwise.

◆ ShowBorderColor()

bool HPS.Publish.SignatureFieldKit.ShowBorderColor ( out HPS.RGBColor  out_color)
inline

Shows the border color for the signature field.

Parameters
out_colorThe border color of the signature field.
Returns
true if a border color was specified, false otherwise.

◆ ShowBorderStyle()

bool HPS.Publish.SignatureFieldKit.ShowBorderStyle ( out HPS.Publish.Border.Style  out_style)
inline

Shows the border style for the signature field.

Parameters
out_styleThe border style for the signature field.
Returns
true if a border style was specified, false otherwise.

◆ ShowBorderThickness()

bool HPS.Publish.SignatureFieldKit.ShowBorderThickness ( out HPS.Publish.Border.Thickness  out_thickness)
inline

Shows the border thickness for the signature field.

Parameters
out_thicknessThe border thickness for the signature field.
Returns
true if a border thickness was specified, false otherwise.

◆ ShowFillColor()

bool HPS.Publish.SignatureFieldKit.ShowFillColor ( out HPS.RGBColor  out_color)
inline

Shows the fill color for the signature field.

Parameters
out_colorThe fill color for the signature field.
Returns
true if a fill color was specified, false otherwise.

◆ ShowFont()

bool HPS.Publish.SignatureFieldKit.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 
)
inline

Shows the font for the signature field.

Parameters
out_typeThe type of font for the signature field.
out_fontThe built-in font for the signature field. This is only valid if out_type is Text.Font.Type.BuiltIn.
out_font_nameThe explicit font name for the signature field. This is only valid if out_type is Text.Font.Type.Explicit.
out_styleThe 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()

bool HPS.Publish.SignatureFieldKit.ShowFontSize ( out int  out_size)
inline

Shows the font size for the signature field.

Parameters
out_sizeThe font size for the signature field.
Returns
true if a font size was specified, false otherwise.

◆ ShowLock()

bool HPS.Publish.SignatureFieldKit.ShowLock ( out bool  out_state)
inline

Shows the lock setting for the signature field.

Returns
true if a lock setting was specified, false otherwise.

◆ ShowName()

bool HPS.Publish.SignatureFieldKit.ShowName ( out string  out_name)
inline

Shows the name for the signature field.

Parameters
out_nameThe name of the signature field.
Returns
true if a name was specified, false otherwise.

◆ ShowPrintability()

bool HPS.Publish.SignatureFieldKit.ShowPrintability ( out bool  out_state)
inline

Shows the printability for the signature field.

Parameters
out_stateThe printability for the signature field.
Returns
true if a printability was specified, false otherwise.

◆ ShowTextColor()

bool HPS.Publish.SignatureFieldKit.ShowTextColor ( out HPS.RGBColor  out_color)
inline

Shows the text color for the signature field.

Parameters
out_colorThe text color for the signature field.
Returns
true if a text color was specified, false otherwise.

◆ ShowTextRotation()

bool HPS.Publish.SignatureFieldKit.ShowTextRotation ( out HPS.Publish.Text.Rotation  out_rotation)
inline

Shows the text rotation for the signature field.

Parameters
out_rotationThe text rotation for the signature field.
Returns
true if a rotation was specified, false otherwise.

◆ ShowTooltip()

bool HPS.Publish.SignatureFieldKit.ShowTooltip ( out string  out_tooltip)
inline

Shows the tooltip for the signature field.

Parameters
out_tooltipThe tooltip text for the signature field.
Returns
true if a tooltip was specified, false otherwise.

◆ ShowVisibility()

bool HPS.Publish.SignatureFieldKit.ShowVisibility ( out bool  out_state)
inline

Shows the visibility for the signature field.

Parameters
out_stateThe visibility for the signature field.
Returns
true if a visibility was specified, false otherwise.

◆ UnsetBorder()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetBorder ( )
inline

Removes the border setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetBorderColor()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetBorderColor ( )
inline

Removes the border color setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetBorderStyle()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetBorderStyle ( )
inline

Removes the border style setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetBorderThickness()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetBorderThickness ( )
inline

Removes the border thickness setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetEverything()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetEverything ( )
inline

Removes all data from the signature field.

Returns
A reference to this SignatureFieldKit.

◆ UnsetFillColor()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetFillColor ( )
inline

Removes the fill color setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetFont()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetFont ( )
inline

Removes the font setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetFontSize()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetFontSize ( )
inline

Removes the font size setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetLock()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetLock ( )
inline

Removes the lock setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetName()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetName ( )
inline

Removes the name setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetPrintability()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetPrintability ( )
inline

Removes the printability setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetTextColor()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetTextColor ( )
inline

Removes the text color setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetTextRotation()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetTextRotation ( )
inline

Removes the text rotation setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetTooltip()

HPS.Publish.SignatureFieldKit HPS.Publish.SignatureFieldKit.UnsetTooltip ( )
inline

Removes the tooltip setting.

Returns
A reference to this SignatureFieldKit.

◆ UnsetVisibility()

HPS.Publish.SignatureFieldKit HPS.Publish.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