Groupdocs API References – GroupDocs.Signature.Domain

Net: Background

Mon, 01 Jan 0001 00:00:00 +0000

Background class

Represents background appearance

public class Background : ICloneable

Constructors

Name	Description
Background()	The default constructor.

Properties

Name	Description
Brush { get; set; }	Gets or sets the background brush. Value by default is null. This property expects instance of Brush objects implementations See different Brush classes
Color { get; set; }	Gets or sets the background color of signature.
Transparency { get; set; }	Gets or sets the background transparency (value from 0.0 (opaque) through 1.0 (clear)).

Methods

Name	Description
Clone()	Implement IClonable interface

Net: BarcodeSignature

Mon, 01 Jan 0001 00:00:00 +0000

BarcodeSignature class

Contains Barcode Signature properties.

public class BarcodeSignature : BaseSignature

Constructors

Name	Description
BarcodeSignature(string)	Initialize BarcodeSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

Properties

Name	Description
Content { get; }	Specifies Barcode binary data image content of type `Format`. By default this property will not be set. Use property `ReturnContent` to enable this feature.
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
EncodeType { get; }	Specifies the Barcode Encode Type.
Format { get; }	Specifies the format of Barcode signature image.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Text { get; }	Specifies text of Barcode.
Top { get; set; }	Specifies top position of signature.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone Barcode Signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Net: BarcodeType

Mon, 01 Jan 0001 00:00:00 +0000

BarcodeType class

Specifies Barcode type properties.

public sealed class BarcodeType : IEquatable<BarcodeType>

Properties

Name	Description
TypeIndex { get; }	Gets object index in a collection of supported Barcode types.
TypeName { get; }	Name of Barcode Type.

Methods

Name	Description
Equals(BarcodeType)	Determines whether the specified BarcodeType is equal to the current object.
override Equals(object)	Overridden method determines whether the specified System.Object is equal to the current System.Object.
override GetHashCode()	Overridden method serves as a hash function for a particular type.

Net: BarcodeTypes

Mon, 01 Jan 0001 00:00:00 +0000

BarcodeTypes class

Barcode Types container.

public static class BarcodeTypes

Properties

Name	Description
static AllTypes { get; }	All barcode types.

Methods

Name	Description
static Parse(string)	Returns Barcode type with pasringType name. If name of Barcode is unknown - Exception will be thrown.
static TryParse(string)	Returns Barcode type with pasringType name. If name of Barcode is unknown - no Exception will be thrown but method will return null value.

Fields

Name	Description
static readonly AustralianPost	Australian Post Barcode Type object.
static readonly AustralianPosteParcel	Australian Post eParcel Barcode Type object.
static readonly Codabar	Codabar Barcode Type object.
static readonly CodablockF	CodablockF Barcode Type object.
static readonly Code11	Code11 Barcode Type object.
static readonly Code128	Code128 Barcode Type object.
static readonly Code16K	Code16K Barcode Type object.
static readonly Code32	Code32 Barcode Type object.
static readonly Code39	Code39 Barcode Type object.
static readonly Code39FullASCII	Code39FullASCII Barcode Type object.
static readonly Code93	Code93 Barcode Type object.
static readonly Code93Standard	Code93Standard Barcode Type object.
static readonly DatabarExpanded	DatabarExpanded Barcode Type object.
static readonly DatabarExpandedStacked	DatabarExpandedStacked Barcode Type object.
static readonly DatabarLimited	DatabarLimited Barcode Type object.
static readonly DatabarOmniDirectional	DatabarOmniDirectional Barcode Type object.
static readonly DatabarStacked	DatabarStacked Barcode Type object.
static readonly DatabarStackedOmniDirectional	DatabarStackedOmniDirectional Barcode Type object.
static readonly DatabarTruncated	DatabarTruncated Barcode Type object.
static readonly DataLogic2of5	DataLogic2of5 Barcode Type object.
static readonly DeutschePostIdentcode	DeutschePostIdentcode Barcode Type object.
static readonly DeutschePostLeitcode	DeutschePostLeitcode Barcode Type object.
static readonly DotCode	DotCode Barcode Type object.
static readonly DutchKIX	DutchKIX Barcode Type object.
static readonly EAN13	EAN13 Barcode Type object.
static readonly EAN14	EAN14 Barcode Type object.
static readonly EAN8	EAN8 Barcode Type object.
static readonly GS1Aztec	GS1Aztec Barcode Type object.
static readonly GS1CodablockF	GS1CodablockF Barcode Type object.
static readonly GS1Code128	GS1 Code128 Barcode Type object.
static readonly GS1CompositeBar	GS1 Composite Barcode Type object.
static readonly GS1DotCode	GS1 DotCode Barcode Type object.
static readonly GS1MicroPdf417	GS1MicroPdf417 Barcode Type object.
static readonly HIBCCode128LIC	HIBC LIC 128 Barcode Type object.
static readonly HIBCCode128PAS	HIBC PAS 128 Barcode Type object.
static readonly HIBCCode39LIC	HIBC LIC 39 Barcode Type object.
static readonly HIBCCode39PAS	HIBC PAS 39 Barcode Type object.
static readonly IATA2of5	IATA2of5 Barcode Type object.
static readonly Interleaved2of5	Interleaved2of5 Barcode Type object.
static readonly ISBN	ISBN Barcode Type object.
static readonly ISMN	ISMN Barcode Type object.
static readonly ISSN	ISSN Barcode Type object.
static readonly ItalianPost25	ItalianPost25 Barcode Type object.
static readonly ITF14	ITF14 Barcode Type object.
static readonly ITF6	ITF6 Barcode Type object.
static readonly MacroPdf417	MacroPdf417 Barcode Type object.
static readonly Mailmark	Royal Mail 2D Mailmark Barcode Type object.
static readonly Matrix2of5	Matrix2of5 Barcode Type object.
static readonly MaxiCode	MaxiCode Barcode Type object.
static readonly MicroPdf417	MicroPdf417 Barcode Type object.
static readonly MSI	MSI Barcode Type object.
static readonly OneCode	OneCode Barcode Type object.
static readonly OPC	OPC Barcode Type object.
static readonly PatchCode	Patch Code Barcode Type object.
static readonly Pdf417	Pdf417 Barcode Type object.
static readonly Pharmacode	Pharma code Barcode Type object.
static readonly Planet	Planet Barcode Type object.
static readonly Postnet	Postnet Barcode Type object.
static readonly PZN	PZN Barcode Type object.
static readonly RM4SCC	RM4SCC Barcode Type object.
static readonly SCC14	SCC14 Barcode Type object.
static readonly SingaporePost	SingaporePost Barcode Type object.
static readonly SSCC18	SSCC18 Barcode Type object.
static readonly Standard2of5	Standard2of5 Barcode Type object.
static readonly SwissPostParcel	SwissPostParcel Barcode Type object.
static readonly UPCA	UPCA Barcode Type object.
static readonly UpcaGs1Code128Coupon	UpcaGs1Code128Coupon Barcode Type object.
static readonly UpcaGs1DatabarCoupon	UpcaGs1DatabarCoupon Barcode Type object.
static readonly UPCE	UPCE Barcode Type object.
static readonly VIN	VIN Barcode Type object.

Net: BaseSignature

Mon, 01 Jan 0001 00:00:00 +0000

