 | |
| HelpProvider Class | |
Provides the functionality for showing on-line help for a WPF application.
Inheritance HierarchyNamespace: WeroSoft.Windows.ContextHelp
Assembly: WeroSoft.Windows.Library (in WeroSoft.Windows.Library.dll) Version: 3.0 Pre-Release
SyntaxC#
public static class HelpProvider
Remarks
This type connects a WPF application with the help in a .chm File. It allows
to hierarchically define the help relation using a help file name and a
help keyword for context specific positioning within one or multiple
help files.
The HelpProvider type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | DefaultFileName |
Gets or sets the file name of the default help file to be used, if no specific help file is defined.
|
| DefaultHelpFileLanguage |
Gets or sets the default help file language.
|
| UsedHelpFileFormat |
Gets or sets the used help file format.
|
Methods| Name | Description | |
|---|---|---|
 | ApplyHelpEntryPoint(DependencyObject, HelpProviderEntryPoint) |
Applies the help entry point to the defined dependency object.
|
| ApplyHelpEntryPoint(DependencyObject, Type, HelpProviderEntryPoint) |
Applies the help entry point to the parent of type parentType of the dependency object.
|
| GetChmHelpContextName |
Implements the getter of the attached property 'HelpKeyword'.
|
| GetChmHelpFileName |
Implements the getter of the attached property 'ChmHelpFileName'.
|
| GetHtmlHelpFileName |
Implements the getter of the attached property 'HtmlHelpFileName'.
|
| GetPdfHelpFileName |
Implements the getter of the attached property 'PdfHelpFileName'.
|
| SetChmHelpContextName |
Implements the setter of the attached property 'HelpKeyword'.
|
| SetChmHelpFileName |
Implements the setter of the attached property 'HelpFileName'.
|
| SetHtmlHelpFileName |
Implements the setter of the attached property 'HtmlHelpFileName'.
|
| SetPdfHelpFileName |
Implements the setter of the attached property 'PdfHelpFileName'.
|
Events| Name | Description | |
|---|---|---|
 | HelpFileNameResolve |
Proposes the possibility to resolve the requested help file name externally.
|
Fields| Name | Description | |
|---|---|---|
 | ChmHelpContextNameProperty |
DependencyProperty used as the backing store for the property 'HelpKeyword'.
This enables animation, styling, binding, etc...
|
| ChmHelpFileNameProperty |
DependencyProperty used as the backing store for the property 'HelpFileName'.
This enables animation, styling, binding, etc...
|
| HelpFolderName |
Defines the help folder name, which is used for searching the help file in some cases.
|
| HtmlHelpFileNameProperty |
DependencyProperty used as the backing store for the property 'HtmlHelpFileName'.
This enables animation, styling, binding, etc...
|
| PdfHelpFileNameProperty |
DependencyProperty used as the backing store for the property 'HelpFileName'.
This enables animation, styling, binding, etc...
|
Attached Properties| Name | Description | |
|---|---|---|
| ChmHelpContextName |
DependencyProperty used as the backing store for the property 'HelpKeyword'.
This enables animation, styling, binding, etc...
|
| ChmHelpFileName |
DependencyProperty used as the backing store for the property 'HelpFileName'.
This enables animation, styling, binding, etc...
|
| HtmlHelpFileName |
DependencyProperty used as the backing store for the property 'HtmlHelpFileName'.
This enables animation, styling, binding, etc...
|
| PdfHelpFileName |
DependencyProperty used as the backing store for the property 'HelpFileName'.
This enables animation, styling, binding, etc...
|
See Also