ComponentOne Accordion for ASP.NET Wijmoprerelease.componentone.com/help/ASPNETWebForms/ASP.AutoComplete.pdfAutoComplete for ASP.NET Web Forms 8 2. In the New Project dialog box expand

ComponentOne

AutoComplete for ASP.NET

Web Forms

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.

AutoComplete for ASP.NET Web Forms

1

Table of Contents Overview ................................................................................................................................. 6

Help with ASP.NET Web Forms Edition ................................................................................ 6

Key Features ............................................................................................................................ 6

Quick Start............................................................................................................................... 7

Step 1 of 3: Add C1AutoComplete to the Page ..................................................................... 7

Step 2 of 3: Customize the Search Box ................................................................................. 8

Step 3 of 3: Run your Application ......................................................................................... 9

Design-Time Support ............................................................................................................. 10

Smart Tag .......................................................................................................................... 10

Context Menu.................................................................................................................... 12

DesignerForm .................................................................................................................... 13

Exploring the AutoComplete DesignerForm ................................................................... 13

How to Use the Designer................................................................................................ 16

Deleting a C1AutoCompleteDataItem......................................................................... 17

Renaming the AutoCompleteDataItem in the Designer .............................................. 17

Adding a Child Item .................................................................................................... 17

Elements ............................................................................................................................... 18

Appearance ........................................................................................................................... 18

Themes.............................................................................................................................. 19

CSS Selectors ..................................................................................................................... 20

Working with the Client-Side ................................................................................................. 21

Client-Side Events .............................................................................................................. 21

Task-Based Help .................................................................................................................... 22

Creating a C1AutoComplete Control in Code ...................................................................... 23

Customizing the Width and Height of C1AutoComplete ..................................................... 24

Using the AutoPostBack Property ...................................................................................... 26

Using DataBinding ............................................................................................................. 29

Using the LoadOnDemand Property ................................................................................... 29

Client-Side Reference ............................................................................................................ 30

Using the Wijmo CDN ............................................................................................................ 31

C1.Web.Wijmo.Controls.4 Assembly ...................................................................................... 32

Namespaces ...................................................................................................................... 32


2

C1.Web.Wijmo.Controls Namespace .............................................................................. 32

Classes ....................................................................................................................... 32

C1BaseStateManager ............................................................................................. 32

Overview ............................................................................................................ 33

Members............................................................................................................ 33

C1TargetControlBase.............................................................................................. 34

Overview ............................................................................................................ 34

Members............................................................................................................ 35

Methods............................................................................................................. 40

GetPropertyValue<V> Method........................................................................ 42

GetScriptDescriptors Method ......................................................................... 43

GetScriptReferences Method .......................................................................... 43

RegisterDesignTimeStyleSheet Method .......................................................... 44

SetPropertyValue<V> Method ........................................................................ 45

Properties .......................................................................................................... 45

CDNDependencyPaths Property...................................................................... 49

CDNPath Property .......................................................................................... 50

DisplayVisible Property ................................................................................... 50

EnableCombinedJavaScripts Property ............................................................. 51

Enabled Property ............................................................................................ 52

Theme Property .............................................................................................. 53

ThemeSwatch Property .................................................................................. 54

UseCDN Property ............................................................................................ 55

WijmoControlMode Property ......................................................................... 56

WijmoCssAdapter Property............................................................................. 56

C1TargetControlHelper........................................................................................... 57

Overview ............................................................................................................ 58

Members............................................................................................................ 59

C1TargetControlHelper Constructor ................................................................... 59

Methods............................................................................................................. 60

ResolveEmbeddedResourceUrl Method .......................................................... 60

C1TargetControlHelper<T> ..................................................................................... 61

Overview ............................................................................................................ 61

Members............................................................................................................ 62


3

C1TargetControlHelper<T> Constructor .............................................................. 64

Methods............................................................................................................. 64

EnsureEnabledState Method .......................................................................... 65

GetScriptDescriptors Method ......................................................................... 66

GetScriptDescriptors() Method ................................................................... 66

GetScriptDescriptors(String) Method .......................................................... 67

RegisterDesignTimeStyleSheet Method .......................................................... 67

RegisterDesignTimeStyleSheets Method ......................................................... 68

RegisterIncludes Method ................................................................................ 69

RegisterOnSubmitStatement Method ............................................................. 69

RegisterRunTimeStylesheets Method ............................................................. 70

RegisterScriptDescriptors Method .................................................................. 70

RegisterScriptDescriptorsWithoutScriptManager Method............................... 71

RegisterScriptDescriptorsWithScriptManager Method .................................... 71

RenderJsonDataField Method ......................................................................... 71

ShowAbout Method ....................................................................................... 72

Properties .......................................................................................................... 72

Control Property ............................................................................................. 73

JsonSerializableHelper Property ...................................................................... 73

Page Property ................................................................................................. 74

ScriptManager Property.................................................................................. 74

ConditionalDependencyProxy ................................................................................ 74

Overview ............................................................................................................ 75

Members............................................................................................................ 76

C1.Web.Wijmo.Controls.C1AutoComplete Namespace .................................................. 76

Classes ....................................................................................................................... 76

AutoCompleteSourceOption................................................................................... 76

Overview ............................................................................................................ 77

Members............................................................................................................ 77

AutoCompleteSourceOption Constructor ........................................................... 78

Properties .......................................................................................................... 79

CallBack Property............................................................................................ 79

Labels Property ............................................................................................... 80

Url Property .................................................................................................... 80


4

C1AutoComplete .................................................................................................... 81

Overview ............................................................................................................ 82

Members............................................................................................................ 83

C1AutoComplete Constructor ............................................................................. 91

Methods............................................................................................................. 92

DataBind Method ........................................................................................... 93

LoadLayout Method........................................................................................ 94

LoadLayout(String) Method ........................................................................ 94

LoadLayout(Stream) Method ...................................................................... 95

LoadLayout(String,LayoutType) Method ..................................................... 95

LoadLayout(Stream,LayoutType) Method ................................................... 96

SaveLayout Method ........................................................................................ 97

SaveLayout(String) Method......................................................................... 98

SaveLayout(Stream) Method ...................................................................... 98

Properties .......................................................................................................... 99

AppendTo Property .......................................................................................105

AutoFocus Property .......................................................................................105

AutoPostBack Property ..................................................................................106

DataCategoryField Property ...........................................................................107

DataLabelField Property ................................................................................108

DataValueField Property ................................................................................108

Delay Property ...............................................................................................109

Items Property ...............................................................................................110

LoadOnDemand Property ..............................................................................111

MaxCount Property .......................................................................................112

MaxLength Property ......................................................................................112

MinLength Property .......................................................................................113

OnClientChange Property ..............................................................................114

OnClientClose Property..................................................................................115

OnClientCreate Property................................................................................116

OnClientFocus Property .................................................................................117

OnClientOpen Property .................................................................................118

OnClientResponse Property ...........................................................................118

OnClientSearch Property ...............................................................................119


5

OnClientSelect Property.................................................................................120

Position Property ...........................................................................................121

Source Property .............................................................................................122

Text Property .................................................................................................123

UniqueID Property .........................................................................................124

Events ...............................................................................................................125

ItemDataBinding Event ..................................................................................126

ItemDataBound Event....................................................................................127

ItemSelected Event ........................................................................................127

TextChanged Event ........................................................................................128

C1AutoCompleteDataItem ....................................................................................129

Overview ...........................................................................................................129

Members...........................................................................................................130

C1AutoCompleteDataItem Constructor .............................................................131

Properties .........................................................................................................131

Category Property .........................................................................................132

Label Property ...............................................................................................132

Value Property...............................................................................................133

C1AutoCompleteDataItemCollection .....................................................................134

Overview ...........................................................................................................134

Members...........................................................................................................135

C1AutoCompleteDataItemCollection Constructor ..............................................136

Methods............................................................................................................137

Add Method ..................................................................................................138

Insert Method................................................................................................139

C1AutoCompleteDataItemEventArgs .....................................................................139

Overview ...........................................................................................................140

Members...........................................................................................................141

C1AutoCompleteDataItemEventArgs Constructor ..............................................142

Properties .........................................................................................................142

Item Property ................................................................................................143

Delegates ..................................................................................................................143

C1AutoCompleteDataItemEventHandler ...............................................................143


6

Overview Create auto-complete search boxes with this Ajax-powered AutoComplete for ASP.NET Web

Forms. This search box supports Data Binding, AutoPostBack for value retrieval, and Ajax

loading of values.

Getting Started

Get started with the following topics:

Key Features

Quick Start

Control Elements

Help with ASP.NET Web Forms Edition Getting Started

For information on installing ComponentOne Studio ASP.NET Web Forms Edition, licensing,

technical support, namespaces and creating a project with the control, please visit Getting

Started with ASP.NET Web Forms Edition.

Key Features The C1AutoComplete control is a special type of search box that can be created on the client-

side or server-side to complete search terms input by the user.

Feature Overview

C1AutoComplete provides several unique features including LoadOnDemand, DataBinding,

AutoPostBack, AutoComplete positioning, a MaxCount property, a MinLength property, and

built-in themes.

LoadOnDemand

AutoComplete for ASP.NET Web Forms is Ajax-powered which allows you to load

information dynamically. Child items are loaded when you type in the search box.

DataBinding

C1AutoComplete allows you to bind the label, value, and category fields to a data

source of your choice.

AutoPostBack

With the AutoPostBack property, you can indicate whether or not the control posts

back to the server each time a user interacts with the control.

http://helpcentral.componentone.com/nethelp/c1studioWeb/

http://helpcentral.componentone.com/nethelp/c1studioWeb/


7

Positioning

The AutoComplete control allows you to identify the position of the control in relation

to the associated input element.

MaxCount

C1AutoComplete allows you to control the maximum number of callback results. To use

this property, you must specify the data source and have the LoadOnDemand property

set to "true".

MinLength

The MinLength property allows you to control the number of characters a user has to

type before the AutoComplete control activates.

Theming

With just a click of the SmartTag, change the AutoComplete's look by selecting one of

the 5 premium themes (Midnight, Aristo, Rocket, Cobalt, and Sterling). Optionally, use

ThemeRoller from jQuery UI to create a customized theme! For more information on

this feature, see Themes.

CSS Support

Use a cascading style sheet (CSS) style to define custom skins. CSS support allows you

to match the search box to your organization's standards.

Quick Start This quick start describes how to get started with AutoComplete for ASP.NET Web Forms. In

the quick start you'll create a project in Visual Studio, add a C1AutoComplete control to the

page, change the appearance and behavior of the control, add a list of DataItems, and observe

the C1AutoComplete's run-time behavior.

See Also

Step 1 of 3: Add C1AutoComplete to the Page

Step 2 of 3: Customize the Search Box

Step 3 of 3: Run your Application

Step 1 of 3: Add C1AutoComplete to the

Page In this step you'll create a new project and add an AutoComplete for ASP.NET Web Forms

search box to your project. To begin the Quick Start, complete the following steps:

1. From the Visual Studio File menu select New │ Project. The New Project dialog box

will appear.


8

2. In the New Project dialog box expand a language in the left-hand pane and select

Web. In the right pane, choose ASP.NET Empty Web Application, enter a Name for

your application, and select OK. A new application will be created.

3. In the Solution Explorer, right-click the project and choose Add Reference.

4. In the Add Reference dialog box, locate and select the C1.Web.Wijmo.Controls and

C1.Web.Wijmo.Controls.Design assemblies and click OK. The references will be

added.

5. While in Design view, navigate to the Visual Studio Toolbox and double-click the

C1AutoComplete icon to add a C1AutoComplete control to the page.

You've completed creating a new project and adding a C1AutoComplete search box to your

project. In the next step you'll customize the search box's appearance and behavior.

Step 2 of 3: Customize the Search Box In this step you'll change the appearance and behavior of the search box you created in the last

step. Complete the following steps to customize your AutoComplete for ASP.NET Web Forms

search box:

1. Select the C1AutoComplete smart tag to open the C1AutoComplete Tasks menu and

set the following:

Enter 300px in the Width textbox

Enter 50px in the Height textbox

Select midnight in the Theme drop-down box to change the appearance of

the AutoComplete control.

2. Click Add AutoCompleteItem to open the C1AutoComplete DesignerForm. Use the

Add ChildItems button to add 13 ChildItems to the C1AutoComplete control.

3. Click the first ChildItem in the list, C1AutoCompleteItem1, and locate the label and

value properties. Enter c++ for both properties. Enter the text from the following table

in the label and value textboxes for the remaining C1AutoCompleteItems:

C1AutoCompleteDataItem Label Value

C1AutoCompleteItem2 java java

C1AutoCompleteItem3 php php

C1AutoCompleteItem4 coldfusion coldfusion

C1AutoCompelteItem5 javascript javascript

C1AutoCompleteItem6 asp asp

C1AutoCompleteItem7 ruby ruby


9

C1AutoCompleteItem8 python python

C1AutoCompleteItem9 c c

C1AutoCompleteItem10 scala scala

C1AutoCompleteItem11 groovy groovy

C1AutoCompleteItem12 haskell haskell

C1AutoCompleteItem13 perl perl

