ScripTouch Sign and Save: Difference between revisions

From Scriptel Wiki
Jump to navigation Jump to search
No edit summary
Line 36: Line 36:


==ScripTouch Sign And Save Usage:==
==ScripTouch Sign And Save Usage:==
<pre>  -o, --output-file    Sets the default output file name.
  -e, --exporter      Sets the default exporter.
  -p, --plugin        Actives plugin mode, disables Save / AutoSave. Firstaccep
ted signature gets returned. Requires -o and -e.
  -f,--fg-color        Foreground color (e.g. #RRGGBB or #RRGGBBAA)
  -b,--bg-color        Background color (e.g. #RRGGBB or #RRGGBBAA)
  -t,--bg-trans        Sets the background to transparent. Incompatible with -f
  -z,--zoom            Sets the zoom level as a percentage of the screen size.Incompatible with -d. Locks zoom slider.
  -d,--max-dimension  Sets the maximum dimension of the resulting image (e.g. 240x64 with a dim of 480 would result in an image thatwas 480x128). Incompatible with -z. Locks zoom slider.
  -l,--line-thickness  Sets the line thickness to use. Locks line width slider.
  -h,--help            Shows this message.
  --hide-options      Hides the signature options, removes the menu item.
  --hide-buttons      Hides the user buttons, removes the menu item.
  --lock-colors        Disables the ability to change colors.
  --pen-style          Sets the pen style. Locks pen style selector.
  --timestamp=(on|off) Enables or disables timestamps, removes menu item.
  --crop=(on|off)      Enables or disables auto-crop, removes menu item.
  --smooth=(on|off)    Enables or disables antialiasing, removes the menu item.
  --dev-btns=(on|off)  Enables or disabled device buttons, removes menu item.
  --autosave=(on|off)  Forces autosave on or off, on requires--autosave-pattern,
--autosave-path,and --autosave-exporter. Removes menu items.
  --ontop=(on|off)    Forces always on top on or off. Removes menu items.
  --autosave-pattern  Specifies the autosave pattern.
  --autosave-path      Specifies the path where files should be autosaved.
  --autosave-exporter  Specifies the exporter to use on autosaved images.
  --autosave-seq-num  Specifies the autosequence start number.
  --preferences-file  Sets the path of the preferences file to use.
  --skip-preferences  Disables loading and saving preferences.
  --no-gui            Sign and Save will start, but will not present a GUI.  EasyScript devices will not function in this mode.
  --dpi                Changes the DPI of saved images.  The default is 72.
  --stdout            Sends file output to stdout. Must be --plugin mode, Overrides --output-file.
Available Exporters:
  BitmapExporter -- Bitmap (.bmp) - Color
  BitmapGrayExporter -- Bitmap (.bmp) - Grayscale
  BitmapMonoExporter -- Bitmap (.bmp) - Monochrome
  CSVExporter -- Comma Separated Values (.csv)
  GIFExporter -- Graphics Interchange Format (.gif)
  JPEGExporter -- JPEG (.jpg, .jpeg, .jfif)
  PNGExporter -- Portable Network Graphics (.png)
  SVGExporter -- Scalable Vector Graphics (.svg)
  SIGScriptelExporter -- Signature File (.sig) - Scriptel Format
  TIFCCITTv4Exporter -- TIF (.tif, .tiff) - CCITTv4 Compression (FAX)
  TIFJpegExporter -- TIF (.tif, .tiff) - JPEG Compression (Technote 2)
Available Pen Styles:
  InkWell
  Chisel
  Plain </pre>
==Preferences File==
The preferences-file flag is used to override the default preferences file. When the user changes an attribute on the Sign and Save UI the change is remembered for the next time the application is started in a preferences file. Normally a default preferences file is used. This flag will cause the application to use a different preferences file. If the file does not exist, it will be created with default attributes.
==Auto Save==
When a signature is accepted by the user with autosave=off a dialog box pops up prompting them to save it. With autosave=on the signature is instantly saved without a prompt. This requires that autosave-pattern, autosave-path, and autosave-exporter be set. The pattern can be any valid filename. The following substitutions are allowed:<pre> ${seq}, ${date}, ${time}. For example:
SignAndSave.exe –autosave=on –autosave-path=c:/temp –autosave-exporter=PNGExporter –autosave-pattern=signature-${seq}-${date}-${time} </pre>
will produce a file with a name similar to signature-1-2015-01-05-10-26-18.png
The state of autosave attributes are stored in the preferences file.
==Examples==
'''List command line arguments and exit:'''
<pre>SignAndSave.exe –help</pre>
'''Start Sign and Save in plugin (skip the save dialog, save as indicated by command line arguments) mode, tell it export the saved signature as a PNG and save it in the Windows temporary directory:'''
<pre>SignAndSave.exe -p -e PNGExporter -o “C:\Windows\Temp\Test.png”</pre>
or
<pre>SignAndSave.exe –plugin –exporter PNGExporter –output-file “C:\Windows\Temp\Test.png”</pre>
'''Start Sign and Save in plugin mode as before, but discard saved preferences, restrict colors (black on transparent), and hide buttons:'''
<pre>SignAndSave.exe -p -e PNGExporter -o “C:\Windows\Temp\Test.png” –skip-preferences –hide-options –hide-buttons –fg-color #000000 –bg-trans –zoom 200 –pen-style InkWell</pre>

Revision as of 14:26, 15 July 2016

ScripTouch Sign and Save
192px
Developer(s) Scriptel Corporation
Operating system Windows XP - Windows 10
Website scriptel.com/support/downloads/


The ScripTouch Sign and Save Command Line Interface allows developers to execute Sign and Save on an installed machine and direct the program to perform actions such as signature customization and the saving of a signature image to a desired location.


ScripTouch Sign And Save Usage:

  -o, --output-file    Sets the default output file name.
  -e, --exporter       Sets the default exporter.
  -p, --plugin         Actives plugin mode, disables Save / AutoSave. Firstaccep
ted signature gets returned. Requires -o and -e.
  -f,--fg-color        Foreground color (e.g. #RRGGBB or #RRGGBBAA)
  -b,--bg-color        Background color (e.g. #RRGGBB or #RRGGBBAA)
  -t,--bg-trans        Sets the background to transparent. Incompatible with -f
  -z,--zoom            Sets the zoom level as a percentage of the screen size.Incompatible with -d. Locks zoom slider.
  -d,--max-dimension   Sets the maximum dimension of the resulting image (e.g. 240x64 with a dim of 480 would result in an image thatwas 480x128). Incompatible with -z. Locks zoom slider.
  -l,--line-thickness  Sets the line thickness to use. Locks line width slider.
  -h,--help            Shows this message.
  --hide-options       Hides the signature options, removes the menu item.
  --hide-buttons       Hides the user buttons, removes the menu item.
  --lock-colors        Disables the ability to change colors.
  --pen-style          Sets the pen style. Locks pen style selector.
  --timestamp=(on|off) Enables or disables timestamps, removes menu item.
  --crop=(on|off)      Enables or disables auto-crop, removes menu item.
  --smooth=(on|off)    Enables or disables antialiasing, removes the menu item.
  --dev-btns=(on|off)  Enables or disabled device buttons, removes menu item.
  --autosave=(on|off)  Forces autosave on or off, on requires--autosave-pattern,
 --autosave-path,and --autosave-exporter. Removes menu items.
  --ontop=(on|off)     Forces always on top on or off. Removes menu items.
  --autosave-pattern   Specifies the autosave pattern.
  --autosave-path      Specifies the path where files should be autosaved.
  --autosave-exporter  Specifies the exporter to use on autosaved images.
  --autosave-seq-num   Specifies the autosequence start number.
  --preferences-file   Sets the path of the preferences file to use.
  --skip-preferences   Disables loading and saving preferences.
  --no-gui             Sign and Save will start, but will not present a GUI.  EasyScript devices will not function in this mode.
  --dpi                Changes the DPI of saved images.  The default is 72.
  --stdout             Sends file output to stdout. Must be --plugin mode, Overrides --output-file.

Available Exporters:
   BitmapExporter -- Bitmap (.bmp) - Color
   BitmapGrayExporter -- Bitmap (.bmp) - Grayscale
   BitmapMonoExporter -- Bitmap (.bmp) - Monochrome
   CSVExporter -- Comma Separated Values (.csv)
   GIFExporter -- Graphics Interchange Format (.gif)
   JPEGExporter -- JPEG (.jpg, .jpeg, .jfif)
   PNGExporter -- Portable Network Graphics (.png)
   SVGExporter -- Scalable Vector Graphics (.svg)
   SIGScriptelExporter -- Signature File (.sig) - Scriptel Format
   TIFCCITTv4Exporter -- TIF (.tif, .tiff) - CCITTv4 Compression (FAX)
   TIFJpegExporter -- TIF (.tif, .tiff) - JPEG Compression (Technote 2)

Available Pen Styles:
   InkWell
   Chisel
   Plain 

Preferences File

The preferences-file flag is used to override the default preferences file. When the user changes an attribute on the Sign and Save UI the change is remembered for the next time the application is started in a preferences file. Normally a default preferences file is used. This flag will cause the application to use a different preferences file. If the file does not exist, it will be created with default attributes.

Auto Save

When a signature is accepted by the user with autosave=off a dialog box pops up prompting them to save it. With autosave=on the signature is instantly saved without a prompt. This requires that autosave-pattern, autosave-path, and autosave-exporter be set. The pattern can be any valid filename. The following substitutions are allowed:

 ${seq}, ${date}, ${time}. For example:

SignAndSave.exe –autosave=on –autosave-path=c:/temp –autosave-exporter=PNGExporter –autosave-pattern=signature-${seq}-${date}-${time} 

will produce a file with a name similar to signature-1-2015-01-05-10-26-18.png

The state of autosave attributes are stored in the preferences file.

Examples

List command line arguments and exit:

SignAndSave.exe –help

Start Sign and Save in plugin (skip the save dialog, save as indicated by command line arguments) mode, tell it export the saved signature as a PNG and save it in the Windows temporary directory:

SignAndSave.exe -p -e PNGExporter -o “C:\Windows\Temp\Test.png”

or

SignAndSave.exe –plugin –exporter PNGExporter –output-file “C:\Windows\Temp\Test.png”

Start Sign and Save in plugin mode as before, but discard saved preferences, restrict colors (black on transparent), and hide buttons:

SignAndSave.exe -p -e PNGExporter -o “C:\Windows\Temp\Test.png” –skip-preferences –hide-options –hide-buttons –fg-color #000000 –bg-trans –zoom 200 –pen-style InkWell