Class

# PDFSignature

<div class="rst-class">

forsearch

</div>

PDF

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

A control that provide a way for the user to sign the created PDF Document using a digital certificate.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                              | Type                               | Read-Only | Shared |
|-----------------------------------|------------------------------------|-----------|--------|
| `FontSize<pdfsignature.fontsize>` | `Integer</api/data_types/integer>` |           |        |
| `Height<pdfsignature.height>`     | `Integer</api/data_types/integer>` |           |        |
| `Name<pdfsignature.name>`         | `String</api/data_types/string>`   |           |        |
| `Page<pdfsignature.page>`         | `Integer</api/data_types/integer>` |           |        |
| `Width<pdfsignature.width>`       | `Integer</api/data_types/integer>` |           |        |
| `X<pdfsignature.x>`               | `Integer</api/data_types/integer>` |           |        |
| `Y<pdfsignature.y>`               | `Integer</api/data_types/integer>` |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                     | Parameters                                                                                                                                                                                                                                                                                                              | Returns | Shared |
|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|--------|
| `Constructor<pdfsignature.constructor0>` | pageNumber As `Integer</api/data_types/integer>`, x As `Integer</api/data_types/integer>`, y As `Integer</api/data_types/integer>`, width As `Integer</api/data_types/integer>`, height As `Integer</api/data_types/integer>`, name As `String</api/data_types/string>`, value As `String</api/data_types/string>` = "" |         |        |

## Property descriptions

<div id="pdfsignature.fontsize">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFSignature.FontSize

**FontSize** As `Integer</api/data_types/integer>`

> The size of the text of the control.

<div id="pdfsignature.height">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFSignature.Height

**Height** As `Integer</api/data_types/integer>`

> The height of the signature control.

<div id="pdfsignature.name">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFSignature.Name

**Name** As `String</api/data_types/string>`

> The name of the signature control.

<div id="pdfsignature.page">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFSignature.Page

**Page** As `Integer</api/data_types/integer>`

> The number of the page upon which the signature control appears.

<div id="pdfsignature.width">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFSignature.Width

**Width** As `Integer</api/data_types/integer>`

> The width of the signature control.

<div id="pdfsignature.x">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFSignature.X

**X** As `Integer</api/data_types/integer>`

> The horizontal location of the top left corner of the signature control.

<div id="pdfsignature.y">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFSignature.Y

**Y** As `Integer</api/data_types/integer>`

> The vertical location of the top left corner of the signature control.

## Method descriptions

<div id="pdfsignature.constructor0">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFSignature.Constructor

**Constructor**(pageNumber As `Integer</api/data_types/integer>`, x As `Integer</api/data_types/integer>`, y As `Integer</api/data_types/integer>`, width As `Integer</api/data_types/integer>`, height As `Integer</api/data_types/integer>`, name As `String</api/data_types/string>`, value As `String</api/data_types/string>` = "")

> <div class="note">
>
> <div class="title">
>
> Note
>
> </div>
>
> `Constructors</api/language/constructor>` are special methods called when you create an object with the `New</api/language/new>` keyword and pass in the parameters above.
>
> </div>
>
> Creates an instance of the control with the values passed.

## Notes

Lastly, and as it happens with many other features of the PDF format specification, the ability to digitally sign the PDF documents created with the <span class="title-ref">PDFDocument</span> class is up to the PDF viewer you use. For example, the free app Adobe Acrobat Reader does support this feature, while that is not the case with the Preview app provided by macOS.

## Sample code

This example adds a <span class="title-ref">PDFSignature</span> to an existing `PDFDocument</api/pdf/pdfdocument>` object stored in the variable *pdfDoc*:

``` xojo
Var signature As New PDFSignature(1, 100, 100, 300, 200, "signature")
pdfDoc.AddControl(signature)
```

## Compatibility

|                       |                               |
|-----------------------|-------------------------------|
| **Project Types**     | Console, Desktop, Mobile, Web |
| **Operating Systems** | iOS, Linux, macOS, Windows    |

<div class="seealso">

`PDFControl</api/pdf/pdfcontrol>` parent class; `PDFDocument</api/pdf/pdfdocument>` class.

</div>