compiler.build.ExcelAddInOptions

Options for building Excel add-ins

Since R2021a

Syntax

opts = compiler.build.ExcelAddInOptions(FunctionFiles)

opts = compiler.build.ExcelAddInOptions(FunctionFiles,Name,Value)

Description

opts = compiler.build.ExcelAddInOptions(FunctionFiles) creates an ExcelAddInOptions object using the MATLAB^® functions specified by FunctionFiles. Use the ExcelAddInOptions object as an input to the compiler.build.excelAddIn function.

opts = compiler.build.ExcelAddInOptions(FunctionFiles,Name,Value) creates an ExcelAddInOptions object with options specified using one or more name-value arguments. Options include the add-in name, additional files to include, and the output directory.

Examples

Create Excel Add-In Options Object

Create an ExcelAddInOptions object using file input.

For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.ExcelAddInOptions(appFile)

opts = 

  ExcelAddInOptions with properties:

                  AddInName: 'magicsquare'
               AddInVersion: '1.0.0.0'
                  ClassName: 'magicsquareClass'
                 DebugBuild: off
               EmbedArchive: on
              FunctionFiles: {'C:\Program Files\MATLAB\R2023a\extern\examples\compiler\magicsquare.m'}
    GenerateVisualBasicFile: off
            AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
                    Verbose: off
                  OutputDir: '.\magicsquareexcelAddIn'

You can modify the property values of an existing ExcelAddInOptions object using dot notation. For example, enable verbose output.

opts.Verbose = 'on'

opts = 

  ExcelAddInOptions with properties:

                  AddInName: 'magicsquare'
               AddInVersion: '1.0.0.0'
                  ClassName: 'magicsquareClass'
                 DebugBuild: off
               EmbedArchive: on
              FunctionFiles: {'C:\Program Files\MATLAB\R2023a\extern\examples\compiler\magicsquare.m'}
    GenerateVisualBasicFile: off
            AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
                    Verbose: on
                  OutputDir: '.\magicsquareexcelAddIn'

Use the ExcelAddInOptions object as an input to the compiler.build.excelAddIn function to build the Excel^® add-in.

buildResults = compiler.build.excelAddIn(opts);

Customize Excel Add-In Options Object

Create an ExcelAddInOptions object and customize it using name-value arguments.

For this example, use the file magicsquare.m located in matlabroot\extern\examples\compiler. Use name-value arguments to specify the output directory, generate a Visual Basic^® file, and enable verbose output.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
opts = compiler.build.ExcelAddInOptions(appFile,...
    'OutputDir','D:\Documents\MATLAB\work\MagicSquareAddIn',...
    'GenerateVisualBasicFile','On')

opts =

  ExcelAddInOptions with properties:

                  AddInName: 'magicsquare'
               AddInVersion: '1.0.0.0'
                  ClassName: 'magicsquareClass'
                 DebugBuild: off
               EmbedArchive: on
              FunctionFiles: {'C:\Program Files\MATLAB\R2023a\extern\examples\compiler\magicsquare.m'}
    GenerateVisualBasicFile: on
            AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
                    Verbose: off
              OutputDir: 'D:\Documents\MATLAB\work\MagicSquareAddIn'

Use the ExcelAddInOptions object as an input to the compiler.build.excelAddIn function to build the Excel add-in.

buildResults = compiler.build.excelAddIn(opts);

Input Arguments

FunctionFiles — MATLAB function files

character vector | string scalar | cell array of character vectors | string array

List of files implementing MATLAB functions, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Files must have a .m extension.

Example: {'myFunction1.m','myFunction2.m'}

Data Types: char | string | cell

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Verbose','on'

AddInName — Name of Excel add-in

character vector | string scalar

Name of the Excel add-in, specified as a character vector or string scalar. The default name of the generated add-in is the first entry of the FunctionFiles argument. The name must begin with a letter and contain only alphabetic characters and underscores.

Example: 'AddInName','myAddIn'

Data Types: char | string

