ExportWizard Documentation
|
Version 1.0 - November 22,
2004 |
Introduction
|
ExportWizard Web control
is a step wizard for database exports. In a few
simple steps, users can choose a SQL Server database object
(table, view, or query) and export its data in any
of the standard formats (XML, CSV, TXT, or HTML)
or generate the SQL script with "INSERT"
statements. |
Properties
Property |
Description |
DesignStep
(Design Time only) |
Enables you to get a WYSIWYG display
of any step during design time. |
DHTMLenabled
|
Determines if user can show and hide
options. |
HeaderStep1 HeaderStep2 HeaderStep3 HeaderStep4 |
Introductory text for each step. Suggested
values: HeaderStep1="Please, select the
data source to
export." HeaderStep2="Select columns to
exports." HeaderStep3="Select Output and
format
options." HeaderStep4="Congratulations !
Your export is done." |
SourceObject |
Property used to limit the possible
tables or views from which to export. Comma-separated
list of database objects. Example:
SourceObject="K_Contact,K_vContact,K_Memo" |
SourceColumns |
Comma-separated list of columns to
be selected by default. Example:
SourceColumns="ID,name,title" |
SqlConnection |
Connection string to the database,
for
example: "SERVER=(local);DATABASE=kakoo;UID=john;PWD=secret;". |
StepIndex
(ReadOnly) |
Index of the step currently displayed.
- step1_Source
- step2_SourceDetails
- step3_OutputType
- step4_Export
At design time, DesignStep allows users to
view each step. |
StyleFields
StyleFieldTitles
StylePanels StylePanelTitles
StyleButtons |
Determines the style of different visual elements. For each
of these style properties is comprised of:
- BackColor
- BorderColor
- BorderStyle
- BorderWidth
- CssClass
- Font
- ForeColor
- Height
- Width
|
In addition, all the standard properties of a web control apply
(inherited from System.Web.UI.WebControls.WebControl).
Enumerations
ExportWizard provides Enumerations.
Enumeration |
Possible Values |
ewOutputType |
- CSV = 0
- TAB = 1
- XML = 2
- SQL = 3
- HTML = 4
|
ewParameter |
- ObjectType = 0
- ObjectName = 1
- ObjectColumns = 2
- ExportType = 3
- Export = 4
|
ewStep |
- step1_Source = 0
- step2_SourceDetails = 1
- step3_OutputType = 2
- step4_Export = 3
|
Events
ExportWizard provides one event Show.
Event |
Description |
Show |
Triggered on display. Events arguments are the wizard
current Title and StepIndex.
ShowEventArgs : Title As String, StepIndex As
Integer |
Methods
GetExport: Returns the database export as a
String. Example: GetExport("K_Contact",
"Firstname,Lastname,PhoneW,email","HTML")
Parameter |
Description |
Table |
Table or View from which to
export. |
Columns |
List of columns to
export. Possible value: Columns="ID,name"
or Columns="*" |
ExportType |
Format in which to export. Possible values: CSV,
HTML, SQL, TXT, or
XML. |
ExportWizard only provides methods inherited from
System.Web.UI.WebControls.WebControl.
Database Access Requirements
For ExportWizard to display the list of tables and views
available in the database it needs to query the system
tables syscolumns,
sysobjects, and systypes.
Read Only access to these tables is necessary.
ExportWizard specifically is designed for Microsoft SQL
Server.
Embedding the Control into the Page
To embed the control, copy the control dll into the bin directory
of your web application and add two lines of code to your
page. The first line registers the control tag prefix (place
this at the top of the page):
<%@ Register TagPrefix = "kew" Namespace
= "Kakoo.ExportWizard" Assembly =
"Kakoo.ExportWizard" %>
The second line embeds the MiniApp control. Place the
line anywhere within the page:
<kew:ExportWizard id
= "ExportWizard1" runat =
"server" SqlConnection="SERVER=(local);DATABASE=kakoodemo;UID=john;PWD=secret;" HeaderStep1 = "ExportWizard guides you through
the steps to export data to many popular data formats. Select the
data source to export." HeaderStep2 = "Select columns to
exports." HeaderStep3
= "Select Output and format
options." HeaderStep4
= "Congratulations! Your export is done." > </kew:ExportWizard >
With VisualStudio.Net, you can use drag & drop to embed the
control into your page.
This option requires you to add the control to the
Toolbox. To add a control to the Toolbox:
 |
- Open an .ASPX page in Design view, and make the Web
Forms tab active in the Toolbox.
- Right-Click the Toolbox, click Add/Remove Items...
- In the Customize Toolbox dialog box click the Browse
button on the lower right below the components list.
- Navigate to the directory that contains the assembly
into which your controls are, and click the name of that
assembly (for example, C:\Kakoo\KolorPicker.dll).
- Click OK to close the dialog box. The control now
appears in the Toolbox under the Web Forms
tab.
|
Installation and Licensing
Copy the Kakoo.ExportWizard.DLL file to the bin directory of your
web site or web application. No other files are needed.
To convert an evaluation copy into a full-use
license, create a text file in the same directory as the
assembly DLL called Kakoo.ExportWizard.LIC. Place the license key,
which you will receive by email upon purchase, in this text file and
save it.
Browser Compatibility
ExportWizard has been successfully tested on the following
Microsoft Windows browsers:
- Internet Explorer 6.0
- Netscape Navigator 7.0
It uses very simple HTML and should run on any browser.
|