Help2 Schnittstelle
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Die Schnittstelle, die Document Explorer unterstützt.
public interface class Help2 : Microsoft::VisualStudio::VSHelp::Help
public interface class Help2 : Microsoft::VisualStudio::VSHelp::Help
__interface Help2 : Microsoft::VisualStudio::VSHelp::Help
[System.Runtime.InteropServices.Guid("78413D2D-0492-4A9B-AB25-730633679977")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Help2 : Microsoft.VisualStudio.VSHelp.Help
[<System.Runtime.InteropServices.Guid("78413D2D-0492-4A9B-AB25-730633679977")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Help2 = interface
interface Help
Public Interface Help2
Implements Help
- Attribute
- Implementiert
Hinweise
Help2 unterstützt Gewusst wie, suchen und Favoriten. Dies ist der Haupteinstiegspunkt für den Zugriff auf den Dokument-Explorer (Dexplorer.exe).
Wie Sie das Objekt abrufen, Help2 hängt von der Anwendung ab.
In nicht-VSPackages:
Das Help2 -Objekt ist ein untergeordnetes Element von DTE in seiner Objekthierarchie, und es kann über die spät gebundene Eigenschaft darauf zugegriffen werden
DTE.Help. Für den Zugriff auf Help2 eine Anwendung, bei der es sich nicht um ein Add-in oder ein Makro handelt, müssen Sie eine Instanz von abrufen DTE , die im folgenden Beispiel veranschaulicht wird:EnvDTE.DTE dte; dte = (EnvDTE.DTE)System.Runtime.InteropServices.Marshal.GetActiveObject("VisualStudio.DTE.8.0"); Object helpobj = dte.Help;In einem Add-in können Sie das Help2 Objekt direkt abrufen:
Microsoft.VisualStudio.VSHelp80.Help2 help2 = (Microsoft.VisualStudio.VSHelp80.Help2)dte.GetObject("Help2");
In einem VSPackage:
Sie erhalten das Help2 Objekt über den SVsHelp Dienst:
Microsoft.VisualStudio.VSHelp80.Help2 help2; // Obtain the Help2 object from SVsHelp service. help2 = (Microsoft.VisualStudio.VSHelp80.Help2) this.GetService(typeof(Microsoft.VisualStudio.VSHelp.SVsHelp));
Eigenschaften
| Collection |
Nur Microsoft-interne Verwendung. |
| Filter |
Ruft den Auflistungsfilter ab oder legt diesen fest. |
| FilterQuery |
Gibt die Abfragezeichenfolge für den aktuellen Hilfeauflistungsfilter zurück. |
| Help |
Wird für die Kompatibilität mit verwendet DTE2 , wenn es als |
| HelpOwner |
Nur Microsoft-interne Verwendung. |
| HxSession |
Nur Microsoft-interne Verwendung. |
Methoden
| AskAQuestion(UInt32) |
Zeigt eine URL auf Grundlage des angegebenen Flags an. |
| CanShowFilterUI() |
Veraltete Methode. |
| CanSyncContents(String) |
Bestimmt, ob eine URL synchronisiert werden kann oder nicht. |
| Close() |
Schließt den Document Explorer und alle seine Seiten. |
| Contents() |
Wählt das Inhalts Navigationsfenster aus und öffnet es, wenn es geschlossen ist. |
| DisplayTopicFrom_OLD_Help(String, UInt32) |
Veraltete Methode. Verwenden Sie stattdessen DisplayTopicFromF1Keyword(String). |
| DisplayTopicFromF1Keyword(String) |
Zeigt die Hilfe für F1 und von den Dialogfeldern an. |
| DisplayTopicFromId(String, UInt32) |
Veraltet. Verwenden Sie stattdessen DisplayTopicFromF1Keyword(String). |
| DisplayTopicFromKeyword(String) |
Führt eine Suche mithilfe des K-Schlüsselwortindexes aus. |
| DisplayTopicFromURL(String) |
Zeigt ein Hilfethema an, das durch die URL im Dokument-Explorer angegeben wird. |
| DisplayTopicFromURLEx(String, IVsHelpTopicShowEvents) |
Nur Microsoft-interne Verwendung. |
| DisplayTopicFromURLEx2(String, UInt32, String) |
Zeigt ein Hilfethema im Dokument-Explorer an, das auf Hilfeanzeigenflags basiert. |
| Favorites() |
Zeigt das Toolfenster "Favoriten" an. |
| FilterUI() |
Veraltete Methode. |
| GetNextTopic(String) |
Erhält eine URL und gibt die nächste URL im Inhaltsverzeichnis zurück. |
| GetObject(String, String) |
Nur Microsoft-interne Verwendung. |
| GetPrevTopic(String) |
Erhält eine URL und gibt die vorherige URL im Inhaltsverzeichnis zurück. |
| HowDoI() |
Zeigt das Fenster "Gewusst wie " an. |
| Index() |
Wählt das Fenster Index aus. |
| IndexResults() |
Wählt das Fenster Index Ergebnisse aus. |
| InitializeSettingsToken(String) |
Nur für die interne Verwendung durch Microsoft vorgesehen. |
| Search() |
Wählt das Such Dialogfeld aus. |
| SearchEx(String, String, UInt32) |
Wählt das Such Fenster aus und füllt optional das Such Dialogfeld mit einem Begriff aus oder führt eine Suche nach einem bestimmten Begriff aus. |
| SearchResults() |
Wählt das Fenster Suchergebnisse aus. |
| SetCollection(String, String) |
Nur Microsoft-interne Verwendung. |
| SyncContents(String) |
Synchronisiert die Inhaltstabelle mit der bereitgestellten URL. |
| SyncIndex(String, Int32) |
Sucht nach dem Thema, das vom K-Schlüsselwort angegeben wird, zeigt jedoch nicht das Thema im Document Explorer an, sofern nicht anders angegeben. |