Upload
others
View
6
Download
0
Embed Size (px)
Citation preview
ComponentOne
QRCode for ASP.NET
Copyright © 1987-2015 GrapeCity, Inc. All rights reserved.
ComponentOne, a division of GrapeCity
201 South Highland Avenue, Third Floor
Pittsburgh, PA 15206 USA
Website: http://www.componentone.com
Sales: [email protected]
Telephone: 1.800.858.2739 or 1.412.681.4343 (Pittsburgh, PA USA Office)
Trademarks
The ComponentOne product name is a trademark and ComponentOne is a registered trademark of GrapeCity, Inc.
All other trademarks used herein are the properties of their respective owners.
Warranty
ComponentOne warrants that the media on which the software is delivered is free from defects in material and
workmanship, assuming normal use, for a period of 90 days from the date of purchase. If a defect occurs during this
time, you may return the defective media to ComponentOne, along with a dated proof of purchase, and
ComponentOne will replace it at no charge. After 90 days, you can obtain a replacement for the defective media by
sending it and a check for $25 (to cover postage and handling) to ComponentOne.
Except for the express warranty of the original media on which the software is delivered is set forth here,
ComponentOne makes no other warranties, express or implied. Every attempt has been made to ensure that the
information contained in this manual is correct as of the time it was written. ComponentOne is not responsible for
any errors or omissions. ComponentOne’s liability is limited to the amount you paid for the product. ComponentOne
is not liable for any special, consequential, or other damages for any reason.
Copying and Distribution
While you are welcome to make backup copies of the software for your own use and protection, you are not
permitted to make copies for the use of anyone else. We put a lot of time and effort into creating this product, and
we appreciate your support in seeing that it is used by licensed users only.
ComponentOne QRCode for ASP.NET Webforms
1
Table of Contents Overview ................................................................................................................................. 4
Help with ComponentOne Studio for ASP.NET Webforms .................................................... 4
Anatomy.................................................................................................................................. 5
Quick Start: Add and Generate QRCode ................................................................................... 5
Design-Time Support ............................................................................................................... 7
Features .................................................................................................................................. 8
Size ...................................................................................................................................... 8
Color.................................................................................................................................... 9
Error Correction Level ........................................................................................................ 10
Code Version ..................................................................................................................... 11
Encoding ............................................................................................................................ 13
User Scenarios ....................................................................................................................... 14
Store Form Data in QRCode ............................................................................................... 14
Business Card QRCode ....................................................................................................... 18
Add a Logo......................................................................................................................... 20
Client-Side Reference ............................................................................................................ 22
C1.Web.Wijmo.Controls.4 Assembly ...................................................................................... 24
Namespaces ...................................................................................................................... 24
C1.Web.Wijmo.Controls Namespace .............................................................................. 24
Overview ................................................................................................................... 24
Classes ....................................................................................................................... 25
C1BaseStateManager ............................................................................................. 25
Overview ............................................................................................................ 25
Members............................................................................................................ 26
C1TargetControlBase.............................................................................................. 26
Overview ............................................................................................................ 27
Members............................................................................................................ 28
Methods............................................................................................................. 33
GetPropertyValue<V> Method........................................................................ 34
GetScriptDescriptors Method ......................................................................... 35
GetScriptReferences Method .......................................................................... 36
RegisterDesignTimeStyleSheet Method .......................................................... 36
ComponentOne QRCode for ASP.NET Webforms
2
SetPropertyValue<V> Method ........................................................................ 37
Properties .......................................................................................................... 38
CDNDependencyPaths Property...................................................................... 41
CDNPath Property .......................................................................................... 42
DisplayVisible Property ................................................................................... 43
EnableCombinedJavaScripts Property ............................................................. 44
Enabled Property ............................................................................................ 45
Theme Property .............................................................................................. 45
ThemeSwatch Property .................................................................................. 46
UseCDN Property ............................................................................................ 47
WijmoControlMode Property ......................................................................... 48
WijmoCssAdapter Property............................................................................. 49
C1TargetControlHelper........................................................................................... 50
Overview ............................................................................................................ 51
Members............................................................................................................ 51
C1TargetControlHelper Constructor ................................................................... 52
Methods............................................................................................................. 52
ResolveEmbeddedResourceUrl Method .......................................................... 53
C1TargetControlHelper<T> ..................................................................................... 53
Overview ............................................................................................................ 54
Members............................................................................................................ 55
C1TargetControlHelper<T> Constructor .............................................................. 56
Methods............................................................................................................. 57
EnsureEnabledState Method .......................................................................... 58
GetScriptDescriptors Method ......................................................................... 58
GetScriptDescriptors() Method ................................................................... 59
GetScriptDescriptors(String) Method .......................................................... 59
RegisterDesignTimeStyleSheet Method .......................................................... 60
RegisterDesignTimeStyleSheets Method ......................................................... 61
RegisterIncludes Method ................................................................................ 62
RegisterOnSubmitStatement Method ............................................................. 62
RegisterRunTimeStylesheets Method ............................................................. 62
RegisterScriptDescriptors Method .................................................................. 63
RegisterScriptDescriptorsWithoutScriptManager Method............................... 63
ComponentOne QRCode for ASP.NET Webforms
3
RegisterScriptDescriptorsWithScriptManager Method .................................... 64
RenderJsonDataField Method ......................................................................... 64
ShowAbout Method ....................................................................................... 65
Properties .......................................................................................................... 65
Control Property ............................................................................................. 66
JsonSerializableHelper Property ...................................................................... 66
Page Property ................................................................................................. 66
ScriptManager Property.................................................................................. 67
C1.Web.Wijmo.Controls.C1QRCode Namespace ............................................................ 67
Overview ................................................................................................................... 67
Classes ....................................................................................................................... 68
C1QRCode .............................................................................................................. 68
Overview ............................................................................................................ 69
Members............................................................................................................ 70
C1QRCode Constructor ....................................................................................... 76
Methods............................................................................................................. 76
GetScriptDescriptors Method ......................................................................... 78
Properties .......................................................................................................... 79
AutoSize Property ........................................................................................... 82
BackColor Property ......................................................................................... 83
CodeVersion Property ..................................................................................... 84
Encoding Property .......................................................................................... 84
EncodingException Property ........................................................................... 85
ErrorCorrectionLevel Property ........................................................................ 86
ForeColor Property ......................................................................................... 87
Height Property .............................................................................................. 88
Image Property ............................................................................................... 88
ImageUrl Property .......................................................................................... 89
SymbolSize Property ....................................................................................... 89
Text Property .................................................................................................. 90
Width Property ............................................................................................... 91
Enumerations............................................................................................................. 91
Encoding ................................................................................................................ 91
ErrorCorrectionLevel .............................................................................................. 92
ComponentOne QRCode for ASP.NET Webforms
4
Overview ComponentOne QRCode for ASP.NET Webforms allows you to store information about the
item it is associated with. A QRCode (or Quick Response Code) is a two dimensional barcode
that comprises black square dots organized on a white background, in a square grid. It is a
machine readable code that can be read by any imaging device such as a camera or a
smartphone. Unlike barcodes, QRCodes store data in both, horizontal and vertical direction and
therefore, can store upto hundred times more information than the conventional barcodes in
the same amount of space.
QRCode codes are widely used in product packaging or labels to track shipping and other
details; on billboards, newspapers, magazines and websites for branding purposes or redirect
users to other websites.
Key Features
Size: Change the size and resolution of the QRCode as required. See Size for more
information.
Color: Modify the color and create customized QRCodes for your brand. See Color for
more information.
Error Correction: Set upto 30% error correction levels, allowing the data to be
recovered even if the code is damaged. See Error Correction Level for more information.
Encoding: Choose from four encoding options, namely Automatic, Numeric,
Alphanumeric and Byte. See Encoding for more information.
Help with ComponentOne Studio for
ASP.NET Webforms For information on installing ComponentOne Studio for ASP.NET Webforms, licensing,
technical support, namespaces and creating a project with the control, please visit Getting
Started with Studio for ASP.NET Webforms.
ComponentOne QRCode for ASP.NET Webforms
5
What's New
For a list of the latest features added to ComponentOne Studio for ASP.NET Webforms, visit
What's New in Studio for ASP.NET Webforms.
Anatomy The following illustration shows the various elements of a QRCode.
Position Markers: Helps in identifying the boundaries of a QRCode.
Format Information: Stores information like the error correction level and masking
information that help in recovering lost or missing data.
Alignment Markers: Allows scanning the code from different angles.
Timing Code: Helps in determining the size of the code.
Version Information: Helps the code reader in determining what type of code it is
reading.
Dead Space: Separates the data from its surroundings.
Data: Stores the information about the item that the QRCode is associated with.
Quick Start: Add and Generate
QRCode This topic describes how to use C1QRCode control in an ASP.NET application and configure it.
Step 1 of 2: Create an Application
ComponentOne QRCode for ASP.NET Webforms
6
Complete the following steps to create an ASP.Net application and add a QRCode control to
your Web Form.
1. In Visual Studio, create a new ASP.Net Web Application and add a new Web Form.
2. Locate the C1QRCode control in the toolbox and place it onto the Web Form.
If you cannot locate the control in the toolbox, right click and select Choose items. The
Choose Toolbox Items dialog appears. Locate the control and click OK.
Step 2 of 2: Generate the QRCode
Complete the following steps to generate the QRCode:
In the Designer
1. Click the Smart Tag. The C1QRCode Tasks Menu appears.
2. Add the text that you want to encode into the QRCode to the Text property.
3. Run the application. The QRCode will be generated.
In Source View
Set the Text property within the <wijmo:C1QRCode> tag to generate the QRCode.
Source View Copy Code
<wijmo:C1QRCode ID="C1QRCode1" runat="server" Text="ComponentOne QRCode for
ASP.NET Webforms" />
In Code
Add the following code to the Page_Load event to add text and generate the QRCode.
C# Copy Code
C1QRCode1.Text = "ComponentOne QRCode for ASP.Net Wijmo";
VB Copy Code
C1QRCode1.Text = "ComponentOne QRCode for ASP.Net Wijmo"
What You've Accomplished
ComponentOne QRCode for ASP.NET Webforms
7
When you run your application, the text that you added to the Text property is encoded into
the QRCode.
When you scan this QRCode using any QRCode reader on a smartphone or any other device, it
decodes the text "ComponentOne QRCode for ASP.NET Webforms".
Design-Time Support QRCode provides customized context menus and smart tags that offer rich design-time support
and simplifies working with the object model.
This section describes how to use QRCode's design-time environment to configure
the C1QRCode control.
C1QRCode Tasks Menu
Text: Add the text that you want to encode into the QRCode.
Encoding: Select from four encoding options: Automatic, Numeric (10 bits per 3 digits),
Alphanumeric (11 bits per 2 characters) and Byte (8 bits per character).
SymbolSize: Increase or decrease the symbol size, depending upon the size of the QRCode, for
a better resolution.
CodeVersion: Select the code version form 0-9.
ErrorCorrectionLevel: Select from four options:
Low L: Allows an error margin of 7%.
Medium M: Allows an error margin of 15%.
Quartile Q: Allows an error margin of 25%.
High H: Allows an error margin of 30%.
ComponentOne QRCode for ASP.NET Webforms
8
About: Display the About Studio for ASP.NET Webforms dialog box, which is helpful in
finding the version number of ComponentOne Studio for ASP.NET Webforms and online
resources.
Features
Size A QRCode must be big enough to be scanned easily and small enough to fit into a page
without occupying much space. You can resize the control, as well as the symbols within the
control to improve the resolution of the control. Complete the following steps to change the
size of the control, as well as the symbols.
A QRCode must be square in shape in order to be scanned properly.
In the Designer
1. Resize the QRCode by clicking the edges of the QRCode and drag it till it reaches the
desired height or width.
2. Resize the symbols by clicking the Smart Tag. In the C1QRCode Tasks Menu, set the
SymbolSize property as per your requirement.
3. Alternatively, right click the QRCode and select Properties to open the Properties
window. Set the Height, Width and SymbolSize properties in the Properties window.
In Source View
Set the Height, Width and SymbolSize properties within the <wijmo:C1QRCode> tag to resize
the QRCode.
Source View Copy Code
<wijmo:C1QRCode ID="C1QRCode1" runat="server" Height="150px"
Text="ComponentOne QRCode for ASP.NET Webforms" Width="150px" SymbolSize="5"
/>
In Code
Add the following code to the Page_Load event to set the Height, Width and SymbolSize
properties in code view.
C# Copy Code
C1QRCode1.Height = 150;
ComponentOne QRCode for ASP.NET Webforms
9
C1QRCode1.Width = 150;
C1QRCode1.SymbolSize = 5;
VB Copy Code
C1QRCode1.Height = 150
C1QRCode1.Width = 150
C1QRCode1.SymbolSize = 5
What You've Accomplished
When you run your application, notice that the size of the QRCode as well as its symbols is now
bigger.
Color Conventionally, QRCodes are black and white, but you can add color to the control without
distorting the scanning ability of the QRCode. This is the easiest way to customize the QRCode
and add branding to it. Along with color, you may also add a logo or other images on the
QRCode to customize it further. See Add a Logo for more information.
A QRCode with a dark background and light symbols is not recommended, as it may not be
scanned properly.
In the Designer
1. Right click the QRCode and select Properties. The Properties window opens.
2. Set the BackColor and ForeColor properties in the Properties window.
In Source View
Set the BackColor and ForeColor properties within the <wijmo:C1QRCode> tag to add color to
the QRCode.
ComponentOne QRCode for ASP.NET Webforms
10
Source View Copy Code
<wijmo:C1QRCode ID="C1QRCode1" runat="server" BackColor="#FFFFCC"
ForeColor="#6600CC" Text="ComponentOne QRCode for ASP.NET Webforms" />
In Code
Add the following code to the Page_Load event to set the BackColor and ForeColor properties
in code view.
C# Copy Code
C1QRCode1.BackColor = System.Drawing.ColorTranslator.FromHtml("#FFFFCC");
C1QRCode1.ForeColor = System.Drawing.ColorTranslator.FromHtml("#6600CC");
VB Copy Code
C1QRCode1.BackColor = System.Drawing.ColorTranslator.FromHtml("#FFFFCC")
C1QRCode1.ForeColor = System.Drawing.ColorTranslator.FromHtml("#6600CC")
What You've Accomplished
When you run your application, notice that the QRCode appears colored.
Error Correction Level This helps in recovering information from the QRCode even when some data is missing or the
QRCode is damaged. This feature is useful in creating customized QRCodes as you can add
images or logos on the QRCode, which may damage the code, but it can still be scanned easily.
The QRCode control has four error correction levels.
Low L: Allows an error margin of 7%.
Medium M: Allows an error margin of 15%.
Quartile Q: Allows an error margin of 25%.
High H: Allows an error margin of 30%.
Complete the following steps to change the error correction level of the QRCode control.
ComponentOne QRCode for ASP.NET Webforms
11
In the Designer
1. Click the Smart Tag. The C1QRCode Tasks Menu appears.
2. Select the error correction level from the ErrorCorrectionLevel combobox, as per your
requirement.
3. Alternatively, right click the QRCode and select Properties to open the Properties
window. Set the ErrorCorrectionLevel property in the Properties window.
In Source View
Set the ErrorCorrectionLevel property within the <wijmo:C1QRCode> tag to change the error
correction level of the QRCode.
Source View Copy Code
<wijmo:C1QRCode ID="C1QRCode1" runat="server" ErrorCorrectionLevel="H" />
In Code
Add the following code to the Page_Load event to set the ErrorCorrectionLevel property in
code view.
C# Copy Code
C1QRCode1.ErrorCorrectionLevel =
C1.Web.Wijmo.Controls.C1QRCode.ErrorCorrectionLevel.H;
VB Copy Code
C1QRCode1.ErrorCorrectionLevel =
C1.Web.Wijmo.Controls.C1QRCode.ErrorCorrectionLevel.H
What You've Accomplished
The error correction level has been set to H (High) allowing an error margin of 30%.
Code Version The QRCode control has 11 code versions, from 0 to 10. Each code version has a different
configuration of the black and white square dots, that the QRCode is composed of.
Configuration means the number of black and white dots present in a symbol. The arrangement
of the black and white dots is referred to as a module. Starting with version 0 that consists of 21
modules along its height and width, every higher version contains 4 more modules per side.
ComponentOne QRCode for ASP.NET Webforms
12
With a rise in the amount of information to be encoded into the QRCode, higher number of
modules are needed in the QRCode, resulting in bigger QRCode symbols. Complete the
following steps to change the code version of the QRCode control.
In the Designer
1. Click the Smart Tag. The C1QRCode Tasks Menu appears.
2. Set the CodeVersion property, as per your requirement.
3. Alternatively, right click the QRCode and select Properties to open the Properties
window. Set the CodeVersion property in the Properties window.
In Source View
Set the CodeVersion property within the <wijmo:C1QRCode> tag to change the code
version of the QRCode.
Source View Copy Code
<wijmo:C1QRCode ID="C1QRCode1" runat="server" CodeVersion="8"
Text="ComponentOne QRCode for ASP.NET Webforms" />
In Code
Add the following code to the Page_Load event to set the CodeVersion property in code view.
C# Copy Code
C1QRCode1.CodeVersion = 8;
VB Copy Code
C1QRCode1.CodeVersion = 8
What You've Accomplished
The code version of the QRCode has been changed to 8, adding more modules to the QRCode.
ComponentOne QRCode for ASP.NET Webforms
13
Encoding QRCode consists of four encoding modes to store data more efficiently:
Numeric: Can encode digits 0 - 9.
AlphaNumeric: Can encode digits 0 - 9, upper case letters A - Z and some other
characters like space $ % * + - . / : ),.
Byte: By default, can encode ISO/IEC 8859-1. It may also encode some other sets that
have been defined.
Automatic: Sets the encoding mode depending on the text added to the control.
The alphanumeric mode compresses a message more than the byte mode, but it is unable
to store lower case alphabets and can store only a few punctuation marks.
Complete the following steps to change the encoding mode of the QRCode control.
In the Designer
1. Click the Smart Tag. The C1QRCode Tasks Menu appears.
2. Select the encoding mode from the Encoding combobox, as per your requirement.
3. Alternatively, right click the QRCode and select Properties to open the Properties
window. Set the Encoding property in the Properties window.
In Source View
Set the Encoding property within the <wijmo:C1QRCode> tag to change the encoding mode
of the QRCode.
Source View Copy Code
<wijmo:C1QRCode ID="C1QRCode1" runat="server" Encoding="Byte"
Text="ComponentOne QRCode
for ASP.NET Webforms" />
In Code
Add the following code to the Page_Load event to set the Encoding property in code view.
ComponentOne QRCode for ASP.NET Webforms
14
C# Copy Code
C1QRCode1.Encoding = C1.Web.Wijmo.Controls.C1QRCode.Encoding.Byte;
VB Copy Code
C1QRCode1.Encoding = C1.Web.Wijmo.Controls.C1QRCode.Encoding.Byte
What You've Accomplished
The encoding mode has been changed to Byte, so characters including lower case letters, digits
as well as punctuations can be encoded into the QRCode.
User Scenarios QRCodes can be used for many purposes, such as:
To redirect users to a website,
To make phone calls or send emails without having to type the entire contact number
or email ID,
To fetch coupons and special offers,
To get directions,
To listen to songs or watch videos,
To connect to WIFI networks,
To store feedback forms or other forms,
To promote brands, etc.
The following topics demonstrate some of the many possible uses of QRCodes. The
following topics assume that you are familiar with programming in Visual Studio .NET.
See Also
Store Form Data in QRCode
Business Card QRCode
Add a Logo
Store Form Data in QRCode A QRCode can be used to store data entered by a user in any form. By doing so the information
can be retrieved by simply scanning the QRCode and not having to enter it every time. This
topic demonstrates how to create an application to store information added to a form in a
QRCode.
ComponentOne QRCode for ASP.NET Webforms
15
In Visual Studio, create a new ASP.Net Web Application and add a new Web Form. Then,
complete the following steps:
In the Designer
1. Place three labels, two text boxes, a combobox and a button onto the Web Form and
set their properties, as shown below:
Control Name Property Value
Label1 Text Name:
Label2 Text Phone:
Label3 Text Gender:
ComboboxItem1 Text, Value Male
ComboboxItem1 Text, Value Female
Button1 ID, Text Submit
2. The form will appear as shown in the image below:
3. 4. Locate the C1QRCode control in the toolbox and place it onto the Web Form.
If you cannot locate the control in the toolbox, right click and select Choose items. The
Choose Toolbox Items dialog appears. Locate the control and click OK.
5. Open the Properties window and set the DisplayVisible property to false, so that the
control is not visible until the submit button is clicked.
In Source View
ComponentOne QRCode for ASP.NET Webforms
16
Following will be your code for the form, in the Source View, after you have added all controls
and set all the properties:
Source View Copy Code
<p>
<asp:Label ID="Label1" runat="server" Text="Name:"></asp:Label>
<asp:TextBox ID="TextBox1" runat="server"></asp:TextBox>
</p>
<p>
<asp:Label ID="Label2" runat="server" Text="Phone:"></asp:Label>
<asp:TextBox ID="TextBox2" runat="server"></asp:TextBox>
</p>
<p>
<asp:Label ID="Label3" runat="server" Text="Gender:"></asp:Label>
<wijmo:C1ComboBox ID="C1ComboBox1" runat="server" Width="160px">
<Items>
<wijmo:C1ComboBoxItem ID="C1ComboBoxItem1" runat="server"
Text="Male" Value="Male" />
<wijmo:C1ComboBoxItem ID="C1ComboBoxItem2" runat="server"
Text="Female" Value="Female" />
</Items>
</wijmo:C1ComboBox>
</p>
<p>
<asp:Button ID="Submit" runat="server" Text="Submit" /><br/>
<wijmo:C1QRCode ID="C1QRCode1" runat="server"
DisplayVisible="false" />
</p>
In Code
Add the following code to the Submit button's click event to generate the QRCode when the
user fills in the information and clicks the Submit button.
C# Copy Code
protected void Submit_Click(object sender, EventArgs e)
{
C1QRCode1.Text = Label1.Text + " " + TextBox1.Text + '\n' + Label2.Text +
" " + TextBox2.Text + '\n' + Label3.Text + " " +
C1ComboBox1.SelectedValue;
ComponentOne QRCode for ASP.NET Webforms
17
C1QRCode1.DisplayVisible = true;
}
VB Copy Code
Protected Sub Submit_Click(sender As Object, e As EventArgs) Handles
Submit.Click
C1QRCode1.Text = Label1.Text + " " + TextBox1.Text + ControlChars.Lf +
Label2.Text +
" " + TextBox2.Text + ControlChars.Lf + Label3.Text + " " +
C1ComboBox1.SelectedValue
C1QRCode1.DisplayVisible = True
End Sub
What You've Accomplished
When you run the project, fill in the details into the form and click the Submit button. A
QRCode containing the details is generated, as shown below:
When you scan the above QRCode, the reader will decode the following data:
Name: Smith Anderson
Phone: 1.800.858.2739
Gender: Male
ComponentOne QRCode for ASP.NET Webforms
18
Business Card QRCode One use of the QRCode can be to store information for a business card. This eliminates the
need for application users to type or save the contact details manually. They can retrieve the
details by simply scanning the code with their smartphone.
In Visual Studio, create a new ASP.Net Web Application and add a new Web Form. Then,
complete the following steps:
In the Designer
1. Place six labels onto the Web Form and set their properties, as shown below:
Control Name Property Value
Label1 Text Smith Anderson
Label2 Text ComponentOne
Label3 Text Address: 203 New York Ave,
New York, USA
Label4 Text Ph: 1.800.858.2739
Label5 Text Fax: 1.800.858.2739
Label6 Text Email:
2. The form similar to the one shown below appears:
3. 4. Locate the C1QRCode control in the toolbox and place it onto the Web Form.
If you cannot locate the control in the toolbox, right click and select Choose items. The
Choose Toolbox Items dialog appears. Locate the control and click OK.
ComponentOne QRCode for ASP.NET Webforms
19
In Source View
Following is the code for the form in the Source View after you have added all the controls and
set the properties:
Source View Copy Code
<b> <asp:Label ID="Label1" runat="server" Text="Smith
Anderson"></asp:Label></b>
<p>
<asp:Label ID="Label2" runat="server" Text="ComponentOne"></asp:Label><br
/>
<asp:Label ID="Label3" runat="server" Text="Address: 203 New York Ave,
New York, USA"></asp:Label><br />
<asp:Label ID="Label4" runat="server" Text=" Ph:
1.800.858.2739"></asp:Label><br />
<asp:Label ID="Label5" runat="server" Text=" Fax:
1.800.858.2739"></asp:Label><br />
<asp:Label ID="Label6" runat="server" Text="Email:
[email protected]"></asp:Label><br />
</p>
<wijmo:C1QRCode ID="C1QRCode1" runat="server" />
In Code
Add the following code to the Page_Load event to generate the QRCode for the labels added
to the form.
C# Copy Code
C1QRCode1.Text = Label1.Text + '\n' + Label2.Text + '\n' + Label3.Text
+ '\n' + Label4.Text + '\n' + Label5.Text + '\n' + Label6.Text;
VB Copy Code
C1QRCode1.Text = Label1.Text + ControlChars.Lf + Label2.Text +
ControlChars.Lf +
Label3.Text + ControlChars.Lf + Label4.Text + ControlChars.Lf +
Label5.Text +
ControlChars.Lf + Label6.Text
ComponentOne QRCode for ASP.NET Webforms
20
What You've Accomplished
When you run the project a QRCode containing the details of the business card is generated, as
shown below:
When you scan the above QRCode, the reader decodes the following information:
Smith Anderson
ComponentOne
Address: 203 New York Ave, New York, USA
Ph: 1.800.858.2739
Fax: 1.800.858.2739
Email: [email protected]
Add a Logo The QRCode allows you an error margin of 30% when the error correction level is set to H
(High). This lets you customize your QRCode by adding images over it without distorting the
scanning ability of the QRCode. It is however advisable not to add an image bigger than 1/3rd
the size of the QRCode.
In Visual Studio, create a new ASP.Net Web Application and add a new Web Form. Then,
complete the following steps to add a logo to the QRCode.
In the Designer
1. Locate the C1QRCode and C1BinaryImage controls in the toolbox and place it onto
the Web Form.
If you cannot locate the controls in the toolbox, right click and select Choose items. The
Choose Toolbox Items dialog appears. Locate the control and click OK.
ComponentOne QRCode for ASP.NET Webforms
21
2. Add the ImageURL to the BinaryImage control to add an image to the control.
3. Set the controls' properties as shown in the table below:
Control Name Property Value
C1QRCode1 Text ComponentOne QRCode
for ASP.NET Webforms
C1QRCode1 ErrorCorrectionLevel H
C1QRCode1 ForeColor #CC0000
C1QRCode1 Height, Width 150px
C1BinaryImage1 Height 85px
C1BinaryImage1 Width 100px
In Source View
1. Following will be your code for the form, in the Source View, after you have added both
controls and set all the properties:
Source View Copy Code
<wijmo:C1QRCode id="C1QRCode1" runat="server" Text="ComponentOne QRCode for
ASP.NET Webforms" Height="150px" Width="150px" ErrorCorrectionLevel="H"
ForeColor="#CC0000" />
<cc1:C1BinaryImage id="C1BinaryImage1" runat="server" Height="85px"
ImageUrl="~/C1.png" Width="100px" />
2. Add the following code within the <head></head> tags to create CSS classes for the
QRCode and the BinaryImage to make the image overlap the QRCode.
Source View Copy Code
<style type="text/css">
.qrcodeA1 { position:absolute; top: -1px; left: 4px; z-index: 1; }
.imgB1 { position:absolute; top: 35px; left: 25px; z-index: 3; right:
759px; }
ComponentOne QRCode for ASP.NET Webforms
22
</style>
3. Set the CssClass property for both the controls, within their respective tags, as shown
below:
Source View Copy Code
<wijmo:C1QRCode id="C1QRCode1" CssClass="qrcodeA1" runat="server"
Text="ComponentOne QRCode for ASP.NET Webforms" Height="150px" Width="150px"
ErrorCorrectionLevel="H" ForeColor="#CC0000" />
<cc1:C1BinaryImage id="C1BinaryImage1" CssClass="imgB1" runat="server"
Height="85px" ImageUrl="~/C1.png" Width="100px" />
What You've Accomplished
When you run the project, a customized QRCode is generated, with a logo added over it, as
shown in the image below:
Client-Side Reference As part of the amazing ComponentOne Web stack, the Wijmo jQuery UI widgets are optimized
for client-side Web development and utilize the power of jQuery for superior performance and
ease of use.
The ComponentOne Wijmo website at http://wijmo.com/widgets/ provides everything you need
to know about Wijmo widgets, including demos and samples, documentation, theming
examples, support and more.
The client-side documentation provides an overview, sample markup, options, events, and
methods for each widget. To get started with client-side Web development for QRCode for
ASP.NET Webforms, click one of the external links to view our Wijmo wiki documentation.
Note that the Overview topic for each of the widgets applies mainly to the widget, not to the
server-side ASP.NET Webforms control.
ComponentOne QRCode for ASP.NET Webforms
23
Using the Wijmo CDN
You can easily load the client-side Wijmo widgets into your web page using a Content Delivery
Network (CDN). CDN makes it quick and easy to use external libraries, and deploy them to your
users. A CDN is a network of computers around the world that host content. Ideally, if you're in
the United States and you access a webpage using a CDN, you'll get your content from a server
based in the US. If you're in India or China, and you access the SAME webpage, the content will
come from a server a little closer to your location.
When web browsers load content, they commonly will check to see if they already have a copy
of the file cached. By using a CDN, you can benefit from this. If a user had previously visited a
site using the same CDN, they will already have a cached version of the files on their machine.
Your page will load quicker since it doesn't need to re-download your support content.
Wijmo has had CDN support from the very beginning. You can find the CDN page at
http://wijmo.com/downloads/cdn/. The markup required for loading Wijmo into your page
looks similar to this:
<!--jQuery References--> <script src="http://ajax.aspnetcdn.com/ajax/jquery/jquery-1.7.1.min.js" type="text/javascript"></script> <script src="http://ajax.aspnetcdn.com/ajax/jquery.ui/1.8.17/jquery-ui.min.js" type="text/javascript"></script> <!--Theme--> <link href="http://cdn.wijmo.com/themes/rocket/jquery-wijmo.css" rel="stylesheet" type="text/css" title="rocket-jqueryui" /> <!--Wijmo Widgets CSS--> <link href="http://cdn.wijmo.com/jquery.wijmo-complete.all.2.0.0.min.css" rel="stylesheet" type="text/css" /> <!--Wijmo Widgets JavaScript--> <script src="http://cdn.wijmo.com/jquery.wijmo-open.all.2.0.0.min.js" type="text/javascript"></script> <script src="http://cdn.wijmo.com/jquery.wijmo-complete.all.2.0.0.min.js" type="text/javascript"></script>
In this markup, you'll notice that some of the .js files are labeled as *.min.js. These files have
been minified - in other words, all unnecessary characters have been removed - to make the
pages load faster. You will also notice that there are no references to individual .js files. The
JavaScript for all widgets, CSS, and jQuery references have been combined into one file,
respectively, such as wijmo-complete.2.0.0.min.js. If you want to link to individual .js files, see
the Dependencies topic for each widget.
With the ComponentOne Studio for ASP.NET Webforms controls, you can click the Use CDN
checkbox in the control's Tasks menu and specify the CDN path if you want to access the
client-side widgets.
ComponentOne QRCode for ASP.NET Webforms
24
C1.Web.Wijmo.Controls.4 Assembly
Namespaces
C1.Web.Wijmo.Controls Namespace
Overview Inheritance Hierarchy
Classes
Class Description
C1BaseStateManager Base class to support view state management for a server
control.
C1TargetControlBase Class to be used as base for the wijmo extenders target
controls. Class to be used as base for the wijmo target
controls.
C1TargetControlHelper
C1TargetControlHelper<T>
ComponentOne QRCode for ASP.NET Webforms
25
See Also
Reference
C1.Web.Wijmo.Controls.4 Assembly
Classes
C1BaseStateManager Base class to support view state management for a server control.
Object Model
Syntax
Visual Basic (Declaration)
Public MustInherit Class C1BaseStateManager
C#
public abstract class C1BaseStateManager
Inheritance Hierarchy
System.Object
C1.Web.Wijmo.Controls.C1BaseStateManager
See Also
Reference
C1BaseStateManager Members
C1.Web.Wijmo.Controls Namespace
Overview Base class to support view state management for a server control.
Object Model
ComponentOne QRCode for ASP.NET Webforms
26
Syntax
Visual Basic (Declaration)
Public MustInherit Class C1BaseStateManager
C#
public abstract class C1BaseStateManager
Inheritance Hierarchy
System.Object
C1.Web.Wijmo.Controls.C1BaseStateManager
See Also
Reference
C1BaseStateManager Members
C1.Web.Wijmo.Controls Namespace
Members The following tables list the members exposed by C1BaseStateManager.
See Also
Reference
C1BaseStateManager Class
C1.Web.Wijmo.Controls Namespace
C1TargetControlBase Class to be used as base for the wijmo extenders target controls. Class to be used as base for
the wijmo target controls.
Object Model
Syntax
Visual Basic (Declaration)
<WidgetDependenciesAttribute(System.Object[])>
ComponentOne QRCode for ASP.NET Webforms
27
Public MustInherit Class C1TargetControlBase
Inherits System.Web.UI.WebControls.WebControl
C#
[WidgetDependencies(System.Object[])]
public abstract class C1TargetControlBase :
System.Web.UI.WebControls.WebControl
Inheritance Hierarchy
System.Object
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
C1.Web.Wijmo.Controls.C1TargetControlBase
C1.Web.Wijmo.Controls.C1QRCode.C1QRCode
See Also
Reference
C1TargetControlBase Members
C1.Web.Wijmo.Controls Namespace
Overview Class to be used as base for the wijmo extenders target controls. Class to be used as base for
the wijmo target controls.
Object Model
Syntax
Visual Basic (Declaration)
<WidgetDependenciesAttribute(System.Object[])>
Public MustInherit Class C1TargetControlBase
Inherits System.Web.UI.WebControls.WebControl
C#
[WidgetDependencies(System.Object[])]
public abstract class C1TargetControlBase :
System.Web.UI.WebControls.WebControl
ComponentOne QRCode for ASP.NET Webforms
28
Inheritance Hierarchy
System.Object
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
C1.Web.Wijmo.Controls.C1TargetControlBase
C1.Web.Wijmo.Controls.C1QRCode.C1QRCode
See Also
Reference
C1TargetControlBase Members
C1.Web.Wijmo.Controls Namespace
Members The following tables list the members exposed by C1TargetControlBase.
Public Properties
Name Description
AccessKey (Inherited from
System.Web.UI.WebControls.WebControl)
AppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Attributes (Inherited from
System.Web.UI.WebControls.WebControl)
CDNDependencyPaths A string array value specifies all css/js references that
wijmo control depends on.
CDNPath Content Delivery Network path.
ClientID (Inherited from System.Web.UI.Control)
ClientIDMode (Inherited from System.Web.UI.Control)
Controls (Inherited from System.Web.UI.Control)
ComponentOne QRCode for ASP.NET Webforms
29
ControlStyle (Inherited from
System.Web.UI.WebControls.WebControl)
ControlStyleCreated (Inherited from
System.Web.UI.WebControls.WebControl)
CssClass (Inherited from
System.Web.UI.WebControls.WebControl)
DisplayVisible Gets or sets a value that indicates whether a server
control is rendered as UI on the page.
EnableCombinedJavaScripts Enable JavaScripts files combined into one file. In
order to combined enabled, you must register the
WijmoHttpHandler in web.config.
Enabled Overridden. Gets or sets a value indicating whether
the Web server control is enabled.
EnableTheming (Inherited from
System.Web.UI.WebControls.WebControl)
EnableViewState (Inherited from System.Web.UI.Control)
HasAttributes (Inherited from
System.Web.UI.WebControls.WebControl)
Height (Inherited from
System.Web.UI.WebControls.WebControl)
ID (Inherited from System.Web.UI.Control)
NamingContainer (Inherited from System.Web.UI.Control)
Page (Inherited from System.Web.UI.Control)
Parent (Inherited from System.Web.UI.Control)
ComponentOne QRCode for ASP.NET Webforms
30
RenderingCompatibility (Inherited from System.Web.UI.Control)
Site (Inherited from System.Web.UI.Control)
SkinID (Inherited from
System.Web.UI.WebControls.WebControl)
Style (Inherited from
System.Web.UI.WebControls.WebControl)
SupportsDisabledAttribute (Inherited from
System.Web.UI.WebControls.WebControl)
TabIndex (Inherited from
System.Web.UI.WebControls.WebControl)
TemplateControl (Inherited from System.Web.UI.Control)
TemplateSourceDirectory (Inherited from System.Web.UI.Control)
Theme Name of the theme that will be used to style the
widgets. Available embedded themes include: aristo,
midnight, and ui-lightness. Note that only one theme
can be used for the whole page at one time. Please
make sure that all widget extenders have the same
Theme value.
ThemeSwatch A value that indicates the theme swatch of the
control, this property only works when
WijmoControlMode property is Mobile.
ToolTip (Inherited from
System.Web.UI.WebControls.WebControl)
UniqueID (Inherited from System.Web.UI.Control)
UseCDN Determines whether the widget extender must load
client resources from CDN (Content Delivery
ComponentOne QRCode for ASP.NET Webforms
31
Network) path given by property CDNPath.
ValidateRequestMode (Inherited from System.Web.UI.Control)
ViewStateMode (Inherited from System.Web.UI.Control)
Width (Inherited from
System.Web.UI.WebControls.WebControl)
WijmoControlMode A value that indicates mode of the control, whether it
is a mobile or web control. Note that only one value
can be used for the whole website or project.
WijmoCssAdapter Indicates the control applies the theme of JQuery UI
or Bootstrap.
Top
Public Methods
Name Description
ApplyStyle (Inherited from System.Web.UI.WebControls.WebControl)
ApplyStyleSheetSkin (Inherited from System.Web.UI.Control)
CopyBaseAttributes (Inherited from System.Web.UI.WebControls.WebControl)
DataBind (Inherited from System.Web.UI.Control)
Dispose (Inherited from System.Web.UI.Control)
FindControl (Inherited from System.Web.UI.Control)
Focus (Inherited from System.Web.UI.Control)
GetPropertyValue<V> Gets the property value by property name.
GetRouteUrl Overloaded. (Inherited from System.Web.UI.Control)
ComponentOne QRCode for ASP.NET Webforms
32
GetScriptDescriptors When overridden in a derived class, registers the
WidgetDescriptor objects for the control.
GetScriptReferences When overridden in a derived class, registers an additional
script libraries for the extender control.
GetUniqueIDRelativeTo (Inherited from System.Web.UI.Control)
HasControls (Inherited from System.Web.UI.Control)
MergeStyle (Inherited from System.Web.UI.WebControls.WebControl)
RegisterDesignTimeStyleSheet Register design time stylesheet
RenderBeginTag (Inherited from System.Web.UI.WebControls.WebControl)
RenderControl (Inherited from System.Web.UI.Control)
RenderEndTag (Inherited from System.Web.UI.WebControls.WebControl)
ResolveClientUrl (Inherited from System.Web.UI.Control)
ResolveUrl (Inherited from System.Web.UI.Control)
SetPropertyValue<V> Sets the property value by property name.
SetRenderMethodDelegate (Inherited from System.Web.UI.Control)
Top
Public Events
Name Description
DataBinding (Inherited from System.Web.UI.Control)
Disposed (Inherited from System.Web.UI.Control)
Init (Inherited from System.Web.UI.Control)
ComponentOne QRCode for ASP.NET Webforms
33
Load (Inherited from System.Web.UI.Control)
PreRender (Inherited from System.Web.UI.Control)
Unload (Inherited from System.Web.UI.Control)
Top
See Also
Reference
C1TargetControlBase Class
C1.Web.Wijmo.Controls Namespace
Methods For a list of all members of this type, see C1TargetControlBase members.
Public Methods
Name Description
ApplyStyle (Inherited from System.Web.UI.WebControls.WebControl)
ApplyStyleSheetSkin (Inherited from System.Web.UI.Control)
CopyBaseAttributes (Inherited from System.Web.UI.WebControls.WebControl)
DataBind (Inherited from System.Web.UI.Control)
Dispose (Inherited from System.Web.UI.Control)
FindControl (Inherited from System.Web.UI.Control)
Focus (Inherited from System.Web.UI.Control)
GetPropertyValue<V> Gets the property value by property name.
GetRouteUrl Overloaded. (Inherited from System.Web.UI.Control)
ComponentOne QRCode for ASP.NET Webforms
34
GetScriptDescriptors When overridden in a derived class, registers the
WidgetDescriptor objects for the control.
GetScriptReferences When overridden in a derived class, registers an additional
script libraries for the extender control.
GetUniqueIDRelativeTo (Inherited from System.Web.UI.Control)
HasControls (Inherited from System.Web.UI.Control)
MergeStyle (Inherited from System.Web.UI.WebControls.WebControl)
RegisterDesignTimeStyleSheet Register design time stylesheet
RenderBeginTag (Inherited from System.Web.UI.WebControls.WebControl)
RenderControl (Inherited from System.Web.UI.Control)
RenderEndTag (Inherited from System.Web.UI.WebControls.WebControl)
ResolveClientUrl (Inherited from System.Web.UI.Control)
ResolveUrl (Inherited from System.Web.UI.Control)
SetPropertyValue<V> Sets the property value by property name.
SetRenderMethodDelegate (Inherited from System.Web.UI.Control)
Top
See Also
Reference
C1TargetControlBase Class
C1.Web.Wijmo.Controls Namespace
GetPropertyValue<V> Method Gets the property value by property name.
Syntax
ComponentOne QRCode for ASP.NET Webforms
35
Visual Basic (Declaration)
Public Function GetPropertyValue(Of V)( _
ByVal propertyName As System.String, _
ByVal nullValue As V _
) As V
C#
public V GetPropertyValue<V>(
System.string propertyName,
V nullValue
)
Parameters
propertyName
Name of the property.
nullValue
The null value.
Type Parameters
V
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
GetScriptDescriptors Method When overridden in a derived class, registers the WidgetDescriptor objects for the control.
Syntax
Visual Basic (Declaration)
Public Overridable Function GetScriptDescriptors() As
System.Collections.Generic.IEnumerable(Of ScriptDescriptor)
C#
public virtual System.Collections.Generic.IEnumerable<ScriptDescriptor>
ComponentOne QRCode for ASP.NET Webforms
36
GetScriptDescriptors()
Return Value
An enumeration of WidgetDescriptor objects.
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
GetScriptReferences Method When overridden in a derived class, registers an additional script libraries for the extender
control.
Syntax
Visual Basic (Declaration)
Public Overridable Function GetScriptReferences() As
System.Collections.Generic.IEnumerable(Of ScriptReference)
C#
public virtual System.Collections.Generic.IEnumerable<ScriptReference>
GetScriptReferences()
Return Value
An object that implements the System.Collections.IEnumerable interface and that contains
ECMAScript (JavaScript) files that have been registered as embedded resources.
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
RegisterDesignTimeStyleSheet Method The System.Web.UI.HtmlTextWriter object that receives the server control content.
resource name of stylesheet file
Register design time stylesheet
ComponentOne QRCode for ASP.NET Webforms
37
Syntax
Visual Basic (Declaration)
Public Sub RegisterDesignTimeStyleSheet( _
ByVal writer As System.Web.UI.HtmlTextWriter, _
ByVal cssResourceName As System.String _
)
C#
public void RegisterDesignTimeStyleSheet(
System.Web.UI.HtmlTextWriter writer,
System.string cssResourceName
)
Parameters
writer
The System.Web.UI.HtmlTextWriter object that receives the server control content.
cssResourceName
resource name of stylesheet file
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
SetPropertyValue<V> Method Sets the property value by property name.
Syntax
Visual Basic (Declaration)
Public Sub SetPropertyValue(Of V)( _
ByVal propertyName As System.String, _
ByVal value As V _
)
C#
ComponentOne QRCode for ASP.NET Webforms
38
public void SetPropertyValue<V>(
System.string propertyName,
V value
)
Parameters
propertyName
Name of the property.
value
The value.
Type Parameters
V
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
Properties For a list of all members of this type, see C1TargetControlBase members.
Public Properties
Name Description
AccessKey (Inherited from
System.Web.UI.WebControls.WebControl)
AppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Attributes (Inherited from
System.Web.UI.WebControls.WebControl)
CDNDependencyPaths A string array value specifies all css/js references that
wijmo control depends on.
ComponentOne QRCode for ASP.NET Webforms
39
CDNPath Content Delivery Network path.
ClientID (Inherited from System.Web.UI.Control)
ClientIDMode (Inherited from System.Web.UI.Control)
Controls (Inherited from System.Web.UI.Control)
ControlStyle (Inherited from
System.Web.UI.WebControls.WebControl)
ControlStyleCreated (Inherited from
System.Web.UI.WebControls.WebControl)
CssClass (Inherited from
System.Web.UI.WebControls.WebControl)
DisplayVisible Gets or sets a value that indicates whether a server
control is rendered as UI on the page.
EnableCombinedJavaScripts Enable JavaScripts files combined into one file. In
order to combined enabled, you must register the
WijmoHttpHandler in web.config.
Enabled Overridden. Gets or sets a value indicating whether
the Web server control is enabled.
EnableTheming (Inherited from
System.Web.UI.WebControls.WebControl)
EnableViewState (Inherited from System.Web.UI.Control)
HasAttributes (Inherited from
System.Web.UI.WebControls.WebControl)
Height (Inherited from
System.Web.UI.WebControls.WebControl)
ComponentOne QRCode for ASP.NET Webforms
40
ID (Inherited from System.Web.UI.Control)
NamingContainer (Inherited from System.Web.UI.Control)
Page (Inherited from System.Web.UI.Control)
Parent (Inherited from System.Web.UI.Control)
RenderingCompatibility (Inherited from System.Web.UI.Control)
Site (Inherited from System.Web.UI.Control)
SkinID (Inherited from
System.Web.UI.WebControls.WebControl)
Style (Inherited from
System.Web.UI.WebControls.WebControl)
SupportsDisabledAttribute (Inherited from
System.Web.UI.WebControls.WebControl)
TabIndex (Inherited from
System.Web.UI.WebControls.WebControl)
TemplateControl (Inherited from System.Web.UI.Control)
TemplateSourceDirectory (Inherited from System.Web.UI.Control)
Theme Name of the theme that will be used to style the
widgets. Available embedded themes include: aristo,
midnight, and ui-lightness. Note that only one theme
can be used for the whole page at one time. Please
make sure that all widget extenders have the same
Theme value.
ThemeSwatch A value that indicates the theme swatch of the
control, this property only works when
ComponentOne QRCode for ASP.NET Webforms
41
WijmoControlMode property is Mobile.
ToolTip (Inherited from
System.Web.UI.WebControls.WebControl)
UniqueID (Inherited from System.Web.UI.Control)
UseCDN Determines whether the widget extender must load
client resources from CDN (Content Delivery
Network) path given by property CDNPath.
ValidateRequestMode (Inherited from System.Web.UI.Control)
ViewStateMode (Inherited from System.Web.UI.Control)
Width (Inherited from
System.Web.UI.WebControls.WebControl)
WijmoControlMode A value that indicates mode of the control, whether it
is a mobile or web control. Note that only one value
can be used for the whole website or project.
WijmoCssAdapter Indicates the control applies the theme of JQuery UI
or Bootstrap.
Top
See Also
Reference
C1TargetControlBase Class
C1.Web.Wijmo.Controls Namespace
CDNDependencyPaths Property A string array value specifies all css/js references that wijmo control depends on.
Syntax
Visual Basic (Declaration)
ComponentOne QRCode for ASP.NET Webforms
42
<System.ComponentModel.RefreshPropertiesAttribute(RefreshProperties.All)>
<C1CategoryAttribute("Behavior")>
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1Base.CDNDependencyPaths", Description="A
string array value specifies all css/js references that wijmo control depends
on.")>
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria
lizationVisibility.Hidden)>
Public Overridable Property CDNDependencyPaths As System.String()
C#
[System.ComponentModel.RefreshProperties(RefreshProperties.All)]
[C1Category("Behavior")]
[System.ComponentModel.DefaultValue()]
[C1Description(Key="C1Base.CDNDependencyPaths", Description="A string
array value specifies all css/js references that wijmo control depends
on.")]
[System.ComponentModel.DesignerSerializationVisibility(DesignerSerializat
ionVisibility.Hidden)]
public virtual System.string[] CDNDependencyPaths {get; set;}
Remarks
Using this property, user can specify the CDN dependencies(such as jQuery, jQuery UI, jQuery
mobile, bootstrap). If some dependencies are set in this property, wijmo controls will find
dependencies path in this property. If found, use the path to load dependency, otherwise, use
the default CDN path. For example, if user wants to specify the dependencies of jQuery and
jQuery UI, he can set the value like this: ["http://ajax.aspnetcdn.com/ajax/jQuery/jquery-
1.11.1.min.js", "http://ajax.aspnetcdn.com/ajax/jquery.ui/1.11.1/jquery-ui.js"]
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
CDNPath Property Content Delivery Network path.
Syntax
Visual Basic (Declaration)
ComponentOne QRCode for ASP.NET Webforms
43
<System.ComponentModel.RefreshPropertiesAttribute(RefreshProperties.All)>
<System.ComponentModel.DefaultValueAttribute()>
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria
lizationVisibility.Hidden)>
<C1DescriptionAttribute(Key="C1Base.CDNPath", Description="Content Delivery
Network path.")>
<C1CategoryAttribute("Behavior")>
Public Overridable Property CDNPath As System.String
C#
[System.ComponentModel.RefreshProperties(RefreshProperties.All)]
[System.ComponentModel.DefaultValue()]
[System.ComponentModel.DesignerSerializationVisibility(DesignerSerializat
ionVisibility.Hidden)]
[C1Description(Key="C1Base.CDNPath", Description="Content Delivery
Network path.")]
[C1Category("Behavior")]
public virtual System.string CDNPath {get; set;}
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
DisplayVisible Property Gets or sets a value that indicates whether a server control is rendered as UI on the page.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.DefaultValueAttribute()>
<C1CategoryAttribute("Behavior")>
<WidgetOptionAttribute()>
<LayoutAttribute(LayoutType.Behavior)>
<C1DescriptionAttribute(Key="C1Controls.DisplayVisible", Description="Gets or
sets a value that indicates whether a server control is rendered as UI on the
page.")>
Public Property DisplayVisible As System.Boolean
C#
ComponentOne QRCode for ASP.NET Webforms
44
[System.ComponentModel.DefaultValue()]
[C1Category("Behavior")]
[WidgetOption()]
[Layout(LayoutType.Behavior)]
[C1Description(Key="C1Controls.DisplayVisible", Description="Gets or sets a
value that indicates whether a server control is rendered as UI on the
page.")]
public System.bool DisplayVisible {get; set;}
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
EnableCombinedJavaScripts Property Enable JavaScripts files combined into one file. In order to combined enabled, you must register
the WijmoHttpHandler in web.config.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria
lizationVisibility.Hidden)>
<C1DescriptionAttribute(Key="C1Base.EnableCombinedJavaScripts",
Description="Enable JavaScripts files combined into one file.")>
<C1CategoryAttribute("Behavior")>
<System.ComponentModel.DefaultValueAttribute()>
Public Overridable Property EnableCombinedJavaScripts As System.Boolean
C#
[System.ComponentModel.DesignerSerializationVisibility(DesignerSerializat
ionVisibility.Hidden)]
[C1Description(Key="C1Base.EnableCombinedJavaScripts",
Description="Enable JavaScripts files combined into one file.")]
[C1Category("Behavior")]
[System.ComponentModel.DefaultValue()]
public virtual System.bool EnableCombinedJavaScripts {get; set;}
See Also
Reference
ComponentOne QRCode for ASP.NET Webforms
45
C1TargetControlBase Class
C1TargetControlBase Members
Enabled Property Gets or sets a value indicating whether the Web server control is enabled.
Syntax
Visual Basic (Declaration)
<WidgetOptionAttribute()>
<C1CategoryAttribute("Behavior")>
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1Base.Enabled", Description="Indicates whether
control is enabled.")>
Public Overrides Property Enabled As System.Boolean
C#
[WidgetOption()]
[C1Category("Behavior")]
[System.ComponentModel.DefaultValue()]
[C1Description(Key="C1Base.Enabled", Description="Indicates whether control
is enabled.")]
public override System.bool Enabled {get; set;}
Property Value
true if control is enabled; otherwise, false. The default is true.
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
Theme Property Name of the theme that will be used to style the widgets. Available embedded themes include:
aristo, midnight, and ui-lightness. Note that only one theme can be used for the whole page at
one time. Please make sure that all widget extenders have the same Theme value.
Syntax
Visual Basic (Declaration)
ComponentOne QRCode for ASP.NET Webforms
46
<System.ComponentModel.DefaultValueAttribute()>
<System.ComponentModel.RefreshPropertiesAttribute(RefreshProperties.All)>
<C1CategoryAttribute("Behavior")>
<C1DescriptionAttribute(Key="C1Base.Theme", Description="Name of the theme
that will be used to style widgets. Available themes: aristo / midnight / ui-
lightness. Note, only one theme can be used for the whole page at one time.
Please, make sure that all widget extenders have the same Theme value.")>
<TypeConverterAttribute("C1.Web.Wijmo.Controls.WijmoThemeNameConverter,
C1.Web.Wijmo.Controls.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")>
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria
lizationVisibility.Hidden)>
Public Overridable Property Theme As System.String
C#
[System.ComponentModel.DefaultValue()]
[System.ComponentModel.RefreshProperties(RefreshProperties.All)]
[C1Category("Behavior")]
[C1Description(Key="C1Base.Theme", Description="Name of the theme that
will be used to style widgets. Available themes: aristo / midnight / ui-
lightness. Note, only one theme can be used for the whole page at one
time. Please, make sure that all widget extenders have the same Theme
value.")]
[TypeConverter("C1.Web.Wijmo.Controls.WijmoThemeNameConverter,
C1.Web.Wijmo.Controls.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")]
[System.ComponentModel.DesignerSerializationVisibility(DesignerSerializat
ionVisibility.Hidden)]
public virtual System.string Theme {get; set;}
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
ThemeSwatch Property A value that indicates the theme swatch of the control, this property only works when
WijmoControlMode property is Mobile.
Syntax
ComponentOne QRCode for ASP.NET Webforms
47
Visual Basic (Declaration)
<TypeConverterAttribute("C1.Web.Wijmo.Controls.WijmoThemeSwatchConverter,
C1.Web.Wijmo.Controls.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")>
<C1DescriptionAttribute(Key="C1Base.ThemeSwatch", Description="A value that
indicates the theme swatch of the control, this property only works when
WijmoControlMode property is Mobile.")>
<C1CategoryAttribute("Appearance")>
<System.ComponentModel.DefaultValueAttribute()>
<WidgetOptionAttribute()>
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria
lizationVisibility.Hidden)>
Public Overridable Property ThemeSwatch As System.String
C#
[TypeConverter("C1.Web.Wijmo.Controls.WijmoThemeSwatchConverter,
C1.Web.Wijmo.Controls.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")]
[C1Description(Key="C1Base.ThemeSwatch", Description="A value that
indicates the theme swatch of the control, this property only works when
WijmoControlMode property is Mobile.")]
[C1Category("Appearance")]
[System.ComponentModel.DefaultValue()]
[WidgetOption()]
[System.ComponentModel.DesignerSerializationVisibility(DesignerSerializat
ionVisibility.Hidden)]
public virtual System.string ThemeSwatch {get; set;}
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
UseCDN Property Determines whether the widget extender must load client resources from CDN (Content
Delivery Network) path given by property CDNPath.
Syntax
ComponentOne QRCode for ASP.NET Webforms
48
Visual Basic (Declaration)
<System.ComponentModel.RefreshPropertiesAttribute(RefreshProperties.All)>
<C1CategoryAttribute("Behavior")>
<System.ComponentModel.DefaultValueAttribute()>
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria
lizationVisibility.Hidden)>
<C1DescriptionAttribute(Key="C1Base.UseCDN", Description="Determines whether
this extender loads client script references from CDN.")>
Public Overridable Property UseCDN As System.Boolean
C#
[System.ComponentModel.RefreshProperties(RefreshProperties.All)]
[C1Category("Behavior")]
[System.ComponentModel.DefaultValue()]
[System.ComponentModel.DesignerSerializationVisibility(DesignerSerializat
ionVisibility.Hidden)]
[C1Description(Key="C1Base.UseCDN", Description="Determines whether this
extender loads client script references from CDN.")]
public virtual System.bool UseCDN {get; set;}
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
WijmoControlMode Property A value that indicates mode of the control, whether it is a mobile or web control. Note that only
one value can be used for the whole website or project.
Syntax
Visual Basic (Declaration)
<C1DescriptionAttribute(Key="C1Base.WijmoControlMode", Description="A value
that indicates mode of the control, whether it is a mobile or web control.
Note that only one value can be used for the whole website or project.")>
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria
lizationVisibility.Hidden)>
<System.ComponentModel.RefreshPropertiesAttribute(RefreshProperties.All)>
<C1CategoryAttribute("Behavior")>
ComponentOne QRCode for ASP.NET Webforms
49
<System.ComponentModel.DefaultValueAttribute()>
Public Overridable Property WijmoControlMode As WijmoControlMode
C#
[C1Description(Key="C1Base.WijmoControlMode", Description="A value that
indicates mode of the control, whether it is a mobile or web control.
Note that only one value can be used for the whole website or project.")]
[System.ComponentModel.DesignerSerializationVisibility(DesignerSerializat
ionVisibility.Hidden)]
[System.ComponentModel.RefreshProperties(RefreshProperties.All)]
[C1Category("Behavior")]
[System.ComponentModel.DefaultValue()]
public virtual WijmoControlMode WijmoControlMode {get; set;}
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
WijmoCssAdapter Property Indicates the control applies the theme of JQuery UI or Bootstrap.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria
lizationVisibility.Hidden)>
<C1CategoryAttribute("Behavior")>
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1Base.WijmoCssAdapter", Description="Indicates
the control applies the theme of JQuery UI or Bootstrap.")>
<TypeConverterAttribute("C1.Web.Wijmo.Controls.WijmoCssAdapterConverter,
C1.Web.Wijmo.Controls.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")>
<System.ComponentModel.RefreshPropertiesAttribute(RefreshProperties.All)>
Public Overridable Property WijmoCssAdapter As System.String
C#
[System.ComponentModel.DesignerSerializationVisibility(DesignerSerializat
ionVisibility.Hidden)]
ComponentOne QRCode for ASP.NET Webforms
50
[C1Category("Behavior")]
[System.ComponentModel.DefaultValue()]
[C1Description(Key="C1Base.WijmoCssAdapter", Description="Indicates the
control applies the theme of JQuery UI or Bootstrap.")]
[TypeConverter("C1.Web.Wijmo.Controls.WijmoCssAdapterConverter,
C1.Web.Wijmo.Controls.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")]
[System.ComponentModel.RefreshProperties(RefreshProperties.All)]
public virtual System.string WijmoCssAdapter {get; set;}
See Also
Reference
C1TargetControlBase Class
C1TargetControlBase Members
C1TargetControlHelper
Object Model
Syntax
Visual Basic (Declaration)
Friend Class C1TargetControlHelper
C#
internal class C1TargetControlHelper
Inheritance Hierarchy
System.Object
C1.Web.Wijmo.Controls.C1TargetControlHelper
C1.Web.Wijmo.Controls.C1TargetControlHelper<T>
See Also
Reference
C1TargetControlHelper Members
C1.Web.Wijmo.Controls Namespace
ComponentOne QRCode for ASP.NET Webforms
51
Overview
Object Model
Syntax
Visual Basic (Declaration)
Friend Class C1TargetControlHelper
C#
internal class C1TargetControlHelper
Inheritance Hierarchy
System.Object
C1.Web.Wijmo.Controls.C1TargetControlHelper
C1.Web.Wijmo.Controls.C1TargetControlHelper<T>
See Also
Reference
C1TargetControlHelper Members
C1.Web.Wijmo.Controls Namespace
Members The following tables list the members exposed by C1TargetControlHelper.
Public Constructors
Name Description
C1TargetControlHelper Constructor
Top
Public Methods
Name Description
ComponentOne QRCode for ASP.NET Webforms
52
ResolveEmbeddedResourceUrl
Top
See Also
Reference
C1TargetControlHelper Class
C1.Web.Wijmo.Controls Namespace
C1TargetControlHelper Constructor
Syntax
Visual Basic (Declaration)
Public Function New()
C#
public C1TargetControlHelper()
See Also
Reference
C1TargetControlHelper Class
C1TargetControlHelper Members
Methods For a list of all members of this type, see C1TargetControlHelper members.
Public Methods
Name Description
ResolveEmbeddedResourceUrl
Top
See Also
Reference
C1TargetControlHelper Class
C1.Web.Wijmo.Controls Namespace
ComponentOne QRCode for ASP.NET Webforms
53
ResolveEmbeddedResourceUrl Method
Syntax
Visual Basic (Declaration)
Public Shared Function ResolveEmbeddedResourceUrl( _
ByVal resourceName As System.String, _
ByVal page As System.Web.UI.Page, _
ByVal combinedScript As System.Boolean _
) As System.String
C#
public static System.string ResolveEmbeddedResourceUrl(
System.string resourceName,
System.Web.UI.Page page,
System.bool combinedScript
)
Parameters
resourceName
page
combinedScript
See Also
Reference
C1TargetControlHelper Class
C1TargetControlHelper Members
C1TargetControlHelper<T>
Object Model
Syntax
Visual Basic (Declaration)
Friend Class C1TargetControlHelper(Of T As
ComponentOne QRCode for ASP.NET Webforms
54
{System.Web.UI.WebControls.WebControl, IC1TargetControl})
Inherits C1TargetControlHelper
C#
internal class C1TargetControlHelper<T> : C1TargetControlHelper
where T: System.Web.UI.WebControls.WebControl, IC1TargetControl
Type Parameters
T
Inheritance Hierarchy
System.Object
C1.Web.Wijmo.Controls.C1TargetControlHelper
C1.Web.Wijmo.Controls.C1TargetControlHelper<T>
See Also
Reference
C1TargetControlHelper<T> Members
C1.Web.Wijmo.Controls Namespace
Overview
Object Model
Syntax
Visual Basic (Declaration)
Friend Class C1TargetControlHelper(Of T As
{System.Web.UI.WebControls.WebControl, IC1TargetControl})
Inherits C1TargetControlHelper
C#
internal class C1TargetControlHelper<T> : C1TargetControlHelper
where T: System.Web.UI.WebControls.WebControl, IC1TargetControl
Type Parameters
T
ComponentOne QRCode for ASP.NET Webforms
55
Inheritance Hierarchy
System.Object
C1.Web.Wijmo.Controls.C1TargetControlHelper
C1.Web.Wijmo.Controls.C1TargetControlHelper<T>
See Also
Reference
C1TargetControlHelper<T> Members
C1.Web.Wijmo.Controls Namespace
Members The following tables list the members exposed by C1TargetControlHelper<T>.
Public Constructors
Name Description
C1TargetControlHelper<T> Constructor
Top
Public Properties
Name Description
Control
JsonSerializableHelper
Page
ScriptManager
Top
Public Methods
Name Description
ComponentOne QRCode for ASP.NET Webforms
56
EnsureEnabledState
GetScriptDescriptors Overloaded. When overridden in a derived
class, registers the WidgetDescriptor
objects for the control.
RegisterDesignTimeStyleSheet Register design-time CSS stylesheet.
RegisterDesignTimeStyleSheets
RegisterIncludes
RegisterOnSubmitStatement
RegisterRunTimeStylesheets
RegisterScriptDescriptors
RegisterScriptDescriptorsWithoutScriptManager
RegisterScriptDescriptorsWithScriptManager
RenderJsonDataField
ShowAbout Show about message box.
Top
See Also
Reference
C1TargetControlHelper<T> Class
C1.Web.Wijmo.Controls Namespace
C1TargetControlHelper<T> Constructor
Syntax
Visual Basic (Declaration)
ComponentOne QRCode for ASP.NET Webforms
57
Public Function New( _
ByVal control As T _
)
C#
public C1TargetControlHelper<T>(
T control
)
Parameters
control
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
Methods For a list of all members of this type, see C1TargetControlHelper<T> members.
Public Methods
Name Description
EnsureEnabledState
GetScriptDescriptors Overloaded. When overridden in a derived
class, registers the WidgetDescriptor
objects for the control.
RegisterDesignTimeStyleSheet Register design-time CSS stylesheet.
RegisterDesignTimeStyleSheets
RegisterIncludes
RegisterOnSubmitStatement
RegisterRunTimeStylesheets
ComponentOne QRCode for ASP.NET Webforms
58
RegisterScriptDescriptors
RegisterScriptDescriptorsWithoutScriptManager
RegisterScriptDescriptorsWithScriptManager
RenderJsonDataField
ShowAbout Show about message box.
Top
See Also
Reference
C1TargetControlHelper<T> Class
C1.Web.Wijmo.Controls Namespace
EnsureEnabledState Method
Syntax
Visual Basic (Declaration)
Public Sub EnsureEnabledState()
C#
public void EnsureEnabledState()
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
GetScriptDescriptors Method When overridden in a derived class, registers the WidgetDescriptor objects for the control.
Overload List
Overload Description
ComponentOne QRCode for ASP.NET Webforms
59
GetScriptDescriptors() When overridden in a derived class, registers the WidgetDescriptor
objects for the control.
GetScriptDescriptors(String) When overridden in a derived class, registers the WidgetDescriptor
objects for the control.
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
GetScriptDescriptors() Method
When overridden in a derived class, registers the WidgetDescriptor objects for the control.
Syntax
Visual Basic (Declaration)
Public Overloads Function GetScriptDescriptors() As
System.Collections.Generic.IEnumerable(Of ScriptDescriptor)
C#
public System.Collections.Generic.IEnumerable<ScriptDescriptor>
GetScriptDescriptors()
Return Value
An enumeration of WidgetDescriptor objects.
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
Overload List
GetScriptDescriptors(String) Method
When overridden in a derived class, registers the WidgetDescriptor objects for the control.
Syntax
ComponentOne QRCode for ASP.NET Webforms
60
Visual Basic (Declaration)
Public Overloads Function GetScriptDescriptors( _
ByVal targetSelector As System.String _
) As System.Collections.Generic.IEnumerable(Of ScriptDescriptor)
C#
public System.Collections.Generic.IEnumerable<ScriptDescriptor>
GetScriptDescriptors(
System.string targetSelector
)
Parameters
targetSelector
The target selector.
Return Value
An enumeration of WidgetDescriptor objects.
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
Overload List
RegisterDesignTimeStyleSheet Method Register design-time CSS stylesheet.
Syntax
Visual Basic (Declaration)
Public Sub RegisterDesignTimeStyleSheet( _
ByVal writer As System.Web.UI.HtmlTextWriter, _
ByVal cssResourceName As System.String _
)
C#
public void RegisterDesignTimeStyleSheet(
System.Web.UI.HtmlTextWriter writer,
ComponentOne QRCode for ASP.NET Webforms
61
System.string cssResourceName
)
Parameters
writer
cssResourceName
CSS resource name.
Remarks
The cssResourceName is the link to an resource element.
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
RegisterDesignTimeStyleSheets Method
Syntax
Visual Basic (Declaration)
Public Sub RegisterDesignTimeStyleSheets( _
ByVal writer As System.Web.UI.HtmlTextWriter _
)
C#
public void RegisterDesignTimeStyleSheets(
System.Web.UI.HtmlTextWriter writer
)
Parameters
writer
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
ComponentOne QRCode for ASP.NET Webforms
62
RegisterIncludes Method
Syntax
Visual Basic (Declaration)
Public Sub RegisterIncludes()
C#
public void RegisterIncludes()
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
RegisterOnSubmitStatement Method
Syntax
Visual Basic (Declaration)
Public Sub RegisterOnSubmitStatement( _
Optional ByVal callback As System.String _
)
C#
public void RegisterOnSubmitStatement(
System.string callback
)
Parameters
callback
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
RegisterRunTimeStylesheets Method
Syntax
ComponentOne QRCode for ASP.NET Webforms
63
Visual Basic (Declaration)
Public Sub RegisterRunTimeStylesheets()
C#
public void RegisterRunTimeStylesheets()
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
RegisterScriptDescriptors Method
Syntax
Visual Basic (Declaration)
Public Sub RegisterScriptDescriptors()
C#
public void RegisterScriptDescriptors()
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
RegisterScriptDescriptorsWithoutScriptManager Method
Syntax
Visual Basic (Declaration)
Public Sub RegisterScriptDescriptorsWithoutScriptManager()
C#
public void RegisterScriptDescriptorsWithoutScriptManager()
See Also
Reference
ComponentOne QRCode for ASP.NET Webforms
64
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
RegisterScriptDescriptorsWithScriptManager Method
Syntax
Visual Basic (Declaration)
Public Sub RegisterScriptDescriptorsWithScriptManager()
C#
public void RegisterScriptDescriptorsWithScriptManager()
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
RenderJsonDataField Method
Syntax
Visual Basic (Declaration)
Public Sub RenderJsonDataField( _
ByVal writer As System.Web.UI.HtmlTextWriter _
)
C#
public void RenderJsonDataField(
System.Web.UI.HtmlTextWriter writer
)
Parameters
writer
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
ComponentOne QRCode for ASP.NET Webforms
65
ShowAbout Method Show about message box.
Syntax
Visual Basic (Declaration)
Public Sub ShowAbout()
C#
public void ShowAbout()
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
Properties For a list of all members of this type, see C1TargetControlHelper<T> members.
Public Properties
Name Description
Control
JsonSerializableHelper
Page
ScriptManager
Top
See Also
Reference
C1TargetControlHelper<T> Class
C1.Web.Wijmo.Controls Namespace
ComponentOne QRCode for ASP.NET Webforms
66
Control Property
Syntax
Visual Basic (Declaration)
Public ReadOnly Property Control As T
C#
public T Control {get;}
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
JsonSerializableHelper Property
Syntax
Visual Basic (Declaration)
Public ReadOnly Property JsonSerializableHelper As JsonSerializableHelper
C#
public JsonSerializableHelper JsonSerializableHelper {get;}
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
Page Property
Syntax
Visual Basic (Declaration)
Public ReadOnly Property Page As System.Web.UI.Page
C#
ComponentOne QRCode for ASP.NET Webforms
67
public System.Web.UI.Page Page {get;}
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
ScriptManager Property
Syntax
Visual Basic (Declaration)
Public ReadOnly Property ScriptManager As System.Web.UI.ScriptManager
C#
public System.Web.UI.ScriptManager ScriptManager {get;}
See Also
Reference
C1TargetControlHelper<T> Class
C1TargetControlHelper<T> Members
C1.Web.Wijmo.Controls.C1QRCode
Namespace
Overview Classes
Class Description
C1QRCode Represents a C1QRCode in an ASP.NET Web page.
Enumerations
Enumeration Description
Encoding Specifies the type of encoding to use (more flexible encodings
ComponentOne QRCode for ASP.NET Webforms
68
consume more space).
ErrorCorrectionLevel Specifies the error-correction level (higher levels consume more
space).
See Also
Reference
C1.Web.Wijmo.Controls.4 Assembly
Classes
C1QRCode Represents a C1QRCode in an ASP.NET Web page.
Object Model
Syntax
Visual Basic (Declaration)
<System.Web.UI.ToolboxDataAttribute("<{0}:C1QRCode
runat=server></{0}:C1QRCode>")>
<System.ComponentModel.DesignerAttribute(DesignerBaseTypeName="System.Compone
ntModel.Design.IDesigner",
DesignerTypeName="C1.Web.Wijmo.Controls.Design.C1QRCode.C1QRCodeDesigner,
C1.Web.Wijmo.Controls.Design.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")>
<System.Drawing.ToolboxBitmapAttribute()>
<System.ComponentModel.LicenseProviderAttribute()>
Public Class C1QRCode
Inherits C1.Web.Wijmo.Controls.C1TargetControlBase
C#
[System.Web.UI.ToolboxData("<{0}:C1QRCode runat=server></{0}:C1QRCode>")]
[System.ComponentModel.Designer(DesignerBaseTypeName="System.ComponentMod
el.Design.IDesigner",
DesignerTypeName="C1.Web.Wijmo.Controls.Design.C1QRCode.C1QRCodeDesigner,
ComponentOne QRCode for ASP.NET Webforms
69
C1.Web.Wijmo.Controls.Design.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")]
[System.Drawing.ToolboxBitmap()]
[System.ComponentModel.LicenseProvider()]
public class C1QRCode : C1.Web.Wijmo.Controls.C1TargetControlBase
Inheritance Hierarchy
System.Object
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
C1.Web.Wijmo.Controls.C1TargetControlBase
C1.Web.Wijmo.Controls.C1QRCode.C1QRCode
See Also
Reference
C1QRCode Members
C1.Web.Wijmo.Controls.C1QRCode Namespace
Overview Represents a C1QRCode in an ASP.NET Web page.
Object Model
Syntax
Visual Basic (Declaration)
<System.Web.UI.ToolboxDataAttribute("<{0}:C1QRCode
runat=server></{0}:C1QRCode>")>
<System.ComponentModel.DesignerAttribute(DesignerBaseTypeName="System.Compone
ntModel.Design.IDesigner",
DesignerTypeName="C1.Web.Wijmo.Controls.Design.C1QRCode.C1QRCodeDesigner,
C1.Web.Wijmo.Controls.Design.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")>
<System.Drawing.ToolboxBitmapAttribute()>
<System.ComponentModel.LicenseProviderAttribute()>
Public Class C1QRCode
Inherits C1.Web.Wijmo.Controls.C1TargetControlBase
ComponentOne QRCode for ASP.NET Webforms
70
C#
[System.Web.UI.ToolboxData("<{0}:C1QRCode runat=server></{0}:C1QRCode>")]
[System.ComponentModel.Designer(DesignerBaseTypeName="System.ComponentMod
el.Design.IDesigner",
DesignerTypeName="C1.Web.Wijmo.Controls.Design.C1QRCode.C1QRCodeDesigner,
C1.Web.Wijmo.Controls.Design.4, Version=4.0.20143.198, Culture=neutral,
PublicKeyToken=9b75583953471eea")]
[System.Drawing.ToolboxBitmap()]
[System.ComponentModel.LicenseProvider()]
public class C1QRCode : C1.Web.Wijmo.Controls.C1TargetControlBase
Inheritance Hierarchy
System.Object
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
C1.Web.Wijmo.Controls.C1TargetControlBase
C1.Web.Wijmo.Controls.C1QRCode.C1QRCode
See Also
Reference
C1QRCode Members
C1.Web.Wijmo.Controls.C1QRCode Namespace
Members The following tables list the members exposed by C1QRCode.
Public Constructors
Name Description
C1QRCode Constructor Initializes a new instance of the C1QRCode class.
Top
Public Properties
Name Description
AccessKey (Inherited from
ComponentOne QRCode for ASP.NET Webforms
71
System.Web.UI.WebControls.WebControl)
AppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Attributes (Inherited from
System.Web.UI.WebControls.WebControl)
AutoSize Gets or sets a value to determine whether control
should reset its size according to the QR code
image.
BackColor Overridden. Gets or sets the background color for
the control.
ClientID (Inherited from System.Web.UI.Control)
ClientIDMode (Inherited from System.Web.UI.Control)
CodeVersion Gets or sets the "version" of QR code to generate.
Controls (Inherited from System.Web.UI.Control)
ControlStyle (Inherited from
System.Web.UI.WebControls.WebControl)
ControlStyleCreated (Inherited from
System.Web.UI.WebControls.WebControl)
CssClass (Inherited from
System.Web.UI.WebControls.WebControl)
DisplayVisible Gets or sets a value that indicates whether a server
control is rendered as UI on the page. (Inherited
from C1.Web.Wijmo.Controls.C1TargetControlBase)
EnableCombinedJavaScripts Enable JavaScripts files combined into one file. In
order to combined enabled, you must register the
WijmoHttpHandler in web.config. (Inherited from
ComponentOne QRCode for ASP.NET Webforms
72
C1.Web.Wijmo.Controls.C1TargetControlBase)
Enabled Gets or sets a value indicating whether the Web
server control is enabled. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
EnableTheming (Inherited from
System.Web.UI.WebControls.WebControl)
EnableViewState (Inherited from System.Web.UI.Control)
Encoding Gets or sets the Encoding used to translate the
content in the Text property into binary values to be
encoded in the QR code.
EncodingException Gets the System.Exception that prevented the Text
from being encoded.
ErrorCorrectionLevel Gets or sets the error correction level used to create
the QR code.
ForeColor Overridden. Gets or sets the foreground color for the
control.
HasAttributes (Inherited from
System.Web.UI.WebControls.WebControl)
Height Overridden. Gets or sets the height of control.
ID (Inherited from System.Web.UI.Control)
Image Gets the image of the QR code.
ImageUrl Get a Base64 string which is a conversion of the QR
code image. Users can set this result into an ASP.net
Image control's "ImageUrl" property or a HTML
Image element's "Src" attribute to show the QR code
ComponentOne QRCode for ASP.NET Webforms
73
image manually.
NamingContainer (Inherited from System.Web.UI.Control)
Page (Inherited from System.Web.UI.Control)
Parent (Inherited from System.Web.UI.Control)
RenderingCompatibility (Inherited from System.Web.UI.Control)
Site (Inherited from System.Web.UI.Control)
SkinID (Inherited from
System.Web.UI.WebControls.WebControl)
Style (Inherited from
System.Web.UI.WebControls.WebControl)
SupportsDisabledAttribute (Inherited from
System.Web.UI.WebControls.WebControl)
SymbolSize Gets or sets the size, in pixels, of the symbols used to
build the QR image.
TabIndex (Inherited from
System.Web.UI.WebControls.WebControl)
TemplateControl (Inherited from System.Web.UI.Control)
TemplateSourceDirectory (Inherited from System.Web.UI.Control)
Text Gets or sets the value that is encoded as a QR code
image.
ToolTip (Inherited from
System.Web.UI.WebControls.WebControl)
UniqueID (Inherited from System.Web.UI.Control)
ComponentOne QRCode for ASP.NET Webforms
74
ValidateRequestMode (Inherited from System.Web.UI.Control)
ViewStateMode (Inherited from System.Web.UI.Control)
Width Overridden. Gets or sets the width of control.
WijmoControlMode A value that indicates mode of the control, whether it
is a mobile or web control. Note that only one value
can be used for the whole website or project.
(Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
Top
Public Methods
Name Description
ApplyStyle (Inherited from System.Web.UI.WebControls.WebControl)
ApplyStyleSheetSkin (Inherited from System.Web.UI.Control)
CopyBaseAttributes (Inherited from System.Web.UI.WebControls.WebControl)
DataBind (Inherited from System.Web.UI.Control)
Dispose (Inherited from System.Web.UI.Control)
FindControl (Inherited from System.Web.UI.Control)
Focus (Inherited from System.Web.UI.Control)
GetPropertyValue<V> Gets the property value by property name. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
GetRouteUrl Overloaded. (Inherited from System.Web.UI.Control)
GetScriptDescriptors Overridden. When overridden in a derived class, registers
the WidgetDescriptor objects for the control.
ComponentOne QRCode for ASP.NET Webforms
75
GetScriptReferences When overridden in a derived class, registers an additional
script libraries for the extender control. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
GetUniqueIDRelativeTo (Inherited from System.Web.UI.Control)
HasControls (Inherited from System.Web.UI.Control)
MergeStyle (Inherited from System.Web.UI.WebControls.WebControl)
RegisterDesignTimeStyleSheet Register design time stylesheet (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
RenderBeginTag (Inherited from System.Web.UI.WebControls.WebControl)
RenderControl (Inherited from System.Web.UI.Control)
RenderEndTag (Inherited from System.Web.UI.WebControls.WebControl)
ResolveClientUrl (Inherited from System.Web.UI.Control)
ResolveUrl (Inherited from System.Web.UI.Control)
SetPropertyValue<V> Sets the property value by property name. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
SetRenderMethodDelegate (Inherited from System.Web.UI.Control)
Top
Public Events
Name Description
DataBinding (Inherited from System.Web.UI.Control)
Disposed (Inherited from System.Web.UI.Control)
Init (Inherited from System.Web.UI.Control)
ComponentOne QRCode for ASP.NET Webforms
76
Load (Inherited from System.Web.UI.Control)
PreRender (Inherited from System.Web.UI.Control)
Unload (Inherited from System.Web.UI.Control)
Top
See Also
Reference
C1QRCode Class
C1.Web.Wijmo.Controls.C1QRCode Namespace
C1QRCode Constructor Initializes a new instance of the C1QRCode class.
Syntax
Visual Basic (Declaration)
Public Function New()
C#
public C1QRCode()
See Also
Reference
C1QRCode Class
C1QRCode Members
Methods For a list of all members of this type, see C1QRCode members.
Public Methods
Name Description
ApplyStyle (Inherited from System.Web.UI.WebControls.WebControl)
ComponentOne QRCode for ASP.NET Webforms
77
ApplyStyleSheetSkin (Inherited from System.Web.UI.Control)
CopyBaseAttributes (Inherited from System.Web.UI.WebControls.WebControl)
DataBind (Inherited from System.Web.UI.Control)
Dispose (Inherited from System.Web.UI.Control)
FindControl (Inherited from System.Web.UI.Control)
Focus (Inherited from System.Web.UI.Control)
GetPropertyValue<V> Gets the property value by property name. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
GetRouteUrl Overloaded. (Inherited from System.Web.UI.Control)
GetScriptDescriptors Overridden. When overridden in a derived class, registers
the WidgetDescriptor objects for the control.
GetScriptReferences When overridden in a derived class, registers an additional
script libraries for the extender control. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
GetUniqueIDRelativeTo (Inherited from System.Web.UI.Control)
HasControls (Inherited from System.Web.UI.Control)
MergeStyle (Inherited from System.Web.UI.WebControls.WebControl)
RegisterDesignTimeStyleSheet Register design time stylesheet (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
RenderBeginTag (Inherited from System.Web.UI.WebControls.WebControl)
RenderControl (Inherited from System.Web.UI.Control)
RenderEndTag (Inherited from System.Web.UI.WebControls.WebControl)
ComponentOne QRCode for ASP.NET Webforms
78
ResolveClientUrl (Inherited from System.Web.UI.Control)
ResolveUrl (Inherited from System.Web.UI.Control)
SetPropertyValue<V> Sets the property value by property name. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
SetRenderMethodDelegate (Inherited from System.Web.UI.Control)
Top
See Also
Reference
C1QRCode Class
C1.Web.Wijmo.Controls.C1QRCode Namespace
GetScriptDescriptors Method When overridden in a derived class, registers the WidgetDescriptor objects for the control.
Syntax
Visual Basic (Declaration)
Public Overrides Function GetScriptDescriptors() As
System.Collections.Generic.IEnumerable(Of ScriptDescriptor)
C#
public override System.Collections.Generic.IEnumerable<ScriptDescriptor>
GetScriptDescriptors()
Return Value
An enumeration of WidgetDescriptor objects.
See Also
Reference
C1QRCode Class
C1QRCode Members
ComponentOne QRCode for ASP.NET Webforms
79
Properties For a list of all members of this type, see C1QRCode members.
Public Properties
Name Description
AccessKey (Inherited from
System.Web.UI.WebControls.WebControl)
AppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Attributes (Inherited from
System.Web.UI.WebControls.WebControl)
AutoSize Gets or sets a value to determine whether control
should reset its size according to the QR code
image.
BackColor Overridden. Gets or sets the background color for
the control.
ClientID (Inherited from System.Web.UI.Control)
ClientIDMode (Inherited from System.Web.UI.Control)
CodeVersion Gets or sets the "version" of QR code to generate.
Controls (Inherited from System.Web.UI.Control)
ControlStyle (Inherited from
System.Web.UI.WebControls.WebControl)
ControlStyleCreated (Inherited from
System.Web.UI.WebControls.WebControl)
CssClass (Inherited from
System.Web.UI.WebControls.WebControl)
ComponentOne QRCode for ASP.NET Webforms
80
DisplayVisible Gets or sets a value that indicates whether a server
control is rendered as UI on the page. (Inherited
from C1.Web.Wijmo.Controls.C1TargetControlBase)
EnableCombinedJavaScripts Enable JavaScripts files combined into one file. In
order to combined enabled, you must register the
WijmoHttpHandler in web.config. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
Enabled Gets or sets a value indicating whether the Web
server control is enabled. (Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
EnableTheming (Inherited from
System.Web.UI.WebControls.WebControl)
EnableViewState (Inherited from System.Web.UI.Control)
Encoding Gets or sets the Encoding used to translate the
content in the Text property into binary values to be
encoded in the QR code.
EncodingException Gets the System.Exception that prevented the Text
from being encoded.
ErrorCorrectionLevel Gets or sets the error correction level used to create
the QR code.
ForeColor Overridden. Gets or sets the foreground color for the
control.
HasAttributes (Inherited from
System.Web.UI.WebControls.WebControl)
Height Overridden. Gets or sets the height of control.
ID (Inherited from System.Web.UI.Control)
ComponentOne QRCode for ASP.NET Webforms
81
Image Gets the image of the QR code.
ImageUrl Get a Base64 string which is a conversion of the QR
code image. Users can set this result into an ASP.net
Image control's "ImageUrl" property or a HTML
Image element's "Src" attribute to show the QR code
image manually.
NamingContainer (Inherited from System.Web.UI.Control)
Page (Inherited from System.Web.UI.Control)
Parent (Inherited from System.Web.UI.Control)
RenderingCompatibility (Inherited from System.Web.UI.Control)
Site (Inherited from System.Web.UI.Control)
SkinID (Inherited from
System.Web.UI.WebControls.WebControl)
Style (Inherited from
System.Web.UI.WebControls.WebControl)
SupportsDisabledAttribute (Inherited from
System.Web.UI.WebControls.WebControl)
SymbolSize Gets or sets the size, in pixels, of the symbols used to
build the QR image.
TabIndex (Inherited from
System.Web.UI.WebControls.WebControl)
TemplateControl (Inherited from System.Web.UI.Control)
TemplateSourceDirectory (Inherited from System.Web.UI.Control)
Text Gets or sets the value that is encoded as a QR code
ComponentOne QRCode for ASP.NET Webforms
82
image.
ToolTip (Inherited from
System.Web.UI.WebControls.WebControl)
UniqueID (Inherited from System.Web.UI.Control)
ValidateRequestMode (Inherited from System.Web.UI.Control)
ViewStateMode (Inherited from System.Web.UI.Control)
Width Overridden. Gets or sets the width of control.
WijmoControlMode A value that indicates mode of the control, whether it
is a mobile or web control. Note that only one value
can be used for the whole website or project.
(Inherited from
C1.Web.Wijmo.Controls.C1TargetControlBase)
Top
See Also
Reference
C1QRCode Class
C1.Web.Wijmo.Controls.C1QRCode Namespace
AutoSize Property Gets or sets a value to determine whether control should reset its size according to the QR code
image.
Syntax
Visual Basic (Declaration)
<C1CategoryAttribute("Appearance")>
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1QRCode.AutoSize", Description="Gets or sets a
value to determine whether control should reset its size according to the QR
code image.")>
ComponentOne QRCode for ASP.NET Webforms
83
Public Property AutoSize As System.Boolean
C#
[C1Category("Appearance")]
[System.ComponentModel.DefaultValue()]
[C1Description(Key="C1QRCode.AutoSize", Description="Gets or sets a value to
determine whether control should reset its size according to the QR code
image.")]
public System.bool AutoSize {get; set;}
See Also
Reference
C1QRCode Class
C1QRCode Members
BackColor Property Gets or sets the background color for the control.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.DefaultValueAttribute()>
<EditorBrowsableAttribute()>
<System.ComponentModel.BrowsableAttribute(True)>
<C1DescriptionAttribute(Key="C1QRCode.BackColor", Description="Gets or sets
the background color for the control.")>
Public Overrides Property BackColor As System.Drawing.Color
C#
[System.ComponentModel.DefaultValue()]
[EditorBrowsable()]
[System.ComponentModel.Browsable(true)]
[C1Description(Key="C1QRCode.BackColor", Description="Gets or sets the
background color for the control.")]
public override System.Drawing.Color BackColor {get; set;}
See Also
Reference
ComponentOne QRCode for ASP.NET Webforms
84
C1QRCode Class
C1QRCode Members
CodeVersion Property Gets or sets the "version" of QR code to generate.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1QRCode.CodeVersion", Description="Gets or sets
the 'version' of QR code to generate (set to zero to auto-select).")>
<C1CategoryAttribute("Data")>
Public Property CodeVersion As System.Integer
C#
[System.ComponentModel.DefaultValue()]
[C1Description(Key="C1QRCode.CodeVersion", Description="Gets or sets the
'version' of QR code to generate (set to zero to auto-select).")]
[C1Category("Data")]
public System.int CodeVersion {get; set;}
Remarks
The QR specification includes 40 "versions" of QR codes. Higher versions consume more space
and are able to encode more information.
The C1QRCode control can generate QR codes versions one through ten only, which allow
encoding up to 652 digits, or 395 alphanumeric characters, or 271 bytes.
Set the CodeVersion property to zero (the default value) to automatically use the most compact
version able to render the content specified in the Text property.
See Also
Reference
C1QRCode Class
C1QRCode Members
Encoding Property Gets or sets the Encoding used to translate the content in the Text property into binary values
to be encoded in the QR code.
ComponentOne QRCode for ASP.NET Webforms
85
Syntax
Visual Basic (Declaration)
<C1CategoryAttribute("Data")>
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1QRCode.Encoding", Description="Determines how
the Text should be encoded (automatic, text, numeric, or bytes).")>
Public Property Encoding As Encoding
C#
[C1Category("Data")]
[System.ComponentModel.DefaultValue()]
[C1Description(Key="C1QRCode.Encoding", Description="Determines how the Text
should be encoded (automatic, text, numeric, or bytes).")]
public Encoding Encoding {get; set;}
Remarks
More flexible encodings have lower capacity. The C1QRCode control can encode up to 652
digits, or 395 alphanumeric characters, or 271 bytes.
The default value for this property is Encoding.Automatic, which causes the control to
automatically select the most compact encoding that can be used based on the content
specified in the Text property.
See Also
Reference
C1QRCode Class
C1QRCode Members
EncodingException Property Gets the System.Exception that prevented the Text from being encoded.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.BrowsableAttribute(False)>
Public ReadOnly Property EncodingException As System.Exception
C#
ComponentOne QRCode for ASP.NET Webforms
86
[System.ComponentModel.Browsable(false)]
public System.Exception EncodingException {get;}
Remarks
The C1QRCode control can be used to encode up to 652 digits, or 395 alphanumeric characters
(uppercase only), or 271 bytes.
If these limits are exceeded, or if any of the control properties is set to values that prevent the
content of the Text property from being encoded, the control remains blank, and the
EncodingException property contains details that explain why the code could not be generated.
Example
The code below sets the Text property and shows a message in case any errors are detected:
C#
c1QRCode1.Text = textBox1.Text; label1.Text = c1QRCode1.EncodingException == null ? string.Empty : c1QRCode1.EncodingException.Message;
See Also
Reference
C1QRCode Class
C1QRCode Members
ErrorCorrectionLevel Property Gets or sets the error correction level used to create the QR code.
Syntax
Visual Basic (Declaration)
<C1CategoryAttribute("Data")>
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1QRCode.ErrorCorrectionLevel",
Description="Gets or sets the error correction level used to create the QR
code.")>
Public Property ErrorCorrectionLevel As ErrorCorrectionLevel
C#
[C1Category("Data")]
[System.ComponentModel.DefaultValue()]
ComponentOne QRCode for ASP.NET Webforms
87
[C1Description(Key="C1QRCode.ErrorCorrectionLevel", Description="Gets or sets
the error correction level used to create the QR code.")]
public ErrorCorrectionLevel ErrorCorrectionLevel {get; set;}
Remarks
Higher levels of error correction add more redundant information to the QR code, making it
more resistant to damage. Higher levels of error correction also reduce the amount of data that
can be encoded in a given area.
The default value for this property is the lowest level, which produces the most compact QR
codes.
See Also
Reference
C1QRCode Class
C1QRCode Members
ForeColor Property Gets or sets the foreground color for the control.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.BrowsableAttribute(True)>
<EditorBrowsableAttribute()>
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1QRCode.ForeColor", Description="Gets or sets
the foreground color for the control.")>
Public Overrides Property ForeColor As System.Drawing.Color
C#
[System.ComponentModel.Browsable(true)]
[EditorBrowsable()]
[System.ComponentModel.DefaultValue()]
[C1Description(Key="C1QRCode.ForeColor", Description="Gets or sets the
foreground color for the control.")]
public override System.Drawing.Color ForeColor {get; set;}
See Also
Reference
ComponentOne QRCode for ASP.NET Webforms
88
C1QRCode Class
C1QRCode Members
Height Property Gets or sets the height of control.
Syntax
Visual Basic (Declaration)
<C1DescriptionAttribute(Key="C1QRCode.Height", Description="Gets or sets the
height of control.")>
Public Overrides Property Height As System.Web.UI.WebControls.Unit
C#
[C1Description(Key="C1QRCode.Height", Description="Gets or sets the height of
control.")]
public override System.Web.UI.WebControls.Unit Height {get; set;}
See Also
Reference
C1QRCode Class
C1QRCode Members
Image Property Gets the image of the QR code.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.BrowsableAttribute(False)>
Public ReadOnly Property Image As System.Drawing.Image
C#
[System.ComponentModel.Browsable(false)]
public System.Drawing.Image Image {get;}
See Also
Reference
ComponentOne QRCode for ASP.NET Webforms
89
C1QRCode Class
C1QRCode Members
ImageUrl Property Get a Base64 string which is a conversion of the QR code image. Users can set this result into an
ASP.net Image control's "ImageUrl" property or a HTML Image element's "Src" attribute to show
the QR code image manually.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.BrowsableAttribute(False)>
Public ReadOnly Property ImageUrl As System.String
C#
[System.ComponentModel.Browsable(false)]
public System.string ImageUrl {get;}
See Also
Reference
C1QRCode Class
C1QRCode Members
SymbolSize Property Gets or sets the size, in pixels, of the symbols used to build the QR image.
Syntax
Visual Basic (Declaration)
<System.ComponentModel.DefaultValueAttribute()>
<C1CategoryAttribute("Data")>
<C1DescriptionAttribute(Key="C1QRCode.SymbolSize", Description="Gets or sets
the size, in pixels, of the symbols used to build the QR image.")>
Public Property SymbolSize As System.Integer
C#
[System.ComponentModel.DefaultValue()]
[C1Category("Data")]
[C1Description(Key="C1QRCode.SymbolSize", Description="Gets or sets the size,
ComponentOne QRCode for ASP.NET Webforms
90
in pixels, of the symbols used to build the QR image.")]
public System.int SymbolSize {get; set;}
Remarks
Larger values will result in larger images which consume more space but may be easier to for
some scanners to read.
The default symbol size is three pixels, which usually represents a good compromise between
size and readability.
This property must be set to values between 2 and 10.
See Also
Reference
C1QRCode Class
C1QRCode Members
Text Property Gets or sets the value that is encoded as a QR code image.
Syntax
Visual Basic (Declaration)
<C1CategoryAttribute("Data")>
<System.ComponentModel.DefaultValueAttribute()>
<C1DescriptionAttribute(Key="C1QRCode.Text", Description="Gets or sets the
value that is encoded as a QR code image.")>
Public Property Text As System.String
C#
[C1Category("Data")]
[System.ComponentModel.DefaultValue()]
[C1Description(Key="C1QRCode.Text", Description="Gets or sets the value that
is encoded as a QR code image.")]
public System.string Text {get; set;}
See Also
Reference
C1QRCode Class
C1QRCode Members
ComponentOne QRCode for ASP.NET Webforms
91
Width Property Gets or sets the width of control.
Syntax
Visual Basic (Declaration)
<C1DescriptionAttribute(Key="C1QRCode.Width", Description="Gets or sets the
width of control.")>
Public Overrides Property Width As System.Web.UI.WebControls.Unit
C#
[C1Description(Key="C1QRCode.Width", Description="Gets or sets the width of
control.")]
public override System.Web.UI.WebControls.Unit Width {get; set;}
See Also
Reference
C1QRCode Class
C1QRCode Members
Enumerations
Encoding Specifies the type of encoding to use (more flexible encodings consume more space).
Syntax
Visual Basic (Declaration)
Public Enum Encoding
Inherits System.Enum
C#
public enum Encoding : System.Enum
Members
Member Description
ComponentOne QRCode for ASP.NET Webforms
92
AlphaNumeric Encode up to 395 alpha-numeric values. Alpha-numeric values include digits
from 0 to 9, uppercase letters from A to Z, space, and the following
additional characters: dollar, percentage, asterisk, plus, minus, slash, and
colon ([0-9][A-Z][$%*+-./:]).
Automatic Select encoding automatically based on the content.
Byte Encode up to 271 bytes.
Numeric Encode up to 652 numeric values.
Inheritance Hierarchy
System.Object
System.ValueType
System.Enum
C1.Web.Wijmo.Controls.C1QRCode.Encoding
See Also
Reference
C1.Web.Wijmo.Controls.C1QRCode Namespace
ErrorCorrectionLevel Specifies the error-correction level (higher levels consume more space).
Syntax
Visual Basic (Declaration)
Public Enum ErrorCorrectionLevel
Inherits System.Enum
C#
public enum ErrorCorrectionLevel : System.Enum
Members
Member Description
ComponentOne QRCode for ASP.NET Webforms
93
H Able to correct up to 30% damage.
L Able to correct up to 7% damage.
M Able to correct up to 15% damage.
Q Able to correct up to 25% damage.
Inheritance Hierarchy
System.Object
System.ValueType
System.Enum
C1.Web.Wijmo.Controls.C1QRCode.ErrorCorrectionLevel
See Also
Reference
C1.Web.Wijmo.Controls.C1QRCode Namespace