Theme:
v
SSGear 30-days Trial Version

Download the 30-days SSGear Trial Version

Download SSGear Trial Version (latest version)

Other pages of interest:

Please read this page before installing SSGear.

Requirements

You must have the Microsoft .Net Framework 4.0 installed on your computer.

You must have a version of APL+Win greater or equal to v3 (or a version of Dyalog APL supporting ActiveX)

FYI: the SpreadsheetGear control required by SSGear is embedded in the LC.Objects.SSGear.dll DLL
If you decide to purchase SSGear later on, you will have to purchase a SpreadsheetGear license at https://www.spreadsheetgear.com/downloads/purchase.aspx

Installation

Proceed as follows to install SSGear 30-days Trial:

  1. run SSGearSetup.exe (after downloading it using the above link)
  2. copy the LC.Objects.SSGear.license file to the folder where you installed SSGear
    (in order for SSGear to work, the LC.Objects.SSGear.license file must be in the same folder as the LC.Objects.SSGear.dll file)
  3. set the SSGear.sf file as your top level UCMD file:
          ]ufile <path>\SSGear
    
    where <path> is the full path of the folder where you installed SSGear
  4. the SSGear.w3 sample workspace is delivered in APL+Win v6.4 format
    If you own an earlier version of APL+Win you can recreate the SSGear.w3 workspace from the SSGear.sf User Command file as follows:
          )clear
          ]uload * /F=<path>\SSGear
          ⎕lx←'AutoStart'
          )wsid <path>\SSGear
          )save
    
    where <path> is the full path of the folder where you installed SSGear

The SSGear Sample Workspace

Once SSGear has been properly installed as described in the above 4 steps, you can load the SSGear.w3 workspace

In this workspace you can run the following sample functions:

SSGear''Displays an APL form with an SSGear object and populates it with sheets, data, graphs, ...
SSG''Creates an APL form with an empty SSGear object (practical to start testing SSGear properties and methods)
SSGraphDisplays a form with a sheet popupated with APL data and displays a graph associated with these data
SSCreates a top level SSGear object (not child of any form)
PricesDisplay a form with an SSGear object showing the SSGear Price List

Note: the first time you create an instance of the LC.Objects.SSGear.SSGear object in an APL Session, it takes a short while, something like one or 2 seconds, as the DLL is loaded into memory: subsequent instantations are instantaneous.

Also note that you can use a left argument of 1 with the SSGear and SSG APL functions, in which case the form that is displayed is made "ontop": be careful though to then not use the right click menu since if you select an option that displays a Dialog Box, it would be displayed behind the form and therefore would seem to freeze APL.

The SSGear Sample Workspace Tutorials

The SSGear.w3 workspace contains a long Tutorial that demonstrates most of the SSGear features.

This Tutorial has also been split into 21 smaller Tutorials to help you explore various parts of the product at your own speed: you may also rerun any of these tutorials in the future to refresh your memory on how to do things with SSGear.

Be sure to run the Tutorials!

Getting documentation

If you installed the product properly and set the SSGear.sf file as your top level UCMD file, then you can use the following 3 User Commands to get documentation about the DLL:

First the ]ssprops User Command lets you know about all properties available in the DLL

      ]ssprops
xBackColor                 xFixedRows                 xPrintLeftMargin
xBackColorIndex            xFont                      xPrintLeftToRight
xBold                      xFontColor                 xPrintMargins
xBookName                  xFontColorIndex            xPrintNoColor
xCalledFromAPL             xFontName                  xPrintPaperSize
xChartGridLines            xFontSize                  xPrintRightMargin
xChartGridLinesColor       xFormula                   xPrintScale
xChartHorizontalGridLines  xFormulaBarVisible         xPrintTitleCols
xChartLegendVisible        xGridHeadings              xPrintTitleRows
xChartMarkerSize           xGridLines                 xPrintTopMargin
xChartMarkerType           xHAlign                    xPrintVCenter
xChartMarkerTypes          xHScrollBarVisible         xPrinterName
xChartSeries               xIsDirty                   xPrinterNames
xChartTitle                xItalic                    xRange
xChartType                 xListSeparator             xRangeSize
xChartTypes                xMaxCol                    xRow
xChartVerticalGridLines    xMaxRow                    xRowCol
xChartXAxisLabelsFont      xNames                     xScrollCol
xChartXAxisRange           xNbCols                    xScrollRow
xChartXAxisTitleFont       xNbRows                    xSheet
xChartXTitle               xNbSheets                  xSheetName
xChartYAxisLabelsFont      xNumberFormat              xSheetNames
xChartYAxisRange           xOrientation               xSheetNo
xChartYAxisTitleFont       xPalette                   xSkipAutoFit
xChartYTitle               xPrintArea                 xStrikeOut
xCol                       xPrintBottomMargin         xSuppressEvents
xDecimalSeparator          xPrintFitToPagesTall       xTabsVisible
xDefaultContextMenu        xPrintFitToPagesWide       xUnderline
xDefaultFont               xPrintFooters              xUsedRange
xDisplayReference          xPrintFootersMargin        xVAlign
xDisplayReferenceString    xPrintGridLines            xVScrollBarVisible
xEnabled                   xPrintHCenter              xVersion
xErrorTrapping             xPrintHeaders              xVisible
xFixedCols                 xPrintHeadersMargin        xWrapText