BaseSignature class

Describes base class for signatures.

public abstract class BaseSignature : ICloneable

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Top { get; set; }	Specifies top position of signature.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
virtual Clone()	Clone signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Net: Border

Mon, 01 Jan 0001 00:00:00 +0000

Border class

Represents border appearance

public class Border : ICloneable, ITransparency

Constructors

Name	Description
Border()	The default constructor.

Properties

Name	Description
Color { get; set; }	Gets or sets the border color of signature.
DashStyle { get; set; }	Gets or sets the signature border style.
Transparency { get; set; }	Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).
Visible { get; set; }	Gets or sets the border visibility.
Weight { get; set; }	Gets or sets the weight of the signature border.

Methods

Name	Description
Clone()	Implement IClonable interface

Net: CertificateMetadataSignature

Mon, 01 Jan 0001 00:00:00 +0000

CertificateMetadataSignature class

Contains Certificate Metadata Signature properties.

public sealed class CertificateMetadataSignature : MetadataSignature

Constructors

Name	Description
CertificateMetadataSignature(string)	Creates Certificate Metadata Signature with predefined name and empty value.
CertificateMetadataSignature(string, object)	Creates Certificate Metadata Signature with predefined values.

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
DataEncryption { get; set; }	Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique metadata name.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies metadata value type.
Value { get; set; }	Specifies metadata object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone Metadata Signature instance.
override Clone(object)	Clone Certificate Metadata Signature instance with given value.
override Equals(object)	Overwrites Equals method to compare signature properties
GetData<T>()	Obtain object from Metadata Signature Value over deserialization.
GetData<T>(IDataEncryption)	Obtain object from Metadata Signature Text over deserialization.
override GetHashCode()	Overrides GetHashCode method
virtual ToBoolean()	Converts to boolean.
virtual ToDateTime()	Converts to DateTime.
virtual ToDateTime(IFormatProvider)	Converts to DateTime.
virtual ToDecimal()	Converts to Decimal.
virtual ToDecimal(IFormatProvider)	Converts to Decimal.
virtual ToDouble()	Converts to Double.
virtual ToDouble(IFormatProvider)	Converts to Double.
virtual ToInteger()	Converts to integer.
virtual ToSingle()	Converts to float.
virtual ToSingle(IFormatProvider)	Converts to float.
override ToString()	Converts to String with override ToString() method
virtual ToString(string)	Converts to String with specified format
override ToString(string, IFormatProvider)	Converts to String with specified format

Net: CheckboxFormFieldSignature

Mon, 01 Jan 0001 00:00:00 +0000

CheckboxFormFieldSignature class

Contains check-box input form field signature properties.

public sealed class CheckboxFormFieldSignature : FormFieldSignature

Constructors

Name	Description
CheckboxFormFieldSignature(string)	Creates CheckboxFormFieldSignature with predefined name.
CheckboxFormFieldSignature(string, bool)	Creates CheckboxFormFieldSignature with predefined name and value

Properties

Name	Description
Checked { get; set; }	Gets or sets checked value of form field check-box input.
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique form field name.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies Form field type.
Value { get; set; }	Specifies Form field data object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone FormField Signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Net: CodeTextAlignment

Mon, 01 Jan 0001 00:00:00 +0000

CodeTextAlignment enumeration

Alignment of code text for Barcodes and QR-codes.

public enum CodeTextAlignment

Values

Name	Value	Description
None	`0`	Text is not visible.
Above	`1`	Text is above the code.
Below	`2`	Text is below the code.

Net: ComboboxFormFieldSignature

Mon, 01 Jan 0001 00:00:00 +0000

ComboboxFormFieldSignature class

Contains combo-box input form field signature properties.

public sealed class ComboboxFormFieldSignature : FormFieldSignature

Constructors

Name	Description
ComboboxFormFieldSignature(string)	Creates ComboboxFormFieldSignature with predefined name.
ComboboxFormFieldSignature(string, List<string>)	Creates ComboboxFormFieldSignature with predefined name and options list.
ComboboxFormFieldSignature(string, List<string>, object)	Creates ComboboxFormFieldSignature with predefined name, options list and selected value.

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Items { get; set; }	Get or set combo-box options list.
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique form field name.
PageNumber { get; }	Specifies the page signature was found on.
Selected { get; set; }	Get or set selected value.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies Form field type.
Value { get; set; }	Specifies Form field data object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone FormField Signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Net: Corners

Mon, 01 Jan 0001 00:00:00 +0000

Corners class

Represents corners of a square graphical object.

public class Corners : ICloneable

Constructors

Name	Description
Corners()	Initializes a new instance of Corners class using zero values.
Corners(double)	Initializes a new instance of the Corners class using the supplied value for all corners.
Corners(double, double, double, double)	Initializes a new instance of the Corners class using the supplied values.

Properties

Name	Description
All { get; set; }	Gets or sets the value for all corners. Changing of any partial corner like top right makes this property equal 0;
BottomLeft { get; set; }	Gets or sets bottom left corner value.
BottomRight { get; set; }	Gets or sets bottom right corner value.
TopLeft { get; set; }	Gets or sets top left corner value.
TopRight { get; set; }	Gets or sets top right corner value.

Methods

Name	Description
Clone()	Gets a copy of this object.
override Equals(object)	Override equals method
override GetHashCode()	Overrides obtaining unique hash code value

Fields

Name	Description
static readonly Empty	Provides a Corners object with no data.

Net: DashStyle

Mon, 01 Jan 0001 00:00:00 +0000

DashStyle enumeration

Represents style of dash drawing lines on documents.

public enum DashStyle

Values

Name	Value	Description
Solid	`0`	Represent a solid line.
ShortDash	`1`	Represent a short dash line.
ShortDot	`2`	Represent a short dot line.
ShortDashDot	`3`	Represent a short dash-dot line.
ShortDashDotDot	`4`	Represent a short dash-dot-dot line.
Dot	`5`	Represent a square dot style.
Dash	`6`	Represent a dash line style.
LongDash	`7`	Represent a long dash style.
DashDot	`8`	Dash short dash.
LongDashDot	`9`	Long dash short dash.
LongDashDotDot	`10`	Long dash short dash short dash.
RoundDot	`11`	Represents a round-dot line.
SquareDot	`12`	Represents a square-dot line.
DashDotDot	`13`	Represents a dash-dot-dot line.
DashLongDash	`14`	Represents a long dash-short dash line.
DashLongDashDot	`15`	Represents a long dash-short dash-dot line.

Net: DeleteResult

Mon, 01 Jan 0001 00:00:00 +0000

DeleteResult class

Result of signature(s) deletion from the document.

public class DeleteResult : IResult

Properties

Name	Description
DestinDocumentSize { get; }	Returns updated document size.
Failed { get; }	List of signatures that were not deleted `BaseSignature`.
ProcessingTime { get; }	Returns the execution time of the process in milliseconds.
SourceDocumentSize { get; }	Returns source document size.
Succeeded { get; }	List of successfully deleted signatures `BaseSignature`.
TotalSignatures { get; }	Returns the total processed signatures.

Net: DigitalFormFieldSignature

Mon, 01 Jan 0001 00:00:00 +0000

DigitalFormFieldSignature class

Contains digital signature input form field properties for Pdf Documents.

public sealed class DigitalFormFieldSignature : FormFieldSignature

