HelpProvider.GetShowHelp メソッド

.NET Framework クラス ライブラリ リファレンス

HelpProvider.GetShowHelp メソッド

指定したコントロールのヘルプを表示する必要があるかどうかを示す値を返します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

<LocalizableAttribute(True)> _
Public Overridable Function
 GetShowHelp ( _
    ctl As Control _
) As Boolean

Visual Basic (使用法)

Dim instance As HelpProvider
Dim ctl As Control
Dim returnValue As Boolean

returnValue = instance.GetShowHelp(ctl)

C#

[LocalizableAttribute(true)] 
public virtual bool GetShowHelp (
    Control ctl
)

C++

[LocalizableAttribute(true)] 
public:
virtual bool GetShowHelp (
    Control^ ctl
)

J#

/** @attribute LocalizableAttribute(true) */ 
public boolean GetShowHelp (
    Control ctl
)

JScript

LocalizableAttribute(true) 
public function GetShowHelp (
    ctl : Control
) : boolean

パラメータ

ctl

ヘルプ表示の対象となる Control。

戻り値
このコントロールにヘルプが表示される場合は true。それ以外の場合は false。

解説

SetHelpKeyword メソッドまたは SetHelpString メソッドを使用して、指定したコントロールにキーワードまたはプロンプトを関連付けると、このメソッドが自動的に呼び出され true を返します。false を SetShowHelp メソッドに渡すことによって、この動作をオーバーライドできます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
HelpProvider クラス
HelpProvider メンバ
System.Windows.Forms 名前空間
GetHelpString
GetHelpKeyword
GetShowHelp
SetHelpString
SetHelpKeyword