Returns the currently active settings (xos file), converted to a json string, without resolving urls.

var settings = exoskeleton.getApplicationSettings();

if (settings.ScriptingMediaEnabled) {
  exoskeleton.speech.speak("hello");
}

Returns the important exoskeleton environment locations. (Current, Settings, Executable)

var locations = exoskeleton.getLocations();
console.log("current directory : " + locations.Current);
console.log("location of (active) settings file : " + locations.Settings);
console.log("location of (active) exoskeleton executable : " + locations.Executable);

Returns the version number for the exoskeleton host you are running in.

var version = exoskeleton.getVersion();
console.log("host exo version : " + version);

Registers a javascript function for processing exoskeleton web service requests. This requires enabling web services in your settings file.

function myServiceProcessor (request) {
  if (request.AbsolutePath === "/version.svc") {
    return {
      ContentType: 'application/json',
      Response: JSON.stringify({ name: 'myapp', major: 1, minor: 4, patch: 7 })
    }
  }

  return null;
}

exoskeleton.registerServiceProcessor(myServiceProcessor);

Initiates shutdown of this exoskeleton app by notifying the container.

Returns the currently active settings (xos file), converted to a json string, without resolving urls.

var settings = exoskeleton.getApplicationSettings();

if (settings.ScriptingMediaEnabled) {
  exoskeleton.speech.speak("hello");
}

Returns the important exoskeleton environment locations. (Current, Settings, Executable)

var locations = exoskeleton.getLocations();
console.log("current directory : " + locations.Current);
console.log("location of (active) settings file : " + locations.Settings);
console.log("location of (active) exoskeleton executable : " + locations.Executable);

Returns the version number for the exoskeleton host you are running in.

var version = exoskeleton.getVersion();
console.log("host exo version : " + version);

Registers a javascript function for processing exoskeleton web service requests. This requires enabling web services in your settings file.

function myServiceProcessor (request) {
  if (request.AbsolutePath === "/version.svc") {
    return {
      ContentType: 'application/json',
      Response: JSON.stringify({ name: 'myapp', major: 1, minor: 4, patch: 7 })
    }
  }

  return null;
}

exoskeleton.registerServiceProcessor(myServiceProcessor);

Initiates shutdown of this exoskeleton app by notifying the container.

Allows creation of c# singleton for further operations.

exoskeleton.com.createInstance("SAPI.SpVoice");

Allows invocation of a method on the global singleton com object instance.

exoskeleton.com.createInstance("SAPI.SpVoice");
exoskeleton.com.invokeMethod("Speak", ["this is a test message scripting activex from java script", 1])

Activates instance to Com type, calls a single method (with params) and then disposes instance.

exoskeleton.com.createAndInvokeMethod ("SAPI.SpVoice", "Speak",
    ["this is a test message scripting activex from java script", 1]);

Adds a CheckBox to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addCheckbox("ExampleDialog", {
  Name: "StudentCheckbox",
  Text: "Student",
  Checked: true,
  Top: 100,
  Left: 10
}, "TopPanel");

Adds a CheckedListBox to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addCheckedListBox("ExampleDialog", {
  Name: "CountryChecklist",
  Top: 10,
  Left: 10,
  Dock: 'Fill'
  Items: ['United States', 'United Kingdom', 'Germany', 'France', 'Japan']
}, "AddressPanel", { CheckedIndices: [0, 2] });

Adds a ComboBox to a named exoskeleton dialog. If the combo box items will remain static, you can set items with 'Items' property. If the items are to be dynamic, you should set 'DisplayMember' and 'ValueMember' properties and databind by separate applyControlPayload object with 'DataSource' object array. Passing an additional 'DataSourceKeepSelection' payload property will attempt to retain the currently selected item across the rebinding. See ms docs

exoskeleton.dialog.addComboBox("ExampleDialog", {
  Name: "CountryDropDown",
  Top: 10,
  Left: 10,
  Items: ['United States', 'United Kingdom', 'Germany', 'France', 'Japan'],
  SelectedItem : 'United States'
}, "AddressPanel");

Adds a DataGridView to a named exoskeleton dialog. See ms docs

var users = [
  { name: "john", age: 24, address: "123 alpha street" },
  { name: "mary", age: 22, address: "222 gamma street" },
  { name: "tom", age: 28, address: "587 delta street" },
  { name: "jane", age: 26, address: "428 beta street" }
];

var result = exoskeleton.dialog.addDataGridView("ExampleDialog", {
  Name: "UserGridView",
  Dock: 'Fill',
  ReadOnly: true,
  AllowUserToAddRows: false,
  SelectionMode: 'FullRowSelect'
}, "DetailsPanel", { ObjectArray: users });

Adds a DateTimePicker to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addDateTimePicker("ExampleDialog", {
  Name: "StartDate",
  Top: 100,
  Left: 100,
  Value: "12/13/2014"
}, "AddressPanel");

Adds a 'dismiss dialog' Button to a named exoskeleton dialog. This is a standard .net button with hardcoded event handler to dismiss dialog. See ms docs

exoskeleton.dialog.addDialogButton("ExampleDialog", {
  Text: "OK",
  Top: 10,
  Left: 200
}, "BottomPanel", { DialogResult: "OK" });

Adds a Label to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addLabel("ExampleDialog", {
  Name: "AddressTextBox",
  Text: "Address:",
  Top: 100,
  Left: 10
}, "AddressPanel");

Adds a ListBox to a named exoskeleton dialog. If the list box items will remain static, you can set items with 'Items' property. If the items are to be dynamic, you should set 'DisplayMember' and 'ValueMember' properties and databind by separate applyControlPayload object with 'DataSource' object array. Passing an additional 'DataSourceKeepSelection' payload property will attempt to retain the currently selected item across the rebinding. See ms docs

exoskeleton.dialog.addListBox("ExampleDialog", {
  Name: "CountryList",
  Top: 10,
  Left: 10,
  Dock: 'Fill'
  Items: ['United States', 'United Kingdom', 'Germany', 'France', 'Japan'],
  SelectedItem : 'United States'
}, "AddressPanel");

Adds a ListView to a named exoskeleton dialog. ListView has the following view modes (defined by 'View' property) :