Constructors

Name	Description
DigitalFormFieldSignature(string)	Creates PdfDigitalFormFieldSignature with predefined name.

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique form field name.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Signed { get; }	Read-only property that shows if Form-field Signature was signed with digital certificate.
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies Form field type.
Value { get; set; }	Specifies Form field data object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone FormField Signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Net: DigitalSignature

Mon, 01 Jan 0001 00:00:00 +0000

DigitalSignature class

Contains Digital signature properties.

public class DigitalSignature : BaseSignature

Constructors

Name	Description
DigitalSignature()	Initialize Digital signature with default parameters.
DigitalSignature(string)	Initialize Digital signature with known SignatureId.
DigitalSignature(X509Certificate2)	Create Digital signature with specified certificate.
DigitalSignature(X509Store)	Create Digital signature based on specified X509 store. First certificate from specified store will be used.
DigitalSignature(X509Store, int)	Create Digital signature based on specified X509 Store and index of certificate.

Properties

Name	Description
Certificate { get; set; }	Gets or sets the X509 certificate.
CertificateCustomStoreName { get; set; }	Specifies the custom store name of the certificate.
CertificateStoreLocation { get; set; }	Specifies the store location of the certificate
CertificateStoreName { get; set; }	Specifies the store name of the certificate.
Comments { get; set; }	Gets or sets the signing purpose comment.
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
IsValid { get; set; }	Keeps true if this digital signature is valid and the document has not been tampered with.
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
SignTime { get; set; }	Gets or sets the time the document was signed.
Thumbprint { get; }	Gets the thumbprint of a certificate.
Top { get; set; }	Specifies top position of signature.
Width { get; set; }	Specifies width of signature.
XAdESType { get; }	XAdES type `XAdESType`. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents.

Methods

Name	Description
override Clone()	Clone Barcode Signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method
static LoadDigitalSignatures()	Load Digital signatures from all system X509 Certificates Stores.
static LoadDigitalSignatures(StoreName)	Load Digital signatures from a certificate storage.
static LoadDigitalSignatures(string)	Load Digital signatures from a certificate storage.
static LoadDigitalSignatures(StoreName, StoreLocation)	Load Digital signatures from a digital certificate storage placed in specific location.
static LoadDigitalSignatures(string, StoreLocation)	Load Digital signatures from a digital certificate storage placed in specific location.

Net: DocumentInfo

Mon, 01 Jan 0001 00:00:00 +0000

DocumentInfo class

Defines document description properties.

public class DocumentInfo : IDocumentInfo

Constructors

Name	Description
DocumentInfo()	Initializes a new instance of the `DocumentInfo` class.

Properties

Name	Description
BarcodeSignatures { get; }	Collection of document barcode signatures added or updated by `Signature` methods.
DigitalSignatures { get; }	Collection of document digital signatures added or updated by `Signature` methods.
Documents { get; }	Collection of all existing documents within the archive files. This property is supported only for Archive document types.
FileType { get; set; }	File format type.
FormFields { get; }	Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.
FormFieldSignatures { get; }	Collection of document Form Field signatures added or updated by `Signature` methods.
ImageSignatures { get; }	Collection of document image signatures added or updated by `Signature` methods.
MaxPageHeight { get; set; }	Specifies max page height.
MetadataSignatures { get; }	Collection of document Metadata signatures.
PageCount { get; set; }	Document pages count.
Pages { get; set; }	Collection of document pages descriptions.
ProcessLogs { get; }	Collection of document history processes like Sign, Update, Delete.
QrCodeSignatures { get; }	Collection of document QR-code signatures added or updated by `Signature` methods.
Signatures { get; }	Collection of document all types signatures `BaseSignature`.
Size { get; set; }	Document size in bytes.
TextSignatures { get; }	Collection of document text signatures.
WidthForMaxHeight { get; set; }	Specifies width for max page height.

Net: DocumentResultSignature

Mon, 01 Jan 0001 00:00:00 +0000

DocumentResultSignature class

Result of processing archive document signing process for document with newly created signatures.

public class DocumentResultSignature : BaseSignature, IResult

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
DestinDocumentSize { get; }	Returns destination document size
ErrorMessage { get; }	if document was processed with error this property will contain the error message
Failed { get; }	List of the signatures that failed during the process `BaseSignature`.
FileName { get; }	Document file name
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
PageNumber { get; }	Specifies the page signature was found on.
ProcessingTime { get; }	Returns the execution time of the process in milliseconds
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
SourceDocumentSize { get; }	Returns source document size
Succeeded { get; }	List of successfully processed signatures `BaseSignature`.
Top { get; set; }	Specifies top position of signature.
TotalSignatures { get; }	Returns the total processed signatures
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
virtual Clone()	Clone signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Remarks

Learn more

More about signing documents withing archives using GroupDocs.Signature: How to sign documents withing archives using C#

Net: DocumentType

Mon, 01 Jan 0001 00:00:00 +0000

DocumentType enumeration

Defines the Document type.

public enum DocumentType

Values

Name	Value	Description
Unknown	`0`	Indicates an error, unknown document type.
Pdf	`1`	PDF Document Type.
WordProcessing	`2`	Word Processing Document Type.
Presentation	`3`	Presentation Document Type.
Spreadsheet	`4`	Spreadsheet Document Type.
Image	`5`	Image Document Type.
Certificate	`6`	Certificate file Type.
Archive	`7`	Archive file type

Net: FileType

Mon, 01 Jan 0001 00:00:00 +0000

FileType class

Represents file type.

public sealed class FileType : IEquatable<FileType>

Properties

Name	Description
Extension { get; }	Filename suffix (including the period “.”) e.g. “.doc”.
FileFormat { get; }	File type name e.g. “Microsoft Word Document”.

Methods

Name	Description
static FromExtension(string)	Maps file extension to file type.
Equals(FileType)	Determines whether the current `FileType` is the same as specified `FileType` object.
override Equals(object)	Determines whether the current `FileType` is the same as specified object.
override GetHashCode()	Returns the hash code for the current `FileType` object.
override ToString()	Returns a string that represents the current object.
static GetSupportedFileTypes()	Retrieves supported file types
operator ==	Determines whether two `FileType` objects are the same.
operator !=	Determines whether two `FileType` objects are not the same.

Fields

