Help.ShowHelp Yöntem

Tanım

Ad Alanı:

System.Windows.Forms

Bütünleştirilmiş Kod:

System.Windows.Forms.dll

Yardım dosyasının içeriğini görüntüler.

Aşırı Yüklemeler

ShowHelp(Control, String)	Belirtilen URL'de Yardım dosyasının içeriğini görüntüler.
ShowHelp(Control, String, String)	Belirli bir anahtar sözcük için belirtilen URL'de bulunan Yardım dosyasının içeriğini görüntüler.
ShowHelp(Control, String, HelpNavigator)	Belirli bir konu için belirtilen URL'de bulunan Yardım dosyasının içeriğini görüntüler.
ShowHelp(Control, String, HelpNavigator, Object)	Kullanıcı tarafından sağlanan URL'de bulunan Yardım dosyasının içeriğini görüntüler.

ShowHelp(Control, String)

Belirtilen URL'de Yardım dosyasının içeriğini görüntüler.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url);

static member ShowHelp : System.Windows.Forms.Control * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String)

Parametreler

parent

Control

Control Yardım iletişim kutusunun üst öğesini tanımlayan bir.

url

String

Yardım dosyasının yolu ve adı.

Örnekler

Aşağıdaki kod örneği yöntemini gösterir ShowHelp . Bu örneği çalıştırmak için aşağıdaki kodu adlı Button1düğmeyi içeren bir forma yapıştırın.

// Open the Help file for the Character Map topic.  
void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm" );
}

// Open the Help file for the Character Map topic.  
private void Button1_Click(System.Object sender, System.EventArgs e)
{

    Help.ShowHelp(TextBox1, "file://c:\\charmap.chm");
}

' Open the Help file for the Character Map topic.  
Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm")
End Sub

Açıklamalar

Bağımsız url değişken C:\path\sample.chm veya /folder/file.htmbiçiminde olabilir. Yolların biçimi hakkında bilgi için bkz. Windows sistemlerinde dosya yolu biçimleri.

Ayrıca bkz.

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Belirli bir anahtar sözcük için belirtilen URL'de bulunan Yardım dosyasının içeriğini görüntüler.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::String ^ keyword);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, string? keyword);

static member ShowHelp : System.Windows.Forms.Control * string * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, keyword As String)

Parametreler

parent

Control

Control Yardım iletişim kutusunun üst öğesini tanımlayan bir.

url

String

Yardım dosyasının yolu ve adı.

keyword

String

Yardım'ın görüntüleneceği anahtar sözcük.

Örnekler

Aşağıdaki kod örneği, mspaint.chm Yardım dosyasıyla etkileşim kurmak için kullanılabilecek üç düğme içeren bir form görüntüler. Yardım Dizinini Göster düğmesi, Yardım dosyasının Dizin sekmesini görüntüler. Yardımı Göster düğmesi, Yardım dosyasındaki içeriği Yardım Gezgini listesinde seçilen değere göre görüntüler. Anahtar Sözcüğü Göster düğmesi, Yardım dosyasındaki içeriği Anahtar Sözcük metin kutusunda belirtilen anahtar sözcüğü temel alarak görüntüler.

Örneğin, Ovals Yardım sayfasını dizin değerine göre göstermek için, Yardım Gezgini açılan listesinden değeri seçinHelpNavigator.KeywordIndex, Parametre metin kutusuna ovaller yazın ve yardımı göster düğmesine tıklayın. Anahtar sözcüğüne göre "Fırçayla boyamak için" Yardım konusunu göstermek için, Anahtar Sözcük metin kutusuna mspaint.chm::/paint_brush.htm yazın ve anahtar sözcüğü göster düğmesine tıklayın.

Bu örnekte yalnızca yöntemine yapılan çağrı gösterilmektedir ShowHelp . Kod örneğinin Help tamamı için sınıfa genel bakış bölümüne bakın.

void showKeyword_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Display help using the provided keyword.
   Help::ShowHelp( this, helpfile, keyword->Text );
}

private void showKeyword_Click(object sender, System.EventArgs e)
{
    // Display help using the provided keyword.
    Help.ShowHelp(this, helpfile, keyword.Text);
}

Private Sub showKeyword_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showKeyword.Click
    ' Display Help using the provided keyword. 
    Help.ShowHelp(Me, helpfile, keyword.Text)
End Sub

Açıklamalar

Bağımsız url değişken C:\path\sample.chm veya /folder/file.htmbiçiminde olabilir. Yolların biçimi hakkında bilgi için bkz. Windows sistemlerinde dosya yolu biçimleri.

ise keywordnull, Yardım dosyasının içindekiler tablosu görüntülenir.

Ayrıca bkz.

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Belirli bir konu için belirtilen URL'de bulunan Yardım dosyasının içeriğini görüntüler.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator navigator);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator navigator);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, navigator As HelpNavigator)

Parametreler

parent

Control

Control Yardım iletişim kutusunun üst öğesini tanımlayan bir.

url

String

Yardım dosyasının yolu ve adı.

navigator

HelpNavigator

Değerlerden HelpNavigator biri.

Örnekler

Aşağıdaki kod örneği, bir Yardım dosyasını dizin sayfasında açmak için yönteminin nasıl kullanılacağını ShowHelp gösterir. Bu örneği çalıştırmak için aşağıdaki kodu adlı Button2düğmeyi içeren bir forma yapıştırın.

// Open the Help file for the Character Map topic and 
// display the Index page.
void Button2_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm", HelpNavigator::Index );
}

// Open the Help file for the Character Map topic and 
// display the Index page.
private void Button2_Click(System.Object sender, System.EventArgs e)
{

    Help.ShowHelp(TextBox1, "file://c:\\charmap.chm", 
        HelpNavigator.Index);
}