• LargeIcon: 'Thumbnail-like' list using 'Items' payload property (no subitems).
• Details - Tabular list using 'ItemArrays' 2-dimensional payload property for subitems.
• SmallIcon - 'Left-to-Right, Top-to-Bottom' list needing only 'Items' payload property.
• List - 'Top-to-Bottom' list needing only 'Items' payload property.
• Tile - 'L->R, T->B' list with large icons, displaying subitems as multiple lines (2D 'ItemArrays')

The various allowable payloads include :

• 'Columns' - In a tabular view mode these define the column captions/sizes ('Text', 'Width')
• 'Items' - Items array supports single dimension array where each array element is a different list item.
• 'ItemArrays' - ItemArrays support 2-dimension array allowing multiple columns for each 'row'.
• 'AppendItems' - AppendItems is the same as 'Items' but the list will not be cleared before adding those (new) items.
• 'AppendItemArrays' - AppendItemArrays will not clear the listview before appending the new items.

See ms docs.

// LargeIcon view mode - depends on already established named imagelist
var controlProperties = { Name: "CountryList", Top: 10, Left: 10, Dock: 'Fill', View: "LargeIcon" };
var controlPayload = {
  LargeImageList: "LargeListIcons",
  Items: [{ Text: "One", ImageIndex: 0 }, { Text: "Two", ImageIndex: 1 }]
};
exoskeleton.dialog.addListView("ExampleDialog", controlProperties, "AddressPanel", controlPayload);

// Details view mode example
controlProperties = { Name: "CountryList", Top: 10, Left: 10, Dock: 'Fill', View: "Details", FullRowSelect: true }
var controlPayload = {
  SmallImageList: "SmallListIcons",
  Columns: [{ Text: "Country", Width:100 }, { Text:"Info1", Width: 120 }, { Text: "Info2", Width: 100 }],
  ItemArrays: [
    [{ Text: "Item One", ImageIndex: 0 }, { Text: "Stuff about One" }, { Text: "More stuff about One" }],
    [{ Text: "Item Two", ImageIndex: 1 }, { Text: "Stuff about Two" }, { Text: "More stuff about Two" }],
    [{ Text: "Item Three", ImageIndex: 2 }, { Text: "Stuff about Three" }, { Text: "More stuff about Three" }]
  ]
};
exoskeleton.dialog.addListView("ExampleDialog", controlProperties, "AddressPanel", controlPayload);

Adds a MaskedTextBox to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addMaskedTextBox("ExampleDialog", {
  Name: "PhoneNumberMaskedEdit",
  Mask: "(999)-000-0000",
  Top: 124,
  Left: 48,
  Width: 100
});

Adds a MonthCalendar to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addMonthCalendar("ExampleDialog", {
  Name: "MonthCalendar",
  ShowToday: true,
  ShowTodayCircle: true,
  MonthlyBoldedDates: ["1/1/2017", "1/15/2017"],  // bolds 1st and 15th days of every month,
  AnnuallyBoldedDates: ["3/20/2017", "6/1/2017", "9/22/2017", "12/22/2017"], 
  Top: 40,
  Left: 40
});

Adds a NumericUpDown control to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addNumericUpDown("ExampleDialog", {
  Name: "AgeNumeric",
  Top: 10,
  Left: 10,
  Minimum: 13,
  Maximum: 120
}, "UserInfoPanel");

Adds a Panel to a named exoskeleton dialog for layout and nesting purposes. See ms docs

exoskeleton.dialog.addPanel({
  Name: "FillPanel",
  Dock: 'Fill'
});
exoskeleton.dialog.addPanel({
  Name: "TopPanel",
  Dock: 'Top',
  Height: 100
});
exoskeleton.dialog.addPanel("ExampleDialog", {
  Name: "BottomPanel",
  Dock: 'Bottom',
  Height: 100
});

Adds a PictureBox to a named exoskeleton form for layout and nesting purposes. See ms docs

exoskeleton.dialog.addPictureBox("SampleForm", {
  Name: "LogoPicbox",
  Location: "10, 10",
  Size: "64, 64"
}, false, { ImagePath: "C:\\Images\\pic1.png" });

Adds a RadioButton to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addRadioButton("ExampleDialog", {
  Name: "GenderMale", Text: "Male", Top: 40, Left: 100, Checked: true
});
exoskeleton.dialog.addRadioButton("ExampleDialog", {
  Name: "GenderFemale", Text: "Female", Top: 40, Left: 140, Checked: false
});

Adds a TextBox to a named exoskeleton dialog. See ms docs

exoskeleton.dialog.addTextBox("ExampleDialog", {
  Name: "Street (1)",
  Top: 40,
  Left: 100,
  Text: user.addr1
}, "AddressPanel");

Adds a TreeView to a named exoskeleton form. Emits 'NodeMouseClick' and 'NodeMouseDoubleClick' events if 'emitEvents' is true. See ms docs

Applies a payload to a control which have already been added to a named dialog. Can be used for applying certain values to control which are not able to be applied just by setting control properties.

exoskeleton.dialog.applyControlPayload("SampleForm", "LogoPicbox", {
  ImagePath: "C:\\images\\pic1.png"
});

Applies property values to controls which have already been added. Can be used for separating control layout and data initialization.

exoskeleton.dialog.applyControlProperties({
  NameTextBox : { Text: "TestUser" },
  EmployeeCheckBox : { Checked: false }
});

Applies a dialog defintion to a named exoskeleton dialog. Dialog definitions allow representation of a series of controls, nesting, and property attributes within a single json object definition.

exoskeleton.dialog.initialize("MyListDialog", { Text: "Test Dialog", Width: 400, Height: 300 });
exoskeleton.dialog.applyDefinition("MyListDialog", {
  SampleList: {
    Type: "ListBox",
    Properties: {
      Dock: "Fill",
      Items: ["one", "two", "three"]
    }
  },
  BottomPanel: { Type: "Panel", Properties: { Dock: "Bottom", Height: 30 } },
  OkButton: {
    Type: "DialogButton",
    Parent: "BottomPanel",
    DialogResult: "OK",
    Properties: { Text: "OK", Width: 100, Height: 30 }
  }
});
var result = exoskeleton.dialog.showDialog("MyListDialog");