Name	Description
static readonly APNG	Animated Portable Network Graphics (.png) is a raster image file format that uses lossless compression. It was developed as an extension of PNG to support animation, serving as an alternative to the GIF format without copyright limitations. Learn more about this file format here.
static readonly AZW3	WordPerfect Document (.wpd)
static readonly BMP	Bitmap Image File (.bmp) is used to store bitmap digital images. These images are independent of graphics adapter and are also called device independent bitmap (DIB) file format. Learn more about this file format here.
static readonly CDR	CorelDraw Vector Graphic Drawing (.cdr) is a vector drawing image file that is natively created with CorelDRAW for storing digital image encoded and compressed. Such a drawing file contains text, lines, shapes, images, colours and effects for vector representation of image contents. Learn more about this file format here.
static readonly CGM	Computer Graphics Metafile (.cgm) is a free, platform-independent, international standard metafile format for storing and exchanging of vector graphics (2D), raster graphics, and text. CGM uses object-oriented approach and many function provisions for image production. Learn more about this file format here.
static readonly CMX	CorelDRAW Metafile Exchange Image File (.cmx)
static readonly CSV	Comma Separated Values File (.csv) represents plain text files that contain records of data with comma separated values. Learn more about this file format here.
static readonly DCM	DICOM Image (.dcm) represents digital image which stores medical information of patients such as MRIs, CT scans and ultrasound images. Learn more about this file format here.
static readonly DJVU	DjVu Image (.djvu) is a graphics file format intended for scanned documents and books especially those which contain the combination of text, drawings, images and photographs. Learn more about this file format here.
static readonly DOC	Microsoft Word Document (.doc) represents documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format here.
static readonly DOCM	Word Open XML Macro-Enabled Document (.docm) is a Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format here.
static readonly DOCX	Microsoft Word Open XML Document (.docx) is a well-known format for Microsoft Word documents. Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from plain binary to a combination of XML and binary files. Learn more about this file format here.
static readonly DOT	Word Document Template (.dot) are template files created by Microsoft Word to have preformatted settings for generation of further DOC or DOCX files. Learn more about this file format here.
static readonly DOTM	Word Open XML Macro-Enabled Document Template (.dotm) represents template file created with Microsoft Word 2007 or higher. Learn more about this file format here.
static readonly DOTX	Word Open XML Document Template (.dotx) are template files created by Microsoft Word to have preformatted settings for generation of further DOCX files. Learn more about this file format here.
static readonly EMF	Enhanced Windows Metafile (.emf) represents graphical images device-independently. Meta-files of EMF comprises of variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format here.
static readonly EPS	Encapsulated PostScript File (.eps) describes an Encapsulated PostScript language program that describes the appearance of a single page. Learn more about this file format here.
static readonly GIF	Graphical Interchange Format File (.gif) is a type of highly compressed image. For each image GIF typically allow up to 8 bits per pixel and up to 256 colours are allowed across the image. Learn more about this file format here.
static readonly GZip	GZip compressed archive (.gz) compressing files with a high compression ratio. Learn more about this file format here.
static readonly JPEG	JPEG Image (.jpeg) is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format here.
static readonly JPG	JPEG Image (.jpg) is a type of image format that is saved using the method of lossy compression. The output image, as result of compression, is a trade-off between storage size and image quality. Learn more about this file format here.
static readonly LZip	LZip compressed archive (.lz) compressing files with a high compression ratio. Learn more about this file format here.
static readonly ODG	OpenDocument Graphic File (.odg) is used by Apache OpenOffice’s Draw application to store drawing elements as a vector image. Learn more about this file format here.
static readonly ODP	OpenDocument Presentation (.odp) represents presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format here.
static readonly ODS	OpenDocument Spreadsheet (.ods) stands for OpenDocument Spreadsheet Document format that are editable by user. Data is stored inside ODF file into rows and columns. Learn more about this file format here.
static readonly ODT	OpenDocument Text Document (.odt) are type of documents created with word processing applications that are based on OpenDocument Text File format. Learn more about this file format here.
static readonly OTP	OpenDocument Presentation Template (.otp) represents presentation template files created by applications in OASIS OpenDocument standard format. Learn more about this file format here.
static readonly OTS	OpenDocument Spreadsheet Template (.ots)
static readonly OTT	OpenDocument Document Template (.ott) represents template documents generated by applications in compliance with the OASIS’ OpenDocument standard format. Learn more about this file format here.
static readonly PCL	Printer Command Language Document (.pcl)
static readonly PDF	Portable Document Format File (.pdf) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System. Learn more about this file format here.
static readonly PFX	Personal Information Exchange (.pfx) file password protected file certificate commonly used for code signing your application. Learn more about this file format here.
static readonly PNG	Portable Network Graphic (.png) is a type of raster image file format that use lossless compression. This file format was created as a replacement of Graphics Interchange Format (GIF) and has no copyright limitations. Learn more about this file format here.
static readonly POT	PowerPoint Template (.pot) represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format here.
static readonly POTM	PowerPoint Open XML Macro-Enabled Presentation Template (.potm) are Microsoft PowerPoint template files with support for Macros. POTM files are created with PowerPoint 2007 or above and contains default settings that can be used to create further presentation files. Learn more about this file format here.
static readonly POTX	PowerPoint Open XML Presentation Template (.potx) represents Microsoft PowerPoint template presentations that are created with Microsoft PowerPoint 2007 and above. Learn more about this file format here.
static readonly PPS	PowerPoint Slide Show (.pps) are created using Microsoft PowerPoint for Slide Show purpose. PPS file reading and creation is supported by Microsoft PowerPoint 97-2003. Learn more about this file format here.
static readonly PPSM	PowerPoint Open XML Macro-Enabled Slide (.ppsm) represents Macro-enabled Slide Show file format created with Microsoft PowerPoint 2007 or higher. Learn more about this file format here.
static readonly PPSX	PowerPoint Open XML Slide Show (.ppsx) files are created using Microsoft PowerPoint 2007 and above for Slide Show purpose. Learn more about this file format here.
static readonly PPT	PowerPoint Presentation (.ppt) represents PowerPoint file that consists of a collection of slides for displaying as SlideShow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. Learn more about this file format here.
static readonly PPTM	PowerPoint Open XML Macro-Enabled Presentation are Macro-enabled Presentation files that are created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format here.
static readonly PPTX	PowerPoint Open XML Presentation (.pptx) are presentation files created with popular Microsoft PowerPoint application. Unlike the previous version of presentation file format PPT which was binary, the PPTX format is based on the Microsoft PowerPoint open XML presentation file format. Learn more about this file format here.
static readonly PS	PostScript File (.ps)
static readonly PSD	Adobe Photoshop Document (.psd) represents Adobe Photoshop’s native file format used for graphics designing and development. Learn more about this file format here.
static readonly RTF	Rich Text Format File (.rtf) represents a method of encoding formatted text and graphics for use within applications. Learn more about this file format here.
static readonly SevenZip	High compressed archive (.7z) compressing files and folders with a high compression ratio. Learn more about this file format here.
static readonly SVG	Scalable Vector Graphics File (.svg) is a Scalar Vector Graphics file that uses XML based text format for describing the appearance of an image. Learn more about this file format here.
static readonly TAR	Unix-based utility for collecting one or more files (.tar) is a archive that can hold one or more files or directories. Learn more about this file format here.
static readonly TGA	Truevision TGA (.tga), also known as TARGA, is a raster image file format developed by Truevision Inc. It supports various color depths and optional RLE compression. TGA files are commonly used in video games, animation pipelines, and graphics applications for high-quality image rendering with optional alpha channel support. Learn more about this file format here.
static readonly TIF	Tagged Image File (.tif) represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format here.
static readonly TIFF	Tagged Image File Format (.tiff) represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color and full-color image data in several color spaces. Learn more about this file format here.
static readonly TSV	Tab Separated Values File (.tsv) represents data separated with tabs in plain text format. Learn more about this file format here.
static readonly TXT	Plain Text File (.txt) represents a text document that contains plain text in the form of lines. Learn more about this file format here.
static readonly Unknown	Represents unknown file type.
static readonly VCF	vCard File (.vcf) is a digital file format for storing contact information. The format is widely used for data interchange among popular information exchange applications. Learn more about this file format here.
static readonly WEBP	WebP Image (.webp) is a modern raster web image file format that is based on lossless and lossy compression. It provides same image quality while considerably reducing the image size. Learn more about this file format here.
static readonly WMF	Windows Metafile (.wmf) represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format images data. Learn more about this file format here.
static readonly WPD	WordPerfect Document (.wpd)
static readonly XLS	Excel Spreadsheet (.xls) represents Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format here.
static readonly XLSB	Excel Binary Spreadsheet (.xlsb) specifies the Excel Binary File Format, which is a collection of records and structures that specify Excel workbook content. Learn more about this file format here.
static readonly XLSM	Excel Open XML Macro-Enabled Spreadsheet (.xlsm) is a type of Spreadsheet files that support macros. Learn more about this file format here.
static readonly XLSX	Microsoft Excel Open XML Spreadsheet (.xlsx) is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Learn more about this file format here.
static readonly XLT	Excel binary Template (.xlt) represents Excel Template File Format. Learn more about this file format here.
static readonly XLTM	Excel Office OpenXML file Template (.xltm) represents Excel Template File Format. Learn more about this file format here.
static readonly ZIP	Document ZIP archive (.zip) is an archive file format that supports lossless data compression. Can hold one or more files or directories. Learn more about this file format here.