' Open the Help file for the Character Map topic and 
' display the Index page.
Private Sub Button2_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button2.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm", HelpNavigator.Index)
End Sub

Açıklamalar

Bağımsız url değişken C:\path\sample.chm veya /folder/file.htmbiçiminde olabilir. Yolların biçimi hakkında bilgi için bkz. Windows sistemlerinde dosya yolu biçimleri.

Derlenmiş Yardım dosyaları sayfalarda içindekiler tablosu, dizin, arama ve anahtar sözcük bağlantıları sağlar. bağımsız değişkeni için navigator aşağıdaki değerleri kullanabilirsiniz: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexveya HelpNavigator.Topic.

Ayrıca bkz.

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

Kullanıcı tarafından sağlanan URL'de bulunan Yardım dosyasının içeriğini görüntüler.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ parameter);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator command, object? parameter);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator * obj -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, parameter As Object)

Parametreler

parent

Control

Control Yardım iletişim kutusunun üst öğesini tanımlayan bir.

url

String

Yardım dosyasının yolu ve adı.

command

HelpNavigator

Değerlerden HelpNavigator biri.

parameter

Object

Konu tanımlayıcısını içeren bir dize.

Özel durumlar

ArgumentException

parameter bir tamsayıdır.

Örnekler

Aşağıdaki kod örneği, mspaint.chm Yardım dosyasıyla etkileşim kurmak için kullanılabilecek üç düğme içeren bir form görüntüler. Yardım Dizinini Göster düğmesi, Yardım dosyasının Dizin sekmesini görüntüler. Yardımı Göster düğmesi, Yardım dosyasındaki içeriği Yardım Gezgini listesinde seçilen değere göre görüntüler. Anahtar Sözcüğü Göster düğmesi, Yardım dosyasındaki içeriği Anahtar Sözcük metin kutusunda belirtilen anahtar sözcüğü temel alarak görüntüler.

Örneğin, Ovals Yardım sayfasını dizin değerine göre göstermek için, Yardım Gezgini açılan listesinden değeri seçinHelpNavigator.KeywordIndex, Parametre metin kutusuna ovaller yazın ve yardımı göster düğmesine tıklayın. Anahtar sözcüğüne göre "Fırçayla boyamak için" Yardım konusunu göstermek için, Anahtar Sözcük metin kutusuna mspaint.chm::/paint_brush.htm yazın ve anahtar sözcüğü göster düğmesine tıklayın.

Bu örnekte yalnızca yöntemine yapılan çağrı gösterilmektedir ShowHelp . Kod örneğinin Help tamamı için sınıfa genel bakış bölümüne bakın.

void showHelp_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Display Help using the Help navigator enumeration
   // that is selected in the combo box. Some enumeration
   // values make use of an extra parameter, which can
   // be passed in through the Parameter text box.
   HelpNavigator navigator = HelpNavigator::TableOfContents;
   if ( navigatorCombo->SelectedItem != nullptr )
   {
      navigator =  *safe_cast<HelpNavigator^>(navigatorCombo->SelectedItem);
   }

   Help::ShowHelp( this, helpfile, navigator, parameterTextBox->Text );
}

private void showHelp_Click(object sender, System.EventArgs e)
{
    // Display Help using the Help navigator enumeration
    // that is selected in the combo box. Some enumeration
    // values make use of an extra parameter, which can
    // be passed in through the Parameter text box.
    HelpNavigator navigator = HelpNavigator.TableOfContents;
    if (navigatorCombo.SelectedItem != null)
    {
        navigator = (HelpNavigator)navigatorCombo.SelectedItem;
    }
    Help.ShowHelp(this, helpfile, navigator, parameterTextBox.Text);
}

Private Sub showHelp_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showHelp.Click
    ' Display Help using the Help navigator enumeration
    ' that is selected in the combo box. Some enumeration
    ' values make use of an extra parameter, which can
    ' be passed in through the Parameter text box.
    Dim navigator As HelpNavigator = HelpNavigator.TableOfContents
    If (navigatorCombo.SelectedItem IsNot Nothing) Then
        navigator = CType(navigatorCombo.SelectedItem, HelpNavigator)
    End If
    Help.ShowHelp(Me, helpfile, navigator, parameterTextBox.Text)
End Sub

Açıklamalar

Bağımsız url değişken C:\path\sample.chm veya /folder/file.htmbiçiminde olabilir. Yolların biçimi hakkında bilgi için bkz. Windows sistemlerinde dosya yolu biçimleri.

Derlenmiş Yardım dosyaları sayfalarda içindekiler tablosu, dizin, arama ve anahtar sözcük bağlantıları sağlar. , , HelpNavigator.KeywordIndexHelpNavigator.TopicIdveya HelpNavigator.AssociateIndex komutunun parameter ek iyileştirmesini sağlamak için bağımsız değişkenini HelpNavigator.Topickullanabilirsiniz. Bağımsız değişkeninde commandHelpNavigator.TableOfContentsbelirtilen değer , HelpNavigator.Indexveya HelpNavigator.Findise, bu değer boş bir dize (""veya String.Empty) olmalıdır. command Bağımsız değişken , , HelpNavigator.TopicIdHelpNavigator.KeywordIndexveya HelpNavigator.AssociateIndexöğesine başvuruda bulunursaHelpNavigator.Topic, bu değer konu adını veya görüntülenecek konunun anahtar sözcüğünü veya sayısal tanımlayıcısını içeren bir dize olmalıdır.

Ayrıca bkz.

• ShowHelpIndex(Control, String)