Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
interface System.ComponentModel.Design.IHelpService
Assembly: System.ComponentModel.TypeConverter
Provides methods for showing Help topics and adding and removing Help keywords at design time.
Methods
void
AddContextAttribute(string name,
string value,
HelpKeywordType keywordType)
Adds a context attribute to the document.
name
The name of the attribute to add.
value
The value of the attribute.
keywordType
The type of the keyword, from the enumeration <see cref="T:System.ComponentModel.Design.HelpKeywordType" /> .
void
ClearContextAttributes()
Removes all existing context attributes from the document.
CreateLocalContext(HelpContextType contextType)
Creates a local <see cref="T:System.ComponentModel.Design.IHelpService" /> to manage subcontexts.
Returns The newly created <see cref="T:System.ComponentModel.Design.IHelpService" /> .
contextType
The priority type of the subcontext to add.
void
RemoveContextAttribute(string name,
string value)
Removes a previously added context attribute.
name
The name of the attribute to remove.
value
The value of the attribute to remove.
void
RemoveLocalContext(IHelpService localContext)
Removes a context created with <see cref="M:System.ComponentModel.Design.IHelpService.CreateLocalContext(System.ComponentModel.Design.HelpContextType)" /> .
localContext
The local context <see cref="T:System.ComponentModel.Design.IHelpService" /> to remove.
void
ShowHelpFromKeyword(string helpKeyword)
Shows the Help topic that corresponds to the specified keyword.
helpKeyword
The keyword of the Help topic to display.
void
ShowHelpFromUrl(string helpUrl)
Shows the Help topic that corresponds to the specified URL.
helpUrl
The URL of the Help topic to display.