compiler.build.ExcelAddInOptions

Опции для создания надстроек Excel

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

    Синтаксис

    opts = compiler.build.ExcelAddInOptions(FunctionFiles)
    opts = compiler.build.ExcelAddInOptions(FunctionFiles,Name,Value)

    Описание

    пример

    opts = compiler.build.ExcelAddInOptions(FunctionFiles) создает ExcelAddInOptions объект с использованием MATLAB® функции, заданные FunctionFiles. Используйте ExcelAddInOptions объект как вход в compiler.build.excelAddIn функция.

    пример

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

    Примеры

    свернуть все

    Создайте ExcelAddInOptions объект с использованием ввода файла.

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

    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'

    Можно изменять значения свойств существующей ExcelAddInOptions объект с использованием записи через точку. Для примера включите подробные выходы.

    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'

    Используйте ExcelAddInOptions объект как вход в compiler.build.excelAddIn функция для создания Excel® надстройка.

    buildResults = compiler.build.excelAddIn(opts);

    Создайте ExcelAddInOptions объект и настройте его с помощью аргументов имя-значение.

    В данном примере используйте файл magicsquare.m расположен в matlabroot\ extern\примеры\компилятор. Используйте аргументы имя-значение, чтобы задать выход директории, сгенерировать Visual Basic® Файл и включите подробные выходы.

    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'

    Используйте ExcelAddInOptions объект как вход в compiler.build.excelAddIn функция для создания надстройки Excel.

    buildResults = compiler.build.excelAddIn(opts);

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

    свернуть все

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

    Пример: {'myFunction1.m','myFunction2.m'}

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

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

    Задайте необязательные разделенные разделенными запятой парами 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 и файл BAS Visual Basic, содержащий Microsoft® Интерфейс функции формулы Excel к надстройке.

    • Если вы задаете это свойство равным '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

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

    свернуть все

    Опции сборки надстроек Excel, возвращенные как ExcelAddInOptions объект.

    См. также

    |

    Введенный в R2021a

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

    Поддержка

    Для просмотра документации необходимо авторизоваться на сайте