Procedura: specificare un file della Guida per un componente
Nella maggior parte delle situazioni è opportuno lasciare agli sviluppatori che usano il componente la possibilità di attivare la Guida in fase di esecuzione. In alcuni casi, tuttavia, può essere utile che il componente consenta di visualizzare la Guida HTML quando viene chiamata. La Guida HTML può essere fornita per i componenti mediante l'oggetto System.Windows.Forms.Help, una classe statica che incapsula il motore HTML Help 1.x. Non è possibile creare istanze di questa classe ed è necessario chiamare direttamente i relativi metodi. Per visualizzare la Guida, chiamare il metodo Help.ShowHelp. Per questo metodo di overload sono necessari almeno due argomenti: il controllo che funge da controllo padre della finestra di dialogo della Guida e l'URL del file della Guida. Il file della Guida può essere un file HTML Help 1.x compilato con estensione CHM o un file HTML nel formato HTML Help.
Se si intende incorporare il supporto per un file della Guida direttamente nel componente, sarà possibile decidere come e quando visualizzarlo nei due modi seguenti:
Il metodo preferito consiste nell'implementazione di un metodo Help che possa essere chiamato dall'applicazione client. Mediante l'applicazione client è possibile passare dei parametri al metodo Help in modo da garantire che vengano visualizzati gli argomenti esatti, mentre lo sviluppatore che crea il codice con quel componente avrà la possibilità di escludere completamente la Guida.
L'altra possibilità consiste nel richiamare in risposta il metodo ShowHelp nel momento in cui nel codice si verificano determinate condizioni. Questo approccio fornisce il massimo controllo sulla Guida visualizzata, ma limita notevolmente l'utilizzo futuro del componente da parte degli sviluppatori.
Per specificare e visualizzare un file della Guida per il componente
Creare e compilare il file della Guida CHM.
Se non è già presente un riferimento allo spazio dei nomi System.Windows.Forms nel componente, aggiungerne uno.
Creare un metodo pubblico per visualizzare la Guida. Questo metodo deve fornire agli sviluppatori un modo semplice per specificare la Guida da visualizzare.
' This method takes parameters from the client application that allow ' the developer to specify when Help is displayed. Public Sub DisplayHelp (ByVal parent as System.Windows.Forms.Control, _ ByVal topic as MyHelpEnum) ' The file to display is chosen by the value of the topic ' parameter. Select Case topic Case MyHelpEnum.enumWidgets Windows.Forms.Help.ShowHelp(parent, "C:\Help\Widgets.chm") Case MyHelpEnum.enumMechanisms ' Insert code to implement additional functionality. End Select End Sub// This method takes parameters from the client application that allow // the developer to specify when Help is to be shown. public void MyHelp(System.Windows.Forms.Control parent, myHelpEnum topic) { // The file to display is chosen by the value of the topic. switch (topic) { case myHelpEnum.enumWidgets: System.Windows.Forms.Help.ShowHelp(parent, " C:\\help\\widgets.chm "); break; case myHelpEnum.enumMechanism: // Insert code to implement additional functionality. break; } }