Allows you to modify properties on a defined dialog Form object instance. See ms docs

exoskeleton.dialog.applyDialogProperties("ExampleForm", { Text = "Add User dialog" });

Initialize a named exoskeleton dialog.

exoskeleton.dialog.initialize("AddressDialog", {
  Text: "Verify address information",
  Width: 600,
  Height: 400
});

Loads a dialog definition from a file and applies it.

var locations = exoskeleton.getLocations();
var defpath = exoskeleton.file.combinePaths([locations.Current, "definitions", "Address.json"]);
exoskeleton.dialog.loadDefinition("AddressDialog", defpath);

Displays a predefined dialog allowing user to select item(s) from a checklist.

// display picklist with no default selection and no multiselection
var result = exoskeleton.dialog.promptCheckedList(
  "Country Selection",
  "Enter all countries of residence",
  ["United States", "United Kingdom", "Germany", "France", "Australia", "Japan", "China", "India"],
  [0, 2, 3]
);

// since no multiselect, result is a string and not array of strings
if (result !== null) {
  console.log("user picked : " + result);
}

Allows display and row selection of an array of similar objects within a .net DataGridView

var users = [
  { name: "john", age: 24, address: "123 alpha street" },
  { name: "mary", age: 22, address: "222 gamma street" },
  { name: "tom", age: 28, address: "587 delta street" },
  { name: "jane", age: 26, address: "428 beta street" }
];

var result = exoskeleton.dialog.promptDataGridView("Users", "Select users to invite :", users);

// result might contain [0,1,2] for john, mary, and jane indices
if (result) {
  result.forEach(function(idx) {
    console.log("invited: " + users[idx].name);
  });
}

Displays a predefined dialog allowing user to pick a date from a calendar.

// display picklist with no default selection and no multiselection
var result = exoskeleton.dialog.promptDatePicker(
  "Date Selection Example",
  "Please choose a start date :",
  "12/21/2017"
);

if (result !== null) {
  console.log(".net date" + result.Value);
  var jsDate = new Date(result.UniversalEpoch);
  console.log("javascript date : " + jsDate);
}

Displays a predefined dialog allowing user to input a string.

var phoneNumber = exoskeleton.dialog.promptInput(
  "Confirm Information",
  "Enter your telephone number",
  user.PhoneNumber
);

if (phoneNumber !== null) {
  user.PhoneNumber = phoneNumber;
}

Displays a predefined dialog allowing user to select item(s) from a list.

// display listbox with no default selection and no multiselection
var result = exoskeleton.dialog.promptList(
  "Country Selection",
  "Enter your country of residence",
  ["United States", "United Kingdom", "Germany", "France", "Australia", "Japan", "China", "India"]
);

// since no multiselect, result is a string and not array of strings
if (result !== null) {
  console.log("user picked : " + result);
}

Displays a predefined dialog allowing user create an instance of a .net datatype, inspect and modify it, and view it's serialized result. This method is mostly for diagnostic purposes during development.

// Let's just inspect an unitialized ListBox object
var result = exoskeleton.dialog.promptPropertyGrid(
  "PropertyGrid Inspector",
  "Some Listbox",
  {}, // we could apply some properties, but we won't for this example
  "System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
  "System.Windows.Forms.ListBox"
);

// we can inspect the structure of the object and what properties look like when serialized
xo.logObject(result);

Displays a named exoskeleton dialog which you have previously created.

var dialogResult = exoskeleton.dialog.showDialog("AddressDialog");
if (dialogResult.Result === 'OK') {
  console.log(dialogResult.UserNameTextBox.Text);
}

Display a dialog to allow the user to select a color. See: ms docs

var result = exoskeleton.dialog.showColorDialog();
if (result) {
  console.log("color : " + result.Color);
  console.log("hex color : " + result.HexColor);
}

Display a dialog to allow the user to select a font. See: ms docs

var result = exoskeleton.dialog.showFontDialog();
if (result) {
  console.log("font : " + result.Font);
  console.log("fontJson : " + result.FontJson);
}

Allows user to pick a file to 'open' and returns that filename. Although only a few options are documented here, any 'OpenFileDialog' properties may be attempted to be passed. See: ms docs

// example passing a few (optional) dialog initialization settings
var dialogValues = exoskeleton.dialog.showOpenFileDialog({
  Title: "Select myapp data file to open",
  InitialDirectory: "c:\\mydatafolder",
  Filter: "dat files (*.dat)|*.dat|All files (*.*)|*.*"
});
// if user did not cancel
if (dialogValues) {
  console.log("selected file (name) : " + dialogValues.FileName);
}

Displays a message box to the user and returns the button they clicked.

var dialogResultString = exoskeleton.dialog.showMessageBox(
   "An error has occured", "MyApp error", "OKCancel", "Exclamation"
);
if (dialogResultString === "OK") {
  console.log("user clicked ok");
}

Allows user to pick a file to 'save' and returns that filename. Although only a few options are documented here, any 'SaveFileDialog' properties may be attempted to be passed. See: ms docs

// example passing a few (optional) dialog initialization settings
var dialogValues = exoskeleton.dialog.showSaveFileDialog({
  Title: "Pick data file to save to",
  InitialDirectory: "c:\\mydatafolder",
  Filter: "dat files (*.dat)|*.dat|All files (*.*)|*.*"
});
// if user did not cancel
if (dialogValues) {
  console.log("selected file (name) : " + dialogValues.FileName);
}

Encrypts a string using the provided password.

var encryptedString = exoskeleton.enc.encrypt("some secret msg", "s0m3p4ssw0rd");

Decrypts a string using the provided password.

var originalString = "some secret msg";
var encryptedString = exoskeleton.enc.encrypt(originalString, "s0m3p4ssw0rd");
var decryptedString = exoskeleton.enc.decrypt(encryptedString, "s0m3p4ssw0rd");
console.log("original: " + originalString);
console.log("encrypted: " + encryptedString);
console.log("decrypted: " + decryptedString);

Create encrypted copies of the specified file(s) using the provided password.