Remarks

Learn more

More about file types supported by GroupDocs.Signature: Document formats supported by GroupDocs.Signature
More about how to get supported formats list in C#: How to get supported file formats in C# code

Net: FormFieldSignature

Mon, 01 Jan 0001 00:00:00 +0000

FormFieldSignature class

Contains Form field signature properties.

public abstract class FormFieldSignature : BaseSignature

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique form field name.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies Form field type.
Value { get; set; }	Specifies Form field data object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone FormField Signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Net: FormFieldType

Mon, 01 Jan 0001 00:00:00 +0000

FormFieldType enumeration

Specifies Form Field type.

public enum FormFieldType

Values

Name	Value	Description
Text	`0`	Simple text input.
Checkbox	`1`	Check-box.
Combobox	`2`	Combo-box
DigitalSignature	`3`	Digital signature area.
Radio	`4`	Radio-button

Net: FormTextFieldType

Mon, 01 Jan 0001 00:00:00 +0000

FormTextFieldType enumeration

Defines types of text for WordsProcessing document form fields.

public enum FormTextFieldType

Values

Name	Value	Description
AllTextTypes	`0`	Form field with any type.
PlainText	`1`	Form field with plain text type.
RichText	`2`	Form field with rich text type.

Net: HashAlgorithm

Mon, 01 Jan 0001 00:00:00 +0000

HashAlgorithm enumeration

Specifies the hash algorithm used for cryptographic signing.

public enum HashAlgorithm

Values

Name	Value	Description
Auto	`0`	Automatically selects the hash algorithm based on context.
Sha1	`1`	The SHA-1 hash algorithm, producing a 160-bit hash value.
Sha256	`2`	The SHA-256 hash algorithm, producing a 256-bit hash value.
Sha384	`3`	The SHA-384 hash algorithm, producing a 384-bit hash value.
Sha512	`4`	The SHA-512 hash algorithm, producing a 512-bit hash value.

Net: HorizontalAlignment

Mon, 01 Jan 0001 00:00:00 +0000

HorizontalAlignment enumeration

Specifies horizontal alignment of element on a document page.

public enum HorizontalAlignment

Values

Name	Value	Description
None	`0`	The object is explicitly positioned, usually using its Left property.
Left	`1`	Specifies that the object shall be left aligned to the horizontal alignment base.
Center	`2`	Specifies that the object shall be centered with respect to the horizontal alignment base.
Right	`3`	Specifies that the object shall be right aligned to the horizontal alignment base.

Net: IAlignment

Mon, 01 Jan 0001 00:00:00 +0000

IAlignment interface

Describes signature area alignment on a document page.

public interface IAlignment

Properties

Name	Description
HorizontalAlignment { get; set; }	Horizontal alignment of Image on a document page.
Margin { get; set; }	Gets the space that is specified by default between Image and Document edges (works if horizontal or vertical alignment is specified).
MarginMeasureType { get; set; }	Margin measurement type (pixels, percents or millimeters).
VerticalAlignment { get; set; }	Vertical alignment of Image on a document page.

Net: IDocumentInfo

Mon, 01 Jan 0001 00:00:00 +0000

IDocumentInfo interface

Defines document description properties.

public interface IDocumentInfo

Properties

Name	Description
BarcodeSignatures { get; }	Collection of document barcode signatures added or updated by `Signature` methods.
DigitalSignatures { get; }	Collection of document digital signatures added or updated by `Signature` methods.
Documents { get; }	Collection of all existing documents within the archive files. This property is supported only for Archive document types.
FileType { get; set; }	File format type
FormFields { get; }	Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.
FormFieldSignatures { get; }	Collection of document Form Field signatures added or updated by `Signature` methods.
ImageSignatures { get; }	Collection of document image signatures added or updated by `Signature` methods.
MaxPageHeight { get; set; }	Specifies max page height.
MetadataSignatures { get; }	Collection of document Metadata signatures.
PageCount { get; set; }	Document pages count.
Pages { get; set; }	Collection of document pages descriptions.
ProcessLogs { get; }	Collection of document history process logs.
QrCodeSignatures { get; }	Collection of document QR-code signatures added or updated by `Signature` methods.
Signatures { get; }	Collection of document all types signatures `BaseSignature`.
Size { get; set; }	Document size in bytes.
TextSignatures { get; }	Collection of document text signatures added or updated by `Signature` methods.
WidthForMaxHeight { get; set; }	Specifies width for max page height.

Net: IRectangle

Mon, 01 Jan 0001 00:00:00 +0000

IRectangle interface

Defines interface properties for signature area on a document page.

public interface IRectangle

Properties

Name	Description
Height { get; set; }	Height of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` SizeMeasureType).
Left { get; set; }	Left X position of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` LocationMeasureType).
LocationMeasureType { get; set; }	Measure type (pixels, percents or millimeters) for Left and Top properties.
SizeMeasureType { get; set; }	Measure type (pixels, percents or millimeters) for Width and Height properties.
Stretch { get; set; }	Stretch mode on Document Page.
Top { get; set; }	Top Y Position of Signature area on Document Page in Measure units (pixels, percents or millimeters see `MeasureType` LocationMeasureType).
Width { get; set; }	Width of Signature area on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType).

Net: IResult

Mon, 01 Jan 0001 00:00:00 +0000

IResult interface

Common interface for signature process result.

public interface IResult

Properties

Name	Description
DestinDocumentSize { get; }	Returns destination document size
Failed { get; }	List of signatures that were not processed `BaseSignature`.
ProcessingTime { get; }	Returns the execution time of the process in milliseconds
SourceDocumentSize { get; }	Returns source document size
Succeeded { get; }	List of successfully processed signatures `BaseSignature`.
TotalSignatures { get; }	Returns the total processed signatures

Net: IRotation

Mon, 01 Jan 0001 00:00:00 +0000

IRotation interface

Defines properties for signature rotation.

public interface IRotation

Properties

Name	Description
RotationAngle { get; set; }	Rotation angle clockwise.

Net: ITextAlignment

Mon, 01 Jan 0001 00:00:00 +0000

ITextAlignment interface

