BubbleHelp Class

-BubbleHelp .NET
The BubbleHelp .Net control is a custom ASP .Net server control that provides context help functionality to the Web Forms. It alows you to create as much help as needed at the exact place desired.

For a list of all members of this type, see BubbleHelp Members.

System.Object
   Control
      WebControl
         CompositeControl
            BubbleHelp

Remarks

Overview

The BubbleHelp .Net control is a custom ASP .Net control that provides context help functionality to the Web Forms. It alows you to create as much help as needed at the exact place desired.

Product Features

This is the list of the product features for this version.

• Has HelpID, Title, and Content properties
• Can set Width and Height of the Help Window
• Requires ZERO (0) coding to create simple context help at design time
• Coupled with HelpSummary control can use DataBound help content
• Localization - supports content in any culture
• Can customize the character in the help Icon(?)
• Styling for the rendered help icon
• Styling for the popup help window
• Visual Studio .NET Designer support

Important Info - Using ZsoftNet ASP .NET Controls

Step 1: Create custom Visual Studio .NET Toolbox Tab

1. Add new custom tab named ZsoftNet in Visual Studio .NET toolbox.

2. Right-click and select Add/Remove Items...

3. If you see any ZsoftNet components, choose from the .NET components, else browse to the instalation forder (Program Files\ZsoftNet\).

4. Select the desired components.



5. Select OK and you will see the components you selected. IMPORTANT: These steps assume that the ZsoftNet.Web.UI.Shared is installed in the GAC. This is done by default durring instalation of any of the ZsoftNet products.

Step 2: Adding Project References

To use any ZsoftNet Control, you need to always do the following 5 steps:

1. Add Reference to ZsoftNet.Web.UI.Shared in your project.

2. Set the CopyLocal component property to True for the Shared component to copy the control to your project at runtime, as this component is installed in the GAC.

3. Add a project reference to the assembly of the control you want to use.

4. Copy the License File for the particular control in the project root. License files for ALL ZsoftNet products are located in the specific product instalation folder (Program Files\ZsoftNet\ )

5. Just drag the control on your Web Form to use.

6. Copy Java Script Files to your project (for controls which require them). Our recommendation is to create scripts/ folder in your application root, and place all the javascript files in there. JavaScript files, for applicable controls, are located in the product installation folder (Program Files\ZsoftNet\).

7. Copy Image Files to your project (for controls which require them). Our recommendation is to create images/ folder in your application root, and place all the image files in there. Image files, for applicable controls, are located in the product installation folder (Program Files\ZsoftNet\).

Visual Studio .Net Design Time Support - YES



Example 1:



Example 2:


Working with BubbleHelp .Net (Standalone)

The control renders a single small icon, with the icon character as specified. The control also renders invisible data which is used to show the help item in context.

BubbleHelp .Net Key Properties.

• Title - the help item title.
• Content - the help item contents.
• HelpStyle - the style for the help items.

Summary

BubbleHelp .Net control can be used to provide user with contextual help on any Web Forms page and the control can be combined with other Web Form controls.

Example

Here is a simple TestBubbleHelp.aspx page behind code. To run this example, create a new Web Form named TestBubbleHelp.aspx, and place this code in the code behind.

            
            using ZsoftNet.Web.UI.BubbleHelp;
            
            namespace TestBubbleHelpControl
            {
            	public class TestBubbleHelp : System.Web.UI.Page
            	{
            		protected BubbleHelp BubbleHelp1;
            	
            		private void Page_Load(object sender, System.EventArgs e)
            		{
            			if ( !Page.IsPostBack)
            			{
            				//All of the properties below can be set up at design time					
            				//Set the script path.
            				BubbleHelp1.ScriptPath = "script/";	
            			
            				//Specify the help id - required
            				BubbleHelp1.HelpID = "Help1";
            				BubbleHelp1.Title = "Test Help Title";
            				BubbleHelp1.Content = "Some content to test Bubble Help";
            			
            			}	
            						
            		}			
            		
            	}
            }	
            

Requirements

Namespace: ZsoftNet.Web.UI.BubbleHelp

Assembly: ZsoftNet.Web.UI.BubbleHelp.1.0 (in ZsoftNet.Web.UI.BubbleHelp.1.0.dll)

See Also

BubbleHelp Members | ZsoftNet.Web.UI.BubbleHelp Namespace

---