addLabel

プロジェクト ファイルにラベルを追加

ページ内をすべて折りたたむ

構文

addLabel(proj,projectFiles,categoryName,labelName)
addLabel(proj,projectFiles,labelName)
addLabel(proj,projectFiles,categoryName,labelName,labelData)
addLabel(fileObject,categoryName,labelName)
addLabel(fileObject,categoryName,labelName,labelData)

説明

addLabel(proj,projectFiles,categoryName,labelName) は、プロジェクト proj 内のファイル projectFiles に、指定されたカテゴリの指定されたラベルを追加します。

例

addLabel(proj,projectFiles,labelName) は、プロジェクト proj 内のファイル projectFiles に、指定されたラベルを追加します。この構文は、ラベル名がプロジェクト内で一意である場合にのみ使用します。

addLabel(proj,projectFiles,categoryName,labelName,labelData) は、指定されたテキストまたは数値データをもつラベルをファイル projectFiles に追加します。組み込みのラベルにラベル データを追加することはできません。

例

addLabel(fileObject,categoryName,labelName) は、指定されたカテゴリの指定されたラベルを指定されたファイルに追加します。

addLabel(fileObject,categoryName,labelName,labelData) は、指定されたテキストまたは数値データをもつラベルを追加します。組み込みのラベルは読み取り専用であるため、ラベル データを追加することはできません。

例

すべて折りたたむ

プロジェクト Times Table App を開きます。currentProject を使用して、現在読み込まれているプロジェクトからプロジェクト オブジェクトを作成します。

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

ファイルの既存のラベルをクエリします。

filename = fullfile("source","timesTableGame.m");
myfile = findFiles(proj,filename,OutputFormat="ProjectFile");
existingLabel =  myfile.Labels
existingLabel = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'none'
            Data: []
            Name: "Design"
    CategoryName: "Classification"

ラベル "Artifact" をカテゴリ "Classification" のファイルに追加します。

newLabel = addLabel(proj,myfile,"Classification","Artifact")

newLabel = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'none'
            Data: []
            Name: "Artifact"
    CategoryName: "Classification"

myfile に追加されているラベルを確認します。ラベルが "Design" から "Artifact" に変更されています。

reviewLabel = myfile.Labels(1)

reviewLabel = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'none'
            Data: []
            Name: "Artifact"
    CategoryName: "Classification"

ファイルから新規ラベルを削除します。ファイル内のラベルがなくなります。

removeLabel(proj,myfile,reviewLabel)
myfile
myfile = 

  ProjectFile with properties:

                   Path: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
                 Labels: [1×0 matlab.project.Label]
               Revision: "286043ae7ee557100902fb645a6c97eca5d50472"
    SourceControlStatus: Unmodified

"Classification" カテゴリのラベル "Utility" をファイル拡張子 .m をもつプロジェクト内のすべてのファイルに追加します。

プロジェクト Times Table App を開きます。currentProject を使用して、現在読み込まれているプロジェクトからプロジェクト オブジェクトを作成します。

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

ファイル一覧を取得します。

files = proj.Files;

プロジェクト内のすべてのファイルに [R2024b] というラベルを追加します。

addLabel(proj,files,"Classification","R2024b");

プロジェクト内のすべてのファイルについて、プロジェクトの [ファイル] ビューの [分類] 列にラベル [R2024b] が表示されます。

ラベル カテゴリ "Review" およびラベル "To Review" を作成し、そのラベルとラベル データをファイルに追加します。組み込みのラベルは読み取り専用であるため、ラベル データを追加することはできません。

プロジェクト Times Table App を開きます。currentProject を使用して、現在読み込まれているプロジェクトからプロジェクト オブジェクトを作成します。

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

新しいカテゴリ "Review" を作成します。

createCategory(proj,"Review","char");

新しいカテゴリに対して、"To Review" ラベルを作成します。

reviewCategory = findCategory(proj,"Review");
createLabel(reviewCategory,"To Review");

ファイルに "To Review" ラベル、およびラベル データの文字ベクトルを追加します。

filename = fullfile("source","timesTableGame.m");
newLabel = addLabel(proj,filename,"Review","To Review","Whole team design review")
newLabel = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'char'
            Data: 'Whole team design review'
            Name: "To Review"
    CategoryName: "Review"

あるいは、Data プロパティを使用してラベル データを設定または変更できます。

myfile = findFiles(proj,filename,OutputFormat="ProjectFile");
mylabel = myfile.Labels(2);
mylabel.Data = "Final review";

入力引数

すべて折りたたむ

プロジェクト。matlab.project.Project オブジェクトとして指定します。

ラベルを付けるプロジェクト ファイル。文字ベクトルの cell 配列、string 配列、または ProjectFile オブジェクトの配列として指定します。ファイルはプロジェクトのルート フォルダー内になければなりません。

ラベルを付けるファイルのオブジェクト。ProjectFile オブジェクトとして指定します。ProjectFile オブジェクトを取得するには、プロジェクトの Files プロパティ (proj.Files) を調べるか、findFiles を使用して名前でファイルを検索します。ファイルはプロジェクト内になければなりません。

ラベルのカテゴリ名。文字ベクトルまたは string スカラーとして指定します。

追加するラベルの名前。文字ベクトル、string スカラー、または file.Label プロパティや findLabel 関数によって返される LabelDefinition オブジェクトとして指定します。プロジェクトに存在しない新規ラベル名を指定することができます。

ラベルに追加するデータ。文字ベクトル、string スカラー、または数値として指定します。データ型は、ラベルの定義によって異なります。その DataType プロパティを調べるには、file.Label または関数 findLabel を使用してラベルを取得します。

バージョン履歴

R2019a で導入

すべて展開する

参考

| | | | |

トピック