Common structures

Last modified by Farooq Sheikh on 2020/01/02 10:17

Common data structures

Page contains description for common structures and its properties

DocumentType properties

Specifies enumeration of supported Document Types.

Example DocumentType object

PageSetup properties
{
"DocumentType": "Spreadsheet"
}

SignatureType properties

Specifies enumeration of supported Signature Types.

Example SignatureType object

PageSetup properties
{
"SignatureType": "Text"
}

 

 

Name

Description

Text

Specifies Text signature type

Image

Specifies Image signature type

Digital

Specifies Digital signature type

Barcode

Specifies Barcode signature type

QRCode

Specifies QRCode signature type

Stamp

Specifies Stamp signature type

 

PagesSetup properties

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

Example PagesSetup object

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

Padding properties

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

Example Padding object

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

SignatureFont Object

Provides properties to specify Font properties for Signature object.

Example SignatureFont object

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

Color Object

Utility class for Color serialization.

Example Color object

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

MeasureType Object

Specifies measure units of signature on document page.

Example MeasureType object

{
"MeasureType": "Pixels"
}

HorizontalAlignment Object

Specifies horizontal alignment of element on Document Page.

Example HorizontalAlignment object.

{
"HorizontalAlignment": "Left"
}

VerticalAlignment Object

Specifies vertical alignment of element on Document Page.

Example VerticalAlignment object.

{
"VerticalAlignment": "Top"
}

TextHorizontalAlignment Object

Specifies text horizontal alignment inside a Signature.

Example TextHorizontalAlignment object.

{
"TextHorizontalAlignment": "Left"
}

TextVerticalAlignment Object

Specifies text vertical alignment inside a Signature.

Example TextVerticalAlignment object.

{
"TextVerticalAlignment": "Top"
}

StretchMode Object

Specifies measure units of signature on document page.

Example StretchMode object.

{
"Stretch": "PageHeight"
}

TextSignatureImplementation Object

Specifies type of implementation for cells Text Signature.

Example CellsTextSignatureImplementation object.

{
"SignatureImplementation": "TextAsImage"
}


DashStyle Object

Represents style of dash drawing lines on documents.

Example DashStyle object.

{
"BorderDashStyle": "Solid"
}

ExtendedDashStyle Object

Represents style of dash drawing lines on documents.

Example ExtendedDashStyle object.

{
"BorderDashStyle": "Solid"
}

StampBackgroundCropType Object

Specifies crop type of background layer on Stamp elements.

Example StampBackgroundCropType object.

{
"BackgroundColorCropType": "InnerArea"
}

StampTextRepeatType Object

Specifies type of text repeat for stamp lines.

Example StampTextRepeatType object.

{
"TextRepeatType": "FullTextRepeat"
}

BorderLine Object

Utility class for BorderLine serialization.

Example BorderLine object

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

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
    }

DigitalSignatureType Object

Digital Signature Type define the method to sign.

Example DigitalSignatureType object

{
  "SignatureType": "CryptoApi"
}

TextMatchType Object

Represents style of dash drawing lines on documents.

Example TextMatchType object

{
  "MatchType": "Contains"
}

CodeTextAlignment Object

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

Example CodeTextAlignment object

{
  "CodeTextAlignment": "Above"
}

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"
}

RadialGradientBrush Object

Example RadialGradientBrush object:

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

SolidBrush Object

Example SolidBrush object:

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

TextureBrush Object

Example TextureBrush object:

{
"imageGuid": "images\signature_01.jpg",
"brushType": "TextureBrush"
}
Tags:
Created by Farooq Sheikh on 2020/01/02 10:17