Main Content

compiler.build.ExcelAddInOptions

Excel アドインのビルドのオプション

    説明

    opts = compiler.build.ExcelAddInOptions(FunctionFiles) は、FunctionFiles で指定された MATLAB® 関数を使用して ExcelAddInOptions オブジェクトを作成します。ExcelAddInOptions オブジェクトを関数 compiler.build.excelAddIn への入力として使用します。

    opts = compiler.build.ExcelAddInOptions(FunctionFiles,Name,Value) は、名前と値の引数を 1 つ以上使って指定したオプションを用いて、ExcelAddInOptions オブジェクトを作成します。オプションには、アドイン名、含める追加ファイル、出力ディレクトリなどがあります。

    すべて折りたたむ

    ファイル入力を使用して ExcelAddInOptions オブジェクトを作成します。

    この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用します。

    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\R2022b\extern\examples\compiler\magicsquare.m'}
        GenerateVisualBasicFile: off
                AdditionalFiles: {}
            AutoDetectDataFiles: on
                SupportPackages: {'autodetect'}
                        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\R2022b\extern\examples\compiler\magicsquare.m'}
        GenerateVisualBasicFile: off
                AdditionalFiles: {}
            AutoDetectDataFiles: on
                SupportPackages: {'autodetect'}
                        Verbose: on
                      OutputDir: '.\magicsquareexcelAddIn'

    ExcelAddInOptions オブジェクトを関数 compiler.build.excelAddIn への入力として使用して、Excel® アドインをビルドします。

    buildResults = compiler.build.excelAddIn(opts);

    ExcelAddInOptions オブジェクトを作成し、名前と値の引数を使用してカスタマイズします。

    この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用します。名前と値の引数を使用して出力ディレクトリを指定し、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\R2022b\extern\examples\compiler\magicsquare.m'}
        GenerateVisualBasicFile: on
                AdditionalFiles: {}
            AutoDetectDataFiles: on
                SupportPackages: {'autodetect'}
                        Verbose: off
                  OutputDir: 'D:\Documents\MATLAB\work\MagicSquareAddIn'

    ExcelAddInOptions オブジェクトを関数 compiler.build.excelAddIn への入力として使用して、Excel アドインをビルドします。

    buildResults = compiler.build.excelAddIn(opts);

    入力引数

    すべて折りたたむ

    MATLAB 関数を実装するファイルのリスト。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。ファイルには .m 拡張子が必要です。

    例: {'myFunction1.m','myFunction2.m'}

    データ型: char | string | cell

    名前と値の引数

    オプションのペアの引数を Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定する必要がありますが、ペアの順序は考慮されません。

    R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name を引用符で囲みます。

    例: 'Verbose','on'

    Excel アドインの名前。文字ベクトルまたは string スカラーとして指定します。生成されたアドインの既定の名前は、FunctionFiles 引数の最初のエントリです。名前は文字で始まり、英字とアンダースコアのみを使用していなければなりません。

    例: 'AddInName','myAddIn'

    データ型: char | string

    アドインのバージョン。文字ベクトルまたは string スカラーとして指定します。

    例: 'AddInVersion','4.0'

    データ型: char | string

    Excel アドインに含める追加のファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

    例: 'AdditionalFiles',["myvars.mat","data.txt"]

    データ型: char | string | cell

    データ ファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

    • このプロパティを 'on' に設定した場合、特定の関数 (loadfopen など) の入力として指定されるデータ ファイルは自動的にアドインに含められます。

    • このプロパティを 'off' に設定した場合、データ ファイルは AdditionalFiles プロパティを使用してアドインに追加しなければなりません。

    例: 'AutoDetectDataFiles','Off'

    データ型: logical

    クラスの名前。文字ベクトルまたは string スカラーとして指定します。クラス名は Excel アドインのクラス名の要件に適合しなければなりません。

    既定値は、FunctionFiles 引数にリストされている最初のファイルの名前に Class を追加したものです。

    例: 'ClassName','magicsquareClass'

    データ型: char | string

    デバッグ シンボルを有効にするためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

    • このプロパティを 'on' に設定した場合、アドインはデバッグ シンボル付きでコンパイルされます。

    • このプロパティを 'off' に設定した場合、アドインはデバッグ シンボル付きでコンパイルされません。

    例: 'DebugSymbols','On'

    データ型: logical

    デプロイ可能なアーカイブを組み込むためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

    • このプロパティを 'on' に設定した場合、関数はデプロイ可能なアーカイブを Excel アドインに組み込みます。

    • このプロパティを 'off' に設定した場合、関数はデプロイ可能なアーカイブを別個のファイルとして生成します。

    例: 'EmbedArchive','Off'

    データ型: logical

    Visual Basic ファイル (.bas) および Excel アドイン ファイル (.xla) を生成するためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

    • このプロパティを 'on' に設定した場合、関数は Excel アドイン XLA ファイルと、アドインに対する Microsoft® Excel の数式関数インターフェイスを含む Visual Basic BAS ファイルを生成します。

    • このプロパティを 'off' に設定した場合、関数は Visual Basic ファイルや Excel アドイン ファイルを生成しません。

    メモ

    Excel アドイン ファイル (.xla) を生成するには、Excel の設定で [VBA プロジェクト オブジェクト モデルへのアクセスを信頼する] を有効にする必要があります。

    例: 'GenerateVisualBasicFile','On'

    データ型: logical

    ビルド ファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

    ビルド フォルダーの既定の名前は、アドイン名に excelAddIn を追加したものです。

    例: 'OutputDir','D:\Documents\MATLAB\work\mymagicexcelAddIn'

    データ型: char | string

    含めるサポート パッケージ。次のオプションのいずれかとして指定します。

    • 'autodetect' (既定) — 依存関係の解析プロセスにより、必要なサポート パッケージが自動的に検出され、含められます。

    • 'none' — サポート パッケージは含められません。このオプションを使用すると、ランタイム エラーの原因となる可能性があります。

    • string スカラー、文字ベクトル、または文字ベクトルの cell 配列 — 指定されたサポート パッケージのみが含められます。インストールされている、または特定のファイルで使用されるサポート パッケージのリストを表示するには、compiler.codetools.deployableSupportPackages を参照してください。

    例: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

    データ型: char | string | cell

    ビルドの詳細を制御するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

    • このプロパティを 'on' に設定した場合、MATLAB コマンド ウィンドウには、ビルド プロセス中のコンパイラ出力を示す進行状況情報が表示されます。

    • このプロパティを 'off' に設定した場合、コマンド ウィンドウには進行状況の情報は表示されません。

    例: 'Verbose','On'

    データ型: logical

    出力引数

    すべて折りたたむ

    Excel アドインのビルド オプション。ExcelAddInOptions オブジェクトとして返されます。

    バージョン履歴

    R2021a で導入