Defines alignment properties for text on text signatures.

public interface ITextAlignment

Properties

Name	Description
TextHorizontalAlignment { get; set; }	Horizontal alignment of text inside a signature.
TextVerticalAlignment { get; set; }	Vertical alignment of text inside a signature.

Net: ITransparency

Mon, 01 Jan 0001 00:00:00 +0000

ITransparency interface

Define Transparency property for different objects appearances

public interface ITransparency

Properties

Name	Description
Transparency { get; set; }	Gets or sets a value to indicate the object Transparency. The value is from 0.0 to 1.0. By default the value is 0

Net: ImageMetadataSignature

Mon, 01 Jan 0001 00:00:00 +0000

ImageMetadataSignature class

Contains Image Metadata signature properties.

public sealed class ImageMetadataSignature : MetadataSignature

Constructors

Name	Description
ImageMetadataSignature(ushort, object)	Creates Image Metadata Signature with Id and value

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
DataEncryption { get; set; }	Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Description { get; }	Read-only value to get description for standard Image Metadata signature
Height { get; set; }	Specifies height of signature.
Id { get; set; }	The identifier of Image Metadata signature. See ImageMetadataSignatures class that contains standard Signature with predefined Id value.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique metadata name.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Size { get; }	Read-only value to get size of Metadata value
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies metadata value type.
Value { get; set; }	Specifies metadata object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone Metadata Signature instance.
override Clone(object)	Clone Image Metadata Signature instance with given value.
override Equals(object)	Overwrites Equals method to compare signature properties
GetData<T>()	Obtain object from Metadata Signature Value over deserialization.
GetData<T>(IDataEncryption)	Obtain object from Metadata Signature Text over deserialization.
override GetHashCode()	Overrides GetHashCode method
override ToBoolean()	Converts to boolean.
override ToDateTime()	Converts to DateTime.
override ToDateTime(IFormatProvider)	Converts to DateTime.
override ToDecimal()	Converts to Decimal.
override ToDecimal(IFormatProvider)	Converts to Decimal.
override ToDouble()	Converts to Double.
override ToDouble(IFormatProvider)	Converts to Double.
override ToInteger()	Converts to integer.
ToLong()	Converts to long.
override ToSingle()	Converts to float.
override ToSingle(IFormatProvider)	Converts to float.
override ToString()	Converts to String with override ToString() method
override ToString(string)	Converts to String with specified format
override ToString(string, IFormatProvider)	Converts to String with specified format

Net: ImageSaveFileFormat

Mon, 01 Jan 0001 00:00:00 +0000

ImageSaveFileFormat enumeration

Defines different save file formats.

public enum ImageSaveFileFormat

Values

Name	Value	Description
Default	`0`	File Format will not be changed.
Bmp	`1`	Saves the document in the Bmp format.
Gif	`2`	Saves the document in the Gif format.
Jpg	`3`	Saves the document in the Jpg format.
Png	`4`	Saves the document in the Png format.
Psd	`5`	Saves the document in the Psd format.
Svg	`6`	Saves the document in the Svg format.
Tiff	`7`	Saves the document in the Tiff format.
Webp	`8`	Saves the document in the Webp format.
Pdf	`9`	Saves the document to the Pdf format.

Net: ImageSignature

Mon, 01 Jan 0001 00:00:00 +0000

ImageSignature class

Contains Image signature properties.

public class ImageSignature : BaseSignature

Constructors

Name	Description
ImageSignature(string)	Initialize ImageSignature object with signature identifier that was obtained after search process. This unique identifier is used to find additional properties for this signature from document signature information layer.

Properties

Name	Description
Content { get; }	Specifies image binary data content of type `Format`. By default this property will not be set. Use property `ReturnContent` to enable this feature.
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Format { get; }	Specifies the format of signature image.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Size { get; }	Specifies the size in bytes of signature image.
Top { get; set; }	Specifies top position of signature.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone Barcode Signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Net: MeasureType

Mon, 01 Jan 0001 00:00:00 +0000

MeasureType enumeration

Specifies measure units of signature on a document page.

public enum MeasureType

Values

Name	Value	Description
Pixels	`0`	Pixels.
Percents	`1`	Percents of page size.
Millimeters	`2`	Millimeters.

Net: MetadataSignature

Mon, 01 Jan 0001 00:00:00 +0000

MetadataSignature class

Contains Metadata signature properties.

public abstract class MetadataSignature : BaseSignature

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
DataEncryption { get; set; }	Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique metadata name.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies metadata value type.
Value { get; set; }	Specifies metadata object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone Metadata Signature instance.
virtual Clone(object)	Clone Metadata Signature instance with given value.
override Equals(object)	Overwrites Equals method to compare signature properties
GetData<T>()	Obtain object from Metadata Signature Value over deserialization.
GetData<T>(IDataEncryption)	Obtain object from Metadata Signature Text over deserialization.
override GetHashCode()	Overrides GetHashCode method
virtual ToBoolean()	Converts to boolean.
virtual ToDateTime()	Converts to DateTime.
virtual ToDateTime(IFormatProvider)	Converts to DateTime.
virtual ToDecimal()	Converts to Decimal.
virtual ToDecimal(IFormatProvider)	Converts to Decimal.
virtual ToDouble()	Converts to Double.
virtual ToDouble(IFormatProvider)	Converts to Double.
virtual ToInteger()	Converts to integer.
virtual ToSingle()	Converts to float.
virtual ToSingle(IFormatProvider)	Converts to float.
override ToString()	Converts to String with override ToString() method
virtual ToString(string)	Converts to String with specified format
virtual ToString(string, IFormatProvider)	Converts to String with specified format

Net: MetadataSignatureCollection

Mon, 01 Jan 0001 00:00:00 +0000

MetadataSignatureCollection class

Collection of Metadata signature objects.

public class MetadataSignatureCollection : ICloneable, IEnumerable<MetadataSignature>

Constructors

Name	Description
MetadataSignatureCollection()	Creates Collection of Metadata signature.

Properties

Name	Description
Count { get; }	Gets number of items in the collection.
Item { get; }	Returns a MetadataSignature object by the name of the property. (2 indexers)

Methods

Name	Description
Add(MetadataSignature)	Add Metadata Signature object to collection.
AddRange(IEnumerable<MetadataSignature>)	Add Metadata Signature collection.
Clear()	Removes all items from the collection.
Clone()	Clone Metadata Signature Collection class with Metadata Signature Items.
Contains(string)	Returns true if a Metadata with the specified name exists in the collection.
GetEnumerator()	Returns enumerator.
IndexOf(string)	Gets the index of a property by name.
Remove(string)	Removes a Metadata Signature with the specified name from the collection.
RemoveAt(int)	Removes a Metadata Signature at the specified index.

Net: MetadataType

Mon, 01 Jan 0001 00:00:00 +0000

MetadataType enumeration

Specifies the supported Metadata signature data type of the value.

public enum MetadataType

Values

Name	Value	Description
Undefined	`0`	Value type is undefined.
Boolean	`1`	Value is Boolean type.
Integer	`2`	Value is integer type.
Double	`3`	Value is Double type.
DateTime	`4`	Value is DateTime type.
String	`5`	Value is string type.

Net: Padding

Mon, 01 Jan 0001 00:00:00 +0000

Padding class

Represents padding or margin information associated with element.