4. Click OK when you have finished entering the above values. These

C1AutoCompleteItems are the items which will complete a user's search.

5. Click the C1AutoComplete control to view the properties in the Properties window.

Locate the MinCount property and change the value from 1 to 2.

You've completed step two of the AutoComplete for ASP.NET Web Forms quick start guide.

In the next step you'll run the project.

Step 3 of 3: Run your Application Now that you've customized your search box's apperance and behavior, the only thing left to

do is to run your application and observe some of the run-time functionality of the

C1AutoComplete search box.

Complete the following steps:

1. Press F5 to run your application. The C1AutoComplete search box should appear as in

the following image:

2. Begin typing a search topic in your search box. Try typing "ja" in the search box. It

should appear as follows:


10

Congratulations, you've created and customized a C1AutoComplete search box control and

completed the AutoComplete for ASP.NET Web Forms Quick Start guide!

Design-Time Support AutoComplete for ASP.NET Web Forms includes customized context menus, smart tags, and

design-time support that simplify working with the object model.

The following sections describe how to use the AutoComplete for ASP.NET Web Forms

design-time environment, particularly the C1AutoComplete Tasks menu accessible from the

C1AutoComplete Smart Tag and C1AutoComplete Context Menu, to configure the

C1AutoComplete control.

See Also

Smart Tag

Context Menu

DesignerForm

Smart Tag The C1AutoComplete control includes a smart tag. A smart tag represents a short-cut tasks

menu that provides the most commonly used properties in each component/command.

To access the C1AutoComplete Tasks menu, click on the Smart Tag arrow in the upper right

corner of the C1AutoComplete control. This will open the C1AutoComplete Tasks menu.


11

The C1AutoComplete Tasks menu operates as follows:

Choose Data Source

The Choose Data Source drop-down box allows you to set the data source for the


Width

The Width textbox allows you to customize the width of the control.

Height

The Height textbox allows you to customize the height of the control.

Add AutoCompleteItem

Clicking Add AutoCompleteItem opens the AutoComplete DesignerForm and allows

you to add items to the C1AutoComplete control by clicking the Add Child Item

button.

Theme

Clicking the Theme drop-down box allows you to select from various visual schemes.

For more information about available visual styles, see Themes.

Create new theme...

The Create new theme... option opens ThemeRoller for Visual Studio. This allows

you to create a new, custom theme without leaving your development environment. To

find more information on using ThemeRoller in your application, see ThemeRoller for

Visual Studio.

Use CDN

Selecting the Use CDN check box will indicate that the control extender must load

http://helpcentral.componentone.com/nethelp/c1studioWeb/Themeroller%20for%20visual%20studio.html

http://helpcentral.componentone.com/nethelp/c1studioWeb/Themeroller%20for%20visual%20studio.html


12

client resources from a content delivery network. By default this box is not checked.

CDN Path

Indicates the path for the content delivery network. Enter a URL here to change the

path.

Use Bootstrap

Selecting the Use Bootstrap checkbox allows you to apply Bootstrap theming to your

control. To find more information on using Bootstrap theming in your application,

see Bootstrap theming.

About

Clicking on the About item displays a dialog box, which is helpful in finding the version

number of ASP.NET Web Forms Edition and online resources.

Edit Templates

Clicking the Edit Templates item enters the C1AutoComplete Tasks Template Editing

Mode.

Context Menu The C1AutoComplete control has additional commands with the context menu that Visual

Studio provides for all .NET controls. To access the C1AutoComplete context menu, right-click

anywhere on the C1AutoComplete control. This will open the C1AutoComplete context menu.

The C1AutoComplete context menu includes the following custom commands added by

C1AutoComplete:

Show Smart Tag

Shows the smart tag for the C1AutoComplete control. For more information on how to

use the smart tag and available features, see C1AutoComplete Smart Tag.

http://helpcentral.componentone.com/nethelp/c1studioWeb/Bootstrap%20for%20ASP.NET%20Wijmo%20Quick%20Start.html


13

Add AutoCompleteItem

Clicking the Add AutoCompleteItem item opens the AutoComplete DesignerForm,

allowing you to add a child item to the C1AutoComplete control.

Edit Template

Clicking the Edit Templates item enters the C1AutoComplete Tasks Template Editing

Mode, allowing you to edit and apply a template to the C1AutoComplete control.

DesignerForm The AutoComplete Designer Form is C1AutoComplete's designer for editing its properties, as

well as the C1AutoCompleteDataItem properties. The AutoComplete Designer Form is

similar to the Properties window as it allows programmers to modify the control visually.

However, it allows you to select a C1AutoCompleteDataItem, set its properties, and then

preview the appearance of the C1AutoComplete control, all within the form.

In this topic you will become familiar with the AutoComplete Designer Form's design interface

so you can use the commands within it to edit C1AutoComplete with minimal effort and time.

To open the AutoComplete Designer Form , click the C1AutoComplete smart tag and select

the Add AutoCompleteItem link from the C1AutoComplete Tasks menu.

See Also

Exploring the AutoComplete DesignerForm

How to Use the Designer

Exploring the AutoComplete DesignerForm The AutoComplete DesignerForm contains a menu, a toolbar, an Edit tab, a Preview tab, and a

properties pane.


14

The Edit Tab

Click the Edit tab and select the C1AutoComplete control or the C1AutoCompleteDataItem for

which you would like to set the properties.

The Preview Tab

Click the Preview tab for a preview of the C1AutoComplete control.

The Properties Pane

The AutoComplete DesignerForm properties pane is almost identical to the Visual Studio

Properties window. Use the properties pane to change the properties for the C1AutoComplete

control or the C1AutoCompleteDataItem.


15

Command Buttons

There are two command buttons summarized in the following table:

Button Description

OK Clicking OK applies the new settings to the C1AutoComplete control.

Cancel Clicking Cancel closes the AutoComplete Designer Form, cancelling the new settings

and applying the default settings to the C1AutoComplete control.

AutoComplete DesignerForm Menu

The AutoComplete DesignerForm menu contains the following available menu items and

submenus:

Menu Item Submenu Item Description

File Exit Closes the AutoComplete Designer Form.

Edit Add Child Adds a new C1AutoCompleteDataItem as a child of the

C1AutoComplete or of another C1AutoCompleteDataItem.


16

Delete Removes the selected C1AutoCompleteDataItem.

Rename Allows you to change the name of the

C1AutoCompleteDataItem.

AutoComplete DesignerForm Toolbar

The AutoComplete DesignerForm Toolbar has options available depending on whether you

have selected the C1AutoComplete control or one of the C1AutoCompleteDataItems.

Note:The Move Item Left, Move Item Right, Insert Item, Cut, Copy, and Paste buttons

are not available.

The table below describes each available button on the toolbar and when they are available:

Button Name Description

Move Item Up Moves the selected C1AutoCompleteDataItem up in the list of

DataItems. This button is available when you select a


Move Item

Down

Moves the selected C1AutoCompleteDataItem down in the list of

DataItems. This button is available when you select a


Add Child Item Adds a C1AutoCompleteDataItem to the C1AutoComplete control.

This button is available when you select the C1AutoComplete

control.

Delete Deletes the selected C1AutoCompleteDataItem or the

C1AutoComplete control. This button is always available.

How to Use the Designer The following topics illustrate how to use the AutoComplete Designer Form for several tasks.

See Also


17

Deleting a C1AutoCompleteDataItem

Renaming the AutoCompleteDataItem in the Designer

Adding a Child Item

Deleting a C1AutoCompleteDataItem You can use one of the following three methods when deleting a C1AutoCompleteDataItem in

the designer:

Deleting a child item through the shortcut menu

Right-click the C1AutoCompleteDataItem you wish to delete and select Delete.

Deleting a child item by pressing on the delete button

Select the item you wish to delete and click on the Delete.

Deleting a child item through the Edit menu.

Click the Edit menu and select Delete.

Renaming the AutoCompleteDataItem in the

Designer You can use one of the following three methods when renaming a C1AutoCompleteDataItem in

the designer:

Pressing F2

1. Select the C1AutoCompleteDataItem you wish to rename.

2. Press the F2 key and type the new name.

Selecting rename from the shortcut menu

1. Right-click the C1AutoCompleteDataItem you wish to rename.

2. Select Rename from the context menu and type the new name.

Selecting rename from the Edit menu

1. Select the C1AutoCompleteDataItem you wish to rename.

2. Click the Edit menu, select Rename, and enter the new name.

Adding a Child Item You can use one of the following three methods when adding a C1AutoCompleteDataItem in

the designer:

Adding a child item through the shortcut menu

Right-click on the C1AutoComplete control and select Add Child | AutoComplete.


18

Adding a Data Item by pressing on the Add Child button

Select C1AutoComplete control, click on the Add Child button's drop-down arrow, and

select AutoComplete.

Adding a child item through the Edit menu

Select the C1AutoComplete control, click on the Edit menu, and select Add Child |

AutoComplete.

Elements This section provides a visual and descriptive overview of the elements that comprise the


The C1AutoComplete control is comprised of an input element and the AutoComplete element

that contains C1AutoCompleteDataItems:

See below for a description of each C1AutoComplete element:

Input Element

The input element allows users to enter the item for which they are searching and to

display the item selected from the AutoComplete element.

AutoComplete Element

The AutoComplete element contains C1AutoCompleteDataItem. They are either items

which you have created during design time or items which are populated from another

data source.

C1AutoCompleteDataItems

C1AutoCompleteDataItems can either be created at design time or can be called from

an outside data source.

Appearance C1AutoComplete is designed to make customization easy for you. The possibilities are endless

when it comes to changing your C1AutoComplete dialog window's appearance.


19

C1AutoComplete provides several styles for its input area and built-in themes, including those

for Office 2007.

In addition to the property styles for each dialog window element, C1AutoComplete provides

full support for CSS styles so you can further customize each dialog window element through

CSS styles.

See Also

Themes

CSS Selectors

Themes C1AutoComplete includes themes allowing you to easily change the control's appearance. The

control includes several built-in themes allowing you to customize the control's appearance to

your application. You can easily change themes from the C1AutoComplete Tasks menu, from

the Properties window, and in code.

The following themes are included in AutoComplete for ASP.NET Web Forms:

Visual Styles Preview

Arctic

Aristo

Cobalt


20

Midnight

Rocket

Sterling

CSS Selectors You can style many C1AutoComplete elements using CSS to make their appearance unique. To

make this customization easier, ComponentOne includes CSS selectors with each of its six built-

in themes.

You can apply general CSS properties such as border, background, text, font, margin, padding,

list, outline, and table to applicable CSS selectors.

For a list of common individual CSS selectors and grouped CSS selectors, select the

C1AutoComplete control in your project and view the drop-down list next to the CssClass

property in the Visual Studio Properties window.

C1AutoComplete CSS selectors begin with ui-autocomplete:


21

You can combine the individual CSS selectors as a group to make the CSS selector more specific

and strong.

Working with the Client-Side The AutoComplete for ASP.NET Web Forms controls have a very rich client-side object model

since most of their members are identical to the members in the server-side control.

When a C1AutoComplete control is rendered, and instance of the client-side control will be

created automatically. This means that you can enjoy the convenience of accessing the

properties and methods of the C1AutoComplete controls without having to postback to the

server.

Using client-side code, you can implement many features in your Web page without the need

to send informaion to the Web server, which takes time. Using the client-side object model

increases the efficiency of your Web site.

See Also

Client-Side Events

Client-Side Events AutoComplete for ASP.NET Web Forms includes several client-side events that allow you to

manipulate the C1AutoComplete controls when an action such as searching in the search box

occurs.

You can use the server-side properties, listed in the Client Side Event table, to specify the name

of the JavaScript function that will respond to a particular client-side event. For example, to


22

assign a JavaScript function called "Search" to respond when the AutoComplete window is

searched, you would set the OnClientSearch property to "search".

The following table lists the events that you can use in your client scripts. These properties are

defined on the server side, but the actual events of the name you declare for each JavaScript

function are defined on the client side.

Event Server-Side Property

Name Event Name Description

OnClientChange change Occurs when the control is

changed.

OnClientClose close Occurs when the control is

closed.

OnClientCreate create Occurs when the control is

created.

OnClientFocus focus Occurs when the control gains

focus.

OnClientOpen open Occurs when the control is

opened.

OnClientSearch search Occurs when a search is

performed.

OnClientSelect select Occurs when the control is

selected.

Task-Based Help The task-based help section assumes that you are familiar with programming in the Visual

Studio ASP.NET environment and have a general understanding of the AutoComplete for

ASP.NET Web Forms control.

Each topic provides a solution for specific tasks using C1AutoComplete. By following the steps

outlined in each topic, you will be able to create projects using a variety of C1AutoComplete

features.


23

Each task-based help topic assumes that you have created a new ASP.NET project.

See Also

Creating a C1AutoComplete Control in Code

Customizing the Width and Height of C1AutoComplete

Using the AutoPostBack Property

Using DataBinding

Using the LoadOnDemand Property

Creating a C1AutoComplete Control in

Code Show All

Hide All

Creating a C1AutoComplete control in code is an easy process. In this topic, you will add a

