Main Content

compiler.build.ExcelAddInOptions

Options for building Excel add-ins

    Description

    example

    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.

    example

    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

    collapse all

    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\R2021a\extern\examples\compiler\magicsquare.m'}
        GenerateVisualBasicFile: off
                AdditionalFiles: {}
            AutoDetectDataFiles: on
                        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\R2021a\extern\examples\compiler\magicsquare.m'}
        GenerateVisualBasicFile: off
                AdditionalFiles: {}
            AutoDetectDataFiles: on
                        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);

    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\R2021a\extern\examples\compiler\magicsquare.m'}
        GenerateVisualBasicFile: on
                AdditionalFiles: {}
            AutoDetectDataFiles: on
                        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

    collapse all

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

    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

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

    Example: 'AddInVersion','4.0'

    Data Types: char | string

    Additional files 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. File paths can be relative to the current working directory or absolute.

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

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

    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

    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

    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

    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.

    Example: 'GenerateVisualBasicFile','On'

    Data Types: logical

    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

    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

    collapse all

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

    Introduced in R2021a