ToolStripControlHost クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
カスタム コントロールまたは Windows フォーム コントロールをホストします。
public ref class ToolStripControlHost : System::Windows::Forms::ToolStripItem
public class ToolStripControlHost : System.Windows.Forms.ToolStripItem
type ToolStripControlHost = class
inherit ToolStripItem
Public Class ToolStripControlHost
Inherits ToolStripItem
- 継承
- 継承
- 派生
例
次のコード例では、OnSubscribeControlEventsを使用してイベントを処理し、そのメンバーの一部をToolStripControlHostに公開して、MonthCalendar コントロールを使用してToolStripControlHostを構築する方法を示します。
//Declare a class that inherits from ToolStripControlHost.
public ref class ToolStripMonthCalendar: public ToolStripControlHost
{
public:
// Call the base constructor passing in a MonthCalendar instance.
ToolStripMonthCalendar() : ToolStripControlHost( gcnew MonthCalendar ) {}
property MonthCalendar^ MonthCalendarControl
{
MonthCalendar^ get()
{
return static_cast<MonthCalendar^>(Control);
}
}
property Day FirstDayOfWeek
{
// Expose the MonthCalendar.FirstDayOfWeek as a property.
Day get()
{
return MonthCalendarControl->FirstDayOfWeek;
}
void set( Day value )
{
MonthCalendarControl->FirstDayOfWeek = value;
}
}
// Expose the AddBoldedDate method.
void AddBoldedDate( DateTime dateToBold )
{
MonthCalendarControl->AddBoldedDate( dateToBold );
}
protected:
// Subscribe and unsubscribe the control events you wish to expose.
void OnSubscribeControlEvents( System::Windows::Forms::Control^ c )
{
// Call the base so the base events are connected.
__super::OnSubscribeControlEvents( c );
// Cast the control to a MonthCalendar control.
MonthCalendar^ monthCalendarControl = (MonthCalendar^)c;
// Add the event.
monthCalendarControl->DateChanged += gcnew DateRangeEventHandler( this, &ToolStripMonthCalendar::HandleDateChanged );
}
void OnUnsubscribeControlEvents( System::Windows::Forms::Control^ c )
{
// Call the base method so the basic events are unsubscribed.
__super::OnUnsubscribeControlEvents( c );
// Cast the control to a MonthCalendar control.
MonthCalendar^ monthCalendarControl = (MonthCalendar^)c;
// Remove the event.
monthCalendarControl->DateChanged -= gcnew DateRangeEventHandler( this, &ToolStripMonthCalendar::HandleDateChanged );
}
public:
event DateRangeEventHandler^ DateChanged;
private:
// Declare the DateChanged event.
// Raise the DateChanged event.
void HandleDateChanged( Object^ sender, DateRangeEventArgs^ e )
{
if ( DateChanged != nullptr )
{
DateChanged( this, e );
}
}
};
//Declare a class that inherits from ToolStripControlHost.
public class ToolStripMonthCalendar : ToolStripControlHost
{
// Call the base constructor passing in a MonthCalendar instance.
public ToolStripMonthCalendar() : base (new MonthCalendar()) { }
public MonthCalendar MonthCalendarControl
{
get
{
return Control as MonthCalendar;
}
}
// Expose the MonthCalendar.FirstDayOfWeek as a property.
public Day FirstDayOfWeek
{
get
{
return MonthCalendarControl.FirstDayOfWeek;
}
set { MonthCalendarControl.FirstDayOfWeek = value; }
}
// Expose the AddBoldedDate method.
public void AddBoldedDate(DateTime dateToBold)
{
MonthCalendarControl.AddBoldedDate(dateToBold);
}
// Subscribe and unsubscribe the control events you wish to expose.
protected override void OnSubscribeControlEvents(Control c)
{
// Call the base so the base events are connected.
base.OnSubscribeControlEvents(c);
// Cast the control to a MonthCalendar control.
MonthCalendar monthCalendarControl = (MonthCalendar) c;
// Add the event.
monthCalendarControl.DateChanged +=
new DateRangeEventHandler(OnDateChanged);
}
protected override void OnUnsubscribeControlEvents(Control c)
{
// Call the base method so the basic events are unsubscribed.
base.OnUnsubscribeControlEvents(c);
// Cast the control to a MonthCalendar control.
MonthCalendar monthCalendarControl = (MonthCalendar) c;
// Remove the event.
monthCalendarControl.DateChanged -=
new DateRangeEventHandler(OnDateChanged);
}
// Declare the DateChanged event.
public event DateRangeEventHandler DateChanged;
// Raise the DateChanged event.
private void OnDateChanged(object sender, DateRangeEventArgs e)
{
if (DateChanged != null)
{
DateChanged(this, e);
}
}
}
'Declare a class that inherits from ToolStripControlHost.
Public Class ToolStripMonthCalendar
Inherits ToolStripControlHost
' Call the base constructor passing in a MonthCalendar instance.
Public Sub New()
MyBase.New(New MonthCalendar())
End Sub
Public ReadOnly Property MonthCalendarControl() As MonthCalendar
Get
Return CType(Control, MonthCalendar)
End Get
End Property
' Expose the MonthCalendar.FirstDayOfWeek as a property.
Public Property FirstDayOfWeek() As Day
Get
Return MonthCalendarControl.FirstDayOfWeek
End Get
Set
MonthCalendarControl.FirstDayOfWeek = value
End Set
End Property
' Expose the AddBoldedDate method.
Public Sub AddBoldedDate(ByVal dateToBold As DateTime)
MonthCalendarControl.AddBoldedDate(dateToBold)
End Sub
' Subscribe and unsubscribe the control events you wish to expose.
Protected Overrides Sub OnSubscribeControlEvents(ByVal c As Control)
' Call the base so the base events are connected.
MyBase.OnSubscribeControlEvents(c)
' Cast the control to a MonthCalendar control.
Dim monthCalendarControl As MonthCalendar = _
CType(c, MonthCalendar)
' Add the event.
AddHandler monthCalendarControl.DateChanged, _
AddressOf HandleDateChanged
End Sub
Protected Overrides Sub OnUnsubscribeControlEvents(ByVal c As Control)
' Call the base method so the basic events are unsubscribed.
MyBase.OnUnsubscribeControlEvents(c)
' Cast the control to a MonthCalendar control.
Dim monthCalendarControl As MonthCalendar = _
CType(c, MonthCalendar)
' Remove the event.
RemoveHandler monthCalendarControl.DateChanged, _
AddressOf HandleDateChanged
End Sub
' Declare the DateChanged event.
Public Event DateChanged As DateRangeEventHandler
' Raise the DateChanged event.
Private Sub HandleDateChanged(ByVal sender As Object, _
ByVal e As DateRangeEventArgs)
RaiseEvent DateChanged(Me, e)
End Sub
End Class
注釈
ToolStripControlHost は、ToolStripComboBox、ToolStripTextBox、および ToolStripProgressBar の基本クラスです。 ToolStripControlHost では、次の 2 つの方法で、カスタム コントロールを含む他のコントロールをホストできます。
Controlから派生するクラスを使用してToolStripControlHostを構築します。 ホストされているコントロールとプロパティに完全にアクセスするには、 Control プロパティを表す実際のクラスにキャストする必要があります。
ToolStripControlHost拡張し、継承されたクラスのパラメーターなしのコンストラクターで、基底クラスコンストラクターを呼び出して、Controlから派生するクラスを渡します。 このオプションを使用すると、 ToolStripで簡単にアクセスできるように、一般的な制御メソッドとプロパティをラップできます。
ToolStripControlHost クラスを使用して、カスタマイズしたコントロールやその他の Windows フォーム コントロールをホストします。
ToolStripItemをカスタマイズするには、ToolStripControlHostから派生し、カスタム実装を作成します。 ホストされたコントロールによって発生したイベントを処理する OnSubscribeControlEvents などのメソッドをオーバーライドしたり、カスタム機能をプロパティに配置してホストされるコントロールを強化したりできます。
コンストラクター
| 名前 | 説明 |
|---|---|
| ToolStripControlHost(Control, String) |
指定したコントロールをホストし、指定した名前を持つ ToolStripControlHost クラスの新しいインスタンスを初期化します。 |
| ToolStripControlHost(Control) |
指定したコントロールをホストする ToolStripControlHost クラスの新しいインスタンスを初期化します。 |
プロパティ
| 名前 | 説明 |
|---|---|
| AccessibilityObject |
コントロールに割り当てられた AccessibleObject を取得します。 (継承元 ToolStripItem) |
| AccessibleDefaultActionDescription |
アクセシビリティ クライアント アプリケーションで使用するコントロールの既定のアクションの説明を取得または設定します。 (継承元 ToolStripItem) |
| AccessibleDescription |
アクセシビリティ クライアント アプリケーションに報告される説明を取得または設定します。 (継承元 ToolStripItem) |
| AccessibleName |
アクセシビリティ クライアント アプリケーションで使用するコントロールの名前を取得または設定します。 (継承元 ToolStripItem) |
| AccessibleRole |
コントロールのユーザー インターフェイス要素の種類を指定する、コントロールのアクセス可能なロールを取得または設定します。 (継承元 ToolStripItem) |
| Alignment |
項目が ToolStripの先頭または末尾に揃えるかどうかを示す値を取得または設定します。 (継承元 ToolStripItem) |
| AllowDrop |
ドラッグ アンド ドロップと項目の並べ替えが、実装するイベントによって処理されるかどうかを示す値を取得または設定します。 (継承元 ToolStripItem) |
| Anchor |
ToolStripItemをバインドするコンテナーの端を取得または設定し、ToolStripItemのサイズを親と共に変更する方法を決定します。 (継承元 ToolStripItem) |
| AutoSize |
項目のサイズが自動的に設定されるかどうかを示す値を取得または設定します。 (継承元 ToolStripItem) |
| AutoToolTip |
ToolStripItem ツールヒントにText プロパティまたは ToolTipText プロパティのどちらを使用するかを示す値を取得または設定します。 (継承元 ToolStripItem) |
| Available |
ToolStripItemをToolStripに配置するかどうかを示す値を取得または設定します。 (継承元 ToolStripItem) |
| BackColor |
コントロールの背景色を取得または設定します。 |
| BackgroundImage |
コントロールに表示される背景イメージを取得または設定します。 |
| BackgroundImageLayout |
|
| BindingContext |
IBindableComponentの通貨マネージャーのコレクションを取得または設定します。 (継承元 BindableComponent) |
| Bounds |
アイテムのサイズと場所を取得します。 (継承元 ToolStripItem) |
| CanRaiseEvents |
コンポーネントがイベントを発生できるかどうかを示す値を取得します。 (継承元 Component) |
| CanSelect |
コントロールを選択できるかどうかを示す値を取得します。 |
| CausesValidation |
ホストされたコントロールがフォーカスを受け取ったときに、ホストされたコントロールが他のコントロールに対して検証イベントを発生させるかどうかを示す値を取得または設定します。 |
| Command |
ToolStripItem のClick イベントが呼び出されたときにExecute(Object) メソッドが呼び出されるICommandを取得または設定します。 (継承元 ToolStripItem) |
| CommandParameter |
Command プロパティに割り当てられているICommandに渡されるパラメーターを取得または設定します。 (継承元 ToolStripItem) |
| Container |
IContainerを含むComponentを取得します。 (継承元 Component) |
| ContentRectangle |
背景の境界線を上書きすることなく、テキストやアイコンなどのコンテンツを ToolStripItem 内に配置できる領域を取得します。 (継承元 ToolStripItem) |
| Control |
このToolStripControlHostがホストしているControlを取得します。 |
| ControlAlign |
フォーム上のコントロールの配置を取得または設定します。 |
| DataBindings |
この IBindableComponentのデータ バインディング オブジェクトのコレクションを取得します。 (継承元 BindableComponent) |
| DefaultAutoToolTip |
既定値として定義されている ToolTip を表示するかどうかを示す値を取得します。 (継承元 ToolStripItem) |
| DefaultDisplayStyle |
ToolStripItemに表示される内容を示す値を取得します。 (継承元 ToolStripItem) |
| DefaultMargin |
項目の既定の余白を取得します。 (継承元 ToolStripItem) |
| DefaultPadding |
アイテムの内部間隔の特性を取得します。 (継承元 ToolStripItem) |
| DefaultSize |
コントロールの既定のサイズを取得します。 |
| DesignMode |
Componentが現在デザイン モードであるかどうかを示す値を取得します。 (継承元 Component) |
| DismissWhenClicked |
ToolStripDropDownの項目をクリックした後に非表示にするかどうかを示す値を取得します。 (継承元 ToolStripItem) |
| DisplayStyle |
このプロパティは、このクラスには関係ありません。 |
| Dock |
親コントロールにドッキングする ToolStripItem 罫線を取得または設定し、親コントロールで ToolStripItem のサイズを変更する方法を決定します。 (継承元 ToolStripItem) |
| DoubleClickEnabled |
このプロパティは、このクラスには関係ありません。 |
| Enabled |
ToolStripItemの親コントロールが有効かどうかを示す値を取得または設定します。 |
| Events |
この Componentにアタッチされているイベント ハンドラーの一覧を取得します。 (継承元 Component) |
| Focused |
コントロールに入力フォーカスがあるかどうかを示す値を取得します。 |
| Font |
ホストされるコントロールで使用するフォントを取得または設定します。 |
| ForeColor |
ホストされるコントロールの前景色を取得または設定します。 |
| Height |
ToolStripItemの高さをピクセル単位で取得または設定します。 (継承元 ToolStripItem) |
| Image |
オブジェクトに関連付けられているイメージ。 |
| ImageAlign |
このプロパティは、このクラスには関係ありません。 |
| ImageIndex |
アイテムに表示されるイメージのインデックス値を取得または設定します。 (継承元 ToolStripItem) |
| ImageKey |
ToolStripItemに表示されるImageList内のイメージのキー アクセサーを取得または設定します。 (継承元 ToolStripItem) |
| ImageScaling |
このプロパティは、このクラスには関係ありません。 |
| ImageTransparentColor |
このプロパティは、このクラスには関係ありません。 |
| IsDisposed |
オブジェクトが破棄されたかどうかを示す値を取得します。 (継承元 ToolStripItem) |
| IsOnDropDown |
現在の Control のコンテナーが ToolStripDropDownかどうかを示す値を取得します。 (継承元 ToolStripItem) |
| IsOnOverflow |
Placement プロパティが Overflow に設定されているかどうかを示す値を取得します。 (継承元 ToolStripItem) |
| Margin |
項目と隣接する項目の間のスペースを取得または設定します。 (継承元 ToolStripItem) |
| MergeAction |
子メニューを親メニューと結合する方法を取得または設定します。 (継承元 ToolStripItem) |
| MergeIndex |
現在の ToolStrip内のマージされた項目の位置を取得または設定します。 (継承元 ToolStripItem) |
| Name |
項目の名前を取得または設定します。 (継承元 ToolStripItem) |
| Overflow |
項目が ToolStrip にアタッチされているか、 ToolStripOverflowButton にアタッチされているか、2 つの間に浮動できるかを取得または設定します。 (継承元 ToolStripItem) |
| Owner |
この項目の所有者を取得または設定します。 (継承元 ToolStripItem) |
| OwnerItem |
このToolStripItemの親ToolStripItemを取得します。 (継承元 ToolStripItem) |
| Padding |
アイテムの内容とその辺の間の内部間隔をピクセル単位で取得または設定します。 (継承元 ToolStripItem) |
| Parent |
ToolStripItemの親コンテナーを取得または設定します。 (継承元 ToolStripItem) |
| Placement |
アイテムの現在のレイアウトを取得します。 (継承元 ToolStripItem) |
| Pressed |
アイテムの状態が押されているかどうかを示す値を取得します。 (継承元 ToolStripItem) |
| Renderer |
親 ToolStripのレンダラーを返します。 (継承元 ToolStripItem) |
| RightToLeft |
右から左へのフォントを使用してロケールをサポートするようにコントロールの要素を配置するかどうかを示す値を取得または設定します。 |
| RightToLeftAutoMirrorImage |
このプロパティは、このクラスには関係ありません。 |
| Selected |
項目が選択されているかどうかを示す値を取得します。 |
| ShowKeyboardCues |
ショートカット キーを表示または非表示にするかどうかを示す値を取得します。 (継承元 ToolStripItem) |
| Site |
ホストされるコントロールのサイトを取得または設定します。 |
| Size |
ToolStripItemのサイズを取得または設定します。 |
| Tag |
アイテムに関するデータを含むオブジェクトを取得または設定します。 (継承元 ToolStripItem) |
| Text |
ホストされるコントロールに表示するテキストを取得または設定します。 |
| TextAlign |
このプロパティは、このクラスには関係ありません。 |
| TextDirection |
このプロパティは、このクラスには関係ありません。 |
| TextImageRelation |
このプロパティは、このクラスには関係ありません。 |
| ToolTipText |
コントロールの ToolTip として表示されるテキストを取得または設定します。 (継承元 ToolStripItem) |
| Visible |
項目が表示されるかどうかを示す値を取得または設定します。 (継承元 ToolStripItem) |
| Width |
ToolStripItemの幅をピクセル単位で取得または設定します。 (継承元 ToolStripItem) |
メソッド
イベント
| 名前 | 説明 |
|---|---|
| AvailableChanged |
Available プロパティの値が変化したときに発生します。 (継承元 ToolStripItem) |
| BackColorChanged |
BackColor プロパティの値が変化したときに発生します。 (継承元 ToolStripItem) |
| BindingContextChanged |
バインディング コンテキストが変更されたときに発生します。 (継承元 BindableComponent) |
| Click |
ToolStripItemがクリックされたときに発生します。 (継承元 ToolStripItem) |
| CommandCanExecuteChanged |
Command プロパティに割り当てられているICommandのCanExecute(Object)状態が変更されたときに発生します。 (継承元 ToolStripItem) |
| CommandChanged |
Command プロパティの割り当てられたICommandが変更されたときに発生します。 (継承元 ToolStripItem) |
| CommandParameterChanged |
CommandParameter プロパティの値が変更されたときに発生します。 (継承元 ToolStripItem) |
| DisplayStyleChanged |
このイベントは、このクラスには関係ありません。 |
| Disposed |
コンポーネントが Dispose() メソッドの呼び出しによって破棄されるときに発生します。 (継承元 Component) |
| DoubleClick |
項目がマウスでダブルクリックされたときに発生します。 (継承元 ToolStripItem) |
| DragDrop |
ユーザーが項目をドラッグし、ユーザーがこの項目にドロップする必要があることを示すマウス ボタンを離すと発生します。 (継承元 ToolStripItem) |
| DragEnter |
ユーザーがこの項目のクライアント領域に項目をドラッグしたときに発生します。 (継承元 ToolStripItem) |
| DragLeave |
ユーザーが項目をドラッグし、マウス ポインターがこの項目のクライアント領域に移動しなくなったときに発生します。 (継承元 ToolStripItem) |
| DragOver |
ユーザーがこの項目のクライアント領域に項目をドラッグしたときに発生します。 (継承元 ToolStripItem) |
| EnabledChanged |
Enabled プロパティ値が変更されたときに発生します。 (継承元 ToolStripItem) |
| Enter |
ホストされたコントロールが入力されたときに発生します。 |
| ForeColorChanged |
ForeColor プロパティ値が変更されたときに発生します。 (継承元 ToolStripItem) |
| GiveFeedback |
ドラッグ操作中に発生します。 (継承元 ToolStripItem) |
| GotFocus |
ホストされたコントロールがフォーカスを受け取ったときに発生します。 |
| KeyDown |
ホストされているコントロールにフォーカスがあるときに、キーが押され、押された状態で発生します。 |
| KeyPress |
ホストされているコントロールにフォーカスがあるときにキーが押されたときに発生します。 |
| KeyUp |
ホストされているコントロールにフォーカスがあるときにキーが離されたときに発生します。 |
| Leave |
入力フォーカスがホストされたコントロールから離れると発生します。 |
| LocationChanged |
ToolStripItemの場所が更新されたときに発生します。 (継承元 ToolStripItem) |
| LostFocus |
ホストされたコントロールがフォーカスを失ったときに発生します。 |
| MouseDown |
マウス ポインターが項目の上にあり、マウス ボタンが押されたときに発生します。 (継承元 ToolStripItem) |
| MouseEnter |
マウス ポインターが項目に入ったときに発生します。 (継承元 ToolStripItem) |
| MouseHover |
マウス ポインターが項目の上にマウス ポインターを置いたときに発生します。 (継承元 ToolStripItem) |
| MouseLeave |
マウス ポインターが項目から離れると発生します。 (継承元 ToolStripItem) |
| MouseMove |
マウス ポインターが項目の上に移動したときに発生します。 (継承元 ToolStripItem) |
| MouseUp |
マウス ポインターが項目の上にあり、マウス ボタンが離されたときに発生します。 (継承元 ToolStripItem) |
| OwnerChanged |
Owner プロパティが変更されたときに発生します。 (継承元 ToolStripItem) |
| Paint |
アイテムが再描画されたときに発生します。 (継承元 ToolStripItem) |
| QueryAccessibilityHelp |
アクセシビリティ クライアント アプリケーションが ToolStripItemのヘルプを呼び出すと発生します。 (継承元 ToolStripItem) |
| QueryContinueDrag |
ドラッグ アンド ドロップ操作中に発生し、ドラッグ ソースがドラッグ アンド ドロップ操作を取り消す必要があるかどうかを判断できるようにします。 (継承元 ToolStripItem) |
| RightToLeftChanged |
RightToLeft プロパティ値が変更されたときに発生します。 (継承元 ToolStripItem) |
| SelectedChanged |
Selected プロパティの値が変化したときに発生します。 (継承元 ToolStripItem) |
| TextChanged |
Text プロパティの値が変化したときに発生します。 (継承元 ToolStripItem) |
| Validated |
ホストされたコントロールが正常に検証された後に発生します。 |
| Validating |
ホストされたコントロールが検証中に発生します。 |
| VisibleChanged |
Visible プロパティの値が変化したときに発生します。 (継承元 ToolStripItem) |
明示的なインターフェイスの実装
| 名前 | 説明 |
|---|---|
| IDropTarget.OnDragDrop(DragEventArgs) |
DragDrop イベントを発生させます。 (継承元 ToolStripItem) |
| IDropTarget.OnDragEnter(DragEventArgs) |
DragEnter イベントを発生させます。 (継承元 ToolStripItem) |
| IDropTarget.OnDragLeave(EventArgs) |
DragLeave イベントを発生させます。 (継承元 ToolStripItem) |
| IDropTarget.OnDragOver(DragEventArgs) |
|