compiler.build.excelAddIn

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

Описание

пример

Внимание

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

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

пример

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

пример

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\примеры\компилятор.

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\примеры\компилятор.

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\примеры\компилятор.

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 аргумент и перекомпиляция, можно создать несколько надстроек с помощью одного и того же объекта опции.

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

Скомпилируйтесь с использованием файловой magicsquare.m расположен в matlabroot\ extern\примеры\компилятор.

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

  Results with properties:

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

The 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. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа 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. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

свернуть все

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

  • Тип сборки, который 'excelAddIn'

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

    • GettingStarted.html

    • AddInName_ AddInVersion.dll

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

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

  • Опции сборки, заданные как ExcelAddInOptions объект

Ограничения

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

Введенный в R2021a