Home > Components > DXCore Components – Tutorial Page Provider

DXCore Components – Tutorial Page Provider

June 17th, 2011

The Tutorial Page Provider DXCore component returns an HTML page, and registers it inside the topic tree of the DXCore User Guide. Many sections of the user guide are dynamically generated, so you can extend it with additional content according to your preference:

DXCore User Guide preview

You can drop the TutorialPageProvider control onto your plug-in design surface from the “DXCore: Extensions & Providers” category of Visual Studio Toolbox:

DXCore Tutorial Page Provider Toolbox

Here’s the Properties window, containing available properties, their categories and default values:

DXCore Tutorial Page Provider properties

The control doesn’t have any Events available.

The TutorialPageProvider component is located in the “DevExpress.CodeRush.Extensions” assembly. It is derived from the “PlugInExtension” base type from the “DevExpress.CodeRush.Core” assembly:

DXCore Tutorial Page Provider hierarchy

Here’s a list of properties in alphabetical order:

Property Name Description
Description Text, describing the purpose or behavior of this plug-in extension.
DisplayName The text name that identifies this extension.
HtmlFile Name of the html file used to store page content.
Register If true, this extension will be available to the DXCore. Otherwise, it will be hidden.
TutorialPath Path to this tutorial page in the User Guide tree list.

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 previous
VS IDEs: any
Updated: Jul/06/2011
ID: D089

Similar Posts: