Exponenta Banner

compiler.build.excelAddIn

Создайте дополнение Microsoft Excel

свернуть все на странице

Синтаксис

compiler.build.excelAddIn(FunctionFiles)
compiler.build.excelAddIn(FunctionFiles,Name,Value)
compiler.build.excelAddIn(opts)
results = compiler.build.excelAddIn(___)

Описание

пример

Внимание

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

Создайте дополнение 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' опция в команде сборки.

Входные параметры

свернуть все

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

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

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

Дополнение Excel создает опции в виде a 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 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

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

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

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

Типы данных: логический

Имя класса в виде вектора символов или строкового скаляра. Имена классов должны совпадать с дополнительными требованиями имени класса Excel.

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

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

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

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

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

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

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

Типы данных: логический

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

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

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

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

Типы данных: логический

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

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

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

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

Типы данных: логический

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

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

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

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

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

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

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

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

Типы данных: логический

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

свернуть все

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

  • Создайте тип, который является 'excelAddIn'

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

    • GettingStarted.html

    • AddInName_AddInVersion.dll

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

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

  • Создайте опции в виде ExcelAddInOptions объект

Ограничения

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

Смотрите также

| |

Введенный в R2021a

Документация MATLAB Compiler

Поддержка