public class Padding : ICloneable

Constructors

Name	Description
Padding()	Initializes a new instance of Padding class using zero values.
Padding(int)	Initializes a new instance of the Padding class using the supplied padding size for all edges.
Padding(int, int, int, int)	Initializes a new instance of the Padding class using the supplied padding sizes.

Properties

Name	Description
All { get; set; }	Gets or sets the padding value for all the edges. Changing of any partial edge like left or top makes this property equal 0;
Bottom { get; set; }	Gets or sets the padding value for the bottom edge.
Horizontal { get; }	Gets the combined padding for the right and left edges.
Left { get; set; }	Gets or sets the padding value for the left edge.
Right { get; set; }	Gets or sets the padding value for the right edge.
Top { get; set; }	Gets or sets the padding value for the top edge.
Vertical { get; }	Gets the combined padding for the top and bottom edges.

Methods

Name	Description
Clone()	Gets a copy of this object.

Fields

Name	Description
static readonly Empty	Provides a Padding object with no padding.

Net: PageInfo

Mon, 01 Jan 0001 00:00:00 +0000

PageInfo class

Document page description class

public class PageInfo

Constructors

Name	Description
PageInfo()	The default constructor.

Properties

Name	Description
Height { get; set; }	Specifies page height
PageNumber { get; set; }	Specifies page number
Width { get; set; }	Specifies page width

Net: PdfDigitalSignature

Mon, 01 Jan 0001 00:00:00 +0000

PdfDigitalSignature class

Contains Pdf Digital signature properties.

public class PdfDigitalSignature : DigitalSignature

Constructors

Name	Description
PdfDigitalSignature()	Initialize Pdf Digital Signature with no certificate.
PdfDigitalSignature(X509Certificate2)	Create Pdf Digital signature with specified certificate.
PdfDigitalSignature(X509Store)	Initialize Pdf Digital Signature based on specified X509 store. First certificate from specified store will be used.
PdfDigitalSignature(X509Store, int)	Create Pdf Digital signature based on specified X509 Store and index of certificate.

Properties

Name	Description
Certificate { get; set; }	Gets or sets the X509 certificate.
CertificateCustomStoreName { get; set; }	Specifies the custom store name of the certificate.
CertificateStoreLocation { get; set; }	Specifies the store location of the certificate
CertificateStoreName { get; set; }	Specifies the store name of the certificate.
Comments { get; set; }	Gets or sets the signing purpose comment.
ContactInfo { get; set; }	Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number.
CreatedOn { get; set; }	Get or set the signature creation date.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
IsValid { get; set; }	Keeps true if this digital signature is valid and the document has not been tampered with.
Left { get; set; }	Specifies left position of signature.
Location { get; set; }	The CPU host name or physical location of the signing.
ModifiedOn { get; set; }	Get or set the signature modification date.
PageNumber { get; }	Specifies the page signature was found on.
Reason { get; set; }	The reason for the signing, such as (I agreeРІР‚В¦).
ShowProperties { get; set; }	Force to show/hide signature properties. In case ShowProperties is true signature field has predefined format of appearance Digitally signed by {`ContactInfo`} Date: {Date} Reason: {`Reason`} Location: {`Location`} ShowProperties is true by default.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
SignTime { get; set; }	Gets or sets the time the document was signed.
Thumbprint { get; }	Gets the thumbprint of a certificate.
TimeStamp { get; set; }	Time stamp for Pdf digital signature. Default value is null.
Top { get; set; }	Specifies top position of signature.
Type { get; set; }	Type of Pdf digital signature.
Width { get; set; }	Specifies width of signature.
XAdESType { get; }	XAdES type `XAdESType`. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents.

Methods

Name	Description
override Clone()	Clone Barcode Signature instance.
override Equals(object)	Overwrites Equals method to compare signature properties
override GetHashCode()	Overrides GetHashCode method

Net: PdfDigitalSignatureType

Mon, 01 Jan 0001 00:00:00 +0000

PdfDigitalSignatureType enumeration

Describes enumeration of PDF digital signature type.

public enum PdfDigitalSignatureType

Values

Name	Value	Description
Signature	`0`	Digital signature.
Certificate	`1`	Digital certificate. Each document could be certified only once.

Net: PdfMetadataSignature

Mon, 01 Jan 0001 00:00:00 +0000

PdfMetadataSignature class

Contains Pdf Metadata signature properties.

public sealed class PdfMetadataSignature : MetadataSignature

Constructors

Name	Description
PdfMetadataSignature(string)	Creates Pdf Metadata signature with predefined name and empty value
PdfMetadataSignature(string, object)	Creates Pdf Metadata signature with predefined values
PdfMetadataSignature(string, object, string)	Creates Pdf Metadata signature with predefined values

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
DataEncryption { get; set; }	Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique metadata name.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
TagPrefix { get; set; }	The prefix tag of Pdf Metadata signature name. By default this property is set to “xmp”. Possible values are
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies metadata value type.
Value { get; set; }	Specifies metadata object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone Metadata Signature instance.
override Clone(object)	Clone Pdf Metadata Signature instance with given value.
override Equals(object)	Overwrites Equals method to compare signature properties
GetData<T>()	Obtain object from Metadata Signature Value over deserialization.
GetData<T>(IDataEncryption)	Obtain object from Metadata Signature Text over deserialization.
override GetHashCode()	Overrides GetHashCode method
virtual ToBoolean()	Converts to boolean.
virtual ToDateTime()	Converts to DateTime.
virtual ToDateTime(IFormatProvider)	Converts to DateTime.
virtual ToDecimal()	Converts to Decimal.
virtual ToDecimal(IFormatProvider)	Converts to Decimal.
virtual ToDouble()	Converts to Double.
virtual ToDouble(IFormatProvider)	Converts to Double.
virtual ToInteger()	Converts to integer.
virtual ToSingle()	Converts to float.
virtual ToSingle(IFormatProvider)	Converts to float.
override ToString()	Converts to String with override ToString() method
virtual ToString(string)	Converts to String with specified format
virtual ToString(string, IFormatProvider)	Converts to String with specified format

Net: PdfMetadataSignatures

Mon, 01 Jan 0001 00:00:00 +0000

PdfMetadataSignatures class

Contains standard Metadata signatures to be used for Pdf document Metadata Signature Options.

public static class PdfMetadataSignatures

Properties

Name	Description
static Author { get; }	Pdf Document Author metadata.
static CreateDate { get; }	Pdf Document creation date metadata signature.
static Creator { get; }	Pdf Document creator metadata property.
static CreatorTool { get; }	Pdf Document creation tool metadata signature.
static Description { get; }	Pdf Document Description metadata property.
static Entry { get; }	Pdf Document Entry metadata property.
static Keywords { get; }	Pdf Document creator metadata property
static MetadataDate { get; }	Pdf Document metadata date information.
static ModifyDate { get; }	Pdf Document modified date metadata property.
static Producer { get; }	Pdf Document Producer metadata property.
static Subject { get; }	Pdf Document Subject metadata property.
static Title { get; }	Pdf Document Title metadata property

Net: PdfSaveFileFormat

Mon, 01 Jan 0001 00:00:00 +0000

PdfSaveFileFormat enumeration

Defines different save file formats.

public enum PdfSaveFileFormat

Values

