compiler.build.excelAddIn
This function is only supported on Windows® operating systems.
Syntax
Description
compiler.build.excelAddIn(
creates an Excel® add-in using MATLAB® functions specified by FunctionFiles
)FunctionFiles
. Before creating
Excel add-ins, install a supported compiler.
compiler.build.excelAddIn(
creates an Excel add-in with options specified using one or more name-value arguments. Options
include the add-in name, the output directory, and whether to generate a Microsoft®
Visual Basic® file.FunctionFiles
,Name,Value
)
compiler.build.excelAddIn(
creates an
Excel add-in with options specified using a
opts
)compiler.build.excelAddInOptions
object opts
. You
cannot specify any other options using name-value arguments.
Examples
Create Excel Add-In
Create an Excel add-in on a Windows system using a function file that generates a magic square.
Ensure that you have the following installed:
The Windows 10 SDK kit. For details, see Windows 10 SDK.
MinGW-w64. To install it from the bat365 File Exchange, see MATLAB Support for MinGW-w64 C/C++ Compiler.
Use
mbuild -setup -client mbuild_com
to ensure that MATLAB is able to create Excel add-ins.
In MATLAB, locate the MATLAB function that you want to deploy as an Excel add-in. For this example, use the file magicsquare.m
located in
.matlabroot
\extern\examples\compiler
appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
Build an Excel add-in using the compiler.build.excelAddIn
command.
compiler.build.excelAddIn(appFile);
The function generates the following files within a folder named
magicsquareexcelAddIn
in your current working directory:
dlldata.c
GettingStarted.html
includedSupportPackages.txt
magicsquare.def
magicsquare.bas
(Only if you enable the'GenerateVisualBasicFile'
option)magicsquare.rc
magicsquare.xla
(Only if you enable the'GenerateVisualBasicFile'
option)magicsquare_1_0.dll
magicsquare_dll.cpp
magicsquare_idl.h
magicsquare_idl.idl
magicsquare_idl.tlb
magicsquare_idl_i.c
magicsquare_idl_p.c
magicsquareClass_com.cpp
magicsquareClass_com.hpp
mccExcludedFiles.log
mwcomtypes.h
mwcomtypes_i.c
mwcomtypes_p.c
readme.txt
requiredMCRProducts.txt
unresolvedSymbols.txt
Customize Excel Add-In
Create an Excel add-in on a Windows system and customize it using name-value arguments.
For this example, use the file magicsquare.m
located in
.matlabroot
\extern\examples\compiler
appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
Build an Excel add-in using the compiler.build.excelAddIn
command.
Use name-value arguments to specify the add-in name and version, generate a Microsoft
Visual Basic file, and enable verbose output.
compiler.build.excelAddIn(appFile,'AddInName','MyMagicSquare',... 'AddInVersion','2.0',... 'GenerateVisualBasicFile','on',... 'Verbose','on');
The function generates the following files within a folder named
MyMagicSquareexcelAddIn
in your current working directory:
dlldata.c
GettingStarted.html
includedSupportPackages.txt
magicsquareClass_com.cpp
magicsquareClass_com.hpp
mccExcludedFiles.log
mwcomtypes.h
mwcomtypes_i.c
mwcomtypes_p.c
MyMagicSquare.bas
MyMagicSquare.def
MyMagicSquare.rc
MyMagicSquare.xla
MyMagicSquare_2_0.dll
MyMagicSquare_dll.cpp
MyMagicSquare_idl.h
MyMagicSquare_idl.idl
MyMagicSquare_idl.tlb
MyMagicSquare_idl_i.c
MyMagicSquare_idl_p.c
readme.txt
requiredMCRProducts.txt
unresolvedSymbols.txt
Create Multiple Add-Ins Using Options Object
Create multiple Excel add-ins on a Windows system using a compiler.build.ExcelAddInOptions
object.
For this example, use the file magicsquare.m
located in
.matlabroot
\extern\examples\compiler
appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
Create an ExcelAddInOptions
object using
appFile
. Use name-value arguments to specify a common output
directory, generate a Visual Basic file, and enable verbose output.
opts = compiler.build.excelAddInOptions(appFile,... 'OutputDir','D:\Documents\MATLAB\work\ExcelAddInBatch',... 'GenerateVisualBasicFile','on',... 'Verbose','on')
opts =
ExcelAddInOptions with properties:
AddInName: 'magicsquare'
AddInVersion: '1.0.0.0'
ClassName: 'magicsquareClass'
DebugBuild: off
EmbedArchive: on
FunctionFiles: {'C:\Program Files\MATLAB\R2023b\extern\examples\compiler\magicsquare.m'}
GenerateVisualBasicFile: on
AdditionalFiles: {}s+ AutoDetectDataFiles: ons+ ObfuscateArchive: offs+ SupportPackages: {'autodetect'}
Verbose: on
OutputDir: 'D:\Documents\MATLAB\work\ExcelAddInBatch'
Build the add-in using the ExcelAddInOptions
object.
compiler.build.excelAddIn(opts);
To create a new add-in using the function file myMagic2.m
with
the same options, use dot notation to modify the FunctionFiles
argument of the existing ExcelAddInOptions
object before running the
build function again.
opts.FunctionFiles = 'myMagic2.m';
compiler.build.excelAddIn(opts);
By modifying the FunctionFiles
argument and recompiling, you can
create multiple add-ins using the same options object.
Get Build Information from Excel Add-In
Create an Excel add-in and save information about the build type, generated files,
included support packages, and build options to a
compiler.build.Results
object.
Compile using the file magicsquare.m
.
results = compiler.build.excelAddIn('magicsquare.m')
results = Results with properties: BuildType: 'excelAddIn' Files: {2×1 cell} IncludedSupportPackages: {} Options: [1×1 compiler.build.ExcelAddInOptions]
The Files
property contains the paths to the following compiled files:
magicsquare_1_0.dll
GettingStarted.html
Note
The files magicsquare.bas
and
magicsquare.xla
are included in Files
only if you enable the 'GenerateVisualBasicFile'
option in
the build command.
Input Arguments
FunctionFiles
— Files implementing MATLAB functions
character vector | string scalar | cell array of character vectors | string array
Files implementing MATLAB functions, 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. Files must have a .m
extension.
Example: ["myfunc1.m","myfunc2.m"]
Data Types: char
| string
| cell
opts
— Excel add-in build options
compiler.build.ExcelAddInOptions
object
Excel add-in build options, specified as a compiler.build.ExcelAddInOptions
object.
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 asload
andfopen
) 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 theAdditionalFiles
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 usingmcc
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
results
— Build results
compiler.build.Results
object
Build results, returned as a compiler.build.Results
object. The Results
object contains:
The build type, which is
'excelAddIn'
Paths to the following files:
GettingStarted.html
AddInName
_AddInVersion
.dll
(if you enable theAddInName
.bas'GenerateVisualBasicFile'
option)
(if you enable theAddInName
.xla'GenerateVisualBasicFile'
option)
A list of included support packages
Build options, specified as an
ExcelAddInOptions
object
Version History
Introduced in R2021a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other bat365 country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)