AddInVersion — Add-in version

'1.0.0.0' (default) | character vector | string scalar

Add-in version, specified as a character vector or a string scalar.

Example: 'AddInVersion','4.0'

Data Types: char | string

AdditionalFiles — Additional files

character vector | string scalar | cell array of character vectors | string array

Additional files and folders to include in the Excel add-in, specified as a character vector, a string scalar, a string array, or a cell array of character vectors. Paths can be relative to the current working directory or absolute.

Example: 'AdditionalFiles',["myvars.mat","data.txt"]

Data Types: char | string | cell

AutoDetectDataFiles — Flag to automatically include data files

'on' (default) | on/off logical value

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 you provide as inputs to certain functions (such as load and fopen) are automatically included in the add-in.

• If you set this property to 'off', then you must add data files to the add-in using the AdditionalFiles property.

Example: 'AutoDetectDataFiles','Off'

Data Types: logical

ClassName — Name of class

character vector | string scalar

Name of the class, specified as a character vector or a string scalar. Class names must match Excel add-in class name requirements.

The default value is the name of the first file listed in the FunctionFiles argument appended with Class.

Example: 'ClassName','magicsquareClass'

Data Types: char | string

DebugBuild — Flag to enable debug symbols

'on' (default) | on/off logical value

Flag to enable debug symbols, 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 add-in is compiled with debug symbols.

• If you set this property to 'off', then the add-in is not compiled with debug symbols.

Example: 'DebugSymbols','on'

Data Types: logical

EmbedArchive — Flag to embed deployable archive

'on' (default) | on/off logical value

Flag to embed the deployable 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 function embeds the deployable archive in the Excel add-in.

• If you set this property to 'off', then the function generates the deployable archive as a separate file.

Example: 'EmbedArchive','Off'

Data Types: logical

GenerateVisualBasicFile — Flag to generate Visual Basic file

'off' (default) | on/off logical value

Flag to generate a Visual Basic file (.bas) and an Excel add-in file (.xla), 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 function generates an Excel add-in XLA file and a Visual Basic BAS file containing the Microsoft^® Excel Formula Function interface to the add-in.

• If you set this property to 'off', then the function does not generate a Visual Basic file or an Excel add-in file.

Note

To generate the Excel add-in file (.xla), you must enable "Trust access to the VBA project object model" in your Excel settings.

Example: 'GenerateVisualBasicFile','on'

Data Types: logical

ObfuscateArchive — Flag to obfuscate deployable archive

'off' (default) | on/off logical value

Flag to obfuscate the deployable 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 folder structures and file names in the deployable archive are obfuscated from the end user, and user code and data contained in MATLAB files are placed into a user package within the archive. Additionally, all .m files are converted to P-files before packaging. This option is equivalent to using mcc with -j and -s specified.

• If you set this property to 'off', then the deployable archive is not obfuscated. This is the default behavior.

Example: 'ObfuscateArchive','on'

Data Types: logical

OutputDir — Path to output directory

character vector | string scalar

Path to the output directory where the build files are saved, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.

The default name of the build folder is the add-in name appended with excelAddIn.

Example: 'OutputDir','D:\Documents\MATLAB\work\mymagicexcelAddIn'

Data Types: char | string

SupportPackages — Support packages

'autodetect' (default) | 'none' | string scalar | cell array of character vectors | string array

Support packages to include, specified as one of the following options:

• 'autodetect' (default) — The dependency analysis process detects and includes the required support packages automatically.

• 'none' — No support packages are included. Using this option can cause runtime errors.

• A string scalar, character vector, or cell array of character vectors — Only the specified support packages are included. To list installed support packages or those used by a specific file, see compiler.codetools.deployableSupportPackages.

Example: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

Data Types: char | string | cell

Verbose — Flag to control build verbosity

'off' (default) | on/off logical value

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

opts — Excel add-in build options

ExcelAddInOptions object

Excel add-in build options, returned as an ExcelAddInOptions object.

Version History

Introduced in R2021a