# compiler.build.StandaloneApplicationOptions

Create a standalone application options object

## Syntax

``opts = compiler.build.StandaloneApplicationOptions(AppFile)``
``opts = compiler.build.standaloneApplicationOptions(AppFile,Name,Value)``

## Description

example

````opts = compiler.build.StandaloneApplicationOptions(AppFile)` creates a default standalone application options object using a MATLAB® function, class, or app specified by `AppFile`. The `StandaloneApplicationOptions` object is passed as an input to the `compiler.build.standaloneApplication` and `compiler.build.standaloneWindowsApplication` functions.```

example

````opts = compiler.build.standaloneApplicationOptions(AppFile,Name,Value)` creates a standalone application options object with additional customizations specified by one or more name-value pairs.```

## Examples

collapse all

Create a `StandaloneApplicationOptions` object on a Windows® system.

`opts = compiler.build.StandaloneApplicationOptions('mymagic.m')`
```opts = StandaloneApplicationOptions with properties: ExecutableName: 'mymagic' CustomHelpTextFile: '' EmbedArchive: on ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2020b\toolbox\toolbox\compiler\resources\default_splash.png' ExecutableIcon: 'C:\Program Files\MATLAB\R2020b\toolbox\compiler\resources\default_icon_48.png' ExecutableVersion: '1.0.0.0' AppFile: 'mymagic.m' TreatInputsAsNumeric: off AdditionalFiles: {} AutoDetectDataFiles: on OutputDir: '.\mymagicstandaloneApplication' Verbose: off```

You can modify property values of an existing `StandaloneApplictionOptions` object using dot notation.

`opts.Verbose = 'on'`
```opts = StandaloneApplicationOptions with properties: ExecutableName: 'mymagic' CustomHelpTextFile: '' EmbedArchive: on ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2020b\toolbox\toolbox\compiler\resources\default_splash.png' ExecutableIcon: 'C:\Program Files\MATLAB\R2020b\toolbox\compiler\resources\default_icon_48.png' ExecutableVersion: '1.0.0.0' AppFile: 'mymagic.m' TreatInputsAsNumeric: off AdditionalFiles: {} AutoDetectDataFiles: on OutputDir: '.\mymagicstandaloneApplication' Verbose: on```

Customize a `StandaloneApplictionOptions` object using name-value pairs on a Windows system.

Create a `StandaloneApplicationOptions` object.

```opts = compiler.build.StandaloneApplicationOptions('mymagic.m',... 'OutputDir','D:\Documents\MATLAB\work\MagicApp',... 'TreatInputsAsNumeric','On',... 'ExecutableIcon','D:\Documents\MATLAB\work\images\magicicon.png',... 'ExecutableVersion','2.0')```
```opts = StandaloneApplicationOptions with properties: ExecutableName: 'mymagic' ExecutableVersion: '2.0' CustomHelpText: '' EmbedArchive: on ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2020b\toolbox\toolbox\compiler\resources\default_splash.png' ExecutableIcon: 'D:\Documents\MATLAB\work\images\magicicon.png' AppFile: 'mymagic.m' TreatInputsAsNumeric: on AdditionalFiles: {} AutoDetectDataFiles: on OutputDir: 'D:\Documents\MATLAB\work\MagicApp' Verbose: off```

You can modify property values of an existing `StandaloneApplictionOptions` object using dot notation.

`opts.Verbose = 'on'`
```opts = StandaloneApplicationOptions with properties: ExecutableName: 'mymagic' ExecutableVersion: '2.0' CustomHelpText: '' EmbedArchive: on ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2020b\toolbox\toolbox\compiler\resources\default_splash.png' ExecutableIcon: 'D:\Documents\MATLAB\work\images\magicicon.png' AppFile: 'mymagic.m' TreatInputsAsNumeric: on AdditionalFiles: {} AutoDetectDataFiles: on OutputDir: 'D:\Documents\MATLAB\work\MagicApp' Verbose: on```

## Input Arguments

collapse all

Path to the main file used to build the application, specified as a row character vector or a string scalar. The file must be a MATLAB function, class, or app of one of the following types: .m, .p, .mlx, .mlapp, or a valid MEX file.

Example: `'mymagic.m'`

Data Types: `char` | `string`

### Name-Value Pair Arguments

