DXCore Components – Tutorial Content Provider
The Tutorial Content Provider DXCore component returns a section of an HTML code for display in the CodeRush User Guide. Many sections of the user guide are dynamically generated, so you can extend it with any content according to your preference. Here’s a preview of the User Guide:
You can drop the TutorialContentProvider control onto your plug-in design surface from the “DXCore: Extensions & Providers” category of Visual Studio Toolbox:
Here’s the Properties window, containing available properties, their categories and default values:
and the Events list:
The TutorialContentProvider component is located in the “DevExpress.CodeRush.Extensions” assembly. It is derived from the “PlugInExtension” base type from the “DevExpress.CodeRush.Core” assembly:
Here’s a list of properties in alphabetical order:
Property name |
Description |
ContentName | Identifier of the content for refrering inside topics. |
Description | Text, describing the purpose or behavior of this plug-in extension. |
DisplayName | The text name that identifies this extension. |
Register | If true, this extension will be available to the DXCore. Otherwise, it will be hidden. |
Events:
Event name |
Description |
GetContent | Handle this event to provide content once it is requested. |
See the “Populating the User Guide with dynamic and static content” topic, to learn more on adding dynamic content into the DXCore User Guide.
—– Products: DXCore Versions: 11.1 and up VS IDEs: any Updated: Jun/18/2011 ID: D090