compiler.build.ExcelAddInOptions
Syntax
Description
creates an opts
= compiler.build.ExcelAddInOptions(FunctionFiles
)ExcelAddInOptions
object using the MATLAB® functions specified by FunctionFiles
. Use the
ExcelAddInOptions
object as an input to the compiler.build.excelAddIn
function.
creates an opts
= compiler.build.ExcelAddInOptions(FunctionFiles
,Name,Value
)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\R2024b\extern\examples\compiler\magicsquare.m'}
GenerateVisualBasicFile: off
AdditionalFiles: {}
AutoDetectDataFiles: on
ExternalEncryptionKey: [0×0 struct]
ObfuscateArchive: off
SecretsManifest: ''
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\R2024b\extern\examples\compiler\magicsquare.m'}
GenerateVisualBasicFile: off
AdditionalFiles: {}
AutoDetectDataFiles: on
ExternalEncryptionKey: [0×0 struct]
ObfuscateArchive: off
SecretsManifest: ''
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
.
Use name-value arguments to specify the output directory, generate a Visual Basic® file, and enable verbose output.matlabroot
\extern\examples\compiler
appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m'); opts = compiler.build.ExcelAddInOptions(appFile, ... 'OutputDir','D:\Documents\MATLAB\work\MagicSquareAddIn', ... 'GenerateVisualBasicFile','On')
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 one of the following extensions: .m
, .p
, .mlx
, or .mexa64
.
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 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
'off'
(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 debugging symbol information is included in the compiled artifact. This option also causesmbuild
to pass appropriate debugging flags to the system compiler. The debug option lets you back trace up to the point where you can identify if the failure occurred in the initialization of MATLAB Runtime, the function call, or the termination routine. This option does not let you debug your MATLAB files with an external debugger.If you set this property to
'off'
, then debug symbols are not included. This is the default option.
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
ExternalEncryptionKey
— Paths to encryption key and loader files
scalar struct
Since R2024b
Paths to the external AES encryption key and MEX key loader files, specified
as a scalar struct with exactly two row char vector or string scalar fields
named EncryptionKeyFile
and
RuntimeKeyLoaderFile
, respectively. Both struct fields
are required. File paths can be relative to the current working directory or
absolute.
For example, specify the encryption key as encrypt.key
and
loader file as loader.mexw64
using struct
keyValueStruct
.
keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'
The encryption key file must be in one of the following supported formats:
Binary 256-bit AES key, with a 32 byte file size
Hex encoded AES key, with a 64 byte file size
The MEX file loader retrieves the decryption key at runtime and must be an interface with the following arguments:
prhs[0]
— Input, char array specified as the static value'get'
prhs[1]
— Input, char array specified as the CTF component UUIDplhs[0]
— Output, 32 byte UINT8 numeric array or 64 byte hex encoded char array, depending on the key format
Avoid sharing the same key across multiple CTFs.
Example: 'ExternalEncryptionKey',keyValueStruct
Data Types: struct
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
SecretsManifest
— Path to JSON manifest file
character vector | string scalar
Since R2024b
Path to a secret manifest JSON file that specifies the secret keys to be embedded in the deployable archive, specified as a character vector or a string scalar. The path can be relative to the current working directory or absolute.
If your MATLAB code calls the getSecret
, getSecretMetadata
, or isSecret
function, you must specify the secret keys to embed in
the deployable archive in a JSON secret manifest file. If your code calls
getSecret
and you do not specify the
SecretsManifest
option, MATLAB
Compiler™ issues a warning and generates a template JSON file in the output
folder named
.
Modify this file by specifying the secret key names in the Embedded field.<component_name>
_secrets_manifest.json
The setSecret
function is not deployable. To embed secret keys in a
deployable archive, you must call setSecret
in MATLAB before you build the archive.
For more information on deployment using secrets, see Handle Sensitive Information in Deployed Applications.
Example: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'
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
See Also
Comando MATLAB
Hai fatto clic su un collegamento che corrisponde a questo comando MATLAB:
Esegui il comando inserendolo nella finestra di comando MATLAB. I browser web non supportano i comandi MATLAB.
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 MathWorks 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)