Click or drag to resize
weroSoft AG, Software
HelpProvider Class
The documentation is integral part of the weroSoft product documentation. This part is intended to be used by developers only.
Provides the functionality for showing on-line help for a WPF application.
Inheritance Hierarchy
SystemObject
  WeroSoft.Windows.ContextHelpHelpProvider

Namespace:  WeroSoft.Windows.ContextHelp
Assembly:  WeroSoft.Windows.Library (in WeroSoft.Windows.Library.dll) Version: 3.0 Pre-Release
Syntax
C#
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
  NameDescription
Public propertyStatic memberDefaultFileName
Gets or sets the file name of the default help file to be used, if no specific help file is defined.
Public propertyStatic memberDefaultHelpFileLanguage
Gets or sets the default help file language.
Public propertyStatic memberUsedHelpFileFormat
Gets or sets the used help file format.
Top
Methods
  NameDescription
Public methodStatic memberApplyHelpEntryPoint(DependencyObject, HelpProviderEntryPoint)
Applies the help entry point to the defined dependency object.
Public methodStatic memberApplyHelpEntryPoint(DependencyObject, Type, HelpProviderEntryPoint)
Applies the help entry point to the parent of type parentType of the dependency object.
Public methodStatic memberGetChmHelpContextName
Implements the getter of the attached property 'HelpKeyword'.
Public methodStatic memberGetChmHelpFileName
Implements the getter of the attached property 'ChmHelpFileName'.
Public methodStatic memberGetHtmlHelpFileName
Implements the getter of the attached property 'HtmlHelpFileName'.
Public methodStatic memberGetPdfHelpFileName
Implements the getter of the attached property 'PdfHelpFileName'.
Public methodStatic memberSetChmHelpContextName
Implements the setter of the attached property 'HelpKeyword'.
Public methodStatic memberSetChmHelpFileName
Implements the setter of the attached property 'HelpFileName'.
Public methodStatic memberSetHtmlHelpFileName
Implements the setter of the attached property 'HtmlHelpFileName'.
Public methodStatic memberSetPdfHelpFileName
Implements the setter of the attached property 'PdfHelpFileName'.
Top
Events
  NameDescription
Public eventStatic memberHelpFileNameResolve
Proposes the possibility to resolve the requested help file name externally.
Top
Fields
  NameDescription
Public fieldStatic memberChmHelpContextNameProperty
DependencyProperty used as the backing store for the property 'HelpKeyword'. This enables animation, styling, binding, etc...
Public fieldStatic memberChmHelpFileNameProperty
DependencyProperty used as the backing store for the property 'HelpFileName'. This enables animation, styling, binding, etc...
Public fieldStatic memberHelpFolderName
Defines the help folder name, which is used for searching the help file in some cases.
Public fieldStatic memberHtmlHelpFileNameProperty
DependencyProperty used as the backing store for the property 'HtmlHelpFileName'. This enables animation, styling, binding, etc...
Public fieldStatic memberPdfHelpFileNameProperty
DependencyProperty used as the backing store for the property 'HelpFileName'. This enables animation, styling, binding, etc...
Top
Attached Properties
  NameDescription
Public attached propertyChmHelpContextName
DependencyProperty used as the backing store for the property 'HelpKeyword'. This enables animation, styling, binding, etc...
Public attached propertyChmHelpFileName
DependencyProperty used as the backing store for the property 'HelpFileName'. This enables animation, styling, binding, etc...
Public attached propertyHtmlHelpFileName
DependencyProperty used as the backing store for the property 'HtmlHelpFileName'. This enables animation, styling, binding, etc...
Public attached propertyPdfHelpFileName
DependencyProperty used as the backing store for the property 'HelpFileName'. This enables animation, styling, binding, etc...
Top
See Also