Then the ]ssmeths User Command lets you know about all methods available in the DLL

      ]ssmeths
XA1toRC                XExport                XPrint                 XSetFormula
XAbout                 XGet                   XPrintPreview          XSetLeftBorders
XAdd                   XGetColName            XProtect               XSetName
XAddAcross             XGetColNum             XQuickChart            XSetNameValue
XAddChart              XGetColPageBreaks      XRCtoA1                XSetNumberFormats
XAddColPageBreaks      XGetColWidths          XRangeExpand           XSetPassword
XAddPageBreaks         XGetFormula            XRangeOffset           XSetPattern
XAddRowPageBreaks      XGetNames              XRedo                  XSetPrintFitToPages
XAddSheet              XGetNextRowPageBreak   XRefresh               XSetPrintFootersFont
XAutoFill              XGetNumberFormats      XRemoveColPageBreaks   XSetPrintHeadersFont
XAutoFit               XGetPageBreaks         XRemovePageBreaks      XSetPrintTitles
XBeginEdit             XGetRange              XRemoveRowPageBreaks   XSetRange
XBeginUpdate           XGetRowPageBreaks      XRemoveSheet           XSetRightBorders
XBlankZeros            XGetSheetNum           XResumeLayoutGrid      XSetRowHeights
XCancelEdit            XGetUsedRange          XSave                  XSetTopBorders
XClearRange            XHideCols              XSaveAs                XSetWrapText
XClearSheet            XHideRows              XSelectAll             XShowCols
XClearSheets           XImport                XSetAlignments         XShowRows
XCloseBook             XImportPartial         XSetBorders            XSuspendLayoutGrid
XCopy                  XInsert                XSetBottomBorders      XUnProtect
XCut                   XLoadFile              XSetChartSeriesLabels  XUndo
XDelete                XLoadFilePartial       XSetColWidths          XUnsetPassword
XEndEdit               XMerge                 XSetDefaultFont
XEndUpdate             XMove                  XSetFixedCols
XEvaluate              XPaste                 XSetFixedRows

And finally the ]ssdoc user command (which is not case sensitive) lets you get documentation about any property or method:

      ]ssdoc setborders
The SetBorders method allows you to change the inside and outside borders of the specified sheet/range

APL Syntax:    'ff.ss'⎕wi'*XSetBorders'sheet range insideBorderType insideBorderColor outsideBorderType outsideBorderColor
C# Syntax:     ss.SetBorders(sheet, range, insideBorderType, insideBorderColor, outsideBorderType, outsideBorderColor);

sheet can be a sheet number in origin 1 or a sheet name
      or "" to mean the currently active sheet
range can be a range address expressed in RC or A1 format
      or "" to mean the currently selected range in the specified sheet
      or -1 to mean the entire specified sheet
insideBorderType and outsideBorderType should be one of:
 	  no
	  thin
	  medium
	  thick
	  double
	  hairline
	  "" to mean: do not change the corresponding border
insideBorderColor and outsideBorderColor should be:
	  either a scalar integer between 1 and 56 inclusive representing a color index into the Palette
      or a 3-element vector of RGB values all between 0 and 255
      or "" to mean:  do not change the corresponding color

Example:
     'ff.ss'⎕wi'setborders' 1 'b2:f8' 'thin' 3 'thick' (0 0 255)  ⍝ thin 3rd Palette color inside and thick blue outside
     'ff.ss'⎕wi'setborders' 1 'h4' '' '' 'thick' (0 0 255)        ⍝ no need for inside border for a single cell
     'ff.ss'⎕wi'setborders' 1 'b2:f8' '' '' 'medium' ''           ⍝ change outside border to medium
     'ff.ss'⎕wi'setborders' 1 'b2:f8' '' '' '' 3                  ⍝ change outside border to the 3rd Palette color

Quick SSGear On-Line Tutorial

Please visit our SSGear Tutorial page for a quick Tutorial to get you started with SSGear.