PlaceHolder control to the page, add an import statement, customize the C1AutoComplete

control, and add the control to the PlaceHolder.


1. In Design View, navigate to the Visual Studio Toolbox and add a PlaceHolder control

to the page.

2. Double-click the page to add a Page_Load event and switch to Code view.

3. Add the following statement to the top of the Code Editor to import the appropriate

namespace.

To write code in Visual Basic

Visual Basic Copy Code

Imports C1.Web.Wijmo.Controls.C1AutoComplete

To write code in C#

C# Copy Code


24

using C1.Web.Wijmo.Controls.C1AutoComplete;

4. Add the following code to the Page_Load event to create the control and add the

control to the PlaceHolder.



'Create a new C1AutoComplete

Dim C1A As New C1AutoComplete()

'Add the control to the PlaceHolder

PlaceHolder1.Controls.Add(C1A)

To write code in C#

C# Copy Code

//Create a new C1AutoComplete

C1AutoComplete C1A = new C1AutoComplete();

//Add the C1AutoComplete to the PlaceHolder control

PlaceHolder1.Controls.Add(C1A);

Customizing the Width and Height of

C1AutoComplete Show All

Hide All

This topic will take you through customizing the width and height of C1AutoComplete. This can

be done in Design View, in Source View, or in code.

In Design View


1. Select the C1AutoComplete control in your project and click the smart tag to open the

C1AutoComplete Tasks menu.

2. Set the Height property of the control to 150px.


25

3. Set the Width property of the control to 200px.

4. Press F5 to run the program and see the changes you made.

In Source View


1. Go to your project's Source View.

2. The Height and Widthproperties are both within the <cc1:C1AutoComplete> tags:

To write code in Source View

<cc1:C1Complete ID="C1AutoComplete1" runat="server"

Height="200px" Width="200px">

3. Set the Height and Width properties to 200px.

4. Press F5 to run your program.

In Code

Add the following code to the Page_Load event to set the Height and Width properties of the




Me.C1AutoComplete1.Height = 150

Me.AutoComplete1.Width = 200

To write code in C#

C# Copy Code

this.C1AutoComplete1.Height = 150;

this.C1AutoComplete1.Width = 200;

Working with C1AutoComplete CSS Selectors

C1AutoComplete supports CSS styling, enabling you to completely customize the control's

appearance. This topic will walk you through applying CSS styling to the C1AutoComplete

control.

1. In Design View, select View | Properties from the Visual Sutdio menu. Select

C1AutoComplete from the drop-down list at the top of the Properies window and

locate the CssClass property.


26

2. Use the drop-down list to choose the appropriate CSS selector, for this topic, choose

the ui-autocomplete selector.

3. Switch to Source View and locate the first set of <asp:Content> tags.

4. Insert <style type="text/css"></style> tags between the <asp:Content>

tags. This set of tags will allow you to add CSS styling to your control.

5. Insert the following script between the <style> tags to add CSS styling to your

control.

6. Run your program. The C1AutoComplete control should appear as in the following

image.

Using the AutoPostBack Property Show All

Hide All

The AutoPostBack property indicates whether or not the control posts back to the server each

time a user interacts with the control. This topic will walk you through creating a

C1AutoComplete control, setting the content, and setting the AutoPostBack property.


1. Add a C1AutoComplete control and a standard ListBox control to your application.

Your Design view should resemble the following image:


27

2. Select the C1AutoComplete control on your page and then navigate to the Visual

Studio Properties window. Locate the AutoPostBack property in the list and set it to

True.

3. Click the Events button to view the C1AutoComplete Events. Locate the

ItemSelected event and enter C1AutoComplete1_ItemSelected.

4. Switch to Source view and locate the <cc1:C1AutoComplete>

</cc1:C1AutoComplete> tags. Insert the following markup between the tags to

create your C1AutoCompleteDataItems.


<Items>

<cc1:C1AutoCompleteDataItem Label="c++" Value="c++" />

<cc1:C1AutoCompleteDataItem Label="java" Value="java"

/>

<cc1:C1AutoCompleteDataItem Label="php" Value="php" />

<cc1:C1AutoCompleteDataItem Label="coldfusion"

Value="coldfusion"/>

<cc1:C1AutoCompleteDataItem Label="javascript"

Value="javascript"/>

<cc1:C1AutoCompleteDataItem Label="asp" Value="asp" />

<cc1:C1AutoCompleteDataItem Label="ruby" Value="ruby"

/>

<cc1:C1AutoCompleteDataItem Label="python"

Value="python" />

<cc1:C1AutoCompleteDataItem Label="c" Value="c" />

<cc1:C1AutoCompleteDataItem Label="scala"

Value="scala" />

<cc1:C1AutoCompleteDataItem Label="groovy"

Value="groovy" />

<cc1:C1AutoCompleteDataItem Label="haskell"

Value="haskell" />

<cc1:C1AutoCompleteDataItem Label="perl" Value="perl"

/>

</Items>

5. Locate the <asp:ListBox></asp:ListBox> tags and add the following markup to

govern the width and height of the ListBox control:


Width="300px" Height="300px"

6. Right-click the Source view and select View Code from the list. There should be code

that resembles the following that Visual Studio created to handle the ItemSelected

event you set previously:




28

Protected Sub C1AutoComplete1_ItemSelected(ByVal sender As Object, ByVal args

As C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemEventArgs)

End Sub

To write code in C#

C# Copy Code

protected void C1AutoComplete1_ItemSelected(object sender,

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemEventArgs args)

7. Place the following code below the ItemSelected event handler. This code will handle

adding a new item to the ListBox control from the C1AutoComplete control:



ListBox1.Items.Add(New ListItem(C1AutoComplete1.Text))

To write code in C#

C# Copy Code

ListBox1.Items.Add(new ListItem(C1AutoComplete1.Text));

8. Press F5 to run your application. Enter "ja" into the search box and select one of the

AutoCompleteDataItems that appears. Select the item to observe the AutoPostBack

property. The application should resemble the following image:


29

Using DataBinding C1AutoComplete supports data binding which allows you to bind the label, value, and category

fields to a data source of your choice.


1. Right-click on the App_Data folder in the Solution Explorer and select Add | Existing

Item from the list.

2. Locate the C1Nwind.mdb database in your ComponentOne Samples folder and click

Add.

3. Select the C1AutoComplete control in your project.

4. Click the smart tag button to open the C1AutoComplete Tasks menu.

5. Click the arrow on the Choose Data Source drop-down list and select New Data

Source from the list. This will open the Data Source Configuration Wizard.

6. Select SqlDatabase from the list and click OK. In the Choose Your Data Connection

window, choose ConnectionString as your data connection and click Next.

7. In the Configure Select Statement window, select Products from the drop-down list

under Specify columns from a table or view and click Next.

8. Click Test Query to make sure the database is properly queried and then click Finish.

9. Press F5 to run your application. Type a few letters into the search box to test the

AutoComplete function.

Using the LoadOnDemand Property The LoadOnDemand property allows you to retrieve data dynamically. The child items are

loaded when the user begins typing in the search box.


1. Right-click on the App_Data folder in the Solution Explorer and select Add | Existing

Item from the list.


30

2. Locate the C1Nwind.mdb database in your ComponentOne Samples folder and click

Add to add the database to your project.

3. Select the C1AutoComplete control in your project.

4. Click the smart tag button to open the C1AutoComplete Tasks menu.

5. Click the arrow on the Choose Data Source drop-down list and select New Data

Source from the list. This will open the Data Source Configuration Wizard.

6. Select SqlDatabase from the list and click OK. In the Choose Your Data Connection

window, use the drop-down menu to choose C1Nwind.mdb as your data connection

and click Next.

7. In the Configure Select Statement window, select Products from the drop-down list

under Specify columns from a table or view and click Next.

8. Click Test Query to make sure the database is properly queried and then click Finish.

9. Select the C1AutoComplete control in your project and then navigate to the Properties

window.

10. Locate the LoadOnDemand property in the Properties window and set it to True.

11. Still in the Properties window, locate the MaxCount property and set it to 5. This

property will limit the number of search results in the AutoComplete and must be used

with the LoadOnDemand property.

12. Press F5 to run your application and type "E" into the search box. The results should

resemble the following image:

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 Web site 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 AutoComplete

for ASP.NET Web Forms, 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 Web Forms control.

See Also

http://www.componentone.com/SuperPages/webstack/

http://wijmo.com/widgets/


31

Using the Wijmo CDN

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:


 <script src="http://code.jquery.com/jquery-

1.9.1.min.js"type="text/javascript"></script> <script src="http://code.jquery.com/ui/1.10.1/jquery-ui.min.js"

type="text/javascript"></script>

 <link href="http://cdn.wijmo.com/themes/aristo/jquery-wijmo.css"

rel="stylesheet" type="text/css" />

 <link href="http://cdn.wijmo.com/jquery.wijmo-

pro.all.3.20132.8.min.css" rel="stylesheet" type="text/css" />

 <script src="http://cdn.wijmo.com/jquery.wijmo-

open.all.3.20132.8.min.js" type="text/javascript"></script> <script src="http://cdn.wijmo.com/jquery.wijmo-

pro.all.3.20132.8.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-pro.all.3.20132.8.min.js

With ASP.NET Web Forms Edition 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.

http://wijmo.com/downloads/cdn/


32

C1.Web.Wijmo.Controls.4 Assembly

Namespaces

C1.Web.Wijmo.Controls Namespace

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


33

Inheritance Hierarchy

System.Object

C1.Web.Wijmo.Controls.C1BaseStateManager

See Also

Reference

C1BaseStateManager Members


Overview Base class to support view state management for a server control.

Object Model

Syntax


Public MustInherit Class C1BaseStateManager

C#

public abstract class C1BaseStateManager


System.Object

C1.Web.Wijmo.Controls.C1BaseStateManager

See Also

Reference

C1BaseStateManager Members


Members The following tables list the members exposed by C1BaseStateManager.

See Also

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls_namespace.html



34

Reference

C1BaseStateManager Class


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


<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


System.Object

System.Web.UI.Control


C1.Web.Wijmo.Controls.C1TargetControlBase

See Also

Reference

C1TargetControlBase Members


Overview Class to be used as base for the wijmo extenders target controls. Class to be used as base for

the wijmo target controls.




35

Object Model

Syntax



Public MustInherit Class C1TargetControlBase

Inherits System.Web.UI.WebControls.WebControl

C#


public abstract class C1TargetControlBase :



System.Object



C1.Web.Wijmo.Controls.C1TargetControlBase

See Also

Reference



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)


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~AccessKey.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~AppRelativeTemplateSourceDirectory.html


36

Attributes (Inherited from


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)

