Exponenta Banner
exponenta event banner

compiler.build. ExcelAddInOptions

Параметры построения надстроек Excel

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

    Синтаксис

    opts = compiler.build.StartAddInOptions (Функциональные файлы)
    opts = compiler.build.StartAddInOptions (Функциональные файлы, Имя, Значение)

    Описание

    пример

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

    Можно изменить значения свойств существующего 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\examples\compiler. Используйте аргументы «имя-значение», чтобы указать выходной каталог, создать файл 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. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл 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

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

    свернуть все

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

    См. также

    |

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

    Документация по компилятору MATLAB

    Поддержка