Class SignHelper

Inheritance

System.Object

SignHelper

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SecureExchangesSDK.Helpers

Assembly: SecureExchangesSDK.dll

Syntax

public static class SignHelper

Fields

CERTIFICATE_STRING

Declaration

public const string CERTIFICATE_STRING = "---------------Secure Exchanges certificate---------------"

Field Value

Type	Description
System.String

Methods

AddFileZoneDefToRecipientIndex(Dictionary<RecipientInfo, List<FileZoneDefinition>>, IEnumerable<SignTemplateRecipient>, String, KeyValuePair<String, RecipientInfo>[])

This method is convert, zone template to definitionzones for recipients

Declaration

public static Dictionary<RecipientInfo, List<FileZoneDefinition>> AddFileZoneDefToRecipientIndex(Dictionary<RecipientInfo, List<FileZoneDefinition>> recipientIndex, IEnumerable<SignTemplateRecipient> templateZones, string SHA512, params KeyValuePair<string, RecipientInfo>[] recipientsMatch)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<RecipientInfo, System.Collections.Generic.List<FileZoneDefinition>>	recipientIndex	Dictionnary by recipients for zones file definitions
System.Collections.Generic.IEnumerable<SignTemplateRecipient>	templateZones	The template zone we need to convert
System.String	SHA512	The SHA512 of the file
System.Collections.Generic.KeyValuePair<System.String, RecipientInfo>[]	recipientsMatch	The template match name, and the recipient associated with that name

Returns

Type	Description
System.Collections.Generic.Dictionary<RecipientInfo, System.Collections.Generic.List<FileZoneDefinition>>

ApplyPKI(ApplyPKISDKArgs)

This method is to apply a PKI on a manifest

Declaration

public static AplyPKISDKAnswer ApplyPKI(ApplyPKISDKArgs args)

Parameters

Type	Name	Description
ApplyPKISDKArgs	args

Returns

Type	Description
AplyPKISDKAnswer

ConvertRecipientIndexToList(Dictionary<RecipientInfo, List<FileZoneDefinition>>)

Take a recipient FileZoneDefinition dictionnary and transform it to a list of RecipientZoneDefinition In fact, that mean the FileZoneDefinition are grouped by Recipients for the sign process

Declaration

public static List<RecipientZoneDefinition> ConvertRecipientIndexToList(Dictionary<RecipientInfo, List<FileZoneDefinition>> recipientIndex)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<RecipientInfo, System.Collections.Generic.List<FileZoneDefinition>>	recipientIndex	The dictionnary previously build. User the AddFileZoneDefToRecipientIndex to fill your dictionnary with a template

Returns

Type	Description
System.Collections.Generic.List<RecipientZoneDefinition>	Return the list of RecipientZoneDefinition that could be use by the MultiRecipientMessage method

CreateFieldCheckBoxZone(String, Int32, String, Single, Single, Single, Single, Boolean, Boolean)

Create a checkbox field.

Declaration

public static SignZoneDetails CreateFieldCheckBoxZone(string filePath, int fieldPage, string fieldName, float fieldX, float fieldY, float fieldWidth, float fieldHeight, bool fieldChecked = false, bool fieldRequired = false)

Parameters

Type	Name	Description
System.String	filePath	PDF file path
System.Int32	fieldPage	Pdf page
System.String	fieldName	The field name
System.Single	fieldX	The field X position
System.Single	fieldY	The field Y position
System.Single	fieldWidth	The field width
System.Single	fieldHeight	The field height
System.Boolean	fieldChecked	Determine if the checkbox is checked by default
System.Boolean	fieldRequired	Determine if the checkbox is required

Returns

Type	Description
SignZoneDetails

CreateFieldDateSignZone(String, Int32, String, Single, Single, Single, Single, Single, String)

Create a signature date field.

Declaration

public static SignZoneDetails CreateFieldDateSignZone(string filePath, int fieldPage, string fieldName, float fieldX, float fieldY, float fieldWidth, float fieldHeight, float fieldFontSize, string fieldDateFormat)

Parameters

Type	Name	Description
System.String	filePath	PDF file path
System.Int32	fieldPage	Pdf page
System.String	fieldName	The field name
System.Single	fieldX	The field X position
System.Single	fieldY	The field Y position
System.Single	fieldWidth	The field width
System.Single	fieldHeight	The field height
System.Single	fieldFontSize	The field font-size
System.String	fieldDateFormat	The field date format

Returns

Type	Description
SignZoneDetails

CreateFieldDateZone(String, Int32, String, Single, Single, Single, Single, Single, String)

Create a date picker field.

Declaration

public static SignZoneDetails CreateFieldDateZone(string filePath, int fieldPage, string fieldName, float fieldX, float fieldY, float fieldWidth, float fieldHeight, float fieldFontSize, string fieldDateFormat)

Parameters