// creates encrypted file(s) with '.enx' suffix
exoskeleton.enc.encryptFiles("c:\\source", "readme.txt", "s0m3p4ssw0rd");
exoskeleton.enc.encryptFiles("c:\\source", "*.doc", "s0m3p4ssw0rd");

Create decrypted copies of the specified file(s) using the provided password.

// creates decrypted file(s) without the '.enx' suffix
exoskeleton.enc.decryptFiles("c:\\source", "readme.txt.enx", "s0m3p4ssw0rd");
exoskeleton.enc.decryptFiles("c:\\source", "*.doc.enx", "s0m3p4ssw0rd");

Creates ana MD5 Hash for the file specified by the provided filename.

var hash = exoskeleton.enc.createMD5Hash("c:\\source\\readme.txt");

Creates ana SH1 Hash for the file specified by the provided filename.

var hash = exoskeleton.enc.createSHA1Hash("c:\\source\\readme.txt");

Creates ana SHA256 Hash for the file specified by the provided filename.

var hash = exoskeleton.enc.createSHA256Hash("c:\\source\\readme.txt");

Creates MD5, SHA1, and SHA256 hashes for the file(s) specified.

var detailedHashInfo = exoskeleton.enc.hashFiles("c:\\source", "*.doc");
console.log(detailedHashInfo.length);
console.log(detailedHashInfo[0].sha256);

Combine multiple paths into one.

var fullyQualifiedPath = exoskeleton.file.combinePaths(["c:\\downloads", "myfile.txt"]);
console.log(fullyQualifiedPath);
// "c:\downloads\myfile.txt"

Combines multiple paths with a single base/source path.

var paths = exoskeleton.file.combinePathsArray("c:\images", ['img1.jpg', 'img2.jpg', 'img3.jpg']);
console.log(paths);
// logs: ['c:\images\img1.jpg','c:\images\img2.jpg','c:\images\img3.jpg']

Copies an existing file to a new file. Overwriting is not allowed.

exoskeleton.file.copyFile("c:\\myfolder\\file1.txt", "c:\\myfolder\\file1.txt.bak");

Creates all directories and subdirectories in the specified path unless they already exist.

exoskeleton.file.createDirectory("c:\\downloads\\subdir");

Deletes an empty directory (if recursive is false), or recursively deletes subfolders and files (if recursive is true).

// this will only work if the 'subdir' folder is empty
exoskeleton.file.deleteDirectory("c:\\downloads\\subdir");
// this will wipe out the whole 'subdir' folder even if it has files or subdirectories
exoskeleton.file.deleteDirectory("c:\\downloads\\subdir", true);

Deletes the specified file.

exoskeleton.file.deleteFile("c:\\myfolder\\file1.txt.bak");

Gets subdirectory names of a parent directory.

var result = exoskeleton.file.getDirectories("c:\\downloads");
console.dir(result);
// might log:
// [
// "c:\\downloads\\subdir1",
// "c:\\downloads\\subdir2",
// "c:\\downloads\\subdir3"
// ]

Gets DirectoryInfo for the specified directory path.

console.dir(exoskeleton.file.getDirectoryInfo("c:\\downloads"));

Returns the directory portion of the path without the filename.

console.log(exoskeleton.file.getDirectoryName("c:\\downloads\\myfile.txt"));
// logs : "c:\downloads"

Gets information about each of the mounted drives.

var driveInfo = exoskeleton.file.getDriveInfo();
driveInfo.forEach(function(drive) {
  console.log(drive.Name + ":" + drive.AvailableFreeSpace);
});

Gets the file extension of the fully qualified path.

console.log(exoskeleton.file.getExtension("c:\\downloads\\myfile.txt"));
// logs : ".txt"

Gets FileInfo for the specified filename.

Gets list of files matching a pattern within a parent directory.

var results = exoskeleton.file.getFiles("c:\\downloads\\music", "*.mp3");

Gets list of files ending in any of the extension/suffix strings provided.

var results = exoskeleton.file.getFilesEndingWith("c:\\downloads\\music", ".mp3,.m4a");

Returns the filename portion of the path without the directory.

console.log(exoskeleton.file.getFileName("c:\\downloads\\myfile.txt"));
// logs : "myfile.txt"

Resolves an absolute path from a path containing inner relative paths

