サポート

FAQ
カスタムコンポーネントの Category および Caption プロパティ情報の取得

ナレッジ番号：5262 | 登録日：2023/07/26 | 更新日：2024/11/21

サマリ

Visual Studio で、カスタムコンポーネントがどのように作成されるかによって、コードベースで、Category および Caption プロパティ情報の取得は、コード基準で異なって見えます。このトピックでは、カスタムコンポーネントを作成する方法として、コンポーネントオブジェクトモデル（COM）を実装する方法と、ESRI ベースクラスを実装する方法について説明します。

内容

カスタムコンポーネントの Category および Caption プロパティ情報の取得
Category および Caption プロパティ情報の取得
実装された COM インタフェースの使用
ESRI ベースクラスの使用

カスタムコンポーネントの Category および Caption プロパティ情報の取得

操作を始める前に、次の仮定について確認してください。

ArcGIS Desktop カスタムコンポーネント（以降カスタムコンポーネント）が、COM インタフェースまたは ESRI ベースクラスの実装に基づいて、Visual Studio で作成されています。
このトピックにおけるカスタムコンポーネントは、ArcGIS Desktop アプリケーション（ArcMap、ArcGlobe、ArcScene、または ArcCatalog）の [ユーザー設定] ダイアログボックスに表示され、ArcGIS Desktop のグラフィカルユーザインタフェース（GUI）に追加したり、削除したりすることができます。一般的に、これらのタイプのカスタムコンポーネントには、ボタン、ツール、ツールバーがあります。[ユーザー設定] ダイアログボックスには表示されず、このトピックとは関連性のないカスタムコンポーネントとしては、エクステンション、ドッカブルウィンドウ、テーブルオブコンテンツ（TOC）などがあります。

Category および Caption プロパティ情報の取得

Category および Caption プロパティ情報を取得すると、カスタムコンポーネントのユーザは、[ユーザー設定] ダイアログボックスに表示されるどのカスタマイゼーションを ArcMap GUI に追加すべきかが分かります。このセクションでは、両方のコーディングの方法を用いて、関連情報を取得する方法について説明します。

実装された COM インタフェースの使用

COM インタフェースクラスの実装によって生成されたカスタムコンポーネントの Category および Caption 情報は、通常 Category および Caption メソッドで見つけることができます。

public string Caption
{
    get
    {
        return "Caption ArcMapClassLibrary_Implements";
    }
}

public string Category
{
    get
    {
        return "Developer Samples";
    }
}

Public ReadOnly Property Caption() As String Implements ESRI.ArcGIS.SystemUI.ICommand.Caption
    Get
        Return "Caption ArcMapClassLibrary_Implements"
    End Get
End Property

Public ReadOnly Property Category() As String Implements ESRI.ArcGIS.SystemUI.ICommand.Category
    Get
        Return "Developer Samples"
    End Get
End Property

ESRI ベースクラスの使用

ESRI ベースクラスによって生成されたカスタムコンポーネントの Category および Caption 情報は、通常クラスのコンストラクタで見つけることができます。VB.NET では MyBase.m_category および MyBase.m_caption プロパティに、C# では base.m_category および base.m_caption プロパティにその情報が含まれます。

public Command1()
{
    base.m_category = "Developer Samples";
    base.m_caption = "Caption ArcMapClassLibrary_BaseCommand";
    base.m_message = "Message - ArcMapClassLibrary_BaseCommand";
    base.m_toolTip = "Tooltip - ArcMapClassLibrary_BaseCommand";
    base.m_name = "Name - ArcMapClassLibrary_BaseCommand";
    //Additional code occurs here ...
}

Public Sub New()
    MyBase.New()
    
    MyBase.m_category = "Developer Samples"
    MyBase.m_caption = "Caption ArcMapClassLibrary_BaseCommand"
    MyBase.m_message = "Message - ArcMapClassLibrary_BaseCommand"
    MyBase.m_toolTip = "Tooltip - ArcMapClassLibrary_BaseCommand"
    MyBase.m_name = "Name - ArcMapClassLibrary_BaseCommand"    
    'Additional code occurs here ...    
End Sub