Type	Name	Description
System.String	filePath	PDF file path
System.Int32	fieldPage	Pdf page
System.String	fieldName	The field name
System.Single	fieldX	The field X position
System.Single	fieldY	The field Y position
System.Single	fieldWidth	The field width
System.Single	fieldHeight	The field height
System.Single	fieldFontSize	The field font-size
System.String	fieldDateFormat	The field date format

Returns

Type	Description
SignZoneDetails

CreateFieldInitialZone(String, Int32, String, Single, Single, Single, Single)

Create an initial field.

Declaration

public static SignZoneDetails CreateFieldInitialZone(string filePath, int fieldPage, string fieldName, float fieldX, float fieldY, float fieldWidth, float fieldHeight)

Parameters

Type	Name	Description
System.String	filePath	PDF file path
System.Int32	fieldPage	Pdf page
System.String	fieldName	The field name
System.Single	fieldX	The field X position
System.Single	fieldY	The field Y position
System.Single	fieldWidth	The field width
System.Single	fieldHeight	The field height

Returns

Type	Description
SignZoneDetails	Return the SignZoneDetails

CreateFieldNumberZone(String, Int32, String, Single, Single, Single, Single, String, Single, Boolean)

Create a number field.

Declaration

public static SignZoneDetails CreateFieldNumberZone(string filePath, int fieldPage, string fieldName, float fieldX, float fieldY, float fieldWidth, float fieldHeight, string fieldValue, float fieldFontSize, bool fieldRequired = false)

Parameters

Type	Name	Description
System.String	filePath	PDF file path
System.Int32	fieldPage	Pdf page
System.String	fieldName	The field name
System.Single	fieldX	The field X position
System.Single	fieldY	The field Y position
System.Single	fieldWidth	The field width
System.Single	fieldHeight	The field height
System.String	fieldValue	The field text value
System.Single	fieldFontSize	The field font-size
System.Boolean	fieldRequired	Determine if the text field is required

Returns

Type	Description
SignZoneDetails

CreateFieldRadioZone(String, Int32, String, Single, Single, Single, Single, String, Boolean)

Create a radio field.

Declaration

public static SignZoneDetails CreateFieldRadioZone(string filePath, int fieldPage, string fieldName, float fieldX, float fieldY, float fieldWidth, float fieldHeight, string fieldValue, bool fieldChecked = false)

Parameters

Type	Name	Description
System.String	filePath	PDF file path
System.Int32	fieldPage	Pdf page
System.String	fieldName	The field name, radios with same name gonna be the same group
System.Single	fieldX	The field X position
System.Single	fieldY	The field Y position
System.Single	fieldWidth	The field width
System.Single	fieldHeight	The field height
System.String	fieldValue	The radio field value
System.Boolean	fieldChecked	Determine if the checkbox is checked by default

Returns

Type	Description
SignZoneDetails

CreateFieldSignZone(String, Int32, String, Single, Single, Single, Single)

Create a signature field.

Declaration

public static SignZoneDetails CreateFieldSignZone(string filePath, int fieldPage, string fieldName, float fieldX, float fieldY, float fieldWidth, float fieldHeight)

Parameters

Type	Name	Description
System.String	filePath	PDF file path
System.Int32	fieldPage	Pdf page
System.String	fieldName	The field name
System.Single	fieldX	The field X position
System.Single	fieldY	The field Y position
System.Single	fieldWidth	The field width
System.Single	fieldHeight	The field height

Returns

Type	Description
SignZoneDetails	Return the SignZoneDetails

CreateFieldTextZone(String, Int32, String, Single, Single, Single, Single, String, Single, Boolean)

Create a text field.

Declaration

public static SignZoneDetails CreateFieldTextZone(string filePath, int fieldPage, string fieldName, float fieldX, float fieldY, float fieldWidth, float fieldHeight, string fieldValue, float fieldFontSize, bool fieldRequired = false)

Parameters

Type	Name	Description
System.String	filePath	PDF file path
System.Int32	fieldPage	Pdf page
System.String	fieldName	The field name
System.Single	fieldX	The field X position
System.Single	fieldY	The field Y position
System.Single	fieldWidth	The field width
System.Single	fieldHeight	The field height
System.String	fieldValue	The field text value
System.Single	fieldFontSize	The field font-size
System.Boolean	fieldRequired	Determine if the text field is required

Returns

Type	Description
SignZoneDetails

ValidateDocumentSignatureIntegrity(ValidateDocumentSignatureIntegrity_args)

VAlidate the document integrity of a signed file

Declaration

public static ValidateDocumentSignatureIntegrityResponse ValidateDocumentSignatureIntegrity(ValidateDocumentSignatureIntegrity_args args)

Parameters

Type	Name	Description
ValidateDocumentSignatureIntegrity_args	args

Returns

Type	Description
ValidateDocumentSignatureIntegrityResponse