console.log(exoskeleton.file.getFullPath("d:\archives\january\..\march\test.txt");
// logs : "d:\archives\march\test.txt"

Gets a list of logical drives.

var result = exoskeleton.file.getLogicalDrives();
console.log(result);
// logs : C:\,D:\,Z:\

Opens a text file, reads all lines of the file and returns text as a string.

Reads a binary file into a Base64 string. Can be used for encoding data urls.

var img1 = document.getElementById("img1");
var pic1 = exoskeleton.file.loadFileBase64("c:\\images\\pic1.png");
img1.src = 'data:image/png;base64,' + pic1;

Writes a text file with the provided contents string. If the file already exists, it will be overwritten.

Writes a binary file with bytes derived from the provided base64 string.

var canvas = document.getElementById('canvas');
var b64Text = canvas.toDataURL();
b64Text = b64Text.replace('data:;image/png;base64,','');
exoskeleton.file.saveFileBase64('canvas1.png', b64Text);

Starts our container singleton watcher on path specified by user. Events will be emitted as multicast, so if multiple forms load multiple watchers, they should distinguish themselves with the eventBaseName parameter.

// The following will generate 'download.created', 'download.deleted', and 'download.changed' events.
exoskeleton.file.startWatcher("C:\downloads", "download");
exoskeleton.events.on("multicast.download.created", function(data) {
  // data params is json encoded string (for now).
  exoskeleton.logger.logInfo("multicast.download.created event received", data);
});

Disables the watcher singleton.

exoskeleton.file.stopWatcher();

Adds a CheckBox to a named exoskeleton form. Emits 'CheckedChanged' event if 'emitEvents' is true. See ms docs

exoskeleton.form.addCheckbox("SampleForm", {
  Name: "StudentCheckbox",
  Text: "Student",
  Checked: true,
  Top: 100,
  Left: 10
}, "TopPanel", true);

// optionally listen to events because we passed 'true' above to emit them.
exoekeleton.events.on("SampleForm.StudentCheckbox.CheckedChanged", function (data) {
  console.log(data.Checked?"Is a student":"Not a student");
});

Adds a CheckedListBox to a named exoskeleton form. Emits 'ItemCheck' event if 'emitEvents' is true. See ms docs

exoskeleton.form.addCheckedListBox("SampleForm", {
  Name: "CountryChecklist",
  Top: 10,
  Left: 10,
  Dock: 'Fill'
  Items: ['United States', 'United Kingdom', 'Germany', 'France', 'Japan']
}, "AddressPanel", false, { CheckedIndices: [0, 2] });

// if we had set emitEvents to true, we would listen for 'SampleForm.CountryCheckList.ItemCheck'

Adds a ComboBox to a named exoskeleton form. Emits 'SelectedIndexChanged' event if 'emitEvents' is true. If the combo box items will remain static, you can set items with 'Items' property. If the items are to be dynamic, you should set 'DisplayMember' and 'ValueMember' properties and databind by separate applyControlPayload object with 'DataSource' object array. Passing an additional 'DataSourceKeepSelection' payload property will attempt to retain the currently selected item across the rebinding. See ms docs

exoskeleton.form.addComboBox("SampleForm", {
  Name: "CountryDropDown",
  Top: 10,
  Left: 10,
  Items: ['United States', 'United Kingdom', 'Germany', 'France', 'Japan'],
  SelectedItem : 'United States'
}, "AddressPanel", true);

exoskeleton.events.on("SampleForm.CountryDropDown.SelectedIndexChanged", function(data) {
  console.log(data.Selected);
});

Adds a DataGridView to a named exoskeleton form. Emits 'SelectionChanged' event if 'emitEvents' is true. See ms docs

var users = [
  { name: "john", age: 24, address: "123 alpha street" },
  { name: "mary", age: 22, address: "222 gamma street" },
  { name: "tom", age: 28, address: "587 delta street" },
  { name: "jane", age: 26, address: "428 beta street" }
];

var result = exoskeleton.form.addDataGridView("SampleForm", {
  Name: "UserGridView",
  Dock: 'Fill',
  ReadOnly: true,
  AllowUserToAddRows: false,
  SelectionMode: 'FullRowSelect'
}, "DetailsPanel", false, { ObjectArray: users });

// normally you might use event buttons to trigger code which 'reads' values
// from form. So for this example will not emit events, but we could have.

Adds a DateTimePicker to a named exoskeleton form. Emits 'ValueChanged' event if 'emitEvents' is true. See ms docs

exoskeleton.form.addDateTimePicker("SampleForm", {
  Name: "StartDate",
  Top: 100,
  Left: 100,
  Value: "12/13/2014"
}, "AddressPanel", true);

exoskeleton.events.on("SampleForm.StartDate.ValueChanged", function(data) {
  console.log("Short date string : " + data.Short);
  Date dt = new Date(data.UniversalEpoch);
  console.log("Date converted to javascript : " + dt);
});

Adds a Button to a named exoskeleton form which will raise an Unicast event. This is a standard .net button with hardcoded event handler to raise 'Click' events. See ms docs

// event buttons will always emit their 'Click' event, so it's not even a param
exoskeleton.form.addEventButton("SampleForm", {
  Name: "SaveButton",
  Text: "Save",
  Top: 10,
  Left: 200
}, "BottomPanel");

exoskeleton.events.on("SampleForm.SaveButton.Click", function() {
  console.log('Button clicked!');
});

Adds a Label to a named exoskeleton form. Emits 'Click' event if 'emitEvents' is true. See ms docs

exoskeleton.form.addLabel("SampleForm", {
  Name: "AddressLabel",
  Text: "Address:",
  Top: 100,
  Left: 10
}, "AddressPanel");

Adds a ListBox to a named exoskeleton form. Emits 'SelectedIndexChanged' event if 'emitEvents' is true. If the list box items will remain static, you can set items with 'Items' property. If the items are to be dynamic, you should set 'DisplayMember' and 'ValueMember' properties and databind by separate applyControlPayload object with 'DataSource' object array. Passing an additional 'DataSourceKeepSelection' payload property will attempt to retain the currently selected item across the rebinding. See ms docs

exoskeleton.form.addListBox("SampleForm", {
  Name: "CountryList",
  Top: 10,
  Left: 10,
  Dock: 'Fill'
  Items: ['United States', 'United Kingdom', 'Germany', 'France', 'Japan'],
  SelectedItem : 'United States'
}, "AddressPanel");

Adds a ListView to a named exoskeleton form. Emits 'Click' and 'DoubleClick' events if 'emitEvents' is true. ListView has the following view modes (defined by 'View' property) :

• LargeIcon: 'Thumbnail-like' list using 'Items' payload property (no subitems).
• Details - Tabular list using 'ItemArrays' 2-dimensional payload property for subitems.
• SmallIcon - 'Left-to-Right, Top-to-Bottom' list needing only 'Items' payload property.
• List - 'Top-to-Bottom' list needing only 'Items' payload property.
• Tile - 'L->R, T->B' list with large icons, displaying subitems as multiple lines (2D 'ItemArrays')

The various allowable payloads include :

• 'Columns' - In a tabular view mode these define the column captions/sizes ('Text', 'Width')
• 'Items' - Items array supports single dimension array where each array element is a different list item.
• 'ItemArrays' - ItemArrays support 2-dimension array allowing multiple columns for each 'row'.
• 'AppendItems' - AppendItems is the same as 'Items' but the list will not be cleared before adding those (new) items.
• 'AppendItemArrays' - AppendItemArrays will not clear the listview before appending the new items.

See ms docs.

// LargeIcon view mode - depends on already established named imagelist
var controlProperties = { Name: "CountryList", Top: 10, Left: 10, Dock: 'Fill', View: "LargeIcon" };
var controlPayload = {
  LargeImageList: "LargeListIcons",
  Items: [{ Text: "One", ImageIndex: 0 }, { Text: "Two", ImageIndex: 1 }]
};
exoskeleton.form.addListView("ExampleForm", controlProperties, "AddressPanel", false, controlPayload);

// Details view mode example
controlProperties = { Name: "CountryList", Top: 10, Left: 10, Dock: 'Fill', View: "Details", FullRowSelect: true }
var controlPayload = {
  SmallImageList: "SmallListIcons",
  Columns: [{ Text: "Country", Width:100 }, { Text:"Info1", Width: 120 }, { Text: "Info2", Width: 100 }],
  ItemArrays: [
    [{ Text: "Item One", ImageIndex: 0 }, { Text: "Stuff about One" }, { Text: "More stuff about One" } ],
    [{ Text: "Item Two", ImageIndex: 1 }, { Text: "Stuff about Two" }, { Text: "More stuff about Two" } ],
    [{ Text: "Item Three", ImageIndex: 2 }, { Text: "Stuff about Three" }, { Text: "More stuff about Three" }]
  ]
};
exoskeleton.form.addListView("ExampleForm", controlProperties, "AddressPanel", false, controlPayload);

Adds a MaskedTextBox to a named exoskeleton form. Emits 'TextChanged' event if 'emitEvents' is true. See ms docs

exoskeleton.form.addMaskedTextBox("SampleForm", {
  Name: "PhoneNumberMaskedEdit",
  Mask: "(999)-000-0000",
  Top: 124,
  Left: 48,
  Width: 100
}, "ContactInfoPanel");

Adds a MonthCalendar to a named exoskeleton form. Emits 'DateChanged' event if 'emitEvents' is true. See ms docs

// Since no parentName value is passed, it will be added directly to the form
exoskeleton.form.addMonthCalendar("SampleForm", {
  Name: "MonthCalendar",
  ShowToday: true,
  ShowTodayCircle: true,
  MonthlyBoldedDates: ["1/1/2017", "1/15/2017"],  // bolds 1st and 15th days of every month,
  AnnuallyBoldedDates: ["3/20/2017", "6/1/2017", "9/22/2017", "12/22/2017"], 
  Top: 40,
  Left: 40
});

Adds a NumericUpDown control to a named exoskeleton form. Emits 'ValueChanged' event if 'emitEvents' is true. See ms docs

exoskeleton.form.addNumericUpDown("SampleForm", {
  Name: "AgeNumeric",
  Top: 10,
  Left: 10,
  Minimum: 13,
  Maximum: 120
}, "UserInfoPanel");

Adds a Panel to a named exoskeleton form for layout and nesting purposes. See ms docs

exoskeleton.form.addPanel("SampleForm", {
  Name: "FillPanel",
  Dock: 'Fill'
});
exoskeleton.form.addPanel("SampleForm", {
  Name: "TopPanel",
  Dock: 'Top',
  Height: 100
});
exoskeleton.form.addPanel("SampleForm", {
  Name: "BottomPanel",
  Dock: 'Bottom',
  Height: 100
});

Adds a PictureBox to a named exoskeleton form for layout and nesting purposes. See ms docs

exoskeleton.form.addPictureBox("SampleForm", {
  Name: "LogoPicbox",
  Location: "10, 10",
  Size: "64, 64"
}, false, { ImagePath: "C:\\Images\\pic1.png" });

Adds a RadioButton to a named exoskeleton form. Emits 'CheckedChanged' event if 'emitEvents' is true. See ms docs

exoskeleton.form.addRadioButton("SampleForm", {
  Name: "GenderMale", Text: "Male", Top: 40, Left: 100, Checked: true
}, null, true);

exoskeleton.form.addRadioButton("SampleForm", {
  Name: "GenderFemale", Text: "Female", Top: 40, Left: 140, Checked: false
});

// since only 2 radio buttons, we will just listen to one of the radio buttons
exoskeleton.events.on("SampleForm.GenderMale.CheckedChanged", function(data) {
  console.log(data.Checked?"male":"female");
});

Adds a TextBox to a named exoskeleton form. Emits 'TextChanged' event if 'emitEvents' is true. See ms docs

exoskeleton.form.addTextBox("SampleForm", {
  Name: "Street (1)",
  Top: 40,
  Left: 100,
  Text: user.addr1
}, "AddressPanel");

Adds a TreeView to a named exoskeleton form. Emits 'NodeMouseClick', 'AfterSelect' and 'NodeMouseDoubleClick' events if 'emitEvents' is true. See ms docs

Applies a payload to a control which have already been added to a named form. Can be used for applying certain values to control which are not able to be applied just by setting control properties.

exoskeleton.form.applyControlPayload("SampleForm", "CountryCheckListBox", {
  CheckedIndices: [0, 3]
});

Applies property values to controls which have already been added to a named form. Can be used for separating control layout and data initialization.

exoskeleton.form.applyControlProperties("SampleForm", {
  NameTextBox : { Text: "TestUser" },
  EmployeeCheckBox : { Checked: false }
});

Applies a form defintion to a named form. Dialog definitions allow representation of a series of controls, nesting, and property attributes within a single json object definition.

exoskeleton.form.initialize("ExampleListDialog", { Text: "Test Dialog", Width: 400, Height: 300 });
exoskeleton.form.applyDefinition("ExampleListDialog", {
  SampleList: {
    Type: "ListBox",
    Properties: {
      Dock: "Fill",
      Items: ["one", "two", "three"]
    }
  },
  BottomPanel: { Type: "Panel", Properties: { Dock: "Bottom", Height: 30 } },
  OkButton: {
    Type: "EventButton",
    Parent: "BottomPanel",
    EventName: "SaveEvent",
    Properties: { Text: "Save", Width: 100, Height: 30 }
  }
});
var result = exoskeleton.form.show("ExampleListDialog");

Allows you to modify properties on a defined Form after it has been initialized. See ms docs

exoskeleton.form.applyFormProperties("ExampleForm", { WindowState = "Minimized" });

Closes a named form.

exoskeleton.form.close("ExampleForm");

Initialize or reinitialize a named form.

exoskeleton.form.initialize("UserEditorForm", {
  Text: "Manage users",
  Width: 600,
  Height: 400
});

Obtains object with control values for all controls on form.

var result = exoskeleton.form.generateDynamicResponse("ExampleForm");

Obtains object this simplified control values for a given form name and control name

var countryValues = exoskeleton.form.getControlProperties("UserEditorForm", "CountryCheckListBox");
console.log(countryValues.CheckedIndices);

Loads a dialog definition from a file and applies it.

var locations = exoskeleton.getLocations();
var defpath = exoskeleton.file.combinePaths([locations.Current, "definitions", "UserEditor.json"]);
exoskeleton.form.loadDefinition("UserEditor", defpath);

Displays a named form which you previously configured.

exoskeleton.form.show("UserEditorForm");

Logs an "info" message to the logger's message list.

exoskeleton.logger.logInfo("myfunction", "something interesting happened");

Logs a "warning" message to the logger's message list.

exoskeleton.logger.logInfo("myfunction", "something odd happened");

Logs an "error" message to the logger's message list.

exoskeleton.logger.logError("something dangerous happened", "myfunction");

Logs text to the logger's console.

var now = new DateTime();
exoskeleton.logger.logText("started processing at : " + now);

Logs an object to the logger's console.

var obj = new { a: 1, b: 2 }
exoskeleton.logger.logObject(obj);

Allows updating properties of the host window (.Net) Form object See: ms docs

exoskeleton.main.applyFormProperties({
  WindowState: "Maximized",
  Opacity: 0.9
});

Process all Windows messages currently in the message queue.

exoskeleton.main.doEvents();

Signals the host container to exit fullscreen mode.

exoskeleton.main.exitFullscreen();

Signals the host container to enter fullscreen mode.

exoskeleton.main.fullscreen();

Opens a new host container with the url and settings provided.

// relative pathname
exoskeleton.main.openNewWindow("My App Settings", "settings.htm", 800, 480);
// external internet address
exoskeleton.main.openNewWindow("My App Settings", "https://en.wikipedia.org/wiki/Main_Page", 800, 480);
// You might also pass raw html, prefixed with '@' symbol.
var html = "@<html><body><h3>Hello World</h3></body></html>";
exoskeleton.main.openNewWindow("My dynamic page", html, 400, 400);

(Advanced) method to dynamically switch into native ui mode. By default exoskeleton uses web ui mode within its hosted webbrowser. That can be overridden in settings to Native UI mode as 'default' for all opened windows. That can be overridden in calls to openNewWindow. Finally, even after host form is loaded, this method along with switchToWebUi() can be used to toggle back and forth dynamically.

exoskeleton.main.switchToNativeUi();

(Advanced) method to dynamically switch into mixed ui mode. MixedUi mode uses native ui layout but leaves the webbrowser visible. The webbrowser will be relocated to the panel named by the parameter. The web browser will will be assigned a DockStyle of 'Fill'. MixedUi mode is a 'late' mode, requiring you to have already applied your form layout/definition and established the panel to be used for locating the browser to. controls

// Typically, to use mixed ui mode, you would :
// - use the 'DefaultToNativeUi' setting in your xos file,
// - initialize and apply your form definition (containing the panel named below), and finally
// - switch into mixedui (as below) once your form layout is complete.
exoskeleton.main.switchToMixedUi("BottomRightPanel");

(Advanced) method to dynamically switch into web ui mode. By default exoskeleton uses web ui mode within its hosted webbrowser. That can be overridden in settings to Native UI mode as 'default' for all opened windows. That can be overridden in calls to openNewWindow. Finally, even after host form is loaded, this method along with switchToNativeUi() can be used to toggle back and forth dynamically.

exoskeleton.main.switchToWebUi();

Updates the window title for the host container.

exoskeleton.main.setWindowTitle("My Editor App - " + filename);

Displays a windows system tray notification.

exoskeleton.main.showNotification("my exo app", "some notification details");

Signals the host container to toggle fullscreen mode.

exoskeleton.main.toggleFullscreen();

Provisions a new (empty) named imagelist

exoskeleton.media.createImageList("listViewIcons", {
  ColorDepth: 32,
  ImageSize: "128, 128",
  TransparentColor: "Transparent"
});

Determines if an imagelist exists by the given name

Populates an image list with images

exoskeleton.media.loadImageList("listViewImages", [
  "c:\imgs\img1.png",
  "c:\imgs\img2.jpg",
  "c:\imgs\img3.bmp",
  "c:\imgs\img4.gif"
]);

Clears a named imagelist but leaves it created for future use.

exoskeleton.media.clearImageList("listViewImages");

Removes a named imagelist from memory.

exoskeleton.media.removeImageList(name);

Removes all named imagelists from memory.

exoskeleton.media.removeAllImageLists();

Invokes text-to-speech to speak the provided message.

exoskeleton.media.speak("this is a test");

Invokes text-to-speech to synchronously speak the provided message.

exoskeleton.media.speakSync("this is a test");

Enables visibility of the window's menu

exoskeleton.menu.show();

Hides visibility of the window's menu

exoskeleton.menu.hide();

Removes all menu items for reinitialization. Host window survives across inner page (re)loads or redirects so menus would need to be (re)initialized on page loads.

exoskeleton.menu.initialize();

Adds a top level menu

exoskeleton.menu.addMenu("File");
exoskeleton.menu.addMenu("About", "AboutClicked");

Adds menu subitems to an existing menu or submenu. Any event emitted on click will be passed the menu item text as parameter.

exoskeleton.menu.initialize();
exoskeleton.menu.addMenu("File");
exoskeleton.menu.addMenuItem("File", "Open", "FileOpenEvent", ["Control", "Shift", "O"]);
exoskeleton.menu.addMenuItem("File", "New");
// for this example we will use the same common event name for submenu items
// these can also be different
exoskeleton.menu.addMenuItem("New", ".txt file", "FileNewEvent");
exoskeleton.menu.addMenuItem("New", ".png file", "FileNewEvent");
exoskeleton.on("FileOpenEvent", function() {
  alert('File/Open clicked');
});
exoskeleton.on("FileNewEvent", function(data) {
  alert('File/New/' + data + ' clicked');
});

Downloads from an internet url and saves to disk.

exoskeleton.net.downloadFile("https://github.com/obeliskos/exoskeleton/archive/0.2.zip",
  "c:\\downloads\\0.2.zip", false);

Fetches text-based resource at the provided url and returns a string of its content.

var readmeText = exoskeleton.net.readUrl("https://raw.githubusercontent.com/obeliskos/exoskeleton/master/README.md");
exoskeleton.logger.logText(readmeText);

Starts a process resource by specifying the name of a document or application file.

exoskeleton.proc.startPath("calc.exe");
exoskeleton.proc.startPath("c:\\windows\\system32\\notepad.exe");

Starts a process resource by providing information in a ProcessStartInfo format.

exoskeleton.proc.start({
  FileName: "notepad.exe",
  Arguments: "c:\\docs\\readme.txt"
});

Gets a detailed list of running processes and their settings. (Takes a long time to run)

var procList = exoskeleton.proc.getProcesses();
procList.forEach(function(p) {
  // properties available should correlate to .net Process class member properties.
  console.log(p.ProcessName + " : " + p.Id);
});

Gets a simplified list of running processes.

var procList = exoskeleton.proc.getProcessesSimplified();
procList.forEach(function(p) {
  // properties available are 'Id', 'ProcessName' and 'MainWindowTitle'.
  console.log(p.ProcessName + " : " + p.Id);
});

Gets detailed process information by process id.

Gets a list of processes of the provided name.

var procList = exoskeleton.proc.getProcessesByName("notepad");
procList.forEach(function(p) {
  console.log(p.ProcessName + " : " + p.Id);
});

Kills a running process.

// The id passed can be looked up via calls to getProcesses or getProcessesByName.
exoskeleton.proc.killProcessById(1608);

Looks up the (string) Value for the Session key provided.

var result = exoskeleton.session.get("username");

Looks up the (object) Value for the Session key provided.

var userInfo = exoskeleton.session.getObject("UserInfo");
console.log(userInfo.name + userInfo.addr + userInfo.phone);

Obtains a string list of all keys currently in the session store.

var result = exoskeleton.session.list();
result.forEach(function(keyname) {
  console.log(exoskeleton.session.get(keyname));
});

Assigns a key/value setting within the session store.

exoskeleton.session.set("username", "jdoe");

Assigns a key/value setting within the session store by serializing it.

exoskeleton.session.setObject("UserInfo", {
  name: "jdoe",
  addr: "123 anystreet",
  phone: "555-1212"
});

Enables visibility of the window's status bar.

exoskeleton.statusbar.show();

Hides visibility of the window's status bar.

exoskeleton.statusbar.hide();

Clears both left and right status labels

exoskeleton.statusbar.initialize();

Sets the text to be displayed in the left status label

exoskeleton.statusbar.setLeftLabel("Welcome to my app");

Sets the text to be displayed in the right status label

exoskeleton.statusbar.setRightLabel("Started : " + new Date());

Get information about the system which this program is being run on.

var si = exoskeleton.system.getSystemInfo();
console.dir(si);
console.log(si.MachineName);

Retrieves a single environment variable value.

var path = exoskeleton.system.getEnvironmentVariable("PATH");

Returns a list of all environment variables as properties and property values.

var envVariables = exoskeleton.system.getEnvironmentVariables();
Object.keys(envVariables, function(key) {
  console.log("key: " + key + " val : " + exoskeleton.system.getEnvironmentVariable(key));
});

Sets an environment variable only within this process or child processes.

var now = new DateTime();
var path = exoskeleton.system.setEnvironmentVariable("LAUNCHTIME", now.toString());

Finds an existing application window by either class or name and focuses it.

// assuming notepad is already running :
exoskeleton.system.focusWindow("notepad", null);
exoskeleton.system.focusWindow(null, "readme.txt - Notepad");

Finds a window and sends keycodes to it. This uses .Net SendKeys(), for info on key codes read : https://msdn.microsoft.com/en-us/library/system.windows.forms.sendkeys(v=vs.110).aspx

exoskeleton.system.focusAndSendKeys("notepad", null, ["t", "e", "s", "t", "{ENTER}"]);

Enables visibility of the window's toolbar.

exoskeleton.toolbar.show();

Hides visibility of the window's toolbar.

exoskeleton.toolbar.hide();

Empties the host window toolstrip of all controls

exoskeleton.toolbar.initialize();

Adds a ToolStripButton to the host window toolstrip

exoskeleton.toolbar.initializeMenu();
exoskeleton.toolbar.addButton("Create new document", "NewDocEvent", "c:\\images\\new.png");
exoskeleton.toolbar.addButton("Exit", "ExitEvent", "c:\\images\\exit.png");
exoskeleton.events.on("NewDocEvent", function() {
  showCustomFileOpenDialog();
});
exoskeleton.events.on("ExitEvent", function() {
  exoskeleton.shutdown();
});

Adds a visual separator for toolstrip control groups

exoskeleton.toolbar.addSeparator();

Converts a .NET date to unix format for use with javascript.

// look up some directory info
var dirinfo = exoskeleton.file.getDirectoryInfo("c:\\myfolder");
// convert its last write time to unix (number of ms since 1/1/1970)
var unixTime = exoskeleton.main.convertDateToUnix(dirinfo.LastWriteTimeUtc);
// create a javascript date from unix format
var dt = new Date(unixTime);

Converts a javascript unix epoch time to a .net formatted date. See ms docs

var now = new Date();
// 24 hr date and time
var result = exoskeleton.util.formatUnixDate(now, "MM/dd/yy H:mm:ss");
alert(result);
// formatted date only
result = exoskeleton.util.formatUnixDate(now.getTime(), "MMMM dd, yyyy");
alert(result);
// formatted time only
result = exoskeleton.util.formatUnixDate(now, "hh:mm:ss tt");

An expected method provided for lokijs to load a database from.

Used to load a value asynchronously from the keystore.

An expected method provided for lokijs to save a database from.

Used to asynchronously save a key/value into the (file based) keystore.

Hashobject for storing the registered events and callbacks

Whether events should be emitted immediately (true) or whenever thread is yielded (false).

Clears all event listeners

// clear event listeners for all registered events
exoskeleton.events.clear();
// clear event listeners for a single event
exoskeleton.events.clear("FileMenuClicked");
// clear event listeners for multiple named events
exoskeleton.events.clear(["FileMenuClicked", "HelpMenuClicked"]);

Used to register a listener to an event.

Used to emit a specific event, possibly with additional parameter data.