Common structures

Page contains description for common structures and its properties

SignatureType properties

Specifies enumeration of supported Signature Types.

Example SignatureType object

{
 "SignatureType": "Text"
}

PagesSetup properties

Provides options to specify special or ordinary pages for Document processing.

Example PagesSetup object

{
  "PagesSetup": {
    "FirstPage": false,
    "LastPage": true,
    "OddPages": false,
    "EvenPages": true,
    "PageNumbers": [
      1,
      3,
      5
    ]
  }
}

PagesSetup Object Fields

Padding properties

Provides options to specify special or ordinary pages for Document processing.

Example of Padding object

{
    "All": 5,
    "Left": 5,
    "Top": 5,
    "Right": 5,
    "Bottom": 5
}

Padding Object Fields

SignatureFont Object

Provides properties to specify Font properties for Signature object.

Example SignatureFont object

{
    "FontFamily": "Times New Roman",
    "FontSize": 14.0,
    "Bold": false,
    "Italic": false,
    "Underline": false
}

SignatureFont Object Fields

Color Object

Utility class for Color serialization.

Example Color object

{
    "Web": "Transparent",
    "Alpha": 0
}

Color Object Fields

MeasureType Object

Specifies measure units of signature on document page.

Example MeasureType object

{
 "MeasureType": "Pixels"
}

MeasureType Enumeration values

HorizontalAlignment Object

Specifies horizontal alignment of element on Document Page.

Example HorizontalAlignment object.

{
 "HorizontalAlignment": "Left"
}

HorizontalAlignment Object Fields

VerticalAlignment Object

Specifies vertical alignment of element on Document Page.

Example VerticalAlignment object.

{
 "VerticalAlignment": "Top"
}

VerticalAlignment Object Fields

TextHorizontalAlignment Object

Specifies text horizontal alignment inside a Signature.

Example TextHorizontalAlignment object.

{
  "TextHorizontalAlignment": "Left"
}

TextHorizontalAlignment Object Fields

TextVerticalAlignment Object

Specifies text vertical alignment inside a Signature.

Example TextVerticalAlignment object.

{
 "TextVerticalAlignment": "Top"
}

TextVerticalAlignment Object Fields

StretchMode Object

Specifies measure units of signature on document page.

Example StretchMode object.

{
 "Stretch": "PageHeight"
}

StretchMode Object Fields

TextSignatureImplementation Object

Specifies type of implementation for cells Text Signature.

Example CellsTextSignatureImplementation object.

{
 "SignatureImplementation": "TextAsImage"
}

CellsTextSignatureImplementation Object Fields

DashStyle Object

Represents style of dash drawing lines on documents.

Example DashStyle object.

{
 "BorderDashStyle": "Solid"
}

DashStyleData Object Fields

StampBackgroundCropType Object

Specifies crop type of background layer on Stamp elements.

Example StampBackgroundCropType object.

{
 "BackgroundColorCropType": "InnerArea"
}

StampBackgroundCropType Object Fields

StampTextRepeatType Object

Specifies type of text repeat for stamp lines.

Example StampTextRepeatType object.

{
 "TextRepeatType": "FullTextRepeat"
}

StampTextRepeatType Object Fields

BorderLine Object

Utility class for BorderLine serialization.

Example BorderLine object

{
"style": "LongDash",
"transparency": 0.5,
"weight": 1.2,
"color": {
  "Web": "DarkOrange"
}

BorderLine Object Fields

StampLine Object

Utility class for StampLine serialization.

Example StampLine object

{
    "height": 30,
    "backgroundColor": {
      "Web": "CornflowerBlue"
    },
    "text": "John Smith",
    "font": {
      "fontFamily": "Times New Roman",
      "fontSize": 20.0,
      "bold": true,
      "italic": true,
      "underline": true
    },
    "textColor": {
      "Web": "Gold"
    },
    "textBottomIntent": 3,
    "textRepeatType": "None",
    "outerBorder": {
      "style": "Dot",
      "transparency": 0.4,
      "weight": 1.4,
      "color": {
        "Web": "GhostWhite"
      }
    },
    "innerBorder": {
      "style": "LongDash",
      "transparency": 0.5,
      "weight": 1.2,
      "color": {
        "Web": "OliveDrab"
      }
    },
    "visible": true
}

StampLine Object Fields

DigitalSignatureType Object

Digital Signature Type define the method to sign.

Example DigitalSignatureType object

{
  "SignatureType": "CryptoApi"
}

DigitalSignatureTypeData Object Fields

TextMatchType Object

Represents style of dash drawing lines on documents.

Example TextMatchType object

{
  "MatchType": "Contains"
}

TextMatchType Object Fields

CodeTextAlignment Object

Alignment of code text for Bar-codes and QR-codes.

Example CodeTextAlignment object

{
  "CodeTextAlignment": "Above"
}

CodeTextAlignment Object Fields

Brush Object

Base class for setting signature background brush. There are four subclasses for describing various brushes:LinearGradientBrush, RadialGradientBrush, SolidBrush, TextureBrush

LinearGradientBrush Object

Example LinearGradientBrush object:

{
 "startColor": {"web": "CornflowerBlue"},
 "endColor": {"web": "DarkBlue"},
 "angle": 0.0,
 "brushType": "LinearGradientBrush"
}

LinearGradientBrush Object Fields

RadialGradientBrush Object

Example RadialGradientBrush object:

{
 "innerColor": {"web": "CornflowerBlue"},
 "outerColor": {"web": "DarkBlue"},
 "brushType": "RadialGradientBrush"
}

RadialGradientBrush Object Fields

SolidBrush Object

Example SolidBrush object:

{
 "color": {"web": "DarkBlue"},
 "brushType": "SolidBrush"
}

SolidBrush Object Fields

TextureBrush Object

Example TextureBrush object:

{
 "imageGuid": "images\signature_01.jpg",
 "brushType": "TextureBrush"
}

TextureBrush Object Fields