Name	Value	Description
Default	`0`	File Format will not be changed.
Pdf	`1`	Saves the document as Pdf (Adobe Portable Document) Format.
Doc	`2`	Saves the document in the Microsoft Word 97-2007 Document Format.
Xps	`3`	Saves the document in the XPS (XML Paper Specification) Format.
DocX	`7`	Saves the document in Microsoft Word Open XML File format.
Svg	`8`	Saves the document in the SVG (Scalable Vector Graphics) format.
Epub	`11`	Saves the document in the IDPF EPUB format.
Pptx	`12`	Saves the document in the PowerPoint Open XML Presentation File format

Net: PdfTextAnnotationBorderEffect

Mon, 01 Jan 0001 00:00:00 +0000

PdfTextAnnotationBorderEffect enumeration

Describes effect which should be applied to the border of the PDF text annotations.

public enum PdfTextAnnotationBorderEffect

Values

Name	Value	Description
None	`0`	No effect.
Cloudy	`1`	The border will appear “cloudy”.

Net: PdfTextStickerIcon

Mon, 01 Jan 0001 00:00:00 +0000

PdfTextStickerIcon enumeration

Describes enumeration of PDF Text annotation sticker icon appearance.

public enum PdfTextStickerIcon

Values

Name	Value	Description
Note	`0`	Note icon.
Comment	`1`	Comment icon.
Key	`2`	Key icon.
Help	`3`	Help icon.
NewParagraph	`4`	New Paragraph icon
Paragraph	`5`	Paragraph icon
Insert	`6`	Insert icon
Check	`7`	Check icon
Cross	`8`	Cross icon
Circle	`9`	Circle icon
Star	`10`	Star icon

Net: PdfTextStickerState

Mon, 01 Jan 0001 00:00:00 +0000

PdfTextStickerState enumeration

Describes enumeration of PDF text annotation sticker states.

public enum PdfTextStickerState

Values

Name	Value	Description
Undefined	`0`	Undefined state.
Marked	`1`	Marked state.
Unmarked	`2`	Unmarked state.
Accepted	`3`	Accepted state.
Rejected	`4`	Rejected state.
Cancelled	`5`	Canceled state.
Completed	`6`	Completed state.
None	`7`	No state.

Net: PresentationMetadataSignature

Mon, 01 Jan 0001 00:00:00 +0000

PresentationMetadataSignature class

Contains Presentation metadata signature properties.

public sealed class PresentationMetadataSignature : MetadataSignature

Constructors

Name	Description
PresentationMetadataSignature(string)	Creates Presentation Metadata Signature with predefined name and empty value
PresentationMetadataSignature(string, object)	Creates Presentation Metadata Signature with predefined values

Properties

Name	Description
CreatedOn { get; set; }	Get or set the signature creation date.
DataEncryption { get; set; }	Gets or sets implementation of `IDataEncryption` interface to encode and decode signature Value properties.
Deleted { get; }	Get the flag that indicates if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Height { get; set; }	Specifies height of signature.
IsSignature { get; set; }	Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Left { get; set; }	Specifies left position of signature.
ModifiedOn { get; set; }	Get or set the signature modification date.
Name { get; set; }	Specifies unique metadata name.
PageNumber { get; }	Specifies the page signature was found on.
SignatureId { get; }	Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
SignatureType { get; }	Specifies the type of signature.
Top { get; set; }	Specifies top position of signature.
Type { get; }	Specifies metadata value type.
Value { get; set; }	Specifies metadata object.
Width { get; set; }	Specifies width of signature.

Methods

Name	Description
override Clone()	Clone Metadata Signature instance.
override Clone(object)	Clone Slides Metadata Signature instance with given value.
override Equals(object)	Overwrites Equals method to compare signature properties
GetData<T>()	Obtain object from Metadata Signature Value over deserialization.
GetData<T>(IDataEncryption)	Obtain object from Metadata Signature Text over deserialization.
override GetHashCode()	Overrides GetHashCode method
virtual ToBoolean()	Converts to boolean.
virtual ToDateTime()	Converts to DateTime.
virtual ToDateTime(IFormatProvider)	Converts to DateTime.
virtual ToDecimal()	Converts to Decimal.
virtual ToDecimal(IFormatProvider)	Converts to Decimal.
virtual ToDouble()	Converts to Double.
virtual ToDouble(IFormatProvider)	Converts to Double.
virtual ToInteger()	Converts to integer.
virtual ToSingle()	Converts to float.
virtual ToSingle(IFormatProvider)	Converts to float.
override ToString()	Converts to String with override ToString() method
virtual ToString(string)	Converts to String with specified format
override ToString(string, IFormatProvider)	Converts to String with specified format

Net: PresentationSaveFileFormat

Mon, 01 Jan 0001 00:00:00 +0000

PresentationSaveFileFormat enumeration

Defines different save file formats.

public enum PresentationSaveFileFormat

Values

Name	Value	Description
Default	`0`	File Format will not be changed.
Pps	`1`	Saves the document as Microsoft Power Point 97-2003 slide show.
Ppt	`2`	Saves the document as Microsoft Power Point 97-2003 presentation.
Pdf	`3`	Saves the document in PDF format.
Xps	`4`	Saves the document in the XPS (XML Paper Specification) format.
Pptx	`5`	Saves the document in the Microsoft Power Point Open XML Presentation format.
Ppsx	`6`	Saves the document in the Microsoft Power Point Open XML Slide Show format.
Tiff	`7`	Renders a page or pages of the document and saves them into a single or multi-page TIFF file.
Odp	`8`	Saves the document as Open Office presentation.
Pptm	`9`	Saves the document as Microsoft Power Point Open XML macro-enabled presentation.
Ppsm	`10`	Saves the document as Microsoft Power Point Open XML macro-enabled slide show.
Potx	`11`	Saves the document as Microsoft Power Point template.
Potm	`12`	Saves the document as Microsoft Power Point macro-enabled template.
Html	`14`	Saves the document in the HTML Format.
Otp	`17`	Saves the document as Open Office presentation template.

Groupdocs API References – GroupDocs.Signature.Domain

Net: Background

Background class

Constructors

Properties

Methods

See Also

Net: BarcodeSignature

BarcodeSignature class

Constructors

Properties

Methods

See Also

Net: BarcodeType

BarcodeType class

Properties

Methods

See Also

Net: BarcodeTypes

BarcodeTypes class

Properties

Methods

Fields

See Also

Net: BaseSignature

BaseSignature class

Properties

Methods

See Also

Net: Border

Border class

Constructors

Properties

Methods

See Also

Net: CertificateMetadataSignature

CertificateMetadataSignature class

Constructors

Properties

Methods

See Also

Net: CheckboxFormFieldSignature

CheckboxFormFieldSignature class

Constructors

Properties

Methods

See Also

Net: CodeTextAlignment

CodeTextAlignment enumeration

Values

See Also

Net: ComboboxFormFieldSignature

ComboboxFormFieldSignature class

Constructors

Properties

Methods

See Also

Net: Corners

Corners class

Constructors

Properties

Methods

Fields

See Also

Net: DashStyle

DashStyle enumeration

Values

See Also

Net: DeleteResult

DeleteResult class

Properties

See Also

Net: DigitalFormFieldSignature

DigitalFormFieldSignature class

Constructors

Properties

Methods

See Also

Net: DigitalSignature

DigitalSignature class