ControlStyle (Inherited from


ControlStyleCreated (Inherited from


CssClass (Inherited from


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


EnableViewState (Inherited from System.Web.UI.Control)

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Attributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ClientID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ClientIDMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Controls.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ControlStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ControlStyleCreated.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~CssClass.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~EnableTheming.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~EnableViewState.html


37

HasAttributes (Inherited from


Height (Inherited from


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


Style (Inherited from


SupportsDisabledAttribute (Inherited from


TabIndex (Inherited from


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

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~HasAttributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Height.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~NamingContainer.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Page.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Parent.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~RenderingCompatibility.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Site.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~SkinID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Style.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~SupportsDisabledAttribute.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~TabIndex.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~TemplateControl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~TemplateSourceDirectory.html


38

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


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


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)

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ToolTip.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~UniqueID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ValidateRequestMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ViewStateMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Width.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ApplyStyle.html


39

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)

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)

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ApplyStyleSheetSkin.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~CopyBaseAttributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~DataBind().html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Dispose.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~FindControl(String).html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Focus.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~GetRouteUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~GetUniqueIDRelativeTo.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~HasControls.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~MergeStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~RenderBeginTag.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~RenderControl(HtmlTextWriter).html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~RenderEndTag.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ResolveClientUrl.html


40

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)

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


Methods For a list of all members of this type, see C1TargetControlBase members.

Public Methods

Name Description


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ResolveUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~SetRenderMethodDelegate.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~DataBinding_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Disposed_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Init_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Load_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~PreRender_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Unload_EV.html


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ApplyStyle.html


41



DataBind (Inherited from System.Web.UI.Control)




GetPropertyValue<V> Gets the property value by property name.


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.




RegisterDesignTimeStyleSheet Register design time stylesheet





C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ApplyStyleSheetSkin.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~CopyBaseAttributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~DataBind().html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Dispose.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~FindControl(String).html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Focus.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~GetRouteUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~GetUniqueIDRelativeTo.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~HasControls.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~MergeStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~RenderBeginTag.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~RenderControl(HtmlTextWriter).html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~RenderEndTag.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ResolveClientUrl.html


42


SetPropertyValue<V> Sets the property value by property name.


Top

See Also

Reference



GetPropertyValue<V> Method Gets the property value by property name.

Syntax


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

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ResolveUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~SetRenderMethodDelegate.html



43

See Also

Reference



GetScriptDescriptors Method When overridden in a derived class, registers the WidgetDescriptor objects for the control.

Syntax


Public Overridable Function GetScriptDescriptors() As

System.Collections.Generic.IEnumerable(Of ScriptDescriptor)

C#

public virtual System.Collections.Generic.IEnumerable<ScriptDescriptor>

GetScriptDescriptors()

Return Value

An enumeration of WidgetDescriptor objects.

See Also

Reference



GetScriptReferences Method When overridden in a derived class, registers an additional script libraries for the extender

control.

Syntax


Public Overridable Function GetScriptReferences() As

System.Collections.Generic.IEnumerable(Of ScriptReference)

C#


44

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



RegisterDesignTimeStyleSheet Method The System.Web.UI.HtmlTextWriter object that receives the server control content.

resource name of stylesheet file

Register design time stylesheet

Syntax


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


45

Reference



SetPropertyValue<V> Method Sets the property value by property name.

Syntax


Public Sub SetPropertyValue(Of V)( _

ByVal propertyName As System.String, _

ByVal value As V _

)

C#

public void SetPropertyValue<V>(

System.string propertyName,

V value

)

Parameters

propertyName

Name of the property.

value

The value.

Type Parameters

V

See Also

Reference



Properties For a list of all members of this type, see C1TargetControlBase members.


46

Public Properties

Name Description



AppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)



CDNDependencyPaths A string array value specifies all css/js references that

wijmo control depends on.

CDNPath Content Delivery Network path.










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.

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~AccessKey.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~AppRelativeTemplateSourceDirectory.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Attributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ClientID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ClientIDMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Controls.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ControlStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ControlStyleCreated.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~CssClass.html


47

Enabled Overridden. Gets or sets a value indicating whether

the Web server control is enabled.






















C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~EnableTheming.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~EnableViewState.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~HasAttributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Height.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~NamingContainer.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Page.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Parent.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~RenderingCompatibility.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Site.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~SkinID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Style.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~SupportsDisabledAttribute.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~TabIndex.html


48



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




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.





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

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~TemplateControl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~TemplateSourceDirectory.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ToolTip.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~UniqueID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ValidateRequestMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~ViewStateMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1TargetControlBase~Width.html


49

See Also

Reference



CDNDependencyPaths Property A string array value specifies all css/js references that wijmo control depends on.

Syntax


<C1CategoryAttribute("Behavior")>

<System.ComponentModel.RefreshPropertiesAttribute(RefreshProperties.All)>

<C1DescriptionAttribute(Key="C1Base.CDNDependencyPaths", Description="A

string array value specifies all css/js references that wijmo control depends

on.")>

<System.ComponentModel.DefaultValueAttribute()>

<System.ComponentModel.DesignerSerializationVisibilityAttribute(DesignerSeria

lizationVisibility.Hidden)>

Public Overridable Property CDNDependencyPaths As System.String()

C#

[C1Category("Behavior")]

[System.ComponentModel.RefreshProperties(RefreshProperties.All)]

[C1Description(Key="C1Base.CDNDependencyPaths", Description="A string

array value specifies all css/js references that wijmo control depends

on.")]

[System.ComponentModel.DefaultValue()]

[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"]



50

See Also

Reference



CDNPath Property Content Delivery Network path.

Syntax




<C1DescriptionAttribute(Key="C1Base.CDNPath", Description="Content Delivery

Network path.")>




Public Overridable Property CDNPath As System.String

C#



[C1Description(Key="C1Base.CDNPath", Description="Content Delivery

Network path.")]




public virtual System.string CDNPath {get; set;}

See Also

Reference



DisplayVisible Property Gets or sets a value that indicates whether a server control is rendered as UI on the page.

Syntax


51



<WidgetOptionAttribute()>

<C1DescriptionAttribute(Key="C1Controls.DisplayVisible", Description="Gets or

sets a value that indicates whether a server control is rendered as UI on the

page.")>


<LayoutAttribute(LayoutType.Behavior)>

Public Property DisplayVisible As System.Boolean

C#


[WidgetOption()]

[C1Description(Key="C1Controls.DisplayVisible", Description="Gets or sets a

value that indicates whether a server control is rendered as UI on the

page.")]


[Layout(LayoutType.Behavior)]

public System.bool DisplayVisible {get; set;}

Remarks

Note that a server control is created and invisible if DisplayVisible is set to false.

See Also

Reference



EnableCombinedJavaScripts Property Enable JavaScripts files combined into one file. In order to combined enabled, you must register

the WijmoHttpHandler in web.config.

Syntax


<C1DescriptionAttribute(Key="C1Base.EnableCombinedJavaScripts",

Description="Enable JavaScripts files combined into one file.")>



52




Public Overridable Property EnableCombinedJavaScripts As System.Boolean

C#

[C1Description(Key="C1Base.EnableCombinedJavaScripts",

Description="Enable JavaScripts files combined into one file.")]





public virtual System.bool EnableCombinedJavaScripts {get; set;}

See Also

Reference



Enabled Property Gets or sets a value indicating whether the Web server control is enabled.

Syntax




<C1DescriptionAttribute(Key="C1Base.Enabled", Description="Indicates whether

control is enabled.")>


Public Overrides Property Enabled As System.Boolean

C#

[WidgetOption()]


[C1Description(Key="C1Base.Enabled", Description="Indicates whether control

is enabled.")]


public override System.bool Enabled {get; set;}

Property Value


53

true if control is enabled; otherwise, false. The default is true.

See Also

Reference



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


<TypeConverterAttribute("C1.Web.Wijmo.Controls.WijmoThemeNameConverter,

C1.Web.Wijmo.Controls.4, Version=4.0.20151.207, Culture=neutral,

PublicKeyToken=9b75583953471eea")>



<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.")>




Public Overridable Property Theme As System.String

C#

[TypeConverter("C1.Web.Wijmo.Controls.WijmoThemeNameConverter,


PublicKeyToken=9b75583953471eea")]



[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.")]


54




public virtual System.string Theme {get; set;}

See Also

Reference



ThemeSwatch Property A value that indicates the theme swatch of the control, this property only works when


Syntax


<C1CategoryAttribute("Appearance")>





<C1DescriptionAttribute(Key="C1Base.ThemeSwatch", Description="A value that

indicates the theme swatch of the control, this property only works when

WijmoControlMode property is Mobile.")>

<TypeConverterAttribute("C1.Web.Wijmo.Controls.WijmoThemeSwatchConverter,



Public Overridable Property ThemeSwatch As System.String

C#

[C1Category("Appearance")]

[WidgetOption()]




[C1Description(Key="C1Base.ThemeSwatch", Description="A value that

indicates the theme swatch of the control, this property only works when

WijmoControlMode property is Mobile.")]

[TypeConverter("C1.Web.Wijmo.Controls.WijmoThemeSwatchConverter,


55



public virtual System.string ThemeSwatch {get; set;}

See Also

Reference



UseCDN Property Determines whether the widget extender must load client resources from CDN (Content

Delivery Network) path given by property CDNPath.

Syntax


<C1DescriptionAttribute(Key="C1Base.UseCDN", Description="Determines whether

this extender loads client script references from CDN.")>






Public Overridable Property UseCDN As System.Boolean

C#

[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




56

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



<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.")>





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.")]





public virtual WijmoControlMode WijmoControlMode {get; set;}

See Also

Reference



WijmoCssAdapter Property Indicates the control applies the theme of JQuery UI or Bootstrap.

Syntax



57



<C1DescriptionAttribute(Key="C1Base.WijmoCssAdapter", Description="Indicates

the control applies the theme of JQuery UI or Bootstrap.")>


<TypeConverterAttribute("C1.Web.Wijmo.Controls.WijmoCssAdapterConverter,





Public Overridable Property WijmoCssAdapter As System.String

C#



[C1Description(Key="C1Base.WijmoCssAdapter", Description="Indicates the

control applies the theme of JQuery UI or Bootstrap.")]


[TypeConverter("C1.Web.Wijmo.Controls.WijmoCssAdapterConverter,





public virtual System.string WijmoCssAdapter {get; set;}

See Also

Reference



C1TargetControlHelper

Object Model

Syntax


Friend Class C1TargetControlHelper


58

C#

internal class C1TargetControlHelper


System.Object

C1.Web.Wijmo.Controls.C1TargetControlHelper

C1.Web.Wijmo.Controls.C1TargetControlHelper<T>

See Also

Reference

C1TargetControlHelper Members


Overview

Object Model

Syntax


Friend Class C1TargetControlHelper

C#

internal class C1TargetControlHelper


System.Object



See Also

Reference






59

Members The following tables list the members exposed by C1TargetControlHelper.

Public Constructors

Name Description

C1TargetControlHelper Constructor

Top

Public Methods

Name Description

ResolveEmbeddedResourceUrl

Top

See Also

Reference

C1TargetControlHelper Class


C1TargetControlHelper Constructor

Syntax


Public Function New()

C#

public C1TargetControlHelper()

See Also

Reference





60

Methods For a list of all members of this type, see C1TargetControlHelper members.

Public Methods

Name Description

ResolveEmbeddedResourceUrl

Top

See Also

Reference



ResolveEmbeddedResourceUrl Method

Syntax


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



61

Reference



C1TargetControlHelper<T>

Object Model

Syntax


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


System.Object



See Also

Reference

C1TargetControlHelper<T> Members


Overview

Object Model



62

Syntax


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


System.Object



See Also

Reference



Members The following tables list the members exposed by C1TargetControlHelper<T>.

Public Constructors

Name Description

C1TargetControlHelper<T> Constructor

Top

Public Properties

Name Description



63

Control

JsonSerializableHelper

Page

ScriptManager

Top

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

RegisterScriptDescriptors

RegisterScriptDescriptorsWithoutScriptManager

RegisterScriptDescriptorsWithScriptManager

RenderJsonDataField

ShowAbout Show about message box.


64

Top

See Also

Reference

C1TargetControlHelper<T> Class


C1TargetControlHelper<T> Constructor

Syntax


Public Function New( _

ByVal control As T _

)

C#

public C1TargetControlHelper<T>(

T control

)

Parameters

control

See Also

Reference



Methods For a list of all members of this type, see C1TargetControlHelper<T> members.

Public Methods

Name Description

EnsureEnabledState



65

GetScriptDescriptors Overloaded. When overridden in a derived

class, registers the WidgetDescriptor


RegisterDesignTimeStyleSheet Register design-time CSS stylesheet.

RegisterDesignTimeStyleSheets

RegisterIncludes

RegisterOnSubmitStatement

RegisterRunTimeStylesheets

RegisterScriptDescriptors

RegisterScriptDescriptorsWithoutScriptManager

RegisterScriptDescriptorsWithScriptManager

RenderJsonDataField

ShowAbout Show about message box.

Top

See Also

Reference



EnsureEnabledState Method

Syntax


Public Sub EnsureEnabledState()

C#



66

public void EnsureEnabledState()

See Also

Reference



GetScriptDescriptors Method When overridden in a derived class, registers the WidgetDescriptor objects for the control.

Overload List

Overload Description

GetScriptDescriptors() When overridden in a derived class, registers the WidgetDescriptor


GetScriptDescriptors(String) When overridden in a derived class, registers the WidgetDescriptor


See Also

Reference



GetScriptDescriptors() Method

When overridden in a derived class, registers the WidgetDescriptor objects for the control.

Syntax


Public Overloads Function GetScriptDescriptors() As

System.Collections.Generic.IEnumerable(Of ScriptDescriptor)

C#

public System.Collections.Generic.IEnumerable<ScriptDescriptor>

GetScriptDescriptors()

Return Value


67


See Also

Reference



Overload List

GetScriptDescriptors(String) Method

When overridden in a derived class, registers the WidgetDescriptor objects for the control.

Syntax


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


See Also

Reference



Overload List

RegisterDesignTimeStyleSheet Method Register design-time CSS stylesheet.


68

Syntax


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

cssResourceName

CSS resource name.

Remarks

The cssResourceName is the link to an resource element.

See Also

Reference



RegisterDesignTimeStyleSheets Method

Syntax


Public Sub RegisterDesignTimeStyleSheets( _

ByVal writer As System.Web.UI.HtmlTextWriter _

)

C#


69

public void RegisterDesignTimeStyleSheets(

System.Web.UI.HtmlTextWriter writer

)

Parameters

writer

See Also

Reference



RegisterIncludes Method

Syntax


Public Sub RegisterIncludes()

C#

public void RegisterIncludes()

See Also

Reference



RegisterOnSubmitStatement Method

Syntax


Public Sub RegisterOnSubmitStatement( _

Optional ByVal callback As System.String _

)

C#

public void RegisterOnSubmitStatement(

System.string callback


70

)

Parameters

callback

See Also

Reference



RegisterRunTimeStylesheets Method

Syntax


Public Sub RegisterRunTimeStylesheets()

C#

public void RegisterRunTimeStylesheets()

See Also

Reference



RegisterScriptDescriptors Method

Syntax


Public Sub RegisterScriptDescriptors()

C#

public void RegisterScriptDescriptors()

See Also

Reference




71

RegisterScriptDescriptorsWithoutScriptManager Method

Syntax


Public Sub RegisterScriptDescriptorsWithoutScriptManager()

C#

public void RegisterScriptDescriptorsWithoutScriptManager()

See Also

Reference



RegisterScriptDescriptorsWithScriptManager Method

Syntax


Public Sub RegisterScriptDescriptorsWithScriptManager()

C#

public void RegisterScriptDescriptorsWithScriptManager()

See Also

Reference



RenderJsonDataField Method

Syntax


Public Sub RenderJsonDataField( _

ByVal writer As System.Web.UI.HtmlTextWriter _

)


72

C#

public void RenderJsonDataField(

System.Web.UI.HtmlTextWriter writer

)

Parameters

writer

See Also

Reference



ShowAbout Method Show about message box.

Syntax


Public Sub ShowAbout()

C#

public void ShowAbout()

See Also

Reference



Properties For a list of all members of this type, see C1TargetControlHelper<T> members.

Public Properties

Name Description

Control


73

JsonSerializableHelper

Page

ScriptManager

Top

See Also

Reference



Control Property

Syntax


Public ReadOnly Property Control As T

C#

public T Control {get;}

See Also

Reference



JsonSerializableHelper Property

Syntax


Public ReadOnly Property JsonSerializableHelper As JsonSerializableHelper

C#

public JsonSerializableHelper JsonSerializableHelper {get;}

See Also



74

Reference



Page Property

Syntax


Public ReadOnly Property Page As System.Web.UI.Page

C#

public System.Web.UI.Page Page {get;}

See Also

Reference



ScriptManager Property

Syntax


Public ReadOnly Property ScriptManager As System.Web.UI.ScriptManager

C#

public System.Web.UI.ScriptManager ScriptManager {get;}

See Also

Reference



ConditionalDependencyProxy Proxy class that assists WidgetDependenciesResolver to resolve conditional dependencies. Any

class that wants to specify WidgetConditionalDependency attribute should be derived from it.

No dependencies here, derived classes must have default constructor only.


75

Object Model

Syntax


Friend MustInherit Class ConditionalDependencyProxy

C#

internal abstract class ConditionalDependencyProxy


System.Object

C1.Web.Wijmo.Controls.ConditionalDependencyProxy

See Also

Reference

ConditionalDependencyProxy Members


Overview Proxy class that assists WidgetDependenciesResolver to resolve conditional dependencies. Any

class that wants to specify WidgetConditionalDependency attribute should be derived from it.

No dependencies here, derived classes must have default constructor only.

Object Model

Syntax


Friend MustInherit Class ConditionalDependencyProxy

C#

internal abstract class ConditionalDependencyProxy




76

System.Object

C1.Web.Wijmo.Controls.ConditionalDependencyProxy

See Also

Reference

ConditionalDependencyProxy Members


Members The following tables list the members exposed by ConditionalDependencyProxy.

See Also

Reference

ConditionalDependencyProxy Class


C1.Web.Wijmo.Controls.C1AutoComplete

Namespace

Classes

AutoCompleteSourceOption

Object Model

Syntax


Public Class AutoCompleteSourceOption

C#

public class AutoCompleteSourceOption





77

System.Object

C1.Web.Wijmo.Controls.C1AutoComplete.AutoCompleteSourceOption

See Also

Reference

AutoCompleteSourceOption Members

C1.Web.Wijmo.Controls.C1AutoComplete Namespace

Overview

Object Model

Syntax


Public Class AutoCompleteSourceOption

C#

public class AutoCompleteSourceOption


System.Object

C1.Web.Wijmo.Controls.C1AutoComplete.AutoCompleteSourceOption

See Also

Reference



Members The following tables list the members exposed by AutoCompleteSourceOption.

Public Constructors

Name Description

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete_namespace.html



78

AutoCompleteSourceOption Constructor

Top

Public Properties

Name Description

CallBack Gets or sets a callback function that provides the most flexibility and can

be used to connect any data source to Autocomplete.

Labels Gets or sets an array can be used for local data.

Url Gets or sets a string to point to a URL resource that will return JSON

data.

Top

See Also

Reference

AutoCompleteSourceOption Class


AutoCompleteSourceOption Constructor

Syntax



C#

public AutoCompleteSourceOption()

See Also

Reference





79

Properties For a list of all members of this type, see AutoCompleteSourceOption members.

Public Properties

Name Description

CallBack Gets or sets a callback function that provides the most flexibility and can

be used to connect any data source to Autocomplete.

Labels Gets or sets an array can be used for local data.

Url Gets or sets a string to point to a URL resource that will return JSON

data.

Top

See Also

Reference



CallBack Property Gets or sets a callback function that provides the most flexibility and can be used to connect

any data source to Autocomplete.

Syntax


<C1DescriptionAttribute(Key="C1AutoComplete.AutoCompleteSourceOption.CallBack

", Description="Gets or sets a callback function that provides the most

flexibility and can be used to connect any data source to Autocomplete.")>

Public Property CallBack As System.String

C#

[C1Description(Key="C1AutoComplete.AutoCompleteSourceOption.CallBack",

Description="Gets or sets a callback function that provides the most

flexibility and can be used to connect any data source to Autocomplete.")]

public System.string CallBack {get; set;}



80

See Also

Reference



Labels Property Gets or sets an array can be used for local data.

Syntax


<C1DescriptionAttribute(Key="C1AutoComplete.AutoCompleteSourceOption.Labels",

Description="Gets or sets an array can be used for local data.")>

Public Property Labels As System.String()

C#

[C1Description(Key="C1AutoComplete.AutoCompleteSourceOption.Labels",

Description="Gets or sets an array can be used for local data.")]

public System.string[] Labels {get; set;}

See Also

Reference



Url Property Gets or sets a string to point to a URL resource that will return JSON data.

Syntax


<C1DescriptionAttribute(Key="C1AutoComplete.AutoCompleteSourceOption.Url",

Description="Gets or sets a string to point to a URL resource that will

return JSON data.")>

Public Property Url As System.String

C#

[C1Description(Key="C1AutoComplete.AutoCompleteSourceOption.Url",


81

Description="Gets or sets a string to point to a URL resource that will

return JSON data.")]

public System.string Url {get; set;}

See Also

Reference



C1AutoComplete

Object Model

Syntax


<System.Web.UI.ParseChildrenAttribute(True)>

<System.ComponentModel.LicenseProviderAttribute()>


<System.Web.UI.ToolboxDataAttribute("<{0}:C1AutoComplete

runat="server"></{0}:C1AutoComplete>")>

<System.Drawing.ToolboxBitmapAttribute()>

<System.ComponentModel.DesignerAttribute(DesignerBaseTypeName="System.Compone

ntModel.Design.IDesigner",

DesignerTypeName="C1.Web.Wijmo.Controls.Design.C1AutoComplete.C1AutoCompleteD

esigner, C1.Web.Wijmo.Controls.Design.4, Version=4.0.20151.207,

Culture=neutral, PublicKeyToken=9b75583953471eea")>

Public Class C1AutoComplete

Inherits C1.Web.Wijmo.Controls.Base.C1TargetDataBoundControlBase

C#

[System.Web.UI.ParseChildren(true)]

[System.ComponentModel.LicenseProvider()]


[System.Web.UI.ToolboxData("<{0}:C1AutoComplete

runat="server"></{0}:C1AutoComplete>")]

[System.Drawing.ToolboxBitmap()]

[System.ComponentModel.Designer(DesignerBaseTypeName="System.ComponentMod


82

el.Design.IDesigner",

DesignerTypeName="C1.Web.Wijmo.Controls.Design.C1AutoComplete.C1AutoCompl

eteDesigner, C1.Web.Wijmo.Controls.Design.4, Version=4.0.20151.207,

Culture=neutral, PublicKeyToken=9b75583953471eea")]

public class C1AutoComplete :

C1.Web.Wijmo.Controls.Base.C1TargetDataBoundControlBase


System.Object



System.Web.UI.WebControls.BaseDataBoundControl

System.Web.UI.WebControls.DataBoundControl

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete

See Also

Reference

C1AutoComplete Members


Overview

Object Model

Syntax


<System.Web.UI.ParseChildrenAttribute(True)>

<System.ComponentModel.LicenseProviderAttribute()>


<System.Web.UI.ToolboxDataAttribute("<{0}:C1AutoComplete

runat="server"></{0}:C1AutoComplete>")>

<System.Drawing.ToolboxBitmapAttribute()>

<System.ComponentModel.DesignerAttribute(DesignerBaseTypeName="System.Compone

ntModel.Design.IDesigner",

DesignerTypeName="C1.Web.Wijmo.Controls.Design.C1AutoComplete.C1AutoCompleteD

esigner, C1.Web.Wijmo.Controls.Design.4, Version=4.0.20151.207,

Culture=neutral, PublicKeyToken=9b75583953471eea")>



83

Public Class C1AutoComplete

Inherits C1.Web.Wijmo.Controls.Base.C1TargetDataBoundControlBase

C#

[System.Web.UI.ParseChildren(true)]

[System.ComponentModel.LicenseProvider()]


[System.Web.UI.ToolboxData("<{0}:C1AutoComplete

runat="server"></{0}:C1AutoComplete>")]

[System.Drawing.ToolboxBitmap()]

[System.ComponentModel.Designer(DesignerBaseTypeName="System.ComponentMod

el.Design.IDesigner",

DesignerTypeName="C1.Web.Wijmo.Controls.Design.C1AutoComplete.C1AutoCompl

eteDesigner, C1.Web.Wijmo.Controls.Design.4, Version=4.0.20151.207,

Culture=neutral, PublicKeyToken=9b75583953471eea")]

public class C1AutoComplete :

C1.Web.Wijmo.Controls.Base.C1TargetDataBoundControlBase


System.Object



System.Web.UI.WebControls.BaseDataBoundControl

System.Web.UI.WebControls.DataBoundControl

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete

See Also

Reference



Members The following tables list the members exposed by C1AutoComplete.

Public Constructors

Name Description

C1AutoComplete Constructor Initializes a new instance of the C1AutoComplete class.

Top



84

Public Properties

Name Description



AppendTo Which element the menu should be appended to.

Reference:

http://jqueryui.com/demos/autocomplete/#appendTo

AppRelativeTemplateSourceDirector

y

(Inherited from System.Web.UI.Control)



AutoFocus If set to true the first item will be automatically

focused. Reference:

http://jqueryui.com/demos/autocomplete/#autoFocus

AutoPostBack Gets or sets the value that indicates whether or not

the control posts back to the server each time a user

interacts with the control.








C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~AccessKey.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~AppRelativeTemplateSourceDirectory.html


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Attributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ClientID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ClientIDMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Controls.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ControlStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ControlStyleCreated.html


85



DataCategoryField Gets or sets the name of the field from the data

source to bind to the category.

DataLabelField Gets or sets the name of the field from the data

source to bind to the label.

DataMember (Inherited from

System.Web.UI.WebControls.DataBoundControl)

DataSource (Inherited from

System.Web.UI.WebControls.BaseDataBoundControl)

DataSourceID (Inherited from


DataSourceObject (Inherited from


DataValueField Gets or sets the name of the field from the data

source to bind to the value.

Delay The delay in milliseconds the Autocomplete waits

after a keystroke to activate itself. A zero-delay makes

sense for local data (more responsive), but can

produce a lot of load for remote data, while being less

responsive. Reference:

http://jqueryui.com/demos/autocomplete/#delay





C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~CssClass.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataMember.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataSource.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataSourceID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataSourceObject.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~EnableTheming.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~EnableViewState.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~HasAttributes.html


86





Items Gets a C1AutoCompleteDataItemCollection object

that contains the items of the current


ItemType (Inherited from


LoadOnDemand Gets or sets the value that indicates whether or not

Loads on demand is enabled. If it set to true, the auto

complete will get suggestions from datasource you

specified.

MaxCount Gets or sets the value that indicates the max number

of callback results (you must specified the data source

and set property "LoadOnDemand" to true) .

MaxLength The attribute "maxlength" of textbox.

MinLength The minimum number of characters a user has to type

before the Autocomplete activates. Zero is useful for

local data with just a few items. Should be increased

when there are a lot of items, where a single character

would match a few thousand items. Reference:

http://jqueryui.com/demos/autocomplete/#minLengt

h


OnClientChange The name of the function which will be called when

the field is blurred, if the value has changed; ui.item

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Height.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ItemType.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~NamingContainer.html


87

refers to the selected item.

OnClientClose The name of the function which will be called when

the list is hidden - doesn't have to occur together with

a change.

OnClientCreate The name of the function which will be called when

autocomplete is created.

OnClientFocus The name of the function which will be called before

focus is moved to an item (not selecting), ui.item

refers to the focused item. The default action of focus

is to replace the text field's value with the value of the

focused item, though only if the focus event was

triggered by a keyboard interaction. Canceling this

event prevents the value from being updated, but

does not prevent the menu item from being focused.

OnClientOpen The name of the function which will be called when

the suggestion menu is opened.

OnClientResponse The name of the function which will be called when a

search completes, even if the menu will not be shown

because there are no results or the Autocomplete is

disabled.

OnClientSearch The name of the function which will be called Before a

request (source-option) is started, after minLength

and delay are met. Can be canceled (return false),

then no request will be started and no items

suggested.

OnClientSelect The name of the function which will be called when an

item is selected from the menu; ui.item refers to the

selected item. The default action of select is to replace

the text field's value with the value of the selected

item. Canceling this event prevents the value from


88

being updated, but does not prevent the menu from

closing.



Position Identifies the position of the Autocomplete widget in

relation to the associated input element. The "of"

option defaults to the input element, but you can

specify another element to position against. You can

refer to the jQuery UI Position utility for more details

about the various options. Reference:

http://jqueryui.com/demos/autocomplete/#position


SelectMethod (Inherited from





Source Defines the data to use, must be specified. See

Overview section for more details, and look at the

various demos. Reference:

http://jqueryui.com/demos/autocomplete/#source






C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Page.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Parent.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~RenderingCompatibility.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~SelectMethod.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Site.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~SkinID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Style.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~SupportsDisabledAttribute.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~TabIndex.html


89




Text Gets or sets the text of autocomplete control.



UniqueID Overridden.





Top

Public Methods

Name Description




DataBind Overridden. This method overrides the generic DataBind

method to bind the related data to the control.



C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~TemplateControl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~TemplateSourceDirectory.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ToolTip.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ValidateRequestMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ViewStateMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Width.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ApplyStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ApplyStyleSheetSkin.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~CopyBaseAttributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Dispose.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~FindControl(String).html


90





LoadLayout Overloaded. Loads control layout properties from the file.







SaveLayout Overloaded. Saves the control layout properties to the file.


Top

Public Events

Name Description

CallingDataMethods (Inherited from System.Web.UI.WebControls.DataBoundControl)

CreatingModelDataSource (Inherited from System.Web.UI.WebControls.DataBoundControl)


DataBound (Inherited from

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Focus.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~GetRouteUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~GetUniqueIDRelativeTo.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~HasControls.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~MergeStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~RenderBeginTag.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~RenderControl(HtmlTextWriter).html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~RenderEndTag.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ResolveClientUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ResolveUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~SetRenderMethodDelegate.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~CallingDataMethods_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~CreatingModelDataSource_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataBinding_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataBound_EV.html


91




ItemDataBinding Occurs before C1AutoCompleteDataItem is created in data

binding.

ItemDataBound Occurs after C1AutoCompleteDataItem is created in data

binding.

ItemSelected Occurs after item of C1AutoComplete is selected.



TextChanged Occurs after text of C1AutoComplete is changed.


Top

See Also

Reference

C1AutoComplete Class


C1AutoComplete Constructor Initializes a new instance of the C1AutoComplete class.

Syntax



C#

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Disposed_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Init_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Load_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~PreRender_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Unload_EV.html



92

public C1AutoComplete()

See Also

Reference



Overload List

Methods For a list of all members of this type, see C1AutoComplete members.

Public Methods

Name Description




DataBind Overridden. This method overrides the generic DataBind

method to bind the related data to the control.







LoadLayout Overloaded. Loads control layout properties from the file.


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~_ctor.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ApplyStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ApplyStyleSheetSkin.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~CopyBaseAttributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Dispose.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~FindControl(String).html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Focus.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~GetRouteUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~GetUniqueIDRelativeTo.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~HasControls.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~MergeStyle.html


93






SaveLayout Overloaded. Saves the control layout properties to the file.


Top

See Also

Reference



DataBind Method This method overrides the generic DataBind method to bind the related data to the control.

Syntax


Public Overrides NotOverridable Sub DataBind()

C#

public override void DataBind()

See Also

Reference



C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~RenderBeginTag.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~RenderControl(HtmlTextWriter).html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~RenderEndTag.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ResolveClientUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ResolveUrl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~SetRenderMethodDelegate.html



94

LoadLayout Method Loads control layout properties from the file.

Overload List


LoadLayout(String) Loads control layout properties from the file.

LoadLayout(Stream) Load control layout properties from the stream.

LoadLayout(String,LayoutType) Loads control layout properties with specified types from the

file.

LoadLayout(Stream,LayoutType) Loads the control layout properties with specified types from

the stream.

See Also

Reference



LoadLayout(String) Method

Loads control layout properties from the file.

Syntax


Public Overloads Sub LoadLayout( _

ByVal filename As System.String _

)

C#

public void LoadLayout(

System.string filename

)

Parameters

filename


95

The file where the values of layout properties will be loaded.

See Also

Reference



Overload List

LoadLayout(Stream) Method

Load control layout properties from the stream.

Syntax



ByVal stream As System.IO.Stream _

)

C#


System.IO.Stream stream

)

Parameters

stream

The stream where the values of layout properties will be loaded.

See Also

Reference



Overload List

LoadLayout(String,LayoutType) Method


The layout types to load.

Loads control layout properties with specified types from the file.


96

Syntax



ByVal filename As System.String, _

ByVal layoutTypes As LayoutType _

)

C#


System.string filename,

LayoutType layoutTypes

)

Parameters

filename


layoutTypes


See Also

Reference



Overload List

LoadLayout(Stream,LayoutType) Method

The stream where the values of the layout properties will be loaded.


Loads the control layout properties with specified types from the stream.

Syntax



ByVal stream As System.IO.Stream, _


97

ByVal layoutTypes As LayoutType _

)

C#


System.IO.Stream stream,

LayoutType layoutTypes

)

Parameters

stream

The stream where the values of the layout properties will be loaded.

layoutTypes


See Also

Reference



Overload List

SaveLayout Method Saves the control layout properties to the file.

Overload List


SaveLayout(String) Saves the control layout properties to the file.

SaveLayout(Stream) Saves control layout properties to the stream.

See Also

Reference




98

SaveLayout(String) Method

Saves the control layout properties to the file.

Syntax


Public Overloads Sub SaveLayout( _

ByVal filename As System.String _

)

C#

public void SaveLayout(

System.string filename

)

Parameters

filename

The file where the values of the layout properties will be saved.

See Also

Reference



Overload List

SaveLayout(Stream) Method

Saves control layout properties to the stream.

Syntax


Public Overloads Sub SaveLayout( _

ByVal stream As System.IO.Stream _

)

C#

public void SaveLayout(

System.IO.Stream stream


99

)

Parameters

stream

The stream where the values of layout properties will be saved.

See Also

Reference



Overload List

Properties For a list of all members of this type, see C1AutoComplete members.

Public Properties

Name Description



AppendTo Which element the menu should be appended to.

Reference:


AppRelativeTemplateSourceDirector

y

(Inherited from System.Web.UI.Control)



AutoFocus If set to true the first item will be automatically

focused. Reference:


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~AccessKey.html



C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Attributes.html


100

AutoPostBack Gets or sets the value that indicates whether or not

the control posts back to the server each time a user

interacts with the control.










DataCategoryField Gets or sets the name of the field from the data

source to bind to the category.

DataLabelField Gets or sets the name of the field from the data

source to bind to the label.

DataMember (Inherited from


DataSource (Inherited from


DataSourceID (Inherited from


DataSourceObject (Inherited from


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ClientID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ClientIDMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Controls.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ControlStyle.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ControlStyleCreated.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~CssClass.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataMember.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataSource.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataSourceID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataSourceObject.html


101

DataValueField Gets or sets the name of the field from the data

source to bind to the value.

Delay The delay in milliseconds the Autocomplete waits

after a keystroke to activate itself. A zero-delay makes

sense for local data (more responsive), but can

produce a lot of load for remote data, while being less

responsive. Reference:

http://jqueryui.com/demos/autocomplete/#delay









Items Gets a C1AutoCompleteDataItemCollection object

that contains the items of the current


ItemType (Inherited from


LoadOnDemand Gets or sets the value that indicates whether or not

Loads on demand is enabled. If it set to true, the auto

complete will get suggestions from datasource you

specified.

MaxCount Gets or sets the value that indicates the max number

of callback results (you must specified the data source

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~EnableTheming.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~EnableViewState.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~HasAttributes.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Height.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ItemType.html


102

and set property "LoadOnDemand" to true) .

MaxLength The attribute "maxlength" of textbox.

MinLength The minimum number of characters a user has to type

before the Autocomplete activates. Zero is useful for

local data with just a few items. Should be increased

when there are a lot of items, where a single character

would match a few thousand items. Reference:

http://jqueryui.com/demos/autocomplete/#minLengt

h


OnClientChange The name of the function which will be called when

the field is blurred, if the value has changed; ui.item

refers to the selected item.

OnClientClose The name of the function which will be called when

the list is hidden - doesn't have to occur together with

a change.

OnClientCreate The name of the function which will be called when

autocomplete is created.

OnClientFocus The name of the function which will be called before

focus is moved to an item (not selecting), ui.item

refers to the focused item. The default action of focus

is to replace the text field's value with the value of the

focused item, though only if the focus event was

triggered by a keyboard interaction. Canceling this

event prevents the value from being updated, but

does not prevent the menu item from being focused.

OnClientOpen The name of the function which will be called when

the suggestion menu is opened.

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~NamingContainer.html


103

OnClientResponse The name of the function which will be called when a

search completes, even if the menu will not be shown

because there are no results or the Autocomplete is

disabled.

OnClientSearch The name of the function which will be called Before a

request (source-option) is started, after minLength

and delay are met. Can be canceled (return false),

then no request will be started and no items

suggested.

OnClientSelect The name of the function which will be called when an

item is selected from the menu; ui.item refers to the

selected item. The default action of select is to replace

the text field's value with the value of the selected

item. Canceling this event prevents the value from

being updated, but does not prevent the menu from

closing.



Position Identifies the position of the Autocomplete widget in

relation to the associated input element. The "of"

option defaults to the input element, but you can

specify another element to position against. You can

refer to the jQuery UI Position utility for more details

about the various options. Reference:

http://jqueryui.com/demos/autocomplete/#position


SelectMethod (Inherited from



C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Page.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Parent.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~RenderingCompatibility.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~SelectMethod.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Site.html


104



Source Defines the data to use, must be specified. See

Overview section for more details, and look at the

various demos. Reference:

http://jqueryui.com/demos/autocomplete/#source









Text Gets or sets the text of autocomplete control.



UniqueID Overridden.





Top

See Also

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~SkinID.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Style.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~SupportsDisabledAttribute.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~TabIndex.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~TemplateControl.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~TemplateSourceDirectory.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ToolTip.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ValidateRequestMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~ViewStateMode.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Width.html


105

Reference



AppendTo Property Which element the menu should be appended to. Reference:


Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.AppendTo", Description="Which

element the menu should be appended to.")>




Public Property AppendTo As System.String

C#


[C1Description(Key="C1AutoComplete.AppendTo", Description="Which element the

menu should be appended to.")]


[WidgetOption()]


public System.string AppendTo {get; set;}

See Also

Reference



AutoFocus Property If set to true the first item will be automatically focused. Reference:


Syntax




106


<C1DescriptionAttribute(Key="C1AutoComplete.AutoFocus", Description="If set

to true the first item will be automatically focused.")>




Public Property AutoFocus As System.Boolean

C#


[C1Description(Key="C1AutoComplete.AutoFocus", Description="If set to true

the first item will be automatically focused.")]



[WidgetOption()]

public System.bool AutoFocus {get; set;}

See Also

Reference



AutoPostBack Property Gets or sets the value that indicates whether or not the control posts back to the server each

time a user interacts with the control.

Syntax




<C1DescriptionAttribute(Key="C1AutoComplete.AutoPostBack", Description="Gets

or sets the value that indicates whether or not the control posts back to the

server each time a user interacts with the control.")>



Public Property AutoPostBack As System.Boolean

C#



107


[C1Description(Key="C1AutoComplete.AutoPostBack", Description="Gets or sets

the value that indicates whether or not the control posts back to the server

each time a user interacts with the control.")]


[WidgetOption()]

public System.bool AutoPostBack {get; set;}

See Also

Reference



DataCategoryField Property Gets or sets the name of the field from the data source to bind to the category.

Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.DataCategoryField",

Description="Gets or sets the name of the field from the data source to bind

to the category.")>

<C1CategoryAttribute("Data")>

<LayoutAttribute(LayoutType.Misc)>

Public Property DataCategoryField As System.String

C#


[C1Description(Key="C1AutoComplete.DataCategoryField", Description="Gets or

sets the name of the field from the data source to bind to the category.")]

[C1Category("Data")]

[Layout(LayoutType.Misc)]

public System.string DataCategoryField {get; set;}

See Also

Reference




108

DataLabelField Property Gets or sets the name of the field from the data source to bind to the label.

Syntax


<C1DescriptionAttribute(Key="C1AutoComplete.DataLabelField",


to the label.")>




Public Property DataLabelField As System.String

C#

[C1Description(Key="C1AutoComplete.DataLabelField", Description="Gets or sets

the name of the field from the data source to bind to the label.")]




public System.string DataLabelField {get; set;}

See Also

Reference



DataValueField Property Gets or sets the name of the field from the data source to bind to the value.

Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.DataValueField",


to the value.")>




109

Public Property DataValueField As System.String

C#


[C1Description(Key="C1AutoComplete.DataValueField", Description="Gets or sets

the name of the field from the data source to bind to the value.")]



public System.string DataValueField {get; set;}

See Also

Reference



Delay Property The delay in milliseconds the Autocomplete waits after a keystroke to activate itself. A zero-

delay makes sense for local data (more responsive), but can produce a lot of load for remote

data, while being less responsive. Reference: http://jqueryui.com/demos/autocomplete/#delay

Syntax


<C1DescriptionAttribute(Key="C1AutoComplete.Delay", Description="The delay in

milliseconds the Autocomplete waits after a keystroke to activate itself. A

zero-delay makes sense for local data (more responsive), but can produce a

lot of load for remote data, while being less responsive.")>





Public Property Delay As System.Integer

C#

[C1Description(Key="C1AutoComplete.Delay", Description="The delay in

milliseconds the Autocomplete waits after a keystroke to activate itself. A

zero-delay makes sense for local data (more responsive), but can produce a

lot of load for remote data, while being less responsive.")]




110

[WidgetOption()]


public System.int Delay {get; set;}

See Also

Reference



Items Property Gets a C1AutoCompleteDataItemCollection object that contains the items of the current


Syntax


<LayoutAttribute(LayoutType.Appearance)>


<System.ComponentModel.NotifyParentPropertyAttribute(True)>

<System.ComponentModel.BrowsableAttribute(False)>


lizationVisibility.Content)>


<CollectionItemTypeAttribute(C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompl

eteDataItem)>

<System.Web.UI.PersistenceModeAttribute(PersistenceMode.InnerProperty)>

<C1DescriptionAttribute(Key="C1AutoComplete.Items", Description="Gets a

C1AutoCompleteDataItem collection object that contains the items of the

current control.")>


Public ReadOnly Property Items As C1AutoCompleteDataItemCollection

C#

[Layout(LayoutType.Appearance)]


[System.ComponentModel.NotifyParentProperty(true)]

[System.ComponentModel.Browsable(false)]


ionVisibility.Content)]



111

[CollectionItemType(C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDa

taItem)]

[System.Web.UI.PersistenceMode(PersistenceMode.InnerProperty)]

[C1Description(Key="C1AutoComplete.Items", Description="Gets a

C1AutoCompleteDataItem collection object that contains the items of the

current control.")]

[WidgetOption()]

public C1AutoCompleteDataItemCollection Items {get;}

See Also

Reference



LoadOnDemand Property Gets or sets the value that indicates whether or not Loads on demand is enabled. If it set to

true, the auto complete will get suggestions from datasource you specified.

Syntax




<C1DescriptionAttribute(Key="C1AutoComplete.LoadOnDemand", Description="Gets

or sets the value that indicates whether or not Loads on demand is enabled.

If it set to true, the auto complete will get suggestions from datasource you

specified.")>



Public Property LoadOnDemand As System.Boolean

C#



[C1Description(Key="C1AutoComplete.LoadOnDemand", Description="Gets or sets

the value that indicates whether or not Loads on demand is enabled.

If it set to true, the auto complete will get suggestions from datasource you

specified.")]


[WidgetOption()]


112

public System.bool LoadOnDemand {get; set;}

See Also

Reference



MaxCount Property Gets or sets the value that indicates the max number of callback results (you must specified the

data source and set property "LoadOnDemand" to true) .

Syntax





<C1DescriptionAttribute(Key="C1AutoComplete.MaxCount", Description="Gets or

sets the value that indicates the max number of callback results (you must

specified the data source and set property "LoadOnDemand" to true) .")>


Public Overridable Property MaxCount As System.Integer

C#




[C1Description(Key="C1AutoComplete.MaxCount", Description="Gets or sets the

value that indicates the max number of callback results (you must specified

the data source and set property "LoadOnDemand" to true) .")]

[WidgetOption()]

public virtual System.int MaxCount {get; set;}

See Also

Reference



MaxLength Property The attribute "maxlength" of textbox.


113

Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.MaxLength", Description="The

attribute "maxlength" of textbox.")>




Public Overridable Property MaxLength As System.Integer

C#


[C1Description(Key="C1AutoComplete.MaxLength", Description="The attribute

"maxlength" of textbox.")]


[WidgetOption()]


public virtual System.int MaxLength {get; set;}

See Also

Reference



MinLength Property The minimum number of characters a user has to type before the Autocomplete activates. Zero

is useful for local data with just a few items. Should be increased when there are a lot of items,

where a single character would match a few thousand items. Reference:

http://jqueryui.com/demos/autocomplete/#minLength

Syntax




<C1DescriptionAttribute(Key="C1AutoComplete.MinLength", Description="The

minimum number of characters a user has to type before the Autocomplete

activates. Zero is useful for local data with just a few items. Should be


114

increased when there are a lot of items, where a single character would match

a few thousand items.")>



Public Property MinLength As System.Integer

C#

[WidgetOption()]


[C1Description(Key="C1AutoComplete.MinLength", Description="The minimum

number of characters a user has to type before the Autocomplete activates.

Zero is useful for local data with just a few items. Should be increased when

there are a lot of items, where a single character would match a few thousand

items.")]



public System.int MinLength {get; set;}

See Also

Reference



OnClientChange Property The name of the function which will be called when the field is blurred, if the value has changed;

ui.item refers to the selected item.

Syntax


<C1DescriptionAttribute(Key="C1AutoComplete.OnClientChange", Description="The

name of the function which will be called when the field is blurred, if the

value has changed; ui.item refers to the selected item.")>

<C1CategoryAttribute("Client-Side Events")>

<WidgetEventAttribute("ev, index")>

<WidgetOptionNameAttribute("change")>



Public Property OnClientChange As System.String


115

C#

[C1Description(Key="C1AutoComplete.OnClientChange", Description="The name of

the function which will be called when the field is blurred, if the value has

changed; ui.item refers to the selected item.")]

[C1Category("Client-Side Events")]

[WidgetEvent("ev, index")]

[WidgetOptionName("change")]



public System.string OnClientChange {get; set;}

See Also

Reference



OnClientClose Property The name of the function which will be called when the list is hidden - doesn't have to occur

together with a change.

Syntax


<WidgetOptionNameAttribute("close")>





<C1DescriptionAttribute(Key="C1AutoComplete.OnClientClose", Description="The

name of the function which will be called when the list is hidden - doesn't

have to occur together with a change.")>

Public Property OnClientClose As System.String

C#

[WidgetOptionName("close")]






116

[C1Description(Key="C1AutoComplete.OnClientClose", Description="The name of

the function which will be called when the list is hidden - doesn't have to

occur together with a change.")]

public System.string OnClientClose {get; set;}

See Also

Reference



OnClientCreate Property The name of the function which will be called when autocomplete is created.

Syntax




<C1DescriptionAttribute(Key="C1AutoComplete.OnClientCreate", Description="The

name of the function which will be called when autocomplete is created.")>

<WidgetOptionNameAttribute("create")>



Public Property OnClientCreate As System.String

C#



[C1Description(Key="C1AutoComplete.OnClientCreate", Description="The name of

the function which will be called when autocomplete is created.")]

[WidgetOptionName("create")]



public System.string OnClientCreate {get; set;}

See Also

Reference




117

OnClientFocus Property The name of the function which will be called before focus is moved to an item (not selecting),

ui.item refers to the focused item. The default action of focus is to replace the text field's value

with the value of the focused item, though only if the focus event was triggered by a keyboard

interaction. Canceling this event prevents the value from being updated, but does not prevent

the menu item from being focused.

Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.OnClientFocus", Description="The

name of the function which will be called before focus is moved to an item

(not selecting), ui.item refers to the focused item.

The default action of focus is to replace the text field's value with the

value of the focused item, though only if the focus event was triggered by a

keyboard interaction.

Canceling this event prevents the value from being updated, but does not

prevent the menu item from being focused.")>


<WidgetOptionNameAttribute("focus")>



Public Property OnClientFocus As System.String

C#


[C1Description(Key="C1AutoComplete.OnClientFocus", Description="The name of

the function which will be called before focus is moved to an item (not

selecting), ui.item refers to the focused item.

The default action of focus is to replace the text field's value with the

value of the focused item, though only if the focus event was triggered by a

keyboard interaction.


prevent the menu item from being focused.")]


[WidgetOptionName("focus")]



public System.string OnClientFocus {get; set;}

See Also


118

Reference



OnClientOpen Property The name of the function which will be called when the suggestion menu is opened.

Syntax


<WidgetOptionNameAttribute("open")>

<C1DescriptionAttribute(Key="C1AutoComplete.OnClientOpen", Description="The

name of the function which will be called when the suggestion menu is

opened.")>





Public Property OnClientOpen As System.String

C#

[WidgetOptionName("open")]

[C1Description(Key="C1AutoComplete.OnClientOpen", Description="The name of

the function which will be called when the suggestion menu is opened.")]





public System.string OnClientOpen {get; set;}

See Also

Reference



OnClientResponse Property The name of the function which will be called when a search completes, even if the menu will

not be shown because there are no results or the Autocomplete is disabled.

Syntax


119





<WidgetOptionNameAttribute("response")>


<C1DescriptionAttribute(Key="C1AutoComplete.OnClientResponse",

Description="The name of the function which will be called when a search

completes, even if the menu will not be shown because there are no results or

the Autocomplete is disabled.")>

Public Property OnClientResponse As System.String

C#




[WidgetOptionName("response")]


[C1Description(Key="C1AutoComplete.OnClientResponse", Description="The name

of the function which will be called when a search completes, even if the

menu will not be shown because there are no results or the Autocomplete is

disabled.")]

public System.string OnClientResponse {get; set;}

See Also

Reference



OnClientSearch Property The name of the function which will be called Before a request (source-option) is started, after

minLength and delay are met. Can be canceled (return false), then no request will be started

and no items suggested.

Syntax


<WidgetOptionNameAttribute("search")>



120




<C1DescriptionAttribute(Key="C1AutoComplete.OnClientSearch", Description="The

name of the function which will be called Before a request (source-option) is

started, after minLength and delay are met.

Can be canceled (return false), then no request will be started and no items

suggested.")>

Public Property OnClientSearch As System.String

C#

[WidgetOptionName("search")]





[C1Description(Key="C1AutoComplete.OnClientSearch", Description="The name of

the function which will be called Before a request (source-option) is

started, after minLength and delay are met.

Can be canceled (return false), then no request will be started and no items

suggested.")]

public System.string OnClientSearch {get; set;}

See Also

Reference



OnClientSelect Property The name of the function which will be called when an item is selected from the menu; ui.item

refers to the selected item. The default action of select is to replace the text field's value with

the value of the selected item. Canceling this event prevents the value from being updated, but

does not prevent the menu from closing.

Syntax


<WidgetOptionNameAttribute("select")>




121

<C1DescriptionAttribute(Key="C1AutoComplete.OnClientSelect", Description="The

name of the function which will be called when an item is selected from the

menu; ui.item refers to the selected item. The default action of select is to

replace the text field's value with the value of the selected item.


prevent the menu from closing.")>



Public Property OnClientSelect As System.String

C#

[WidgetOptionName("select")]



[C1Description(Key="C1AutoComplete.OnClientSelect", Description="The name of

the function which will be called when an item is selected from the menu;

ui.item refers to the selected item. The default action of select is to

replace the text field's value with the value of the selected item.


prevent the menu from closing.")]



public System.string OnClientSelect {get; set;}

See Also

Reference



Position Property Identifies the position of the Autocomplete widget in relation to the associated input element.

The "of" option defaults to the input element, but you can specify another element to position

against. You can refer to the jQuery UI Position utility for more details about the various

options. Reference: http://jqueryui.com/demos/autocomplete/#position

Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.Position",


122

Description="Identifies the position of the Autocomplete widget in relation

to the associated input element. The "of" option defaults to the input

element, but you can specify another element to position against. You can

refer to the jQuery UI Position utility for more details about the various

options.")>

<TypeConverterAttribute("System.ComponentModel.ExpandableObjectConverter,

System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>






Public Property Position As PositionSettings

C#


[C1Description(Key="C1AutoComplete.Position", Description="Identifies the

position of the Autocomplete widget in relation to the associated input

element. The "of" option defaults to the input element, but you can

specify another element to position against. You can refer to the jQuery

UI Position utility for more details about the various options.")]

[TypeConverter("System.ComponentModel.ExpandableObjectConverter, System,

Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]

[WidgetOption()]





public PositionSettings Position {get; set;}

See Also

Reference



Source Property Defines the data to use, must be specified. See Overview section for more details, and look at

the various demos. Reference: http://jqueryui.com/demos/autocomplete/#source

Syntax


123





<TypeConverterAttribute("System.ComponentModel.ExpandableObjectConverter,

System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>


<C1DescriptionAttribute(Key="C1AutoComplete.Source", Description="Defines the

data to use, must be specified. See Overview section for more details, and

look at the various demos.")>




Public ReadOnly Property Source As AutoCompleteSourceOption

C#




[TypeConverter("System.ComponentModel.ExpandableObjectConverter, System,

Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]


[C1Description(Key="C1AutoComplete.Source", Description="Defines the data

to use, must be specified. See Overview section for more details, and

look at the various demos.")]

[WidgetOption()]



public AutoCompleteSourceOption Source {get;}

See Also

Reference



Text Property Gets or sets the text of autocomplete control.

Syntax


124



<C1DescriptionAttribute(Key="C1AutoComplete.Text", Description="Gets or sets

the text of autocomplete control.")>




Public Overridable Property Text As System.String

C#

[WidgetOption()]

[C1Description(Key="C1AutoComplete.Text", Description="Gets or sets the text

of autocomplete control.")]




public virtual System.string Text {get; set;}

See Also

Reference



UniqueID Property

Syntax




<System.ComponentModel.BrowsableAttribute(False)>

Public Overrides ReadOnly Property UniqueID As System.String

C#

[WidgetOption()]


[System.ComponentModel.Browsable(false)]

public override System.string UniqueID {get;}

See Also


125

Reference



Events For a list of all members of this type, see C1AutoComplete members.

Public Events

Name Description

CallingDataMethods (Inherited from System.Web.UI.WebControls.DataBoundControl)

CreatingModelDataSource (Inherited from System.Web.UI.WebControls.DataBoundControl)


DataBound (Inherited from




ItemDataBinding Occurs before C1AutoCompleteDataItem is created in data

binding.

ItemDataBound Occurs after C1AutoCompleteDataItem is created in data

binding.

ItemSelected Occurs after item of C1AutoComplete is selected.



TextChanged Occurs after text of C1AutoComplete is changed.


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~CallingDataMethods_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~CreatingModelDataSource_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataBinding_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~DataBound_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Disposed_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Init_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Load_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~PreRender_EV.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoComplete~Unload_EV.html


126

Top

See Also

Reference



ItemDataBinding Event Occurs before C1AutoCompleteDataItem is created in data binding.

Syntax


<C1DescriptionAttribute(Key="C1AutoComplete.ItemDataBinding",

Description="Occurs before C1AutoCompleteDataItem created in data binding.")>

<C1CategoryAttribute("Misc")>

Public Event ItemDataBinding As C1AutoCompleteDataItemEventHandler

C#

[C1Description(Key="C1AutoComplete.ItemDataBinding", Description="Occurs

before C1AutoCompleteDataItem created in data binding.")]

[C1Category("Misc")]

public event C1AutoCompleteDataItemEventHandler ItemDataBinding

Event Data

The event handler receives an argument of type C1AutoCompleteDataItemEventArgs containing

data related to this event. The following C1AutoCompleteDataItemEventArgs properties

provide information specific to this event.

Property Description

Item Gets the C1AutoCompleteDataItem related with this event.

See Also

Reference





127

ItemDataBound Event Occurs after C1AutoCompleteDataItem is created in data binding.

Syntax


<C1DescriptionAttribute(Key="C1AutoComplete.ItemDataBound",

Description="Occurs after C1AutoCompleteDataItem is created in data

binding.")>


Public Event ItemDataBound As C1AutoCompleteDataItemEventHandler

C#

[C1Description(Key="C1AutoComplete.ItemDataBound", Description="Occurs after

C1AutoCompleteDataItem is created in data binding.")]


public event C1AutoCompleteDataItemEventHandler ItemDataBound

Event Data






See Also

Reference



ItemSelected Event Occurs after item of C1AutoComplete is selected.

Syntax



128


<C1DescriptionAttribute(Key="C1AutoComplete.ItemSelected",

Description="Occurs after item of C1AutoComplete is selected.")>

Public Event ItemSelected As C1AutoCompleteDataItemEventHandler

C#


[C1Description(Key="C1AutoComplete.ItemSelected", Description="Occurs after

item of C1AutoComplete is selected.")]

public event C1AutoCompleteDataItemEventHandler ItemSelected

Event Data






See Also

Reference



TextChanged Event Occurs after text of C1AutoComplete is changed.

Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.TextChanged", Description="Occurs

after text of C1AutoComplete is changed.")>

Public Event TextChanged As System.EventHandler

C#


[C1Description(Key="C1AutoComplete.TextChanged", Description="Occurs after


129

text of C1AutoComplete is changed.")]

public event System.EventHandler TextChanged

See Also

Reference



C1AutoCompleteDataItem

Object Model

Syntax


Public Class C1AutoCompleteDataItem

C#

public class C1AutoCompleteDataItem


System.Object

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItem

See Also

Reference

C1AutoCompleteDataItem Members


Overview

Object Model

Syntax



130


Public Class C1AutoCompleteDataItem

C#

public class C1AutoCompleteDataItem


System.Object

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItem

See Also

Reference



Members The following tables list the members exposed by C1AutoCompleteDataItem.

Public Constructors

Name Description

C1AutoCompleteDataItem Constructor

Top

Public Properties

Name Description

Category Gets or sets the category of autocomplete item.

Label Gets or sets the label of autocomplete item.

Value Gets or sets the value of autocomplete item.

Top

See Also



131

Reference

C1AutoCompleteDataItem Class


C1AutoCompleteDataItem Constructor

Syntax



C#

public C1AutoCompleteDataItem()

See Also

Reference



Properties For a list of all members of this type, see C1AutoCompleteDataItem members.

Public Properties

Name Description

Category Gets or sets the category of autocomplete item.

Label Gets or sets the label of autocomplete item.

Value Gets or sets the value of autocomplete item.

Top

See Also

Reference






132

Category Property Gets or sets the category of autocomplete item.

Syntax




<C1DescriptionAttribute(Key="C1AutoComplete.C1AutoCompleteDataItem.Category",

Description="Gets or sets the category of autocomplete item.")>


Public Property Category As System.String

C#

[WidgetOption()]


[C1Description(Key="C1AutoComplete.C1AutoCompleteDataItem.Category",

Description="Gets or sets the category of autocomplete item.")]


public System.string Category {get; set;}

See Also

Reference



Label Property Gets or sets the label of autocomplete item.

Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.C1AutoCompleteDataItem.Label",

Description="Gets or sets the label of autocomplete item.")>



Public Property Label As System.String


133

C#


[C1Description(Key="C1AutoComplete.C1AutoCompleteDataItem.Label",

Description="Gets or sets the label of autocomplete item.")]

[WidgetOption()]


public System.string Label {get; set;}

See Also

Reference



Value Property Gets or sets the value of autocomplete item.

Syntax



<C1DescriptionAttribute(Key="C1AutoComplete.C1AutoCompleteDataItem.Value",

Description="Gets or sets the value of autocomplete item.")>



Public Property Value As System.String

C#

[WidgetOption()]

[C1Description(Key="C1AutoComplete.C1AutoCompleteDataItem.Value",

Description="Gets or sets the value of autocomplete item.")]



public System.string Value {get; set;}

See Also

Reference




134

C1AutoCompleteDataItemCollection

Object Model

Syntax


Public Class C1AutoCompleteDataItemCollection

Inherits

C1.Web.Wijmo.Controls.Base.Collections.C1ObservableItemCollection(Of

C1AutoComplete,C1AutoCompleteDataItem)

C#

public class C1AutoCompleteDataItemCollection :

C1.Web.Wijmo.Controls.Base.Collections.C1ObservableItemCollection<C1AutoCompl

ete,C1AutoCompleteDataItem>


System.Object

System.Collections.ObjectModel.Collection<T>

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection

See Also

Reference

C1AutoCompleteDataItemCollection Members


Overview

Object Model

Syntax


Public Class C1AutoCompleteDataItemCollection



135

Inherits

C1.Web.Wijmo.Controls.Base.Collections.C1ObservableItemCollection(Of

C1AutoComplete,C1AutoCompleteDataItem)

C#

public class C1AutoCompleteDataItemCollection :

C1.Web.Wijmo.Controls.Base.Collections.C1ObservableItemCollection<C1AutoCompl

ete,C1AutoCompleteDataItem>


System.Object

System.Collections.ObjectModel.Collection<T>

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection

See Also

Reference



Members The following tables list the members exposed by C1AutoCompleteDataItemCollection.

Public Constructors

Name Description

C1AutoCompleteDataItemCollection Constructor Initializes a new instance of the

C1AutoCompleteDataItem class..

Top

Public Properties

Name Description

Item (Inherited from

System.Collections.ObjectModel.Collection<C1AutoCompleteDataItem>)

Top

Public Methods


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~Item.html


136

Name Description

Add Adds C1AutoCompleteDataItem node to the collection.

Clear (Inherited from


Contains (Inherited from


CopyTo (Inherited from


IndexOf (Inherited from


Insert Insert a C1AutoCompleteDataItem item into a specific position in the

collection.

Remove (Inherited from


RemoveAt (Inherited from


Top

See Also

Reference

C1AutoCompleteDataItemCollection Class


C1AutoCompleteDataItemCollection Constructor Initializes a new instance of the C1AutoCompleteDataItem class..

Syntax


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~Clear.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~Contains.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~CopyTo.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~IndexOf.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~Remove.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~RemoveAt.html



137


ByVal owner As C1AutoComplete _

)

C#

public C1AutoCompleteDataItemCollection(

C1AutoComplete owner

)

Parameters

owner

Parent ComboBox.

See Also

Reference



Methods For a list of all members of this type, see C1AutoCompleteDataItemCollection members.

Public Methods

Name Description

Add Adds C1AutoCompleteDataItem node to the collection.

Clear (Inherited from


Contains (Inherited from


CopyTo (Inherited from


IndexOf (Inherited from


C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~Clear.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~Contains.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~CopyTo.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~IndexOf.html


138

Insert Insert a C1AutoCompleteDataItem item into a specific position in the

collection.

Remove (Inherited from


RemoveAt (Inherited from


Top

See Also

Reference



Add Method Adds C1AutoCompleteDataItem node to the collection.

Syntax


Public Shadows Sub Add( _

ByVal item As C1AutoCompleteDataItem _

)

C#

public new void Add(

C1AutoCompleteDataItem item

)

Parameters

item

item to add.

See Also

Reference

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~Remove.html

C1.Web.Wijmo.Controls.4~C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemCollection~RemoveAt.html



139



Insert Method Item position. Value should be greater or equal to 0

The new C1AutoCompleteDataItem item.

Insert a C1AutoCompleteDataItem item into a specific position in the collection.

Syntax


Public Shadows Sub Insert( _

ByVal index As System.Integer, _

ByVal child As C1AutoCompleteDataItem _

)

C#

public new void Insert(

System.int index,

C1AutoCompleteDataItem child

)

Parameters

index

Item position. Value should be greater or equal to 0

child

The new C1AutoCompleteDataItem item.

See Also

Reference



C1AutoCompleteDataItemEventArgs Contains event data for data binding events. Such as

C1AutoCompleteDataItem.BoundItemCreated event and

C1AutoCompleteDataItem.ItemDataBinding event.


140

Object Model

Syntax


Public Class C1AutoCompleteDataItemEventArgs

Inherits System.EventArgs

C#

public class C1AutoCompleteDataItemEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemEventArgs

See Also

Reference

C1AutoCompleteDataItemEventArgs Members


Overview Contains event data for data binding events. Such as

C1AutoCompleteDataItem.BoundItemCreated event and


Object Model

Syntax


Public Class C1AutoCompleteDataItemEventArgs

Inherits System.EventArgs



141

C#

public class C1AutoCompleteDataItemEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.Web.Wijmo.Controls.C1AutoComplete.C1AutoCompleteDataItemEventArgs

See Also

Reference



Members The following tables list the members exposed by C1AutoCompleteDataItemEventArgs.

Public Constructors

Name Description

C1AutoCompleteDataItemEventArgs Constructor Initializes a new instance of the

C1CarouselItem class.

Top

Public Properties

Name Description


Top

See Also

Reference

C1AutoCompleteDataItemEventArgs Class





142

C1AutoCompleteDataItemEventArgs Constructor Initializes a new instance of the C1CarouselItem class.

Syntax



ByVal item As C1AutoCompleteDataItem _

)

C#

public C1AutoCompleteDataItemEventArgs(

C1AutoCompleteDataItem item

)

Parameters

item

C1AutoCompleteDataItem related with this event

See Also

Reference



Properties For a list of all members of this type, see C1AutoCompleteDataItemEventArgs members.

Public Properties

Name Description


Top

See Also

Reference


143



Item Property Gets the C1AutoCompleteDataItem related with this event.

Syntax


Public ReadOnly Property Item As C1AutoCompleteDataItem

C#

public C1AutoCompleteDataItem Item {get;}

See Also

Reference



Delegates

C1AutoCompleteDataItemEventHandler The source of the event.

An C1CarouselItemEventArgs that contains event data.

Represents the method that will handle an data binding events of C1AutoCompleteDataItem.

Such as C1AutoCompleteDataItem.BoundItemCreated event and


Syntax


Public Delegate Sub C1AutoCompleteDataItemEventHandler( _

ByVal sender As System.Object, _

ByVal args As C1AutoCompleteDataItemEventArgs _

)

C#

public delegate void C1AutoCompleteDataItemEventHandler(



144

System.object sender,

C1AutoCompleteDataItemEventArgs args

)

Parameters

sender

The source of the event.

args

An C1CarouselItemEventArgs that contains event data.

See Also

Reference

C1AutoCompleteDataItemEventHandler Members

Documents

ComponentOne Accordion for ASP.NET Wijmoprerelease.componentone.com/help/ASPNETWebForms/ASP.AutoComplete.pdfAutoComplete for ASP.NET Web Forms 8 2. In the New Project dialog box expand