AccessibleObject.GetHelpTopic(String) Metoda

Definice

Obor názvů:

System.Windows.Forms

Sestavení:

System.Windows.Forms.dll

Zdroj:

AccessibleObject.cs

Získá identifikátor pro identifikátor tématu nápovědy a cestu k souboru nápovědy přidružené k tomuto přístupnému objektu.

public:
 virtual int GetHelpTopic([Runtime::InteropServices::Out] System::String ^ % fileName);

public virtual int GetHelpTopic(out string? fileName);

abstract member GetHelpTopic : string -> int
override this.GetHelpTopic : string -> int

Public Overridable Function GetHelpTopic (ByRef fileName As String) As Integer

Parametry

fileName

String

Při návratu tato vlastnost obsahuje cestu k souboru nápovědy přidruženému k tomuto přístupnému objektu.

Návraty

Int32

Identifikátor tématu nápovědy nebo -1, pokud neexistuje žádné téma nápovědy. Při návratu fileName obsahuje parametr cestu k souboru nápovědy přidruženému k tomuto přístupnému objektu.

Výjimky

COMException

Téma nápovědy pro ovládací prvek nelze načíst.

Poznámky

Chcete-li zobrazit nápovědu pro AccessibleObject pomocí systému nápovědy Windows, můžete předat název souboru a ID tématu příslušné metodě Help.ShowHelpHelp.

Poznámky pro dědice

Ne všechny objekty musí tuto vlastnost podporovat.

Viz také

• Help
• Help