Specify optional comma-separated pairs of `Name,Value` arguments. `Name` is the argument name and `Value` is the corresponding value. `Name` must appear inside quotes. You can specify several name and value pair arguments in any order as `Name1,Value1,...,NameN,ValueN`.

Example: `'Verbose','on'`

Additional files to be included in the standalone application, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. File paths can be relative to the current working directory or absolute.

Example: `'AdditionalFiles',["myvars.mat","myfunc.m"]`

Data Types: `char` | `string` | `cell`

Flag to automatically include data files, specified as `'on'` or `'off'`, or as numeric or logical `1` (`true`) or `0` (`false`). A value of `'on'` is equivalent to `true`, and `'off'` is equivalent to `false`. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type `matlab.lang.OnOffSwitchState`.

• If you set this property to `'on'`, then data files that are provided as inputs to certain functions (`load`, `fopen`, etc) are automatically included in the standalone application.

• If you set this property to `'off'`, then data files must be added to the application using the `AdditionalFiles` property.

Example: `'AutoDetectDataFiles','Off'`

Path to a help file containing help text for the end user of the application, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

Example: `'CustomHelpTextFile','D:\Documents\MATLAB\work\helpfile.txt'`

Data Types: `char` | `string`

Flag to embed the standalone archive, specified as `'on'` or `'off'`, or as numeric or logical `1` (`true`) or `0` (`false`). A value of `'on'` is equivalent to `true`, and `'off'` is equivalent to `false`. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type `matlab.lang.OnOffSwitchState`.

• If you set this property to `'on'`, then the standalone archive is embedded into the standalone executable.

• If you set this property to `'off'`, then the standalone archive is generated as a separate file.

Note

This property is ignored for Java libraries.

Example: `'EmbedArchive','Off'`

Data Types: `logical`

Path to an icon image, specified as a character vector or a string scalar. The image is used as the icon for the standalone application executable. The path can be relative to the current working directory or absolute. Accepted image types are `.jpg`, `.jpeg`, `.png`, `.bmp`, and `.gif`.

The default path is:

`matlabroot\toolbox\compiler\resources\default_icon_48.png`

Example: `'ExecutableIcon','D:\Documents\MATLAB\work\images\myIcon.png'`

Data Types: `char` | `string`

Name of the generated application, specified as a character vector or a string scalar. The default value is the file name of `AppFile`. Target output names must begin with a letter or underscore character and contain only alpha-numeric characters or underscores.

Example: `'ExecutableName','MagicSquare'`

Data Types: `char` | `string`

Path to the splash image, specified as a character vector or a string scalar. The image is used as the splash screen for the standalone application. The path can be relative to the current working directory or absolute. Accepted image types are `.jpg`, `.jpeg`, `.png`, `.bmp`, and `.gif`. The image is resized to 400 pixels by 400 pixels.

Example: `'D:\Documents\MATLAB\work\images\mySplash.png'`

Data Types: `char` | `string`

Version of the executable, specified as a character vector or a string scalar.

Note

This is only used on Windows.

Example: `'4.0'`

Data Types: `char` | `string`

Path to the output directory where the build files are saved, specified as a character vector or a string scalar.

If no path is specified, a build folder named `ExecutableNamestandaloneApplication` will be created in the current working directory.

Example: `'OutputDir','D:\Documents\MATLAB\work\MagicSquarestandaloneApplication'`

Interpret command line inputs as numeric values, specified as `'on'` or `'off'`, or as numeric or logical `1` (`true`) or `0` (`false`). A value of `'on'` is equivalent to `true`, and `'off'` is equivalent to `false`. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type `matlab.lang.OnOffSwitchState`.

• If you set this property to `'on'`, then command line inputs will be treated as numeric MATLAB doubles.

• If you set this property to `'off'`, then command line inputs will be treated as MATLAB character vectors.

Example: `'TreatInputsAsNumeric','On'`

Flag to control build verbosity, specified as `'on'` or `'off'`, or as numeric or logical `1` (`true`) or `0` (`false`). A value of `'on'` is equivalent to `true`, and `'off'` is equivalent to `false`. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type `matlab.lang.OnOffSwitchState`.

• If you set this property to `'on'`, then the MATLAB command window displays progress information indicating code generation stages and compiler output during the build process.

• If you set this property to `'off'`, then the command window does not display progress information.

Example: `'Verbose','On'`

Data Types: `logical`

## Output Arguments

collapse all

Standalone application build options, returned as a `StandaloneApplictionOptions` object.