Caption プロパティ (ToolPropsBase)

すべてのツールまたは特定のインスタンスのいずれかのキャプションを指定するテキストを返すまたは設定します。

シンタックス

Visual Basic

'宣言
 
Public Property Caption As String

C#

public string Caption {get; set;}

プロパティ値

すべてのツールまたは特定のインスタンスのいずれかのキャプションを指定するテキスト。

例外

例外	解説
System.NotSupportedException	プロパティは、基本の Form または UserControl で定義された UltraToolbarsManager 内のツールに対して、デザインタイムに修正されます。継承されたツールは、作成された Form または UserControl のデザイナーを通して、ランタイムまたはデザインタイムに修正される必要があります。

解説

SharedProps オブジェクトに設定されると、このプロパティはキャプションが明示的に設定されていないツールのすべてのインスタンスに対するキャプションを指定します。InstanceProps オブジェクトに対して設定される場合、このプロパティはツールのひとつのインスタンスに対してキャプションを指定します。

カスタマイズの間に、特定のツール インスタンスのキャプションは、ユーザーによって変更できます。CaptionResolved プロパティは、ツールのキャプションを解決するために使用されます。

ToolTipText プロパティが明示的に設定されると、このプロパティの値はデフォルトのツールチップとして機能します。

使用例

Visual Basic

Imports System.Diagnostics
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinToolbars

	Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click

		' ----------------------------------------------------------------------------
		' 2 つのツールバーを作成し、UltraToolbarManager のツールバー コレクションに追加します
		Me.UltraToolbarsManager1.Toolbars.AddToolbarRange(New String() {"MyToolbar1", "MyToolbar2"})


		' ----------------------------------------------------------------------------
		' ボタン ツールを作成し、'MyToolbar1' および 'MyToolbar2' に追加します
		Dim buttonTool As New ButtonTool("MyButton")

		' メニューまたはツールバーに追加する前に、常に新しいツールを
		' UltraToolbarManager のルート ツール コレクションに追加します
		Me.UltraToolbarsManager1.Tools.Add(buttonTool)

		' ツールの 1 つのインスタンスを 'MyToolbar1' に追加し、他のインスタンスを 'MyToolbar2' に追加します
		Me.UltraToolbarsManager1.Toolbars("MyToolbar1").Tools.AddTool("MyButton")
		Me.UltraToolbarsManager1.Toolbars("MyToolbar2").Tools.AddTool("MyButton")


		' ----------------------------------------------------------------------------
		' ツールの 2 つのインスタンスに影響する 'MyButton' のプロパティを変更
		' しますそのためには、ツールの SharedProps オブジェクトにアクセスします
		Me.UltraToolbarsManager1.Tools("MyButton").SharedProps.DisplayStyle = ToolDisplayStyle.ImageAndText
		Me.UltraToolbarsManager1.Tools("MyButton").SharedProps.Caption = "Basic Caption"
		Me.UltraToolbarsManager1.Tools("MyButton").SharedProps.AppearancesSmall.Appearance.Image = Bitmap.FromHicon(SystemIcons.Information.Handle)


		' ----------------------------------------------------------------------------
		' 'MyToolbar1' 上にある 'MyButton' インスタンスのプロパティを変更します
		' そのためには、'MyToolbar1' の Tools コレクションにあるツールのインスタンスを取得して、
		' その InstancedProps オブジェクトにアクセスします
		Me.UltraToolbarsManager1.Toolbars("MyToolbar1").Tools("MyButton").InstanceProps.Caption = "Special Caption"
		Me.UltraToolbarsManager1.Toolbars("MyToolbar1").Tools("MyButton").InstanceProps.IsFirstInGroup = True

	End Sub

C#

using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinToolbars;

		private void button1_Click(object sender, System.EventArgs e)
		{

			// ----------------------------------------------------------------------------
			// 2 つのツールバーを作成し、UltraToolbarManager のツールバー コレクションに追加します
			this.ultraToolbarsManager1.Toolbars.AddToolbarRange(new string [] {"MyToolbar1", "MyToolbar2"} );


			// ----------------------------------------------------------------------------
			// ボタン ツールを作成し、'MyToolbar1' および 'MyToolbar2' に追加します
			ButtonTool buttonTool = new ButtonTool("MyButton");

				// メニューまたはツールバーに追加する前に、常に新しいツールを
				// UltraToolbarManager のルート ツール コレクションに追加します
				this.ultraToolbarsManager1.Tools.Add(buttonTool);

				// ツールの 1 つのインスタンスを 'MyToolbar1' に追加し、他のインスタンスを 'MyToolbar2' に追加します
				this.ultraToolbarsManager1.Toolbars["MyToolbar1"].Tools.AddTool("MyButton");
				this.ultraToolbarsManager1.Toolbars["MyToolbar2"].Tools.AddTool("MyButton");


			// ----------------------------------------------------------------------------
			// ツールの 2 つのインスタンスに影響する 'MyButton' のプロパティを変更
			// しますそのためには、ツールの SharedProps オブジェクトにアクセスします
			this.ultraToolbarsManager1.Tools["MyButton"].SharedProps.DisplayStyle	= ToolDisplayStyle.ImageAndText;
			this.ultraToolbarsManager1.Tools["MyButton"].SharedProps.Caption		= "Basic Caption";
			this.ultraToolbarsManager1.Tools["MyButton"].SharedProps.AppearancesSmall.Appearance.Image = Bitmap.FromHicon(SystemIcons.Information.Handle);


			// ----------------------------------------------------------------------------
			// 'MyToolbar1' 上にある 'MyButton' インスタンスのプロパティを変更します
			// そのためには、'MyToolbar1' の Tools コレクションにあるツールのインスタンスを取得して、
			// その InstancedProps オブジェクトにアクセスします
			this.ultraToolbarsManager1.Toolbars["MyToolbar1"].Tools["MyButton"].InstanceProps.Caption			= "Special Caption";
			this.ultraToolbarsManager1.Toolbars["MyToolbar1"].Tools["MyButton"].InstanceProps.IsFirstInGroup	= true;

		}