Home | Contact Us | FAQ | Search & Site Map | Link to Us
Sign In | Join | Other 45 Sites in Network
HomeAnnouncementsFree MagazinesWhite PapersSubmit Content
Discussion GroupsASP.NETWindows FormsLanguages.NET FrameworkVisual Studio.NET
Articles.NET FrameworkASP.NETToolsWindows Forms
.NET DirectoryOpen Source ProjectsUser GroupsWeb Resources
Related Topics
Visual Basic 6SQL ServerMS AccessOther DB ProductsMS Server ProductsMore Topics ...

.NET Forum / Visual Studio.NET / IDE / May 2006

Tip: Looking for answers? Try searching our database.

asp net custom controls library help

Thread view: 
Enable EMail Alerts  Start New Thread
Thread rating: 
martin - 09 May 2006 11:08 GMT
I write a costom controls asp.net library using visual basic.
I want that while using the controls in design time a  help can be shown
that is relevant to the control.

I read about VSHIK - help integration kit - but I am not sure if I have to
integrate my help into visual studio.
actually I can do without integrating the help with visual studio, but how
do I c\make the relation  between the user controls librarty and the help
file.
and how do I deploy this to the end user (developer) machine?

TIA!
Peter Macej - 09 May 2006 11:25 GMT
> I want that while using the controls in design time a  help can be shown
> that is relevant to the control.

What kind of help exactly? There are 3 kinds of context help you can get
for your control:
1.  Whole help topic is shown when you press F1.

You need to add XML comments into your source code and generate Help2 or
CHM help from them.

2. Quick summary is shown in IntelliSense and Object Browser.

You need to add XML comments into your source code and then generate XML
doc file and place it in the same folder as your DLL.

3. Short property description is shown in Properties Window.

Use Description attribute:
<System.ComponentModel.Description("Indicates button state.")> _
   Public Property pushed() As Boolean

For the first two you need specialized tool, e.g. our VBdocman .NET or
NDoc. See
http://tinyurl.com/jh2xk
and
http://dotnet.mvps.org/dotnet/faqs/?id=tooltipsxmldocumentation&lang=en

> do I c\make the relation  between the user controls librarty and the help
> file.

Your help must be in MS Help2 (.HxS) or HTML Help 1.x (.CHM) format. See
http://helpware.net/mshelp2/demo/DynamicHelp.htm for the former one.

In general, you need to include XML Data Islands (especially F keywords)
into your topic HTML files.

If you are using CHM instead of Help2, you need to include those islands
in special XML file and place it in VS .NET folder (usually in
C:\Program Files\Microsoft Visual Studio
.NET\common7\ide\html\XMLLinks\1033).

The detailed article is in VSHIK white paper Dynamic_Help.doc. You can
usually find it in C:\Program Files\VSHIK\Whitepapers\. Of course, you
need to have VSHIK installed.

You can also observe syntax of F-keywords by opening help for any class
in VS .NET and view its source code.

Or our tool VBdocman .NET (http://www.vbdocman.com/net/) does it all for
you.

Signature

Peter Macej
Helixoft - http://www.vbdocman.com
VBdocman - Automatic generator of technical documentation for VB, VB
.NET and ASP .NET code


Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...

Oracle MagazineNetwork ComputingComputer WorldBio-IT WorldeWeekInformation WeekInfosecurity
 
Sign In
Join
My Latest Posts
My Monitored Threads
My Blog
My Photo Gallery
My Profile
My Homepage

Start New Thread
Enable EMail Alerts
Rate this Thread



©2008 Advenet LLC   Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.