exponenta event banner

compiler.build.excelAddIn

Создание надстройки Microsoft Excel

Описание

пример

Внимание

Эта функция поддерживается только в операционных системах Windows ®.

compiler.build.excelAddIn(FunctionFiles) создает надстройку Excel ® с использованием функций MATLAB ®, указанных вFunctionFiles. Перед созданием надстроек Excel установите поддерживаемый компилятор.

пример

compiler.build.excelAddIn(FunctionFiles,Name,Value) создает надстройку Excel с параметрами, заданными с помощью одного или нескольких аргументов «имя-значение». Параметры включают имя надстройки, каталог вывода и необходимость создания файла Microsoft ® Visual Basic ®.

пример

compiler.build.excelAddIn(opts) создает надстройку Excel с параметрами, заданными с помощью compiler.build.excelAddInOptions объект opts. Другие параметры нельзя задать с помощью аргументов «имя-значение».

пример

results = compiler.build.excelAddIn(___) возвращает информацию о построении в виде compiler.build.Results с использованием любой из комбинаций входных аргументов в предыдущих синтаксисах. Сведения о построении состоят из типа построения, путей к скомпилированным файлам и параметров построения.

Примеры

свернуть все

Создайте надстройку Excel в системе Windows с помощью файла функций, который создает магический квадрат.

В MATLAB найдите функцию MATLAB, которую необходимо развернуть как надстройку Excel. Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler.

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

Создание надстройки Excel с помощью compiler.build.excelAddIn команда.

compiler.build.excelAddIn(appFile);

Функция создает следующие файлы в папке с именем magicsquareexcelAddIn в текущей рабочей папке:

  • dlldata.c

  • GettingStarted.html

  • magicsquare.def

  • magicsquare.bas (Только если включить 'GenerateVisualBasicFile' опция)

  • magicsquare.rc

  • magicsquare.xla (Только если включить 'GenerateVisualBasicFile' опция)

  • 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

Создайте надстройку Excel в системе Windows и настройте ее с помощью аргументов «имя-значение».

Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler.

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

Создание надстройки Excel с помощью compiler.build.excelAddIn команда. Используйте аргументы «имя-значение» для указания имени и версии надстройки, создания файла Microsoft Visual Basic и включения подробных выходных данных.

compiler.build.excelAddIn(appFile,'AddInName','MyMagicSquare',...
    'AddInVersion','2.0',...
    'GenerateVisualBasicFile','on',...
    'Verbose','on');

Функция создает следующие файлы в папке с именем MyMagicSquareexcelAddIn в текущей рабочей папке:

  • dlldata.c

  • GettingStarted.html

  • 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

Создание нескольких надстроек Excel в системе Windows с помощью compiler.build.ExcelAddInOptions объект.

Для этого примера используйте файл magicsquare.m расположен в matlabroot\extern\examples\compiler.

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

Создание ExcelAddInOptions объект с использованием appFile. Используйте аргументы «имя-значение», чтобы указать общий выходной каталог, создать файл Visual Basic и включить подробный вывод.

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\R2021a\extern\examples\compiler\magicsquare.m'}
    GenerateVisualBasicFile: on
            AdditionalFiles: {}
        AutoDetectDataFiles: on
                    Verbose: on
                  OutputDir: 'D:\Documents\MATLAB\work\ExcelAddInBatch'

Создайте надстройку с помощью ExcelAddInOptions объект.

compiler.build.excelAddIn(opts);

Создание новой надстройки с помощью файла функции myMagic2.m с теми же опциями, используйте точечную нотацию для изменения FunctionFiles аргумент существующего ExcelAddInOptions перед повторным запуском функции построения.

opts.FunctionFiles = 'myMagic2.m';
compiler.build.excelAddIn(opts);

Путем изменения FunctionFiles аргумент и перекомпиляция, можно создать несколько надстроек, используя один и тот же объект options.

Создание надстройки Excel и сохранение информации о типе сборки, созданных файлах и параметрах сборки в compiler.build.Results объект.

Компиляция с помощью файла magicsquare.m расположен в matlabroot\extern\examples\compiler.

results = compiler.build.excelAddIn('magicsquare.m')
results = 

  Results with properties:

            BuildType: 'excelAddIn'
                Files: {2×1 cell}
              Options: [1×1 compiler.build.ExcelAddInOptions]

Files содержит пути к следующим скомпилированным файлам:

  • magicsquare_1_0.dll

  • GettingStarted.html

Примечание

Файлы magicsquare.bas и magicsquare.xla включены в Files только при включении 'GenerateVisualBasicFile' в команде build.

Входные аргументы

свернуть все

Файлы, реализующие функции MATLAB, указанные как символьный вектор, строковый скаляр, строковый массив или массив ячеек символьных векторов. Пути к файлам могут быть относительно текущей рабочей папки или абсолютными. Файлы должны иметь .m расширение.

Пример: ["myfunc1.m","myfunc2.m"]

Типы данных: char | string | cell

Параметры компоновки надстройки Excel, указанные как compiler.build.ExcelAddInOptions объект.

Аргументы пары «имя-значение»

Укажите дополнительные пары, разделенные запятыми Name,Value аргументы. Name является именем аргумента и Value - соответствующее значение. Name должен отображаться внутри кавычек. Можно указать несколько аргументов пары имен и значений в любом порядке как Name1,Value1,...,NameN,ValueN.

Пример: 'Verbose','on'

Имя надстройки Excel, указанное как вектор символов или скаляр строки. Имя по умолчанию созданной надстройки является первой записью FunctionFiles аргумент. Имя должно начинаться с буквы и содержать только буквенные символы и знаки подчеркивания.

Пример: 'AddInName','myAddIn'

Типы данных: char | string

Версия надстройки, заданная как вектор символов или скаляр строки.

Пример: 'AddInVersion','4.0'

Типы данных: char | string

Дополнительные файлы для включения в надстройку Excel, указанные как символьный вектор, строковый скаляр, строковый массив или массив ячеек символьных векторов. Пути к файлам могут быть относительно текущей рабочей папки или абсолютными.

Пример: 'AdditionalFiles',["myvars.mat","data.txt"]

Типы данных: char | string | cell

Флажок для автоматического включения файлов данных, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on', то файлы данных, которые вы предоставляете в качестве входных данных для определенных функций (таких как load и fopen) автоматически включаются в надстройку.

  • Если для этого свойства задано значение 'off', то необходимо добавить файлы данных в надстройку с помощью AdditionalFiles собственность.

Пример: 'AutoDetectDataFiles','Off'

Типы данных: logical

Имя класса, указанное как символьный вектор или строковый скаляр. Имена классов должны соответствовать требованиям к именам классов надстроек Excel.

Значением по умолчанию является имя первого файла, указанного в FunctionFiles аргумент, добавленный с Class.

Пример: 'ClassName','magicsquareClass'

Типы данных: char | string

Флаг для включения символов отладки, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on', то надстройка компилируется с использованием символов отладки.

  • Если для этого свойства задано значение 'off', то надстройка не компилируется с символами отладки.

Пример: 'DebugSymbols','On'

Типы данных: logical

Флаг для встраивания развертываемого архива, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on'затем функция встраивает развертываемый архив в надстройку Excel.

  • Если для этого свойства задано значение 'off', затем функция генерирует развертываемый архив в виде отдельного файла.

Пример: 'EmbedArchive','Off'

Типы данных: logical

Флажок для создания файла Visual Basic (.basи файл надстройки Excel (.xla), указано как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on'затем функция генерирует XLA-файл надстройки Excel и файл Visual Basic BAS, содержащий интерфейс Microsoft Excel Formula Function для надстройки.

  • Если для этого свойства задано значение 'off', то функция не создает файл Visual Basic или файл надстройки Excel.

Пример: 'GenerateVisualBasicFile','On'

Типы данных: logical

Путь к выходному каталогу, в котором сохраняются файлы построения, определяемый как вектор символов или строковый скаляр. Путь может быть относительно текущего рабочего каталога или абсолютным.

Именем по умолчанию папки построения является имя надстройки, добавляемое с excelAddIn.

Пример: 'OutputDir','D:\Documents\MATLAB\work\mymagicexcelAddIn'

Типы данных: char | string

Флаг для управления подробностью построения, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on'затем в окне команд MATLAB отображается информация о ходе выполнения, указывающая на вывод компилятора в процессе построения.

  • Если для этого свойства задано значение 'off', то командное окно не отображает информацию о ходе выполнения.

Пример: 'Verbose','On'

Типы данных: logical

Выходные аргументы

свернуть все

Результаты построения, возвращенные как compiler.build.Results объект. Results объект содержит:

  • Тип построения, который является 'excelAddIn'

  • Пути к следующим файлам:

    • GettingStarted.html

    • AddInName_AddInVersion.dll

    • AddInName.bas (при включении 'GenerateVisualBasicFile' опция)

    • AddInName.xla (при включении 'GenerateVisualBasicFile' опция)

  • Параметры построения, указанные как ExcelAddInOptions объект

Ограничения

  • Эта функция поддерживается только в операционных системах Windows.

Представлен в R2021a