ComponentOne ADO.NET DataExtender for WinForms

ComponentOne

ADO.NET DataExtender

Copyright 1987-2013 GrapeCity, Inc. All rights reserved.

ComponentOne, a division of GrapeCity

201 South Highland Avenue, Third Floor

Pittsburgh, PA 15206 • USA

Internet: [email protected]

Web site: http://www.componentone.com

Sales

E-mail: [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 original CD (or diskettes) are 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 CD (or disk) 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 a defective CD (or disk) by sending it and a check for $25 (to cover postage and handling) to ComponentOne.

Except for the express warranty of the original CD (or disks) 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. We are 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.

This manual was produced using ComponentOne Doc-To-Help™.

mailto:[email protected]

http://www.componentone.com/

http://www.doctohelp.com/

C1DataExtender

1

Table of Contents ComponentOne ADO.NET DataExtender Overview ........................................................................... 4

Help with ComponentOne Studio for WinForms ............................................................................ 4

Key Features........................................................................................................................................ 5

Differences between DataObjects for WinForms and ADO.NET DataExtender ............................. 8

Benefits of Using ADO.NET DataExtender ...................................................................................... 8

ADO.NET DataExtender Quick Start .................................................................................................... 9

Step 1 of 4: Connect to a Data Source .......................................................................................... 10

Step 2 of 4: Define One or More Views ........................................................................................ 11

Step 3 of 4: Connect the View to a Grid Control........................................................................... 13

Step 4 of 4: Run Your Quick Start Application .............................................................................. 15

Design-Time Support ........................................................................................................................ 15

C1DataViewSet Smart Tag ............................................................................................................ 16

C1DataViewSet Context Menu ..................................................................................................... 17

C1DataViewSet Designer .............................................................................................................. 18

Working with C1DataViewSet ........................................................................................................... 22

C1DataViewSet Data Sources ....................................................................................................... 24

Connecting a C1DataViewSet Component to a Typed or Untyped ADO.NET Dataset ............. 25

C1DataView Definitions ................................................................................................................ 26

Simple View Definition .............................................................................................................. 27

Creating a Simple View Definition ........................................................................................ 27

Composite View Definition ....................................................................................................... 28

Creating a Composite View Definition .................................................................................. 30

C1ViewColumn Definitions ........................................................................................................... 33

Defining Column Value Calculations ......................................................................................... 34

Defining Column Styles ............................................................................................................. 35

Row and Column Level Constraints .............................................................................................. 37

Defining Constraints.................................................................................................................. 38

C1DataView Relations ....................................................................................................................... 41

Creating Table and Column Aliases............................................................................................... 41

2

Creating a Master-Detail Relationship Between C1DataViews .................................................... 45

Specifying a Parent View............................................................................................................... 46

Interaction with an Underlying ADO.NET Dataset ........................................................................ 48

Data Fetching ............................................................................................................................ 49

Working with DataSetExtender ........................................................................................................ 52

Connection Information ................................................................................................................ 54

Working with Typed DataViewSet .................................................................................................... 56

Data Driven Application Paradigm ................................................................................................ 56

Data Library Approach .............................................................................................................. 57

Creating a Data Library ............................................................................................................. 57

Creating a Typed DataViewSet ..................................................................................................... 58

ADO.NET DataExtender Samples ...................................................................................................... 59

ADO.NET DataExtender Task-Based Help ......................................................................................... 62

Working with the C1ViewSetDesignerForm ................................................................................. 63

Adding a C1DataView................................................................................................................ 63

Defining C1DataView ................................................................................................................ 65

Previewing a C1DataView ......................................................................................................... 66

Removing a C1DataView ........................................................................................................... 66

Working with the C1DataView Definition Statement Builder ...................................................... 67

Accessing the C1DataView Definition Statement Builder ........................................................ 67

Adding a Child Table Node ........................................................................................................ 68

Accessing and Changing Join Properties ................................................................................... 69

Specifying or Changing the Table Alias ..................................................................................... 70

Specifying a Filter Condition ..................................................................................................... 71

Adding Specific Columns to the View ....................................................................................... 71

Viewing and Changing the Definition Statement ..................................................................... 73

Adding a Child View ...................................................................................................................... 73

Committing Changes ..................................................................................................................... 73

Sorting and Filtering Data ............................................................................................................. 74

Updating a C1DataView Definition ............................................................................................... 75

Composite Row Editing ................................................................................................................. 78

DataView Row Actions for an Outer Join .................................................................................. 78

3

Modifying the Base DataTable(s) .............................................................................................. 80

DataView Row Actions for an Inner Join ................................................................................... 82

Using C1DataViewSet with an Untyped ADO.NET DataSet .......................................................... 83

Fetching Data from the Server at Run Time ............................................................................. 84

C1.C1DataExtender.2 Assembly ........................................................................................................ 89

Overview ....................................................................................................................................... 89

Namespaces .................................................................................................................................. 89

C1.C1DataExtender Namespace ............................................................................................... 89

Overview ............................................................................................................................... 89

Classes ................................................................................................................................... 98

Enumerations ...................................................................................................................... 672

Interfaces ............................................................................................................................ 691

Delegates ............................................................................................................................ 694

4

ComponentOne ADO.NET DataExtender Overview ComponentOne ADO.NET DataExtender is a powerful component that works with ADO.NET

datasets and provides additional rich data views in the native ADO.NET datasets. ADO.NET

DataExtender allows you to set up a data model for a Windows Form by means of a single

component named C1DataViewSet. ADO.NET DataExtender simplifies working with ADO.NET in

fact ADO.NET DataExtender mediates with ADO.NET, automating reading the schema and data

from the database, exposing database tables and views as regular ADO.NET objects and providing

an ability to set up customized views of their data.

ADO.NET DataExtender leverages ADO.NET features introduced with .NET 2.0, such as the ability

to create entire datasets based on information contained in the database schema, including not

only the data but also relations and constraints. In contrast to native ADO.NET, ADO.NET

DataExtender allows you to reuse a single typed DataSet class that represents the whole database

schema, with turned on constraints (including foreign key constraints), but populated with only a

subset of data necessary in a certain application form. In general ComponentOne ADO.NET

DataExtender simplifies data modeling and programming for Windows Forms applications.

Getting Started

ADO.NET DataExtender Quick Start

Design-Time Support

ADO.NET DataExtender Samples

Help with ComponentOne Studio for WinForms

Getting Started

For information on installing ComponentOne Studio for WinForms, licensing, technical support,

namespaces and creating a project with the control, please visit Getting Started with Studio for

WinForms.

What's New

For a list of the latest features added to ComponentOne Studio for WinForms, visit What's New in

Studio for WinForms.

See Also

Key Features

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

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

http://www.componentone.com/SuperProducts/StudioWinForms/Features/#WhatsNew

http://www.componentone.com/SuperProducts/StudioWinForms/Features/#WhatsNew

5

Key Features ADO.NET DataExtender allows you to set up a data model for a Windows Form by means of a

single component named C1DataViewSet. Some of the key benefits of ADO.NET DataExtender

include:

Simplicity

A single C1DataViewSet component serves as the binding agent for all tables and relations.

Without ADO.NET DataExtender, two components (a BindingSource and a DataAdapter) are

required to represent each table or relation.

Connectivity

C1DataViewSet can represent data from the following types of data sources:

o Typed ADO.NET DataSet

o Untyped ADO.NET DataSet

o Connection String

Programmability

The C1DataViewSet component represents a rich set of events for custom processing of row

navigation and changing occurrences. For the convenience of writing event handlers in design time,

all C1DataView events are propagated by the owning C1DataViewSet component. C1DataViewSet

event data determines in what specific C1DataView an event has occurred.

The C1DataViewSet component supports the following events, which are useful for responding to

changes in row currency, current row values, and connections:

Event Description

ColumnChanged Occurs when a C1ViewColumn value is being retrieved. This event allows

process editing actions made on C1ViewColumn objects.

ColumnChanging Occurs after a value has been changed for the specified C1ViewColumn in a

C1ViewRow. This event allows process editing actions made on C1ViewColumn

objects.

CurrentChanged This special event, CurrentChanged, is useful when you need to process current

row change independent of the reason for this change in the case that another

row becomes current, due to navigation, sorting, filtering, and so on, or due to

6

a change of current row column values.

PositionChanged C1DataView objects provide data navigation capabilities, so you don't need to

retrieve CurrencyManager for managing row navigation. You can use the

PositionChanged event to process navigation occurrences (along with Current

and Position properties).

RowChanged Occurs after editing of a C1ViewRow has been completed. This event allows

process editing actions made on C1ViewRow objects.

RowChanging Occurs before editing of C1ViewRow objects. This event allows process editing

actions made on C1ViewRow objects.

ViewListChanged If you need to process changes in view rows that occurred due to changes

made by means of a C1DataView and underlying DataTable objects, use the

ViewListChanged event.

Within these event handlers, the following properties can be used to address the current row for

the affected C1DataView object:

Property Description

Current Returns the C1ViewRow of the CurrencyManager that services this C1DataView.

Position Returns the position of the current C1ViewRow in the CurrencyManager that services this

C1DataView.

Smart Update

The Update method of the C1DataViewSet component automatically determines the correct order

in which rows should be committed to the server. It also refreshes client row columns with new

values generated on the server, including the cases of server-generated auto-increment columns in

conjunction with master-detail relationships between tables.

Without ADO.NET DataExtender, the user must call the Update method of one or more

DataAdapters in order to commit changes from a DataSet to the underlying data source. In many

7

circumstances, the order in which DataSet changes are sent to the data source is crucial. For

example, if a primary key value for an existing row is updated, and a new row has been added with

the new primary key value, the update must be processed before the insertion.

Composite Views

Composite views (similar to a SQL join) combine multiple DataTables in a single DataTable object.

As updates are made to the composite view, they are automatically reflected in the constituent

tables, and vise versa.

Column Styles

Column styles are UI-related attributes that can be assigned to data columns in the

C1ViewSetDesignerForm, and then realized at run time when bound to a ComponentOne control.

The current set of controls that support column styles includes C1TrueDBGrid, C1FlexGrid, and

C1Input.

You can define, format, or edit mask for a certain column. You can also set it up to have a lookup

combo box or any other ComponentOne control that supports this feature. Simply by being

connected to this column, the ComponentOne control will automatically reflect those definitions.

Calculated Columns

Read-only calculated columns can be specified in the C1ViewSetDesignerForm using any .NET-

compatible language, or as part of the SQL-like statement that defines the view. The column

expressions are evaluated at run time as navigation and updates occur through interaction with any

bound control.

Constraint Expressions

Column and row level constraints can be specified in the C1ViewSetDesignerForm using any .NET-

compatible language. The expressions are evaluated at run time as updates occur through

interaction with any bound control.

Column and row level constraints usage:

o Column level constraints are useful for enforcing upper and lower bounds and non-

null values.

o Row level constraints are commonly used to express validation criteria involving

multiple columns.

See Also Differences between DataObjects for WinForms and ADO.NET DataExtender

Benefits of Using ADO.NET DataExtender

8

Differences between DataObjects for WinForms and ADO.NET

DataExtender The following describes the differences between ComponentOne DataObjects for WinForms and

ComponentOne ADO.NET DataExtender.

DataObjects for WinForms

C1DataObjects provides a powerful replacement for ADO.NET. It has its own dataset layer, where

data integrity constraints and other business logic can be defined. C1DataObjects is available for

.NET 1.0 and 2.0.


ADO.NET DataExtender works with and extends ADO.NET. It works with ADO.NET datasets and

provides additional rich data views in the native ADO.NET datasets. ADO.NET DataExtender is

available for .NET 2.0 only.

Differences between DataObjects for WinForms and


Although both products are related to the data layer of .NET applications, they are fundamentally

different. ADO.NET DataExtender is not just a new, enhanced version of DataObjects for

WinForms. It delegates the data storage and business logic to ADO.NET and concentrates on

enhancing its features, rather than trying to replace it.

DataObjects for WinForms users migrating to


We expect many DataObjects for WinForms users to migrate to ADO.NET DataExtender (plus

ADO.NET 2.0). However, users who rely on certain DataObjects for WinForms features (specifically

3-tier application configuration and virtualized record sets) will not be able to migrate immediately,

and that's why we will continue to maintain DataObjects for WinForms.

See Also

Benefits of Using ADO.NET DataExtender

Benefits of Using ADO.NET DataExtender ADO.NET DataExtender leverages ADO.NET features introduced with .NET 2.0 that were not

available before. For example, the ability to create entire datasets based on information contained

in the database schema, including not only the data but also relations and constraints. In contrast

9

to native ADO.NET, ADO.NET DataExtender allows you to reuse a single typed DataSet class that

represents the whole database schema, with turned on constraints (including foreign key

constraints) but populated with only a subset of data necessary in a certain application form.

Other key benefits of ADO.NET DataExtender include:

Rich data views

ADO.NET DataExtender concentrates on providing rich data views using ADO.NET as the

underlying data storage and business logic engine. For example, you can use a SQL-like syntax to

create views that combine data from different tables. These are different from regular SQL queries

because the views are connected to the client-side source tables. Changing the view affects the

table and vice versa.

Ability to attach presentation attributes to data columns

You can also attach presentation attributes to data columns, including data entry masks, display

formats, and value-translation maps (for example, to show a customer name instead of their ID in

an Orders table).

Capability to surpasses view level limitations

ADO.NET DataExtender goes beyond the view level boundaries. For example, it can fetch data

from the server on demand and update the data back to the server, as well as, define additional

constraints on the data (using the DataSetExtender class).

Mediation with the DataSet object

Although it works with ADO.NET, ADO.NET DataExtender doesn't force programmers to deal with

the DataSet object at all. At a minimum, you can simply specify a connection string and the

ADO.NET DataExtender object will automatically read the schema and data from the database,

exposing database tables and views as regular ADO.NET objects and providing an ability to set up

customized views of their data.

See Also

ADO.NET DataExtender Quick Start

ADO.NET DataExtender Quick Start This quick start tutorial shows you how to add the C1DataViewSet component to your form,

connect to a data source, and define some views. By following the steps outlined in the quick start,

you will be able create a rich data view.

10

See Also

Step 1 of 4: Connect to a Data Source

Step 2 of 4: Define One or More Views

Step 3 of 4: Connect the View to a Grid Control

Step 4 of 4: Run Your Quick Start Application

Step 1 of 4: Connect to a Data Source To begin, create a .NET projectand add the C1DataViewSet component to your form. To set up your

new Windows form and connect to a data source, complete the following steps:

1. Click the smart tag ( ) located above the C1DataViewSet component to open its

C1DataViewSet Tasks menu.

2. From the C1DataViewSet Tasks menu, select the Choose DataSet drop-down arrow and

select Add Project Data Source.

3. The DataSource Configuration Wizard appears, and DataBase is selected. Click Next.

4. Click New Connection to locate and connect to a database.

5. Leave the Data source set to Microsoft Access Database File.

6. Click Browse and select Nwind.mbd located in the samples directory that is located in one

of the following directories:

o For XP: C:\Documents and Settings\<username>\My Documents\ComponentOne

Samples\Common

o For Windows Vista/7: C:\Users\<username>\Documents\ComponentOne

Samples\Common

7. Then click Open. You can test the connection and then click OK.

8. The connection string appears in the drop-down list. Click Next.

http://helpcentral.componentone.com/nethelp/c1studiowinforms/#!Documents/creatinganetproject.htm

http://helpcentral.componentone.com/nethelp/c1studiowinforms/#!Documents/addingthecomponenton.htm

11

9. Since it is not necessary to copy the database to your project, click No in the dialog box.

10. Click Next to save the connection string as NwindConnectionString.

11. Select Tables, and then click Finish to complete your datasource configuration.

12. Select NwindDataSet to bind the database to your project.

You have successfully added the C1DataViewSet component to your Windows form and

connected to a data source. The next topic shows how to define a view.

See Also

Step 2 of 4: Define One or More Views

Step 2 of 4: Define One or More Views At this point, the C1DataViewSet component does not have any views defined. Using the

C1ViewSetDesignerForm, you can define one or more views at design time. If the underlying data

source has table relationships defined, then you can add individual tables accordingly.

To define a data table, for example, Orders, complete the following steps:



2. From its Tasks menu, select Edit to edit the C1DataViewSet's structure. The

C1ViewSetDesignerForm appears.

12

3. Click the Add View button.

4. In the Add View dialog box that appears, select Orders from the left pane and then click

Add.

5. Click Close to close the Add View dialog box.

The Preview tab of the Designer reveals the view that you just created:

13

Note: The left side of the C1ViewSetDesignerForm shows the hierarchical C1DataView

structure, while the right side provides a design surface for editing the selected element, such

as a C1DataView or one of its C1ViewColumn objects (derived from the underlying

DataColumn). The Preview tab is provided for examining the views that will be exposed to

bound controls.

6. Click OK to close the designer.

You have successfully defined a data view, Orders. The next topic shows how to connect the data

table to a grid.

See Also

Step 3 of 4: Connect the View to a Grid Control

Step 3 of 4: Connect the View to a Grid Control At this point you have added the Orders view, but you do not have a grid to show the data. In

order to expose the Orders view, you have to bind the data view to a control.

To add a grid to your form and connect the data view to the grid, complete the following steps:

14

1. From the Toolbox, double-click C1TrueDBGrid to add it to your form.

2. With the C1TrueDBGrid Tasks menu open, select the Choose Data Source drop-down

arrow and select C1DataViewSet1 from the Form1 List Instances node.

3. From the C1TrueDBGrid Tasks menu, select Dock in parent container.

4. From the Visual Studio Properties window, locate the C1TrueDBGrid.DataMember, select

the drop-down arrow, and choose the Orders view from its list.

This binds the data to the grid.

5. Click Yes to replace the column layout.

You have successfully added a grid control to your form and connected the Orders view to the

control. The next topic shows how to run the application.

15

See Also

Step 4 of 4: Run Your Quick Start Application

Step 4 of 4: Run Your Quick Start Application Click the Start Debugging button to run your application. The following image shows the

ADO.NET DataExtender Quick Start form after completing each main step in the quick start (steps

1 - 3):

Congratulations!

You have successfully added the C1DataViewSet component to your form, connected to a data

source, and defined a view.

See Also

Design-Time Support

Design-Time Support ADO.NET DataExtender provides visual editing to make it easier to create data views. The

following section details each type of support available in ADO.NET DataExtender.

Invoking the Smart Tags

16

In Visual Studio, the C1DataViewSet component includes a smart tag. A smart tag represents a

short-cut tasks menu that provides the most commonly used properties. You can invoke the smart

tag by clicking on the smart tag ( ) in the upper-right corner of the component. For more

information on how to use the smart tag for the C1DataViewSet, see C1DataViewSet Smart Tag.

Design Time Editors

ADO.NET DataExtender provides the C1ViewSetDesignerForm. For more information about the

designer, see C1DataViewSet Designer.

C1DataViewSet Component Properties

You can access the properties for the C1DataViewSet component simply by right-clicking on the

component and selecting Properties or by selecting the class from the drop-down list box of the

Properties window. Additionally, you can view the properties in the Properties page of the

C1ViewSetDesignerForm.

See Also

C1DataViewSet Smart Tag

C1DataViewSet Context Menu

C1DataViewSet Designer

C1DataViewSet Smart Tag The C1DataViewSet component provides quick and easy access to the C1ViewSetDesignerForm

and data source connections through its smart tag.

To access the C1DataViewSet Tasks menu, click on the smart tag ( ) in the upper-right corner of

the C1DataViewSet component. This will open the C1DataViewSet Tasks menu.

17

The C1DataViewSet Tasks menu operates as follows:

Connect to Data Source

The C1DataViewSet Tasks menu lists the following options to connect to a data source:

Choose DataSet

Click the drop-down arrow in the Choose Dataset drop-down box to select a data source

to connect to data. Note that you must first create a typed or untyped ADO.NET dataset.

Select Provider

Click the drop-down arrow in the Select Provider text box to select a data provider. Then

click the drop-down arrow in the and define database ConnectionString text box to

specify a ConnectionString.

Edit C1DataViewSet structure

Clicking on Edit opens the C1ViewSetDesignerForm. For more information on the designer, see

C1DataViewSet Designer.

See Also

C1DataViewSet Context Menu

C1DataViewSet Context Menu The C1DataViewSet component provides a context menu for additional functionality to use at

design time. Right-click on the C1DataViewSet component to open the following context menu:

About ComponentOne DataExtender

18

Clicking on the About ComponentOne DataExtender item displays the About ComponentOne

DataExtender dialog box, which is helpful in finding the ADO.NET DataExtender version number and

online resources.

Edit C

Clicking on the Edit item opens the C1ViewSetDesignerForm. For more information on the designer,

see C1DataViewSet Designer.

See Also

C1DataViewSet Designer

C1DataViewSet Designer To view the C1ViewSetDesignerForm:

Click on the smart tag ( ) in the upper-right corner of the C1DataViewSet component and

select Edit. See C1DataViewSet Smart Tag for more information.

OR

Select Edit from the C1DataViewSet Context Menu. See C1DataViewSet Context Menu for

more information.

OR

19

From the Visual Studio Properties window, select the Edit link.

The following designer appears:

20

Properties Tab

The designer's Properties tab lists the C1DataViewSet component's properties.

Column Style Tab

The designer's Column Styles tab lists different elements of column data representation that can

be defined using ColumnStyle subproperties, for example, Format, EditMask, and Visible.

Here is the Column Styles page:

Select the General, Format, Input, and Lookup tabs to modify the column styles.

Constraints Tab

The designer's Constraints tab allows you to define row and column level constraints declaratively,

that is, you can specify a logical expression evaluating validity of row or column data as a property

value of the corresponding row or column.

Here is the Constraints page:

21

Preview Tab

With the time-saving designer interface, the preview pane enables you to preview changes made to

the component without having to run the program to see the changes.

Here is a preview of the Employees data view:

22

See Also

Working with C1DataViewSet

Working with C1DataViewSet A single C1DataViewSet component on a Form represents a set of data views based on DataTables

from an ADO.NET dataset, with master-details relationships between them. The C1DataViewSet

component also provides clear navigational and data changing event handlers for each view

defined in a view set. Additionally, it performs automatic data fetching and committing, or

updating, to a server in only one method call. This approach makes the Form's data model

definition and data manipulation highly manageable and easy to use.

To define a data model used in a Form, you have to add a C1DataViewSet component to a Form

and choose one of the following data sources:

Typed ADO.NET Dataset

Untyped ADO.NET Dataset

A connection string referencing a particular database

After defining a data source, you must define a set of data views, or C1DataView objects, which can

be done using the C1ViewSetDesignerForm.

C1DataView is a customized view of a DataTable, either single, multiple, or joined tables, designed

for UI controls for binding, sorting, filtering, searching, navigating, and editing. Each C1DataView

23

object can represent data from either a single table of a data source (simple view) or from a row set

constructed as a join of multiple tables from a data source (composite view), similar to a SQL server

view.

C1DataView objects can be connected with master-detail relationships between them, which

provide detail views with automatic child row filtering and foreign key inheritance.

A UI control can then be bound to a specific C1DataView of a C1DataViewSet by setting its

DataSource property to the C1DataViewSet and setting its DataMember property to the

C1DataView name.

C1DataViewSet also provides events that allow custom processing of row navigation and data

changing occurrences in each individual C1DataView.

Once a C1DataView object has been specified within a C1DataViewSet, you can run the program.

In the following example, the Form contains a grid bound to a C1DataView object that represents

the Orders DataTable from a typed dataset.

The data is automatically fetched from the server for the C1DataView; no special effort is required.

After the user makes corrections to the client data, the changes made in the C1DataView, or

multiple C1DataViews, can be committed to a database server with a single method call. When

performing database updates, C1DataViewSet takes into account the types of corrections

performed on data rows and the interrelations between data tables in order to commit data rows in

the correct order, thus preventing possible conflicts on a server. As a part of the database updating

24

process, C1DataViewSet retrieves auto-generated primary key values (and additional row values

which may be changed on the server) back to the client rows, and correctly updates the foreign key

values of child rows.

See Also

C1DataViewSet Data Sources

C1DataView Definitions

C1ViewColumn Definitions

Row and Column Level Constraints

C1DataViewSet Data Sources C1DataViewSet can represent data from typed or untyped ADO.NET dataset or a connection string.

Here are these three types of data sources briefly introduced:

Typed ADO.NET Dataset

The DataSet property connects C1DataViewSet to a typed dataset component that has

been placed on a Form. In this case, C1DataViewSet retrieves Table Adapters, defined as a

part of typed dataset definition, for each DataTable. To fetch data and commit changes

back to the server, C1DataViewSet uses the information represented by adapters.

Untyped ADO.NET Dataset

The DataSet property connects C1DataViewSet to an untyped dataset component that has

been placed on a Form.

In this case, C1DataViewSet is not able to fetch data and commit changes back to the

server. You should create DataTable objects, and manually fill and update their data back to

the server. Note that the C1DataView(s) defined in a C1DataViewSet are only able to

represent the data according to their definitions.

Connection String

In this case, the ConnectionString and ConnectionProvider properties define a connection

to a database. The ConnectionString property defines a database that is used as

datasource. The ConnectionProvider property defines the name of the ADO.NET Data

Provider that is used when connecting to the database. C1DataViewSet retrieves database

schema information, automatically creates an internal ADO.NET dataset, which does not

appear on the form, and works against it. This dataset is still accessible at run time through

the DataSet property.

To connect to these data sources you must have a C1DataViewSet component on your form. The

following sections explain the necessary steps you must take to make each connection.

See Also

Connecting a C1DataViewSet Component to a Typed or Untyped ADO.NET Dataset

25

Connecting a C1DataViewSet Component to a Typed or Untyped ADO.NET Dataset

Connecting a C1DataViewSet to a typed or untyped ADO.NET dataset involves the following basic

operations:

1. Create a typed or untyped ADO.NET dataset. Consult the Microsoft Visual Studio

Documentation for more information on this process. In this example, we created a typed

ADO.NET dataset, nwindDataSet1, based on the Northwind database included with this

product.

2. From the Toolbox, add a C1DataViewSet component to your form.

Note: If you have not already added the C1DataViewSet component to the Toolbox, see

Adding ADO.NET DataExtender Components to a Project.

3. The C1DataViewSet properties appear in the Properties window in the lower right pane of

the Visual Studio IDE.

4. Set the DataSet property to nwindDataSet1.

You can also click the smart tag ( ) above the C1DataViewSet component to open the

C1DataViewSet Tasks menu, where you can select the DataSet from the Choose DataSet

drop-down list, as shown in the following image:

See Also

C1DataView Definitions


26

C1DataView Definitions Each C1DataView of a C1DataViewSet can represent data from a single DataTable of an underlying

ADO.NET dataset (simple view), or a row set constructed as a join of multiple DataTables

(composite view). The latter case is similar to SQL Views, except that the join is constructed against

client data.

Once a data source has been specified for C1DataViewSet, you can define C1DataView by assigning

a special SQL SELECT-like statement to the Definition property. The formal syntax of this statement

is as follows:

SELECT <column list>FROM <table1> [AS <table1_alias>] [ [INNER|OUTER]

JOIN <table2> [AS <table2_alias>] [ON <relation_condition>] ]*

WHERE <condition>

Simple view definition

To define a view representing data from a single DataTable named Orders, for example, you would

use the following statement:

SELECT * FROM Orders

Composite view definition

To define a composite view joining data from the Orders and Order Details DataTables, you would

use the following statement:

SELECT * FROM Orders JOIN [Order Details]

This is a simplified version of the statement. The full form of this statement can be written as:

SELECT * FROM [Orders] OUTER JOIN [Order Details] ON Orders.OrderID =

[Order Details].OrderID

The ON Orders.OrderID = [Order Details].OrderID construction explicitly defines DataRelation

connecting the specified DataTables that will be used in a join. Note that expression in the ON

clause cannot be an arbitrary one, but it must explicitly map on a join condition of one of the

DataRelations connecting the joining DataTables. If this clause is omitted, then an appropriate

relation is determined automatically. Note that if there is no relation connecting the tables, then the

statement is treated as incorrectly defined.

JOIN, as in a SQL SELECT statement, can be OUTER or INNER, with the same semantics as used in

SQL. If this keyword is omitted, JOIN is treated as OUTER. In contrast to SQL, the outer joins in a

C1DataView definition are always LEFT, and there is no way to define RIGHT or FULL joins.

You have the option of entering these definition statements manually at design time or you can use

the C1DataViewSet's Definition Statement Builder. For more information on using the Definition

Statement Builder, see Working with the C1DataView Definition Statement Builder.

27

See Also


Simple View Definition

Simple tables are the basic data objects in a schema. We distinguish between simple and composite

tables, although both are DataTable objects and for the most part can be used interchangeably.

Composite tables combine multiple simple tables in a single DataTable object. A composite table

row contains fields from different tables, for details see Composite View Definition.

Creating a Simple View Definition

To create a simple view definition, complete the following steps:

1. Click the smart tag ( ) above the C1DataViewSet component and select Edit from its tasks

menu. The C1ViewSetDesignerForm appears.

2. Click the Add View button. The Add View dialog box opens.

3. Select a parent view or None under Select a parent view from the list of available views in

the right pane.

4. Then select a table from the list of available dataset tables under Select a child view to

add. Click Add, and close the Add View dialog box.

5. The definition statement appears in the Definition property text box of the

C1ViewSetDesignerForm dialog box.

28

Using the Diagram View to Create a Simple View

Definition

Alternatively, you can select the Diagram View button to create a simple view definition:

While working in Diagram View, the user can perform the following tasks:

Select a view by clicking on the view "box" title.

Select a column by clicking on the column in the view "box".

Select a relation by clicking on the relation in the view "box".

Move and resize view "box" using the mouse.

Composite View Definition

A composite view represents data from multiple joined tables as a single rowset, similar to a view in

SQL server. Each view row, or C1ViewRow object, doesn't actually store column values; it only

29

references DataRow objects from underlying base DataTable objects. These view rows are

accessible through the C1ViewRow.BaseRows collection. The base DataRow can be retrieved from

this collection by an alias of a corresponding DataTable. Note that in the case of an OUTER join it's

possible that there is no base DataRow for a certain table; instead, a null value is stored in the

C1ViewRow.BaseRows collection for this table alias.

A join between two DataTable objects can have slightly different semantics and is classified in

ADO.NET DataExtender as the following:

Main

Relation between the left and right table of a join is one-to-many.

Lookup

Relation between the left and right table of a join is many-to-one.

We'll call the right table of the Main join the Main table and the right table of the Lookup join the

Lookup table. The first table of a view definition statement (which has no left joined table) is always

treated as Main table.

The left table cannot have more that one right table with relations to the Main join. If this

requirement is violated then the view definition statement is considered incorrectly defined. On the

contrary, the left table can have any number of "Lookup" joins with the right tables.

For example, consider a join between the Customers and Orders tables. Note that the relation

between Customers and Orders is one-to-many. If you set the view definition as follows:

SELECT * FROM Customers JOIN Orders

then you have the Main join between Customers and Orders. However, if you define it as:

SELECT * Orders FROM JOIN Customers

then you get the Lookup join.

Main/ Lookup table semantics affect the row deletion behavior of C1DataView. When you perform

a C1ViewRow deletion, only DataRow objects that correspond to Main tables can be deleted

(DataRow objects of Lookup tables are always kept untouched). In general, the right most Main

DataRow is always deleted. Suppose that this row is in a DataTable named T. Then a Main

DataRow which is left to the already deleted row is investigated if this DataRow has no other

related DataRow objects from DataTable T, then this row is deleted as well and this process is

repeated for the next left row. Otherwise, if this row has related rows from T, it leaves the row

untouched.

30

When you add a new C1ViewRow, ADO.NET DataExtender can create corresponding base

DataRow objects and/or reference the existing ones. By default, new DataRow objects are created.

The special case is when you enter a value of a column that represents a foreign key column of base

DataTable and a parent DataTable that is referenced by this foreign key is in the set of base

DataTables joining by C1DataView. For example, consider the following definition for the

C1ViewColumn representing the Orders.CustomerID DataColumn in the view:

SELECT * FROM Customers JOIN Orders

When a value of such a foreign key column is being set, C1DataView first looks whether DataRow

with the corresponding primary key value exists in the parent DataTable. If so, the modified

C1ViewRow starts to reference those parent DataRow. If not, a new parent DataRow is created and

its primary key value is set to equal the entered foreign key value.

If a view definition has at least one INNER join[INNER join means that only matching records

present in both views (tables) will appear in the result] , new base DataRow objects will be created

for each base DataTable by default. In the case when all joins in the view definition are

OUTER[OUTER join means that records of the first view (table) will appear in the result even if there

are no matching records in the second view (table)] , a new base DataRow will be created only if

you enter a value for a view column representing that base DataRow column. In this case, base

rows will be created also for each of the Main DataTable objects which are at the left side for this

DataTable.

When you edit an existing C1ViewRow object, the same rules as for row addition apply.

See Also


Creating a Composite View Definition

A composite table can contain multiple table views based on a single table. In other words, a simple

table can occur several times in a composite table diagram. Users can expose multiple related

tables as a single rowset by defining a composite view, either visually or using an SQL-like

statement.

For an example showing how to set up a data model for a Windows form and create a

C1DataViewSet with a composite view, see the C1DataExtender video, which is available for

download from the ComponentOne HelpCentral Videos page.

To create a composite view definition that joins data from multiple tables together in one view,

complete the following steps:

1. Click the smart tag ( ) above the C1DataViewSet component and select Edit from its task


javascript:void(0);

javascript:void(0);

http://helpcentral.componentone.com/Videos.aspx

31

2. Click the Add View button. The Add View dialog box appears.

3. Select a parent view from the right pane, and select Composite view from the list of child

tables.

4. Click Add.

The C1DataView Definition Statement Builder opens. The Diagram View represents a

view definition as a diagram, which allows you to add tables and define table and relation

properties.

Note: Alternatively, you can access the C1Data View Definition Statement Builder by clicking

the ellipsis button next to the Definition property.

5. Click the Add Child Table button. The Add Child Table dialog box appears.

6. Select Orders from the list of available tables under Select a child table to add.

7. Click Add.

8. With Orders selected as the parent table in the right pane, select Order Details from the

list of tables under Select a child table to add. In this example we are creating an OUTER

32

join, which is selected by default.

9. Click Add, and then Close.

The C1DataView Definition Statement Builder now contains the definition we just

created. It does not contain the OUTER keyword, so JOIN is treated as OUTER.

33

See Also


C1ViewColumn Definitions ComponentOne ADO.NET DataExtender allows defining of different aspects of visual data

representation in ComponentOne UI controls on a data level. For example, you can define, format,

or edit mask for a certain column. You also set it up to have a lookup combo box or any other

ComponentOne control that supports this feature. Simply by being connected to this column, the

ComponentOne control will automatically reflect those definitions.

In order to allow defining of UI related properties, ADO.NET DataExtender offers the

C1ViewColumn.ColumnStyle property. The C1ViewColumn.ColumnStyle property contains

subproperties, such as Format, EditMask and Visible that make it possible to define different

aspects of column data representation in UI.

The current set of controls that support column styles includes ComponentOne True DBGrid for

WinForms, FlexGrid for WinForms, and Input for WinForms.

34

In addition to defining visual data representation, calculations can be defined to determine the final

value of C1ViewColumn. The calculations can be defined in three ways:

By the DataColumnExtender.CalculationExpression property of the DataColumnExtender

(DataSetExtender column) and C1ViewColumn (C1DataView column) objects. In this case an

expression can be written using the syntax of an arbitrary .NET Framework programming

language available on your computer.

By an event handler method of the C1DataViewSet.CalculateColumn event.

By the C1DataView Definition Statement Builder of the Definition property. See

C1DataView Definitions for additional information.

See Also Defining Column Value Calculations

Defining Column Styles

Defining Column Value Calculations

Calculation expression

Similar to constraint expressions (see Row and Column Level Constraints for more information),

calculation expressions defined through the C1ViewColumn.CalculationExpression property are

treated as the code of some class method. It returns a value of a type appropriate to a column data

type and it is expressed in a specified .NET Framework programming language. Such a class has the

following members which can be used in the calculation:

Members Description

row References a row on which column calculation is performed. If the expression is defined

for a C1DataView the data type is C1ViewRow. If the expression is defined for a

DataColumn the data type is type System.Data.DataRow.

column References a column on which the value is calculated. If the expression is defined for a

C1ViewColumn the data type is C1ViewColumn. If the expression is defined for a

DataColumn in DataSetExtender the data type is System.Data.DataColumn.

baseValue Contains the value before the calculation is applied which is the base value of a column.

Column value transformation process

In general, when a C1ViewColumn value in a certain C1ViewRow is being retrieved, the following

chain of column value transformations occurs:

35

If C1ViewColumn represents a certain DataColumn:

1. A value of base DataColumn is retrieved.

2. A calculation expression (defined in the

DataColumnExtender.CalculationExpression property) of the corresponding

DataColumnExtender of DataSetExtender is evaluated. The value of the

baseValue property accessible from this expression is set to the value produced in

step 1.

If C1ViewColumn is calculated (that is, defined through expression in the View Definition

statement):

3. A value of C1ViewColumn is calculated according its expression definition.

In any case:

4. A calculation expression defined in the CalculationExpression property of

C1ViewColumn is evaluated. The baseValue property accessible from this

expression is set to a value produced either in step 2 or step 3 (depending on the

kind of C1ViewColumn).

5. If the RaiseCalculateColumnEvents property value is set to True then the

CalculateColumn event is triggered. The value of event arguments Value property

is set to a value produced in step 4; this property value can be changed in the

event handler code and it becomes a value of the C1ViewColumn.

Note: A calculated column value is not stored in the base DataRow, the calculation is just a

function on a base value stored in the row.

See Also Defining Column Styles

Defining Column Styles

Different elements of column data representation in UI can be defined using the ColumnStyle sub

properties such as:

Format

EditMask

Visible

Editing column styles:

You can easily edit each column's style by means of the Column Styles tab located in the

C1ViewSetDesignerForm. Editing a column style involves the following basic operations:

36

1. From the C1ViewSetDesignerForm, select the UnitPrice column from the left pane and

then click the Column Styles tab.

2. To format the UnitPrice column, select the Format tab and set the Format type to

Currency.

37

3. Run the application and notice that the UnitPrice column is formatted accordingly.

See Also Row and Column Level Constraints

Row and Column Level Constraints C1DataView objects, constituting C1DataViewSet, allow you to define row and column level

constraints declaratively, that is, you can specify a logical expression evaluating validity of row or

column data as a property value of the corresponding row or column. In order to make these

expressions powerful, ADO.NET DataExtender allows you to use syntax from any .NET Framework

programming language available on your computer. Thus, you are able to write multi-line

expression code which includes logical branches, loops and so on. When defining row and column

level constraints, consider the following:

Row level constraints are evaluated at the end of row editing (when the EndEdit method is

being called on a row).

Column level constraints are evaluated in an attempt to set new value to a certain column

of a row.

If a constraint's expression is evaluated to False, it is considered violated.

Constraints can be defined both in C1DataViewSet (in C1DataView and constituting C1ViewColumn

objects) and in the DataSetExtender (for table and column items), with the place of constraint

definition influencing its semantics. Constraints defined in C1DataViewSet are evaluated only when

changes are being made through a C1DataView row, or C1ViewRow object. The changes performed

through the DataTable rows of an underlying dataset are not checked by these constraints. A

constraint expression is based on a C1DataView row's values in this case, but not on values of base

DataTable rows.

In contrast, constraints defined in the DataSetExtender are evaluated when changes are made to

underlying DataTable rows, directly or through C1DataView row (note that changes made to

C1DataView row are reflected in underlying DataTable rows). In this case, the constraint expression

uses values of a DataTable row (DataRow object).

Any constraint expression is treated as the code of some class method returning a logical value and

expressed in a specified .NET Framework programming language. Therefore, expression code must

have a line which returns a value from the method (for example, RETURN statement for Visual Basic

and C#).

For row level constraint expressions the following class properties are accessible from the

expression code:

row (of type C1ViewRow for a constraint defined for C1DataView and of type

System.Data.DataRow for a constraint defined for a DataTable in DataSetExtender).

References a row for which the constraint is checking.

38

Example expression code in Visual Basic:

RETURN row("UnitPrice") * row("Quantity") < 100

For column level constraints you should treat expression as a method code of a class with the

properties as follows:

row (of type C1ViewRow for a constraint defined for C1DataView and of type

System.Data.DataRow for a constraint defined for a DataTable in DataSetExtender).

References a row for which column constraint is checking.

column (of type C1ViewColumn for a constraint defined for C1ViewColumn and of type

System.Data.DataColumn for a constraint defined for a DataColumn in DataSetExtender).

References a column for which the value is about to be changed.

The new Value (of type System.Object) contains a new proposed column value.

Example expression code in Visual Basic:

RETURN newValue > 0

Constraint expressions are defined through the ConstraintExpression property of corresponding

classes (C1DataView, C1ViewRow, DataTableExtender and DataColumnExtender;

DataTableExtender and DataColumnExtender define DataTable and DataColumn extended

properties in the DataSetExtender) with the following nested properties:

ConstraintExpression.Expression.Language defines the name of the .NET Framework programming

language, whose syntax is used to define an expression.

ConstraintExpression.Expression.Text defines an expression code.

ConstraintExpression.ErrorDescription allows defining an optional message for exception

which will be raised if the constraint is violated.

See Also Defining Constraints

Defining Constraints

You can define constraints using the Constraints tab located in the C1ViewSetDesignerForm. To

define a constraint expression for the UnitPrice field of the Products table, perform the following

tasks:

1. Right-click the C1DataViewSet component and select Edit from its Tasks menu. The


2. From the left pane, select the UnitPrice column of the Products table and click the

Constraints tab.

39

3. Select vb from the Language drop-down list to specify Visual Basic as the programming

language used to define expression.

4. Type the following expression in the Expression text box: Return newValue > 0

OR

Click the Expression Builder button to open the Expression Builder dialog box:

40

Select the greater than operator and enter 0 for the Value. Click OK to close the dialog box.

5. Type the following string in the Error Message box: UnitPrice must be a positive number

6. Click OK to close the dialog box.

If the user attempts to enter a negative number in the UnitPrice column of the Products grid, the

following error message appears:

Negative numbers are not allowed in accordance with the constraint we defined for the

Products.UnitPrice field.

41

See Also

C1DataView Relations

C1DataView Relations C1DataViews of C1DataViewSet can be set up to operate either as independent rowsets or to be

involved in a master-detail relationship. In the latter case, the behavior of the detail view has the

following specifics:

The set of rows accessible by means of detail view (that is, represented to bound controls

and programmatically in the C1DataView.Rows collection) is restricted by the rows which

are children for the current record of the master view. Note that the current view record is

programmatically accessible through the Current property and can be changed through the

Position property. You can still retrieve and use the CurrencyManager for these purposes,

but C1DataView provides everything you need, making accessibility much easier.

When a new row is added to a detail view, its foreign key field value is automatically filled

with the corresponding primary key value of the current row of the master view (foreign

key inheritance).

You can easily add a view as a detail of another view by selecting a master view in the

C1ViewSetDesignerForm and pressing the Add View toolbar button. The master view is one of

the C1DataViews, either simple or composite, that you create when you click the Add View button.

See C1DataView Definitions for additional information on adding C1DataViews.

See Also

Creating Table and Column Aliases

Creating a Master-Detail Relationship Between C1DataViews

Specifying a Parent View

Interaction with an Underlying ADO.NET Dataset

Creating Table and Column Aliases You can create aliases to make it easier to work with table and column names. The table and

column occurrences in a definition statement are differentiated by their aliases. Aliases come in

handy when:

You want to make the statement in the SQL pane shorter and easier to read.

You refer to the same table or column more than once, such as in a master-detail

relationship.

42

For example, you can create an alias o for a table name Orders, and then refer to the table as o

throughout the rest of the query.

The following statement shows an example of table and column aliases:

SELECT o.OrderID AS [Order ID], o.OrderDate AS [Date of Order], od.*

FROM Orders AS o JOIN [Order Details] AS od ON o.OrderID = od.OrderID

In this statement the Orders table has been given the alias o, and the Order Details table has the

alias od. The OrderID column has the alias Order ID while the OrderDate column has the alias Date

of Order.

To create this statement using the C1ViewSetDesignerForm, complete the following steps:

1. Right-click the C1DataViewSet component and select Edit from its context menu. The

C1ViewSetDesignerForm appears


3. Select a parent view from the right pane, and under Select a child view to add, select

Composite view from the list.

4. Click Add.

The C1DataView Definition Statement Builder opens.

5. Click the Tree View button, this represents a view definition as a tree and allows you to add

tables.

Note: Alternatively, you can access the C1Data View Definition Statement Builder by clicking

the ellipsis button next to the Definition property.

43

6. Click the Add Child Table button to open the Add Child Table dialog box and select

Orders from the list of available tables. Click Add, and then Close.

7. Under Table properties enter o in the Alias text box.

8. To create the first part of our definition, select o.OrderID from the Column drop-down list.

The column qualifier in the SELECT column list can have one of the following forms:

o * denotes all columns of all base DataTable(s). If it's defined it must be the only

column qualifier in the column list.

o [<table alias>.* denotes all columns from the specified base DataTable.

o [<table alias>.]<column name> [AS] [<column alias>] denotes the specific

DataColumn with optional column alias, with optional indication of the base

DataTable to which this column belongs.

o <expression> [AS] <column alias> defines a calculated column, whose value is

determined by evaluating the specified expression. The expression can include

constants, column references, arithmetical, logical and comparison operations, and

IS [NOT] NULL constructions, <match_expression> [ NOT ] LIKE

44

<pattern_expression> [ ESCAPE <escape_character> ] constructions, and

subexpressions can be grouped by means of parentheses. Column references of

the expression must indicate columns from the base DataTable(s), but not the

columns from the SELECT list.

9. Enter Order ID in the Alias column to give the OrderID column of the o table the alias

Order ID.

Note: The table automatically changes to o in the Table column.

10. To add another column to our C1DataView, select o.OrderDate from the second row of the

Column column.

11. Enter Date of Order in the Alias column.

o Note: The table automatically changes to o in the Table column.

12. In this example, you will create a JOIN to the Order Details table. Click the Add Child

Table button.

13. Select Order Details from the Select a child table to add list, and enter od in the Table

Alias text box.

14. In the Column column, select od.* from the drop-down list. This allows you to select all of

the columns from the Order Details table for our C1DataView.

The table automatically changes to od in the Table column, and our definition is complete:

15. Click OK, and then close the Add View box.

The new Orders view is added to the C1ViewSetDesignerForm, and the definition is

assigned to the Definition property.

45

See Also Creating a Master-Detail Relationship Between C1DataViews

Creating a Master-Detail Relationship Between C1DataViews To create a master-detail relationship between C1DataViews, complete the following steps:

1. Click the arrow above the C1DataViewSet component to open the C1DataViewSet Tasks

menu and select Edit.

2. In the C1ViewSetDesignerForm, select a master view and click the Add View button.

3. In the Add View dialog box, set up a C1DataView definition, either simple or composite,

and click OK.

The child, or details, view is added to the editor under the master view. The blue arrows

indicate a master-detail relationship; the master view name is on the left of the single

arrow, and the detail view name is on the right. The child view is listed below the master-

detail relationship indicator.

46

In this example, the Products view has a child view, Suppliers.

See Also

Specifying a Parent View

Specifying a Parent View Two views can be tied by a master-detail relationship only if one of the base DataTables, which has

the view on which the definition is based, of the master view has a DataRelation defined in the

underlying dataset which connects it to some base DataTable of the detail view.

When you specify a parent view for a certain detail view in the Add View dialog box of the

C1ViewSetDesignerForm, you can specify this DataRelation explicitly.

If you choose not to specify it, the C1DataViewSet automatically selects some DataRelation which

can connect those views. Namely, this DataRelation determines the fields which are used to filter

out detail rows for a current master row.

There are cases when more than one DataRelation can connect views, for example, suppose that we

have views with the following definitions:

47

MasterView SELECT * Customers JOIN Orders

DetailView SELECT * Orders JOIN [Order Details]

These views can be tied based on two DataRelation �"Customers -> Orders" (Orders from the

DetailView here) and "Orders -> Order Details" (Orders from the MasterView here).

In this case it's reasonable to define a base DataRelation explicitly because C1DataViewSet could

select a DataRelation other than the one you are supposed to use.

You can specify a parent view in the Add View dialog box when you add a C1DataView. To do this:

1. Add a view to your C1DataViewSet and specify the definition in the Add View dialog box.

2. From the left pane select a child view, and under Select a parent view, select one of the

possible parent view tables from the list.

You can access the Set Parent View dialog box from the C1ViewSetDesignerForm by clicking the

Set Parent View button.

Another complex case when more than one DataRelation connects views is when some or both of

the views involved in a master-detail relationship reference the same DataTable more than once (in

this case the tables' occurrences in a definition statement are differentiated by their aliases). If the

base DataRelation corresponds to such a DataTable, you should have the ability to specify which

occurrence of the DataTable must be used (that is, rows of what table alias participate in the

relationship). You can do this by explicitly defining an involved DataTable alias in the Set Parent

View dialog box. To do this:

1. Click the Set Parent View button. The Set Parent View dialog box opens.

48

2. Select a Base DataRelation that corresponds to the DataTable from the drop-down box.

3. Specify the Parent DataTable alias and Child DataTable alias.

Note: Set any of the Parent relation details drop-down lists to <auto detected> if you want

the C1ViewSetDesignerForm to automatically detect them for you.

See Also Interaction with an Underlying ADO.NET Dataset

Interaction with an Underlying ADO.NET Dataset Interaction between C1DataViewSet and an underlying dataset, either defined explicitly through the

DataSet property or internally created based on the ConnectionString / ConnectionProvider

property values, is absolutely clear in the sense that a rowset of C1DataView and of base DataTables

(the ones referenced in the C1DataViewSet definition statement) is always in sync.

When C1DataView performs data fetching from the database server, it actually fetches rows to the

base DataTables and constructs its own rowset based on their rows.

After this is done, the corrections made to C1DataView rows are immediately reflected in the base

DataTables' rows, and vise versa you can edit (modify/add/delete) rows directly through DataTables,

and those corrections will be reflected in rowsets of all C1DataViews based on modified

DataTables.

See Also

49

Data Fetching

Data Fetching

Fetching is the process of retrieving rows from the result set and returning them to the application.

You can turn on or off AutoFetching for all views in C1DataViewSet by means of the

C1DataViewSet.AutoFetch property (turned on by default).

You can control AutoFetching of a specific C1DataView data using the C1DataView.AutoFetch

property. If C1DataView.AutoFetch is set to its default value, AutoFetchModeEnum.Default, then

the AutoFetch mode is determined by the C1DataViewSet.AutoFetch property value of an owning

C1DataViewSet.

The following capture shows how to access the C1DataView.AutoFetch property through the

C1ViewSetDesignerForm:

50

If the effective value of the AutoFetch property is set to AutoFetchModeEnum.Yes, then data for

underlying DataTables is fetched even if the data has already been fetched by another C1DataView.

By changing this property value to AutoFetchModeEnum.YesIfNoData, you instruct ADO.NET

DataExtender to check whether data necessary for this C1DataView has already been fetched by

other fetch requests. If this is the case, then data will not be fetched repeatedly.

Automatic fetching of foreign key lookup tables is controlled by the AutoFetchLookupTable. It has

an effect only for view columns that represents a foreign key DataColumn and has the ItemListType

property set to ItemListTypeEnum.ForeignKey.

The following capture shows how to access the AutoFetchLookupTable property through the


51

If this property is set to its default value, AutoFetchModeEnum.Default, then an effective value of

this property is determined by the C1DataView.AutoFetch property value of C1DataView that this

column belongs to.

Using the Fill method

To load data into your application, you must call the Fill method of a data adapter. When automatic

data fetching is suppressed, or in order to refresh client rowsets with data from a server, you can

use any of the following Fill methods:

The Fill (including LookupTables as Boolean) method fills all the views in the viewset, and a

Boolean parameter indicates whether foreign key lookup tables should be filled.

The Fill () method is equivalent to C1DataViewSet.Fill (False).

The C1DataView.Fill (Boolean) method allows the user to fill a specific C1DataView, with an

indication whether its lookup tables should be filled.

The Fill () method is equivalent to Fill (False).

The FillLookupTable () method fills a lookup table of the column.

This method has an effect only if the column represents a foreign key DataColumn and its

ItemListType property is assigned with ItemListTypeEnum.ForeignKey value

52

See Also

Working with DataSetExtender

Working with DataSetExtender Typed ADO.NET dataset provides a set of properties for constituting DataTables and their

DataColumns, which are propagated by C1DataViewSet to its C1DataViews and C1ViewColumns.

For example, DataColumn.ReadOnly is used as a default value for the ReadOnly property of a

column that is based on the corresponding DataColumn.

However, C1DataViews and their constituting C1ViewColumn objects provide an extended set of

properties (compared to an ADO.NET DataTable and DataColumn, which are not necessary, but

useful for some properties) when defining them one time in one single place, similar to what is

done for typed dataset properties.

Such a place is provided by ADO.NET DataExtender and is called DataSetExtender.

DataSetExtender provides storage for specifying an extended set of property values for the

specific typed dataset. For example, DataSetExtender represents DataTable and DataColumn

related properties which are not defined on these classes, but which C1DataViewSet would like to

have and is capable of consuming. The core class that represents DataSetExtender is

DataSetExtender.

Creating a DataSetExtender

To create a DataSetExtender, perform the following tasks:

1. Select Add New Item from the Project menu in Visual Studio. Alternatively, right-click the

project node in the Solution Explorer and select Add | New Item from its context menu.

The Add New Item window appears.

53

2. Select DataSet Extender for the dataset, enter a name for the DataSetExtender in the

Name text box, and click Add.

The DataSetExtender is created as a global project item, similar to typed ADO.NET dataset,

and its designer appears in a separate window of the VS IDE.

3. From the Properties window, set the DataSetExtender.DataSet property value to an

existing typed ADO.NET dataset within the project.

The DataSetExtender represents an additional set of properties for this dataset. The

DataSetExtender automatically creates all items representing DataTable and DataColumn

objects from the specified typed dataset, and will keep them in sync when they are updated

in the future. For instance, if you add a new DataTable or DataColumn to the typed

dataset a corresponding item is automatically created in DataSetExtender the next time you

open its designer.

To set the properties for one of the items listed in the DataSetExtender:

1. Select an item which represents either a table or column in the DataSetExtender designer.

2. Modify its properties through the Visual Studio Properties window.

To apply DataSetExtender property values to a certain C1DataViewSet component:

1. Select one of the C1DataViewSet components on the form.

2. Set the C1DataViewSet.SchemaExtender property to the name of the DataSetExtender in

the Visual Studio Properties window. Note that you have to rebuild your project for the

name of the DataExtender to appear in the C1DataViewSet.SchemaExtender drop-down list.

See Also Connection Information

54

Connection Information DataTable objects of a typed dataset usually have a corresponding Table Adapter that defines a

connection (a DbConnection derived object) used to retrieve and update the data of a DataTable

from/to the database server, along with other attributes devoted to the client and server data

interchange.

The C1DataViewSet needs some additional information concerning the specifics of the database

server, which is referenced in the connection of a Table Adapter. This additional information helps

C1DataViewSet to provide the entirety of its capabilities; for example, automatically refreshing the

server generated primary key value in a client row.

This information is represented in the DataConnectionExtenderBase derived class,

DataTableConnectionExtender, belonging to the DataTableExtender objects of

DataSetExtender and is accessible through the DataTableExtender.ConnectionInfo property.

The property values of the DataTableConnectionExtender objects can be:

Determined automatically

To detect property values automatically, set the

DataConnectionExtenderBase.AutoDetect property to True. In this case ADO.NET

DataExtender will detect a type of database server represented by a corresponding Table

Adapter connection. If this database server is familiar to ADO.NET DataExtender, then

property values of the connection information object will be assigned automatically. The

type of server is identified through the DataConnectionExtenderBase.ServerType

property, if the server type is not recognized by ADO.NET DataExtender then this property

is ServerTypeEnum.Unknown.

Defined explicitly

When the server type is unknown you can manually set the connection information

property values. To do this, ensure that DataConnectionExtenderBase.AutoDetect is set

to False and DataTableConnectionExtender.BaseConnection to a null value, and then

you can set property values explicitly.

Inherited from property values of the global connection information objects of type

DataSetConnectionExtender contained in the DataSetExtender.ConnectionInfo's

collection

Usually, the only connection is used for all or most Table Adapters of a typed dataset. To

make connection information management more flexible, ADO.NET DataExtender allows

you to define one or more DataSetConnectionExtender objects in the

DataSetExtender.ConnectionInfos collection and simply inheriting their values in

DataTableExtender.ConnectionInfo objects. In order to use this capability, just set the

55

DataTableExtender.ConnectionInfo.DataTableConnectionExtender.BaseConnection

property value to an instance of a DataSetConnectionExtender object from the

DataSetExtender.ConnectionInfos collection.

To connect DataSetExtender to the specific typed

dataset:

1. Select DataSetExtender1.cs (or DataSetExtender1.vb) from the Solution Explorer window

and double-click it to open it.

2. From the Schema Extender tree, select the DataTableExtender that you wish to define.

3. Modify its DataTableConnectionExtender.BaseConnection property through the Visual

Studio Properties window:

When DataSetExtender is initialized for the first time after connecting it to the specific typed

dataset, it investigates connections defined in Table Adapters and creates a distinct list of

corresponding DataSetConnectionExtender objects in the DataSetExtender.ConnectionInfos

collection. Usually it will create a single DataSetConnectionExtender object. For each

DataTableExtender object contained in the DataSetExtender the

DataTableConnectionExtender.BaseConnection property value is set to the instance of the

corresponding DataSetConnectionExtender object from the DataSetExtender.ConnectionInfos

collection. Doing this will ease management in the future. If you need to make database server

adjustments, simply change the property values of the global DataSetConnectionExtender object

which will automatically change the property values of all DataTableExtender.ConnectionInfo

objects.

56

See Also

Working with Typed DataViewSet

Working with Typed DataViewSet ADO.NET DataExtender also provides a facility to create strongly typed view set definitions that

are global for your project. Such a definition resides as a project level item and can be reused in

multiple forms of your application. This feature is called typed DataViewSet and, compared to a

locally defined DataViewSet, has the following benefits:

Allows defining a view set structure in a single centralized place and the ability to reuse it in

multiple places of your application. Being defined in a .dll, it can be reused in multiple

applications.

In addition to the view set structure, you can create event handler code for views and view

set itself that will be a part of the view set definition, that is will be reusable as well.

Provides a strongly typed object model for a convenient and safe access to a view set data

in a code.

For example, the following VB code retrieves current Employee's name as a string from

untyped view set:

CType(northWindViewSet.Views("Employees").Current("FirstName"),

String)

The following VB code represents a typed view set:

northWindViewSet.EmployeesView.Current.FirstName

Taking into account the fact that during typing the code for the untyped view set you must

type view and column names manually, whereas for typed view set you will have a full

IntelliSense support, you may realize that programming against the typed view set is far

more productive.

See Also

Data Driven Application Paradigm

Data Driven Application Paradigm In order to create a robust and well-manageable data driven application which uses ADO.NET

DataExtender, we suggest the following application architecture:

Create a typed dataset that represents the whole or a significant part of your database.

Define business logic here by writing event handlers for the

ColumnChanging/RowChanging/RowDeleting events of DataTables.

57

Create a DataSetExtender that extends this typed dataset.

Use C1DataViewSet components connected to the dataset and referencing its

DataSetExtender to define the form's data model. Bind UI controls to C1DataView objects

defined in this C1DataViewSet, and write event handlers for events represented by

C1DataViewSet to provide custom processing of data navigation and changing specific for

this Form.

If you would like to use the same view set definition in multiple places of the application, or

if you just want a more convenient strongly typed access to the view set object model then

you may want to create a project level typed DataViewSet.

See Also Data Library Approach

Creating a Data Library

Data Library Approach

You have the opportunity to raise manageability of the data representation layer even greater by

creating a Data Library that can be reused between multiple applications. To create a Data Library,

perform the following steps:

1. Create a regular Class Library project.

2. Add typed DataSet, DataSetExtender and a number of typed DataViewSet components

that to the library.

Now you can reference this Class Library in your applications and use components defined in the

Class Library, see Creating a Data Library for details.

Creating a Data Library

The ability to create project level view set definitions gives you the option to create a data library

that can be reused among multiple applications. This can be done by means of a regular .dll (Class

Library) project where you can add:

Typed ADO.NET DataSet

A number of typed DataViewSet definitions that uses those DataSet as a data source

Optionally, you can create:

ADO.NET DataExtender that represents the DataSet and can be referenced in typed

DataViewSets

You may then reference this .dll from you application's project and use the view sets defined in the

library in a usual manner.

In the case when Data Library is included as a Project in your solution and you reference it as a

project (References|Add Reference and select the Projects tab); rebuilding the solution makes all

the typed view sets from the Data Library available in the Toolbox.

58

If Data Library project is not a part of the solution then you will need to install it in the Toolbox

manually. Simply select the Data Library assembly in the Choose Toolbox Items dialog box of VS

IDE. For more information, see Adding ComponentOne Components to a Project.

See Also

Creating a Typed DataViewSet

Creating a Typed DataViewSet To create a new typed DataViewSet, complete the following basic operations:

1. Select Add New Item from the Project menu in Visual Studio. Alternatively, right-click the

project node in the Solution Explorer and select Add | New Item from its context menu.

The Add New Item dialog box of VS IDE appears.

2. Select the C1Typed DataViewSet item and click Add. A new project item that represents a

typed DataViewSet will be created.

The C1TypedDataViewSet designer appears.

3. From the Toolbox, add a DataSet control to the component tray at the bottom of the

C1TypedDataViewSet designer by performing a drag-and-drop operation.

4. The Add DataSet dialog box appears. The Typed dataset option is selected, click OK.

5. From the Properties window, assign the DataSet control to the DataSet property of the

C1TypedDataViewSet.

The C1TypedDataViewSet designer is similar to the untyped C1DataViewSet, but it has added

support that allows you to create specifically typed event handlers for views and the typed

C1DataViewSet itself, as well as for any component placed on the component tray.

To create the specifically typed event handlers for views, simply double-click the event item in the

Events list of the VS IDE Properties window, which is accessed by selecting the Events button .

An event handler method definition will be created in the code file.


59

As for other types of project level components, typed DataViewSet is represented by the following

code files:

A code file for a user's custom code with a filename.ext name template (you can define

additional members for viewset and dataview classes, event handler methods are also

here).

A code file with the filename.Designer.ext name template that contains auto generated

code and should not be changed manually.

To use a typed DataViewSet instance in forms:

Rebuild your application. A Toolbox item that represents this ViewSet appears under the

<Project Name> Components tab at the top of the Toolbox.

From there you can place it on a Form using a drag-and-drop operation.

See Also ADO.NET DataExtender Samples

ADO.NET DataExtender Samples Please be advised that this ComponentOne software tool is accompanied by various sample

projects and/or demos, which may make use of other development tools included with the

ComponentOne Studios.

All samples use the standard Microsoft Access sample Northwind database, Nwind.mdb. Note that

the sample projects have the database location hard coded in the connection string:

For Windows XP: C:\Documents and Settings\<username>\My Documents\ComponentOne

Samples\Common

For Windows 7/Vista: C:\Users\<username>\Documents\ComponentOne

Samples\Common

If you have the Northwind database installed in a different location, you can change the connection

strings, or copy the Nwind.mdb file to the required location.

You can access samples from the ComponentOne Sample Explorer. To view samples, click the Start

button and then click ComponentOne | Studio for WinForms | Samples | ADO.NET

DataExtender Samples.

Click one of the following links to view a list of ADO.NET DataExtender samples:

To write code in Visual Basic

ADO.NET DataExtender includes the following Visual Basic samples:

60

Sample Description

ViewSet_Define_Fill_Update Explains the basic functionality of the C1DataViewSet component.

Namely, it depicts how to define C1DataViewSet to work against

ADO.NET typed DataSet, fill it with data and commit changes made

by the user back to the database server. This sample uses the

C1DataViewSet component connected to a typed DataSet object

with two C1DataView objects joined by a C1ViewRelation object.

ClientFilterSortFind Demonstrates filtering, sorting and searching of C1DataView rows,

which are performed on a client. This sample uses the


with a single C1DataView.

SchemaExtender Demonstrates the usage of ADO.NET typed DataSet with

DataSetExtender and explains the usage of constraints defined in an

arbitrary .NET programming language (represented by the

ConstraintsForm form). This sample uses the C1DataViewSet

component connected to a typed DataSet object with a single

C1DataView.

CompositeRowEditing Depicts some details of composite rows editing behavior. This

sample uses the C1DataViewSet component connected to a typed

DataSet object with a single C1DataView.

UntypedDataSet Demonstrates how to use C1DataViewSet in conjunction with

untyped ADO.NET DataSet. C1DataViewSet allows the user to show

and edit data from untyped DataSet tables according to its

C1DataView(s) definitions This sample uses the C1DataViewSet

component connected to an untyped DataSet object with a single

C1DataView.

Programmatic Demonstrates how to create and use C1DataViewSet in run time

programmatically. This sample creates the C1DataViewSet

component connected to a typed DataSet object with two

61

C1DataView objects joined by a C1ViewRelation object.

ColumnStyles_In_FlexGrid Demonstrates how to set up column styles, which are honored by

the C1FlexGrid control in run time, using an ADO.NET DataSet

Extender.

ColumnStyles_In_TrueDBGrid Demonstrates how to set up column styles, which are honored by

the C1TrueDBGrid control in run time, using an ADO.NET DataSet

Extender.

To write code in C#

ADO.NET DataExtender includes the following C# samples:

Sample Description

ViewSet_Define_Fill_Update Explains the basic functionality of the C1DataViewSet component.

Namely, it depicts how to define C1DataViewSet to work against

ADO.NET typed DataSet, fill it with data and commit changes made

by the user back to the database server. This sample uses the


with two C1DataView objects joined by a C1ViewRelation object.

ClientFilterSortFind Demonstrates filtering, sorting and searching of C1DataView rows,

which are performed on a client. This sample uses the


with a single C1DataView.

SchemaExtender Demonstrates the usage of ADO.NET typed DataSet with

DataSetExtender and explains the usage of constraints defined in an

arbitrary .NET programming language (represented by the

ConstraintsForm form). This sample uses the C1DataViewSet

component connected to a typed DataSet object with a single

C1DataView.

62

CompositeRowEditing Depicts some details of composite rows editing behavior. This

sample uses the C1DataViewSet component connected to a typed

DataSet object with a single C1DataView.

UntypedDataSet Demonstrates how to use C1DataViewSet in conjunction with

untyped ADO.NET DataSet. C1DataViewSet allows the user to show

and edit data from untyped DataSet tables according to its

C1DataView(s) definitions This sample uses the C1DataViewSet

component connected to an untyped DataSet object with a single

C1DataView.

Programmatic Demonstrates how to create and use C1DataViewSet in run time

programmatically. This sample creates the C1DataViewSet

component connected to a typed DataSet object with two

C1DataView objects joined by a C1ViewRelation object.

ColumnStyles_In_FlexGrid Demonstrates how to set up column styles, which are honored by

the C1FlexGrid control in run time, using an ADO.NET DataSet

Extender.

ColumnStyles_In_TrueDBGrid Demonstrates how to set up column styles, which are honored by

the C1TrueDBGrid control in run time, using an ADO.NET DataSet

Extender.

See Also

ADO.NET DataExtender Task-Based Help

ADO.NET DataExtender Task-Based Help The task-based help assumes that you are familiar with programming in Visual Studio .NET

environment, and know how to use bound controls in general. Each topic provides a solution for

specific tasks using ADO.NET DataExtender. The help uses an Access database, Nwind.mdb, as the

data source. It is assumed Nwind.mdb is in the ComponentOne Samples\Common directory (see

ADO.NET DataExtender Samples for more information) where it is installed when ADO.NET

DataExtender is installed, and it is referred to by filename instead of the full pathname for the sake

of brevity.

63

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

C1DataViewSet component to the form and defined a data source for it. For additional

information, see Creating a .NET Project and C1DataViewSet Data Sources.

See Also

Working with the C1ViewSetDesignerForm

Working with the C1DataView Definition Statement Builder

Working with the C1ViewSetDesignerForm The following topics demonstrate how to add and modify C1DataViews using the

C1ViewSetDesignerForm. Using the C1ViewSetDesignerForm, you can define one or more views

at design time. If the underlying data source has table relationships defined, then you can add

individual tables accordingly.

Complete the following steps to open the




2. From its Tasks menu, select Edit to edit the C1DataViewSet's structure. The


See Also Adding a C1DataView

Defining C1DataView

Previewing a C1DataView

Removing a C1DataView

Adding a C1DataView

To add a C1DataView, complete the following steps:

1. Open the C1ViewSetDesignerForm.

http://helpcentral.componentone.com/nethelp/c1studiowinforms/#!Documents/creatinganetproject.htm

64

2. Click the Add View button.

The Add View dialog box opens.

You can create a definition at this time or add one later. You can also specify a parent view,

if creating a child view.

3. Click Add, and then Close.

The view you have added will appear in the left pane of the C1ViewSetDesignerForm.

See Also

Defining C1DataView

65

Defining C1DataView

To create a C1DataView definition, use the Definition property or the Add C1DataView dialog box.

Using the C1DataView.Definition property:

Select an existing C1DataView. You have two options when using the Definition property:

Click the ellipsis button next to the Definition property to open the C1DataView

Definition Statement Builder and create the definition.

OR

Enter a definition directly into the text box next to the Definition property.

Using the C1DataView dialog box:

1. Open the C1ViewSetDesignerForm, and select Edit from the C1DataViewSet Tasks



3. Select a table from the list of available dataset tables under Select a child view to add if

creating a simple view definition.

See Also Previewing a C1DataView

66

Previewing a C1DataView

You can view your changes and edits at design time by means of the Preview tab located in the

C1ViewSetDesignerForm. To preview a C1DataView.Fill (Boolean) , complete the following steps:

Open the C1ViewSetDesignerForm.

Select the view to preview.

Click the Preview tab.

See Also



To remove a view, complete the following steps:

1. Open the C1ViewSetDesignerForm.

2. Select the view to be removed.

67

3. Click the Delete View button.

See Also Working with the C1DataView Definition Statement Builder

Working with the C1DataView Definition Statement Builder The following topics show how to define C1DataViews using the C1DataView Definition

Statement Builder.

See Also

Accessing the C1DataView Definition Statement Builder

Adding a Child Table Node

Accessing and Changing Join Properties

Specifying or Changing the Table Alias

Specifying a Filter Condition

Adding Specific Columns to the View

Viewing and Changing the Definition Statement

Accessing the C1DataView Definition Statement Builder

To open the C1DataView Definition Statement Builder, you have two options:

If you have not created a view:

1. From the C1ViewSetDesignerForm, select the Add View button to open the Add View

dialog box.

2. From the Add View dialog box, select Composite View under Select a child view to add

and click Add.

If you have created a view:

1. From the C1ViewSetDesignerForm, select the view (table) from the left pane.

2. In the Properties grid, click the ellipsis button next to the Definition property.

68

See Also Adding a Child Table Node

Adding a Child Table Node

To add a child table node, complete the following steps:

1. Open the C1DataView Definition Statement Builder.

2. Click the Add Child Table button to open the Add Child Table dialog box.

3. Select a table from the list of available tables under Select a child table to add.

Note: The available tables in the list depend on the DataRelations in your DataSet. If

specifying the initial table, all tables within the DataSet are available. If specifying a child table

node for an existing table, only tables that have a relation to that table are available. Open the

DataSet Designer to view table relations. For more information on relations and the DataSet

Designer, see the Microsoft Visual Studio Documentation.

4. Click Add, and Close.

See Also Accessing and Changing Join Properties

69

Accessing and Changing Join Properties

You can specify whether a join is an OUTER or INNER join and set the relation between the tables

through the Join properties dialog box. To change join properties from the C1DataView

Definition Statement Builder, complete the following steps:


2. Add a Child Table Node.

When adding the initial table, the Join properties dialog box is not available. Add a child

table to the current table for the Join properties dialog box to become available.

3. Click the Add Child Table button to open the Add Child Table dialog box.

4. Select the table you just added from the list of available tables under Select a parent view,

or None.

5. Select a related table from the list of available tables under Select a child table to add.

6. Click Add, and Close.

7. Open the Join properties dialog box.

o If the Tree View is selected, click the connection node between the two tables to

view the Joint Properties in the window on the right.

o If the Diagram View is selected, right-click the connection between the two tables

and select Properties.

The Join properties dialog box will appear.

70

8. From the Join properties dialog box, select an OUTER or INNER join and set the relation

between the two selected tables from the Relation drop-down box.

If a relation is not specified here then it will be automatically detected. A relation must be

specified only if related tables have more than one relation between them, because, in this

case, the automatically detected relation may not be the relation you want.

See Also



A table alias can be specified when the table is added to the definition statement. If no alias was

specified or the alias needs to be changed, you can add one through the Alias property.

To add a table alias through the Alias property, complete the following steps:


2. Select a table from the Table drop-down list and a column from the Column drop-down

list.

3. Enter an alias name in the Alias text box in the lower pane.

See Also Specifying a Filter Condition

71

Specifying a Filter Condition

You can specify a filter condition (an expression of the WHERE clause of a definition statement) that

is used to limit number of rows represented by the view. The expression can include constants,

column references, arithmetical, logical and comparison operations, and IS [NOT] NULL

constructions, and subexpressions can be entered and grouped using parentheses. Column

references of the expression must indicate columns from the base DataTable(s), but not the

columns from the SELECT list. The expression must return a logical value.

To specify a filter condition, complete the following steps:


2. Enter an expression in the Filter condition text box.

For example, if you want to apply a filter that finds a specific OrderID, I can use the

following expression:

OrderID = 10248

The expression is added to the definition statement.

In the view, only rows containing an OrderID of 10248 are displayed.

See Also



From the C1DataView Definition Statement Builder you can add columns to the view manually

or using the Add columns buttons.

To add columns manually (in Diagram View):

72

1. Select a column to add to the view by selecting the checkbox beside the column item

Note that you may also use the Column drop-down list to select a column to add to the

table

2. Enter an alias name for the column in the Alias text box

3. Specify a table using the Table drop-down list

To add columns using the Add columns buttons (in

Tree View)

1. From the Columns list in the right pane, select a column to add

2. Click the Add selected columns button . If you want to add all of the columns that are

not already in the definition statement, click the Add all columns which are not in

statement button. The specified columns appear in the left pane

See Also Viewing and Changing the Definition Statement

73

Viewing and Changing the Definition Statement

Once you have added tables and columns for the definition statement, the definition statement

appears in the bottom pane. You can change the statement in this pane, if necessary, although this

can change other settings in the definition statement builder.

See Also

Adding a Child View

Adding a Child View To add a child view to a C1DataViewSet, complete the following steps:

1. In the C1ViewSetDesignerForm, select a view in the left pane and press the Add View

button.

2. Select a child view to add from the list and click Add. Select the ellipsis button next to

the Definition property to open the C1DataView Definition Statement Builder.

3. Set up a C1DataView definition, either simple or composite, in the C1DataView definition

area of the dialog box and click OK. See C1DataView Definitions for more information on

creating simple and composite views.

The child view object is created and has the Definition property value set.

4. Click OK to close the C1DataView Definition Statement Builder and again to close the

C1ViewSetDesignerForm.

See Also Committing Changes

Committing Changes To commit changes to the server, complete the following steps:

1. Add a Button control to your Windows form.

2. Define some C1DataView objects for the C1DataViewSet component on the form.

3. Add the following code:


Visual Basic Copy Code

Private Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles

Button1.Click

C1DataViewSet1.Update()

74

End Sub

To write code in C#

C# Copy Code

private void button1_Click(object sender, EventArgs e)

{

C1DataViewSet1.Update();

}

The Update method automatically determines the correct order in which rows should be committed

to the server. It also refreshes client row columns with new values generated on the server,

including the cases of server generated autoincrement columns in conjunction with master-detail

relationships between tables.

See Also

Sorting and Filtering Data

Sorting and Filtering Data

Sorting

To sort C1DataView rows, complete the following steps:

1. From the C1ViewSetDesignerForm, select a DataView.

2. Enter a sort order definition in the Sort property by specifying the columns in the order

they should be sorted.

Note: Each column name should be separated by a comma. Ascending order is the default sort

order, but you can sort in descending order by adding DESC after the column name.

Filtering

To filter C1DataView rows, complete the following steps:

1. From the C1ViewSetDesignerForm, select a view from the ViewSet.

2. Enter a filter definition in the DataView's C1DataView.RowFilter property.

The syntax of a filter expression is the same as for the WHERE clause of the View Definition

Language, with the single exception that the RowFilter expression references columns of

75

C1DataView (C1ViewColumn objects) while the View Definition Language's WHERE expression

references columns of the base DataTable(s).

See Also

Updating a C1DataView Definition

Updating a C1DataView Definition This topic shows how to update a view's definition at run time. It assumes you have created a

project with two DataGrids bound to a C1DataViewSet and two text boxes. To update the view's

definition at run time, add code to the Button_Click events:

1. Add the following Button1_Click event code:




Button1.Click

C1DataViewSet1.Views(0).Definition = TextBox1.Text

End Sub

To write code in C#

C# Copy Code


{

C1DataViewSet1.Views[0].Definition = textBox1.Text;

}

2. Add the following Button2_Click event code:



76

Private Sub Button2_Click(ByVal sender As Object, ByVal e As EventArgs) )

Handles Button2.Click

C1DataViewSet1.Views("OrdDetProductView").Definition = TextBox2.Text

End Sub

To write code in C#

C# Copy Code


{

C1DataViewSet1.Views["OrdDetProductView"].Definition = textBox2.Text;

}

The Update button enables the user to make and update changes to the view's definition

statement in run time.

Editing at run time:

Observe that the views are filled automatically.

77

C1DataViewSet1 fills the underlying base DataTable(s) of nwindDataSet1which are referenced in

the views (Orders, Order Details and Products in this example) and builds rowsets of views based

on the content of those tables. All other DataTable(s) of nwindDataSet1 remain empty.

Testing the Update button:

In the OrdersView definition textbox, change Orders to Products.

Now press the Update button and you'll see that the DataTable changes to the Products

view and builds rowsets of views based on the content of the Products DataTable.

Sample Available

For the complete sample, see the ViewSet_Define_Fill_Update sample, which is available for

download from the ComponentOne HelpCentral Sample page.

See Also

Composite Row Editing

http://helpcentral.componentone.com/ProductResources.aspx?View=Samples

78

Composite Row Editing This topic demonstrates the behavior of composite rows after editing. It assumes you have created

a project with a textbox, a button and three DataGridViews. One grid is bound to a C1DataViewSet

and the other two are bound to a dataset. To begin, complete the following steps:

1. From the C1ViewSetDesignerForm, create new C1DataView with the following definition

to establish a composite view with an outer join between the Orders and Order Details

tables: SELECT o.OrderID, o.CustomerID, od.* FROM Orders AS o OUTER JOIN [Order Details] AS od

2. Connect DataGridView1 to the C1DataView by setting its DataGridView.DataSource

property to C1DataViewSet1 and DataGridView.DataMember property to DataView.

3. Set the DataGridView.DataMember property for dataGridView2 and dataGridView3 to

Orders and Order Details, respectively. Then set the DataGrid.DataSource property for

both DataGrid2 and DataGrid3 to nwindDataSet1.

dataGridView2 and dataGridView3 are now bound to Orders and Order Details

DataTable(s) from the nwindDataSet1 DataSet, that is, to the base tables on which the view

is based.

4. Create an Update button to the right of the textbox. See Updating a C1DataView Definition

for instructions on this.

5. Run the application and begin editing the composite rows to view their behavior.

Sample Available

For the complete sample, see the CompositeRowEditing sample, which is available for download

from the ComponentOne HelpCentral Sample page.

See Also

DataView Row Actions for an Outer Join

Modifying the Base DataTable(s)

DataView Row Actions for an Inner Join

DataView Row Actions for an Outer Join

To observe DataView row actions for an OUTER JOIN, complete the following steps:

Add a new row to the DataGridView (dataGridView1) and assign the CustomerID column

ALFKI. Scroll to the bottom of the Orders DataTable (dataGridView2) and the Order

Details DataTable (dataGridView3) and notice that the new row has been added to Orders

DataTable, but not the Order Details DataTable. This occurs because the OrdersDetails


79

DataTable does not have a CustomerID child row.

Also note that the OrderID column of the new row has taken a value automatically, because

this column is defined as DataColumn.AutoIncrement in nwindDataSet1.

Now select the newly added row and assign the ProductID to 10 (note that this column

represents a column from the Order Details DataTable), and end editing. Observe that the

new row has been added to the Order Details DataTable, with the OrderID column

referencing the newly added row from the Orders DataTable.

Add another row to the DataView's grid, and set its od_OrderId column (foreign key of

Orders Details DataTable referencing the Orders DataTable) to the same value as in the

80

previously added row. Next, assign the ProductID column to 12, and end editing. Observe

that nothing has changed in the Orders DataTable, but a new row has been added to the

Order Details DataTable. Note that a new row has not been added to the Orders

DataTable because the od_OrderId column has been assigned with a value referencing the

existing row from the Orders DataTable.

img border="0" alt="" src="ImagesExt/image9_22.png" width="549" height="329" />

Set the view's OrderID column value (primary key of Orders DataTable) in one of the newly

added rows to 20000. Observe that this value will be changed in the other view's added

row, as well as the values of OrderID columns in the corresponding rows of Orders and

Order Details DataTables.

See Also Modifying the Base DataTable(s)

Modifying the Base DataTable(s)

To observe DataView row actions for an OUTER JOIN, complete the following steps:

1. In the Orders DataTable, change the value of CustomerID column of the previously added

row to VINET, end editing and observe that this value has changed in both corresponding

81

rows of the DataView.

2. In the Order Details DataTable, delete one of the newly added rows and see that the

corresponding composite row was deleted from DataView.

Then delete the other newly added row and observe that the corresponding row has not

disappeared from DataView, but the values of columns corresponding to the Order Details

DataTable became null. This is because of the OUTER join.

82

Now delete the row from the Orders DataTable and see that the corresponding row

disappeared from DataView.

See Also



To observe DataView row actions for an INNER JOIN, complete the following steps:

1. In the textbox containing the view definition statement, change the OUTER keyword to

INNER (to define an inner join) and press the Update Definition button to apply the

changes.

2. Perform the same operations as from DataView Row Actions for an OUTER Join and notice

the following changes:

o When you try to add a view row without assigning some column corresponding to

a column from the Order Details DataTable, you get a constraint violation

exception concerning the empty ProductID column.

This occurs because the inner join composite view row can only exist if it references

the rows from each base DataTable.

83

o Click the Yes button and add a value to the ProductID column; notice that the view

creates a new row in the Order Details and Orders DataTables.

o When you delete the last child row from Order Details DataTable for the specific

parent row, a corresponding view row will be removed, regardless of the existence

of a parent row from the Orders DataTable.

See Also Using C1DataViewSet with an Untyped ADO.NET DataSet

Using C1DataViewSet with an Untyped ADO.NET DataSet This topic demonstrates how to use C1DataViewSet in conjunction with an untyped ADO.NET

DataSet, where data fetching and committing are performed by means other than the

C1DataViewSet. It assumes you have created a project with a textbox, three buttons and three

DataGridView controls.

Note: C1DataViewSet only allows the user to show and edit data from untyped DataSet tables

according to its C1DataView(s) definitions.

To begin, complete the following steps:

1. Create an untyped DataSet by adding a DataSet control to the form and connecting the

C1DataViewSet to dataSet1. For more information on creating an untyped DataSet, see the

Microsoft Visual Studio Documentation.

2. To connect dataGridView1 to the C1DataViewSet, set the DataGridView.DataSource

property to C1DataViewSet1.

3. Set dataGrid1's DataGridView.DataMember property to DataView.

84

4. From the C1ViewSetDesignerForm, select the DataView's Definition property and enter

the following definition to establish a single view: Select * From Orders join [Order Details]

5. Add an OleDbConnection and two OleDbDataAdapter controls to your form.

Configure the settings to create a data connection that allows the adapter to communicate

with the Nwind.mdb database. For more information on Data Adapter configuration, see

the Microsoft Visual Studio Documentation.

6. Set the OleDbConnection.ConnectionString property to Nwind.mdb to create a data

connection to the specific database.

7. Change the OleDbAdapter1.Name property to ordersDataAdapter and the

OleDbAdapter2.Name property to OrdDetDataAdapter.

Sample Available

For the complete sample, see the UntypedDataSet sample, which is available for download from

the ComponentOne HelpCentral Sample page.

Fetching Data from the Server at Run Time

To fetch data from the server at run time by the click of a button, complete the following steps:

1. Double-click button1 (in the sample project, the Create Orders and Fill button at the right

of dataGridView2) to bring up the Button1_Click event handler and replace it with the

following code:




Button1.Click

ordersDataAdapter.Fill(dataSet1)

Dim tb As DataTable = dataSet1.Tables("Orders")

tb.PrimaryKey = New DataColumn() {tb.Columns("OrderID")}

ordersDataGrid.DataSource = dataSet1

ordersDataGrid.DataMember = "Orders"

Button1.Enabled = False

End Sub

To write code in C#


85

C# Copy Code


{

ordersDataAdapter.Fill(dataSet1);

DataTable tb = dataSet1.Tables["Orders"];

tb.PrimaryKey = new DataColumn[] { tb.Columns["OrderID"] };

ordersDataGrid.DataSource = dataSet1;

ordersDataGrid.DataMember = "Orders";

button1.Enabled = false;

}

2. Double-click button2 (in the sample project, the Create OrderDetails and Fill button at the

top right of dataGridView3) to bring up the Button2_Click event handler and enter the

following code:




Button2.Click

ordDetDataAdapter.Fill(dataSet1)

Dim tb As DataTable = dataSet1.Tables("Order Details")

tb.PrimaryKey = New DataColumn() {tb.Columns("OrderID"),

tb.Columns("ProductID")}

ordDetDataGrid.DataSource = dataSet1.Tables("Order Details")


End Sub

To write code in C#

C# Copy Code


{

ordDetDataAdapter.Fill(dataSet1);

86

DataTable tb = dataSet1.Tables["Order Details"];

tb.PrimaryKey = new DataColumn[] { tb.Columns["OrderID"],

tb.Columns["ProductID"] };

ordDetDataGrid.DataSource = dataSet1.Tables["Order Details"];


}

End Sub

3. Double-click button3 (in the sample project, the Create Relation button at the bottom

right of dataGrid3) to bring up the Button3_Click event handler and enter the following

code:




Button3.Click

Dim rel As New DataRelation("Orders - Order Details",

dataSet1.Tables("Orders").Columns("OrderID"), dataSet1.Tables("Order

Details").Columns("OrderID"))

dataSet1.Relations.Add(rel)


End Sub

To write code in C#

C# Copy Code


{

DataRelation rel = new DataRelation("Orders - Order Details",

dataSet1.Tables["Orders"].Columns["OrderID"],

dataSet1.Tables["Order Details"].Columns["OrderID"]);

dataSet1.Relations.Add(rel);


}

87

Run the application and observe the following:

Notice that the view is inactive (no columns, no rows). This is because the underlying

dataSet1 is empty.

Press the Create Orders and Fill button, which adds Orders DataTable to dataSet1, filling

the view with data.

This operation is performed by means of the OleDbDataAdapter object

(ordersDataAdapter) which operates against Access NWind.mdb database. The view is still

inactive, because the Order Details DataTable has yet to be added in dataSet1, which is

referenced in the view's definition.

88

Press Create OrderDetails and Fill button, notice that the Order Details DataTable has

been added to dataSet1 and filled the view with data.

After this, action view is inactive because the join specified in the view's definition supposes

presence of DataRelation between joined DataTable(s).

Finally, press Create Relation button, which creates DataRelation between tables. This

operation makes the DataView become active, filling the view with composite rows based

89

on data from underlying DataTable(s).

C1.C1DataExtender.2 Assembly

Overview %%description%%

" -->

Namespaces

Namespace Description

C1.C1DataExtender

Namespaces

C1.C1DataExtender Namespace

Overview

Classes

Class Description

BaseRowCollection Represents a collection of base System.Data.DataRow

90

objects for the C1ViewRow.

BaseTableCollection

C1DataView Represents a customized view of a DataTable (single or

multiple joined tables) destined for user interface

controls binding, sorting, filtering, searching, navigation

and editing.

C1DataViewCollection Represents the collection of C1DataView objects

belonging to C1DataViewSet.

C1DataViewSet Represents a set of related C1DataView objects

constituting a client's data model.

C1ExpressionDef Defines a programming language and text of expression.

C1NameValueCollection<TValue>

C1TypedDataView The base class for a typed DataView.

C1TypedDataViewSet The base class for a typed ViewSet.

C1TypedViewRow The base class for a typed ViewRow.

C1ViewColumn Represents a column of C1DataView.

C1ViewColumnCalculateEventArgs Provides data for the

C1ViewColumnCalculateEventHandler delegate.

C1ViewColumnChangeEventArgs Provides data for the

C1ViewColumnChangeEventHandler delegate.

C1ViewColumnCollection Represents the collection of C1ViewColumn objects for

the C1DataViewSet.

91

C1ViewColumnCollectionBase The base class of the collection of C1ViewColumn

objects for the C1DataViewSet.

C1ViewCurrentChangedEventArgs Provides data for the

C1ViewCurrentChangedEventHandler delegate.

C1ViewFilterRowEventArgs Provides data for the C1ViewFilterRowEventHandler

delegate.

C1ViewListChangedEventArgs Provides data for the C1ViewListChangedEventHandler

delegate.

C1ViewModel Provides an object model for View Definition Language.

C1ViewPositionChangedEventArgs Provides data for the

C1ViewPositionChangedEventHandler delegate.

C1ViewRelation Represents a master-detail relationship between two

C1DataView objects in the C1DataViewSet.

C1ViewRelationCollection Represents a collection of C1ViewRelation objects

contained in the C1DataViewSet.

C1ViewRow Represents a row of C1DataView.

C1ViewRowAddNewEventArgs Provides data for the C1ViewRowAddNewEventHandler

delegate.

C1ViewRowChangeEventArgs Provides data for the C1ViewRowChangeEventHandler

delegate.

C1ViewSchemaTableCollection Represents the collection of

C1.C1DataExtender.SchemaExtender.DataTableExten

der objects corresponding to base DataTable objects.

92

CatalogCollection Represents a collection of SQL Server catalog names for

the C1DataViewSet.ConnectionCatalogs property.

ColumnStyle Represents a base for classes defining a column style on

a column level.

ColumnStyleBase The base class that represents Column Style - a set of

properties that affects C1ViewColumn data

representation in ComponentOne user interface controls.

ColumnStyleRule

ColumnStyleRuleCollection

ConnectionOpeningEventArgs Provides data for the ConnectionOpeningEventHandler

delegate.

ConstraintExpression

DataColumnExpressionImplBase

DataColumnTypeTypeConverter

EomColumnRef The base class for defining of reference to table column.

EomConstant

EomElement The base class for all elements of EOM

EomElementCollection

EomFunctionCall Represents a call to a function with a list of actual

parameters in "expression tree". For "plain structure" use

the EomFunctionCallSymbol class.

93

EomFunctionCallSymbol Represents function call in "plain structure". For

"expression tree" use the EomFunctionCall class.

EomLParen Represents "(".

EomMarkupElement The base class for elements which are not operands, such

as parentheses and operation signs.

EomOperandCollection

EomOperandElement The base class for all elements representing operands of

an expression.

EomOperation Represents an operation, in the form Left Operator Right.

To define unary operation set Left to null.

EomOperatorSymbol Represents an operator symbol.

EomRParen Represents ")".

EomUtils

FieldTypes

FilterRowEventArgs

GlobalColumnStyleBase Base class for all global column styles

GlobalColumnStyleCollectionBase The base class for global column style collections.

ImmutableCollectionBase

ImmutableKeyedCollectionBase Represents a read-only collection that provides an access

to items by a key or an index.

94

LookupItem Represents an item of LookupItemList collection.

LookupItemList Represents a collection of LookupItem objects for the

ColumnStyleBase.ItemList property.

RowDisplayBase Defines a pattern used to construct a string that

represents a table row in lookup list.

RowDisplayColumnCollection

RowDisplayColumnRef

TypeTypeConverter Base class that provides a converter for properties of the

Type type. Notes to inheritor: GetStandardValues

method must be overridden to return a list of standard

types.

ViewJoin Represents a join between two base DataTables in the

C1ViewModel.

ViewJoinCollection

ViewModelColumn Represents a column defined for a view in the

C1ViewModel.

ViewModelColumnCollectionBase Represents a base class for collections of

ViewModelColumn objects.

ViewModelColumnDefinitionCollecti

on

Represents a collection of ViewModelColumn objects

intended to define the list of C1ViewModel columns.

ViewModelColumnEffectiveCollectio

n

Represents a read-only collection of ViewModelColumn

objects denoting actual list of C1ViewModel columns.

ViewNode Represents a reference to a base DataTable in the

95

C1ViewModel.

ViewSetColumnStyle Represents Column Style definition for C1ViewColumn -

a set of properties that affects C1ViewColumn data


ViewSetColumnStyleCollection Represents a collection of ViewSetGlobalColumnStyle

objects for the C1DataViewSet.ColumnStyles property.

ViewSetGlobalColumnStyle Represents a global Column Style definition for

C1DataViewSet - a set of properties that affects

C1ViewColumn data representation in ComponentOne

user interface controls.

Interfaces

Interface Description

IRowAccessor This interface is necessary to pass CompositeViewRow (which is internal) to

expression implementation class, which is situated in another assembly.

Delegates

Delegate Description

C1ViewColumnCalculateEventHandler Represents the method that handles the

C1DataView.CalculateColumn event.

C1ViewColumnChangeEventHandler Represents the method that handles the

C1DataViewSet.ColumnChanging,

C1DataViewSet.ColumnChanged,

C1DataView.ColumnChanging and

C1DataView.ColumnChanged events.

C1ViewCurrentChangedEventHandler Represents the method that handles the

C1DataViewSet.CurrentChanged and

96

C1DataView.CurrentChanged events.

C1ViewFilterRowEventHandler Represents the method that handles the

C1DataViewSet.FilterRow event.

C1ViewListChangedEventHandler Represents the method that handles the

C1DataViewSet.ViewListChanged event.

C1ViewPositionChangedEventHandler Represents the method that handles the

C1DataViewSet.PositionChanged event.

C1ViewRowAddNewEventHandler Represents the method that handles the

C1DataViewSet.RowAddNew and

C1DataView.RowAddNew events.

C1ViewRowChangeEventHandler Represents the method that handles the

C1DataViewSet.RowChanging,

C1DataViewSet.RowChanged,

C1DataView.RowChanging and

C1DataView.RowChanged events.

ConnectionOpeningEventHandler Represents the method that handles the

C1DataViewSet.ConnectionOpening event.

FilterRowEventHandler

Enumerations

Enumeration Description

AutoFetchModeEnum Describes the possible autofetching modes.

AutoFetchParentsModeEnum Describes the possible autofetching modes for orphan rows'

parents.

97

BaseColumnStyleEnum Defines the possible types of base column style

determination strategies.

C1CurrentChangedReasonEnum This enum contains members specifying the reason for the

triggering of C1DataViewSet.CurrentChanged and


C1ViewRowActionEnum Describes an action performed on a C1ViewRow.

ColumnStylePropertyFlags Enumerates inheritable properties of column style.

ColumnStyleRuleEnum

DataAccessModeEnum

DuplicateKeyOccurenceEnum Describes a place of a row in a list of rows with the same key.

EomOperatorEnum

EomSpecialSqlFunctionEnum

HorizontalAlignmentEnum Defines the possible types of text alignment.

IdentityColumnRetrieveModeEn

um

Describes the possible moments when

DataConnectionExtenderBase.IdentityColumnLastValueSe

lect statement must be passed to a database server.

ItemListTypeEnum Defines the possible types of item list for a column style.

JoinSemanticsEnum Specify the possible types of ViewJoin semantics.

JoinTypeEnum Specify the possible types of ViewJoin.

VirtualModeEnum Defines the possible Virtual Modes of a view.

See Also

98

Reference

C1.C1DataExtender.2 Assembly

Classes

BaseRowCollection

Represents a collection of base System.Data.DataRow objects for the C1ViewRow.

Object Model

Syntax

Visual Basic (Declaration)

Public Class BaseRowCollection

C#

public class BaseRowCollection

Inheritance Hierarchy

System.Object

C1.C1DataExtender.BaseRowCollection

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008

(Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later),

Windows Server 2003 SP2

See Also

Reference

BaseRowCollection Members


Overview

Represents a collection of base System.Data.DataRow objects for the C1ViewRow.

99

Object Model

Syntax


Public Class BaseRowCollection

C#

public class BaseRowCollection


System.Object

C1.C1DataExtender.BaseRowCollection

Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by BaseRowCollection.

Public Properties

Name Description

Count

100

Item Overloaded. Gets the base DataRow at the specified index.

Top

Public Methods

Name Description

CopyTo

GetEnumerator

Top

See Also

Reference

BaseRowCollection Class


Methods

For a list of all members of this type, see BaseRowCollection members.

Public Methods

Name Description

CopyTo

GetEnumerator

Top

See Also

Reference



101

CopyTo Method

Syntax


Public Sub CopyTo( _

ByVal array As System.Array, _

ByVal index As System.Integer _

)

C#

public void CopyTo(

System.Array array,

System.int index

)

Parameters

array

index

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows

Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core

supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference



GetEnumerator Method

Syntax


Public Function GetEnumerator() As System.Collections.IEnumerator

102

C#

public System.Collections.IEnumerator GetEnumerator()

Requirements




See Also

Reference



Properties

For a list of all members of this type, see BaseRowCollection members.

Public Properties

Name Description

Count

Item Overloaded. Gets the base DataRow at the specified index.

Top

See Also

Reference



Count Property

Syntax


103

Public ReadOnly Property Count As System.Integer

C#

public System.int Count {get;}

Requirements




See Also

Reference



Item Property

Gets the base DataRow at the specified index.

Overload List

Overload Description

Item(Int32) Gets the base DataRow at the specified index.

Item(String) Gets DataRow corresponding to the base DataTable with the specified alias.

Requirements




See Also

Reference



104

Item(Int32) Property

An index of DataRow.

Gets the base DataRow at the specified index.

Syntax


Public Overloads ReadOnly Property Item( _


) As System.Data.DataRow

C#

public System.Data.DataRow Item(

System.int index

) {get;}

Parameters

index

An index of DataRow.

Property Value

A DataRow at the specified index.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server

2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1

or later), Windows Server 2003 SP2

See Also

Reference



Overload List

Item(String) Property

A base DataTable alias.

105

Gets DataRow corresponding to the base DataTable with the specified alias.

Syntax



ByVal tableAlias As System.String _

) As System.Data.DataRow

C#

public System.Data.DataRow Item(

System.string tableAlias

) {get;}

Parameters

tableAlias

A base DataTable alias.

Property Value

A DataRow if DataTable with the specified alias exists; otherwise, a null value.

Requirements




See Also

Reference



Overload List

BaseTableCollection

Object Model

106

Syntax


Public Class BaseTableCollection

Inherits ImmutableKeyedCollectionBase

C#

public class BaseTableCollection : ImmutableKeyedCollectionBase


System.Object

C1.C1DataExtender.ImmutableKeyedCollectionBase

C1.C1DataExtender.BaseTableCollection

Requirements




See Also

Reference

BaseTableCollection Members


Overview

Object Model

Syntax


Public Class BaseTableCollection


107

C#

public class BaseTableCollection : ImmutableKeyedCollectionBase


System.Object



Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by BaseTableCollection.

Public Properties

Name Description

Count Gets a number of element in the collection. (Inherited from

C1.C1DataExtender.ImmutableKeyedCollectionBase)

IsSynchronized Implements the IList.IsSynchronized property. (Inherited from


Item Overloaded.

SyncRoot Implements the IList.SyncRoot property. (Inherited from

108


Top

Public Methods

Name Description

CopyTo Copies the collection items to the specified array starting from the specified

index in the target array. (Inherited from


GetEnumerator Gets a collection enumerator. (Inherited from


GetTableAlias

GetTableIndexes

IndexOfKey Gets and index of an item with the specified key. (Inherited from


Top

See Also

Reference

BaseTableCollection Class


Methods

For a list of all members of this type, see BaseTableCollection members.

Public Methods

Name Description


109





GetTableAlias

GetTableIndexes



Top

See Also

Reference



GetTableAlias Method

Syntax


Public Function GetTableAlias( _


) As System.String

C#

public System.string GetTableAlias(

System.int index

)

Parameters

index

110

Requirements




See Also

Reference



GetTableIndexes Method

Syntax


Public Function GetTableIndexes( _

ByVal baseTable As System.Data.DataTable _

) As System.Integer()

C#

public System.int[] GetTableIndexes(

System.Data.DataTable baseTable

)

Parameters

baseTable

Requirements




See Also

Reference



111

Properties

For a list of all members of this type, see BaseTableCollection members.

Public Properties

Name Description





Item Overloaded.



Top

See Also

Reference



Item Property

Overload List


Item(Int32)

Item(String)

Requirements

112




See Also

Reference




Syntax




) As System.Data.DataTable

C#

public System.Data.DataTable Item(

System.int index

) {get;}

Parameters

index

Requirements




See Also

Reference



Overload List

113


Syntax




) As System.Data.DataTable

C#

public System.Data.DataTable Item(


) {get;}

Parameters

tableAlias

Requirements




See Also

Reference



Overload List

C1DataView

Represents a customized view of a DataTable (single or multiple joined tables) destined for user

interface controls binding, sorting, filtering, searching, navigation and editing.

Object Model

Syntax

114


Public Class C1DataView

Inherits System.ComponentModel.MarshalByValueComponent

C#

public class C1DataView : System.ComponentModel.MarshalByValueComponent

Remarks

In order to make C1DataView operable, you should add it to the C1DataViewSet.Views collection

and set its definition statement in the Definition property, see C1DataView Definitions topic for

details.

In design time you could use C1DataViewSet Editor to define views and their definitions.


System.Object

System.ComponentModel.MarshalByValueComponent

C1.C1DataExtender.C1DataView

C1.C1DataExtender.C1TypedDataView

Requirements




See Also

Reference

C1DataView Members


Overview

Represents a customized view of a DataTable (single or multiple joined tables) destined for user

interface controls binding, sorting, filtering, searching, navigation and editing.

Object Model

115

Syntax


Public Class C1DataView

Inherits System.ComponentModel.MarshalByValueComponent

C#

public class C1DataView : System.ComponentModel.MarshalByValueComponent

Remarks

In order to make C1DataView operable, you should add it to the C1DataViewSet.Views collection

and set its definition statement in the Definition property, see C1DataView Definitions topic for

details.

In design time you could use C1DataViewSet Editor to define views and their definitions.


System.Object




Requirements




See Also

Reference

C1DataView Members


Members

Properties Methods Events

The following tables list the members exposed by C1DataView.

116

Public Constructors

Name Description

C1DataView Constructor Overloaded.

Top

Public Properties

Name Description

AllowDelete Gets or sets a value indicating whether deletion of rows is permitted for

this C1DataView.

AllowEdit Gets or sets a value indicating whether editing of C1ViewRow objects

that belong to this C1DataView is permitted.

AllowNew Gets or sets a value indicating whether addition of new rows is permitted

for this C1DataView.

AutoFetch Controls the autofetching behavior for this C1DataView.

BaseSchemaTables Gets the collection of

C1.C1DataExtender.SchemaExtender.DataTableExtender objects from

the C1DataViewSet.SchemaExtender of the owning C1DataViewSet that

extends System.Data.DataTable objects from the BaseTables collection.

BaseTables Gets the collection of System.Data.DataTable objects referenced in the

Definition property.

Columns Gets the collection of C1ViewColumn objects that belong to this

C1DataView.

ConstraintExpression Defines a row level constraint.

117

Container (Inherited from System.ComponentModel.MarshalByValueComponent)

Count Returns a number of rows in the C1DataView.

Current Returns the current C1ViewRow of the

System.Windows.Forms.CurrencyManager that services this C1DataView.

Definition Gets or sets view definition statement.

DefinitionModel Represents an object model for the definition statement assigned to the


DesignMode (Inherited from System.ComponentModel.MarshalByValueComponent)

IsActive Indicates wheather this C1DataView is active, that is able to represent

data according to its Definition.

Item Returns a C1ViewRow object at the specified index.

Position Returns the position of current C1ViewRow in the


PrimaryKey Returns an array of C1ViewColumn objects that constitute a primary key

of this view.

RaiseFilterRowEvent Indicates whether the FilterRow event should be fired.

RowFilter Gets or sets an expression used to filter rows in C1DataView.

Site (Inherited from System.ComponentModel.MarshalByValueComponent)

Sort Gets or sets a string defining a sort order of rows in this C1DataView.

ViewName Gets or sets the name of the C1DataView.

118

ViewSet Gets the C1DataViewSet object that this C1DataView belongs to.

VirtualMode Indicates whether Virtual Mode should be used for this C1DataView.

Top

Public Methods

Name Description

AddNew Adds a new row to this C1DataView.

Delete Deletes C1ViewRow at the specified index.

Dispose (Inherited from System.ComponentModel.MarshalByValueComponent)

Fill Overloaded. Re-fetch data represented by this C1DataView from database

server.

Find Overloaded. Finds a row in this C1DataView by the specified sort key

value.

FindByPrimaryKey Overloaded. Finds a row in this C1DataView by the specified primary key

value.

GetEnumerator Gets a C1ViewRow enumerator for this C1DataView.

GetService (Inherited from System.ComponentModel.MarshalByValueComponent)

Reset Rebuilds the Rows collection and sends Reset notification.

ShowQueryBuilder Overloaded. Shows the view definition query builder in a modal window.

ToString

Top

119

Public Events

Name Description

CalculateColumn Occurs when the C1ViewColumn value is being retrieved.

ColumnChanged Occurs after a value has been changed for the specified C1ViewColumn in a

C1ViewRow.

ColumnChanging Occurs when a value is being changed for specified C1ViewColumn in a

C1ViewRow.

CurrentChanged Occurs when row or values of the current C1ViewRow belonging to this

C1DataView has been changed.

Disposed (Inherited from System.ComponentModel.MarshalByValueComponent)

FilterRow Allows to filter out C1DataView rows on a client in code.

ListChanged

PositionChanged Occurs when Position property has been changed for this C1DataView.

RowAddNew Occurs when the AddNew method is being called.

RowChanged Occurs after editing of C1ViewRow has been successfully finished.

RowChanging Occurs before editing of C1ViewRow will be finished.

Top

See Also

Reference

C1DataView Class


120

C1DataView Constructor

Overload List


C1DataView Constructor(C1DataViewSet) Initializes a new instance of C1DataView object and adds

it to the C1DataViewSet.Views collection of the specified

C1DataViewSet.

C1DataView Constructor() Initializes a new instance of C1DataView object.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

C1DataView Constructor(C1DataViewSet)

A C1DataViewSet object to which new instance of C1DataView will be added. If a null value is

specified then C1DataView will not belong to any C1DataViewSet.

Initializes a new instance of C1DataView object and adds it to the C1DataViewSet.Views collection

of the specified C1DataViewSet.

Syntax


Public Function New( _

ByVal viewSet As C1DataViewSet _

)

C#

121

public C1DataView(

C1DataViewSet viewSet

)

Parameters

viewSet

A C1DataViewSet object to which new instance of C1DataView will be added. If a null value

is specified then C1DataView will not belong to any C1DataViewSet.

Remarks

After C1DataView has been created and added to a C1DataViewSet, you should set its

definition statements in the Definition property. See C1DataView Definitions topic for details.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

C1DataView Constructor()

Initializes a new instance of C1DataView object.

Syntax


Public Function New()

C#

public C1DataView()

Remarks

122

After C1DataView has been created, you should add it to the C1DataViewSet.Views collection and

set its definition statement in the Definition property, see C1DataView Definitions topic for details.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

Methods

For a list of all members of this type, see C1DataView members.

Public Methods

Name Description

AddNew Adds a new row to this C1DataView.

Delete Deletes C1ViewRow at the specified index.



server.

Find Overloaded. Finds a row in this C1DataView by the specified sort key

value.


value.

C1.C1DataExtender.2~C1.C1DataExtender.C1DataView~Dispose().html

123

GetEnumerator Gets a C1ViewRow enumerator for this C1DataView.


Reset Rebuilds the Rows collection and sends Reset notification.


ToString

Top

See Also

Reference

C1DataView Class


AddNew Method

Adds a new row to this C1DataView.

Syntax


Public Function AddNew() As C1ViewRow

C#

public C1ViewRow AddNew()

Return Value

A newly added C1ViewRow.

Remarks

See the Composite View Definition topic for details on row editing.

Requirements

C1.C1DataExtender.2~C1.C1DataExtender.C1DataView~GetService.html

124




See Also

Reference

C1DataView Class

C1DataView Members

Delete Method

A zero-based index of the deleting C1ViewRow.

Deletes C1ViewRow at the specified index.

Syntax


Public Sub Delete( _


)

C#

public void Delete(

System.int index

)

Parameters

index

A zero-based index of the deleting C1ViewRow.

Requirements




See Also

Reference

125

C1DataView Class

C1DataView Members

Fill Method

Re-fetch data represented by this C1DataView from database server.

Overload List


Fill() Re-fetch data represented by this C1DataView from database server.

Fill(Boolean) Re-fetch data represented by this C1DataView from database server,

optionally refetching a data for foreign key lookup tables.

Fill(Boolean,Boolean) Re-fetch data represented by this C1DataView from database server,

optionally refetching a data for foreign key lookup tables.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Fill() Method

Re-fetch data represented by this C1DataView from database server.

Syntax


Public Overloads Sub Fill()

C#

126

public void Fill()

Remarks

This method is equivalent to C1DataView.Fill(False).

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

Fill(Boolean) Method

Indicates whether foreign key lookup tables should be re-fetched.

Re-fetch data represented by this C1DataView from database server, optionally refetching a data

for foreign key lookup tables.

Syntax


Public Overloads Sub Fill( _

ByVal includingLookupTables As System.Boolean _

)

C#

public void Fill(

System.bool includingLookupTables

)

Parameters

includingLookupTables


127

Remarks

This method re-fetch rows of base DataTable objects and rebuild this C1DataViewSet's rowset

accordingly. It doesn't clear base tables rows before filling, instead it refreshes client rowsets

with a data fetched from server in the following way: for each row retrieved from server it

finds the existing client DataRow with the same primary key, if such a row has not been found

then adds a new DataRow to DataTable. If DataRow has been found and if it has not been

modified since it was fetched first time (DataRow.RowState == DataRowState.Unchanged)

then its data is refreshed with the values retrieved from server; otherwise, if row has been

changed then it stays untouched.

The includingLookupTables indicates whether foreign key lookup tables of this C1DataView

should be re-fetched. It has an effect only for view columns that represents a foreign key

DataColumn and has the ColumnStyle.ItemListType property set to

ItemListTypeEnum.ForeignKey. See the Data Fetching topic for details.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

Fill(Boolean,Boolean) Method


Indicates whether data should be fetched even it has been fetched before by fetch requests from

another views.

Re-fetch data represented by this C1DataView from database server, optionally refetching a data

for foreign key lookup tables.

Syntax


128


ByVal includingLookupTables As System.Boolean, _

ByVal forceFetch As System.Boolean _

)

C#

public void Fill(

System.bool includingLookupTables,

System.bool forceFetch

)

Parameters



forceFetch

Indicates whether data should be fetched even it has been fetched before by fetch requests

from another views.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

Find Method

Finds a row in this C1DataView by the specified sort key value.

Overload List


129

Find(Object) Finds a row in this C1DataView by the specified sort

key value.

Find(Object[],DuplicateKeyOccurenceEnum) Finds a row in this C1DataView by the specified sort

key value.

Find(Object[]) Finds a row in this C1DataView by the specified sort

key value.

Find(String[],Object[]) Finds a row in this C1DataView by the specified values

of the specified columns.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Find(Object) Method

A sort key value to search. This value corresponds to the first column of sort key which is specified

in the Sort property. If the System.Type of the value differs from the C1ViewColumn.DataType of

the corresponding sort key column then this value will be converted to the column target type

automatically. In the case where such a conversion is impossible an exception will be raised.


Syntax


Public Overloads Function Find( _

ByVal sortKey As System.Object _

) As System.Integer

130

C#

public System.int Find(

System.object sortKey

)

Parameters

sortKey

A sort key value to search. This value corresponds to the first column of sort key which is

specified in the Sort property. If the System.Type of the value differs from the

C1ViewColumn.DataType of the corresponding sort key column then this value will be

converted to the column target type automatically. In the case where such a conversion is

impossible an exception will be raised.

Return Value

An index of the row if it was found; otherwise a negative number, which is the bitwise

complement of the index of the next row which key is larger than specified.

Remarks

Finds a row in the C1DataView by the specified sort key value and returns its index or, in the

case that a row is not found, a negative number, which is the bitwise complement of the index

of the next row which key is larger than specified. If a row has been found and there are

multiple rows with the specified sort key then an accidental row index that matches the search

criteria is returned.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

131

Find(Object[],DuplicateKeyOccurenceEnum) Method

An array of sort key values. The order of values in the array must correspond to the order of

columns specified in the Sort property. If the System.Type of some array value differs from the

C1ViewColumn.DataType of the corresponding sort key column then this value will be converted to

the column's target type automatically. In the case where such a conversion is impossible, an

exception will be raised.

Specify which row occurrence to return in the case of multiple rows with the same sort key value:

first, last or accidental.


Syntax



ByVal sortKey() As System.Object, _

ByVal duplicateKeyOccurence As DuplicateKeyOccurenceEnum _

) As System.Integer

C#


System.object[] sortKey,

DuplicateKeyOccurenceEnum duplicateKeyOccurence

)

Parameters

sortKey


columns specified in the Sort property. If the System.Type of some array value differs from

the C1ViewColumn.DataType of the corresponding sort key column then this value will be

converted to the column's target type automatically. In the case where such a conversion is

impossible, an exception will be raised.

duplicateKeyOccurence

Specify which row occurrence to return in the case of multiple rows with the same sort key

value: first, last or accidental.

Return Value

132



Remarks

Finds a row in the C1DataView by the specified sort key value and returns its index or, in

the case that a row is not found, a negative number, which is the bitwise complement of

the index of the next row which key is larger than specified. The length of the specified

sort key can be less then number of sort columns specified in the Sort property. If a row

has been found and there are multiple rows with the specified sort key, the

duplicateKeyOccurence parameter specifies what row from the set of these rows to

return. Note that setting it to DuplicateKeyOccurenceEnum.Accidental gives faster search

than DuplicateKeyOccurenceEnum.First or DuplicateKeyOccurenceEnum.Last.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

Find(Object[]) Method


columns specified in the Sort property. If the System.Type of some array value differs from the

C1ViewColumn.DataType of the corresponding sort key column then this value will be converted to

the column's target type automatically. In the case where such a conversion is impossible, an

exception will be raised.


Syntax



ByVal sortKey() As System.Object _

133

) As System.Integer

C#


System.object[] sortKey

)

Parameters

sortKey


columns specified in the Sort property. If the System.Type of some array value differs from

the C1ViewColumn.DataType of the corresponding sort key column then this value will be



Return Value



Remarks

Finds a row in the C1DataView by the specified sort key value and returns its index or, in the

case that a row is not found, a negative number, which is the bitwise complement of the index

of the next row which key is larger than specified. The length of the specified sort key can be

less then number of sort columns specified in the Sort property. If a row has been found and

there are multiple rows with the specified sort key then an accidental row index that matches

the search criteria is returned.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

134

Find(String[],Object[]) Method

An array of column names to search on.

An array of values of the columns specified in the columnNames parameter. The length and order

of values must correspond to column names specified in the columnNames parameter. If the

System.Type of some array value differs from the C1ViewColumn.DataType of the corresponding

column then this value will be converted to the column's target type automatically. In the case

where such a conversion is impossible, an exception will be raised.

Finds a row in this C1DataView by the specified values of the specified columns.

Syntax



ByVal columnNames() As System.String, _

ByVal columnValues() As System.Object _

) As System.Integer

C#


System.string[] columnNames,

System.object[] columnValues

)

Parameters

columnNames

An array of column names to search on.

columnValues

An array of values of the columns specified in the columnNames parameter. The length and

order of values must correspond to column names specified in the columnNames

parameter. If the System.Type of some array value differs from the

C1ViewColumn.DataType of the corresponding column then this value will be converted to

the column's target type automatically. In the case where such a conversion is impossible,

an exception will be raised.

Return Value

An index of found row or -1 if row has not been found.

135

Remarks

This method investigates the passed set of columns before performing a search. If

columnNames matches subkey of primary key or sort key then performs quick search by

the corresponding key; otherwise, performs linear search.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

FindByPrimaryKey Method

Finds a row in this C1DataView by the specified primary key value.

Overload List


FindByPrimaryKey(Object) Finds a row in this C1DataView by the specified primary key value.

FindByPrimaryKey(Object[]) Finds a row in this C1DataView by the specified primary key value.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

136

FindByPrimaryKey(Object) Method

A primary key value. The PrimaryKey property must contain a single C1ViewColumn. If the

System.Type of the value differs from the C1ViewColumn.DataType of the corresponding primary

key column then this value will be converted to the column's target type automatically. In the case

where such a conversion is impossible, an exception will be raised.


Syntax


Public Overloads Function FindByPrimaryKey( _

ByVal key As System.Object _

) As System.Integer

C#

public System.int FindByPrimaryKey(

System.object key

)

Parameters

key

A primary key value. The PrimaryKey property must contain a single C1ViewColumn. If the

System.Type of the value differs from the C1ViewColumn.DataType of the corresponding

primary key column then this value will be converted to the column's target type

automatically. In the case where such a conversion is impossible, an exception will be

raised.

Return Value


Requirements




See Also

Reference

137

C1DataView Class

C1DataView Members

Overload List

FindByPrimaryKey(Object[]) Method

An array of primary key values. The length and order of values of the array must be the same as in

the PrimaryKey property. If the System.Type of some array value differs from the

C1ViewColumn.DataType of the corresponding primary key column then this value will be




Syntax


Public Overloads Function FindByPrimaryKey( _

ByVal key() As System.Object _

) As System.Integer

C#

public System.int FindByPrimaryKey(

System.object[] key

)

Parameters

key

An array of primary key values. The length and order of values of the array must be the

same as in the PrimaryKey property. If the System.Type of some array value differs from the

C1ViewColumn.DataType of the corresponding primary key column then this value will be



Return Value


Requirements

138




See Also

Reference

C1DataView Class

C1DataView Members

Overload List


Gets a C1ViewRow enumerator for this C1DataView.

Syntax



C#


Return Value

An IEnumerator for navigating throw the list of C1ViewRow objects.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Reset Method

Rebuilds the Rows collection and sends Reset notification.

139

Syntax


Public Sub Reset()

C#

public void Reset()

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

ShowQueryBuilder Method

Shows the view definition query builder in a modal window.

Overload List


ShowQueryBuilder() Shows the view definition query builder in a modal window.

ShowQueryBuilder(IWin32Window) Shows the view definition query builder in a modal window

with the specified owner.

Requirements




See Also

140

Reference

C1DataView Class

C1DataView Members

ShowQueryBuilder() Method

Shows the view definition query builder in a modal window.

Syntax


Public Overloads Sub ShowQueryBuilder()

C#

public void ShowQueryBuilder()

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

ShowQueryBuilder(IWin32Window) Method

The window that will own the query builder window.

Shows the view definition query builder in a modal window with the specified owner.

Syntax


Public Overloads Sub ShowQueryBuilder( _

ByVal ownerWindow As System.Windows.Forms.IWin32Window _

)

141

C#

public void ShowQueryBuilder(

System.Windows.Forms.IWin32Window ownerWindow

)

Parameters

ownerWindow

The window that will own the query builder window.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Overload List

ToString Method

Syntax


Public Overrides Function ToString() As System.String

C#

public override System.string ToString()

Requirements




See Also

142

Reference

C1DataView Class

C1DataView Members

Properties


Public Properties

Name Description


this C1DataView.


that belong to this C1DataView is permitted.


for this C1DataView.

AutoFetch Controls the autofetching behavior for this C1DataView.








C1DataView.

ConstraintExpression Defines a row level constraint.


C1.C1DataExtender.2~C1.C1DataExtender.C1DataView~Container.html

143

Count Returns a number of rows in the C1DataView.



Definition Gets or sets view definition statement.





data according to its Definition.

Item Returns a C1ViewRow object at the specified index.




of this view.

RaiseFilterRowEvent Indicates whether the FilterRow event should be fired.

RowFilter Gets or sets an expression used to filter rows in C1DataView.



ViewName Gets or sets the name of the C1DataView.


C1.C1DataExtender.2~C1.C1DataExtender.C1DataView~DesignMode.html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataView~Site.html

144


Top

See Also

Reference

C1DataView Class


AllowDelete Property

Gets or sets a value indicating whether deletion of rows is permitted for this C1DataView.

Syntax


Public Property AllowDelete As System.Boolean

C#

public System.bool AllowDelete {get; set;}

Remarks

This property value is inherited by default from the

C1.C1DataExtender.SchemaExtender.DataTableExtender.AllowDelete property values of

C1.C1DataExtender.SchemaExtender.DataTableExtender objects from the BaseSchemaTables

collection that corresponds to "Main" table nodes (see Composite View Definition topic for details

on "Main" and "Lookup" table nodes). If

C1.C1DataExtender.SchemaExtender.DataTableExtender.AllowNew property values are true for

all "Main" tables then default value is true; otherwise, false.

You can change this value to false only if default calculated value is true. You can't change default

false value to true.

Requirements




See Also

145

Reference

C1DataView Class

C1DataView Members

AllowEdit Property

Gets or sets a value indicating whether editing of C1ViewRow objects that belong to this

C1DataView is permitted.

Syntax


Public Property AllowEdit As System.Boolean

C#

public System.bool AllowEdit {get; set;}

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

AllowNew Property

Gets or sets a value indicating whether addition of new rows is permitted for this C1DataView.

Syntax


Public Property AllowNew As System.Boolean

C#

public System.bool AllowNew {get; set;}

146

Remarks

This property value is inherited by default from the

C1.C1DataExtender.SchemaExtender.DataTableExtender.AllowNew property values of

C1.C1DataExtender.SchemaExtender.DataTableExtender objects from the BaseSchemaTables

collection that corresponds to "Main" table nodes (see Composite View Definition topic for details

on "Main" and "Lookup" table nodes). If

C1.C1DataExtender.SchemaExtender.DataTableExtender.AllowNew property values are true for

all "Main" tables then default value is true; otherwise, false.

You can change this value to false only if default calculated value is true. You can't change default

false value to true.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

AutoFetch Property

Controls the autofetching behavior for this C1DataView.

Syntax


Public Property AutoFetch As AutoFetchModeEnum

C#

public AutoFetchModeEnum AutoFetch {get; set;}

Remarks

This property allows to turn on or off automatic data fetching for this C1DataView. If AutoFetch is

set to AutoFetchModeEnum.Default (which is the default) then the effective value is determined by

147

the C1DataViewSet.AutoFetch property value of an owning C1DataViewSet. See the Data Fetching

topic for details.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

BaseSchemaTables Property

Gets the collection of C1.C1DataExtender.SchemaExtender.DataTableExtender objects from the

C1DataViewSet.SchemaExtender of the owning C1DataViewSet that extends System.Data.DataTable

objects from the BaseTables collection.

Syntax


Public ReadOnly Property BaseSchemaTables As C1ViewSchemaTableCollection

C#

public C1ViewSchemaTableCollection BaseSchemaTables {get;}

Remarks

C1.C1DataExtender.SchemaExtender.DataTableExtender objects in this collection has the same

order as corresponding System.Data.DataTable objects from the BaseTables collection.

Requirements




See Also

148

Reference

C1DataView Class

C1DataView Members

BaseTables Property

Gets the collection of System.Data.DataTable objects referenced in the Definition property.

Syntax


Public ReadOnly Property BaseTables As BaseTableCollection

C#

public BaseTableCollection BaseTables {get;}

Remarks

Tables can be retrieved from the collection by index or by table alias specified in Definition. If alias

for a table has not been defined explicitly in the definition statement then table name should be

used (it is treated as an alias).

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Columns Property

Gets the collection of C1ViewColumn objects that belong to this C1DataView.

Syntax


149

Public ReadOnly Property Columns As C1ViewColumnCollection

C#

public C1ViewColumnCollection Columns {get;}

Remarks

The set of columns represented by C1DataView is defined as a part of view definition statement

(see Definition). C1DataViewSet can make the following forced corrections to the final set of

columns:

Columns that are in the primary key of C1DataView are included in the list of columns even

if they are not specified in the definition statement.

For joined DataTable objects in composite view, columns that are in the child key of

DataRelation that join is based on are not included in the final set of view columns even if

they are explicitly specified in the definition statement.

Requirements Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008



See Also

Reference

C1DataView Class

C1DataView Members

ConstraintExpression Property

Defines a row level constraint.

Syntax


Public ReadOnly Property ConstraintExpression As ConstraintExpression

C#

public ConstraintExpression ConstraintExpression {get;}

Remarks

150

See the Row and Column Level Constraints topic for details.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Count Property

Returns a number of rows in the C1DataView.

Syntax



C#


Remarks

This property returns value with regards to RowFilter and master-detail relationship for a detail

view.

Requirements




See Also

Reference

151

C1DataView Class

C1DataView Members

Current Property

Returns the current C1ViewRow of the System.Windows.Forms.CurrencyManager that services this

C1DataView.

Syntax


Public ReadOnly Property Current As C1ViewRow

C#

public C1ViewRow Current {get;}

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Definition Property

Gets or sets view definition statement.

Syntax


Public Property Definition As System.String

C#

public System.string Definition {get; set;}

Remarks

152

See the C1DataView Definitions topic for details on view definition language.

If this property value is empty or contains a definition statement that has syntactic or semantic

errors then view is inactive, that is represents neither columns nor rows.

Example

The following example uses a button control to update the view's definition at run time:

Visual Basic Private Sub Button1_Click(sender As Object, e As EventArgs) C1DataViewSet1.Views(0).Definition = TextBox1.Text End

Sub

C# private void button1_Click(object sender, EventArgs e) { C1DataViewSet1.Views[0].Definition = textBox1.Text; }




See Also

Reference

C1DataView Class

C1DataView Members

DefinitionModel Property

Represents an object model for the definition statement assigned to the Definition property.

Syntax


Public ReadOnly Property DefinitionModel As C1ViewModel

C#

public C1ViewModel DefinitionModel {get;}

Requirements




153

See Also

Reference

C1DataView Class

C1DataView Members

IsActive Property

Indicates wheather this C1DataView is active, that is able to represent data according to its

Definition.

Syntax


Public ReadOnly Property IsActive As System.Boolean

C#

public System.bool IsActive {get;}

Remarks

C1DataView is active if all of the following conditions are satisfied:

C1DataView is added to the C1DataViewSet.Views collection.

The owning C1DataViewSet is connected to a data source (via the System.Data.DataSet or

the ConnectionString properties).

The Definition property defined a valid definition statement, that is it has no syntactic and

semantic errors.

In this case C1DataView is able to represent the list of columns and rows.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

154

Item Property

The zero-based index of the C1ViewRow to get.

Returns a C1ViewRow object at the specified index.

Syntax


Public ReadOnly Default Property Item( _


) As C1ViewRow

C#

public C1ViewRow this[

System.int index

]; {get;}

Parameters

index

The zero-based index of the C1ViewRow to get.

Property Value

A C1ViewRow.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Position Property

Returns the position of current C1ViewRow in the System.Windows.Forms.CurrencyManager that

services this C1DataView.

155

Syntax


Public Property Position As System.Integer

C#

public System.int Position {get; set;}

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

PrimaryKey Property

Returns an array of C1ViewColumn objects that constitute a primary key of this view.

Syntax


Public ReadOnly Property PrimaryKey As C1ViewColumn()

C#

public C1ViewColumn[] PrimaryKey {get;}

Remarks

See the Composite View Definition topic for details on how a primary key is determined.

Requirements

156




See Also

Reference

C1DataView Class

C1DataView Members

RaiseFilterRowEvent Property

Indicates whether the FilterRow event should be fired.

Syntax


Public Property RaiseFilterRowEvent As System.Boolean

C#

public System.bool RaiseFilterRowEvent {get; set;}

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

RowFilter Property

Gets or sets an expression used to filter rows in C1DataView.

Syntax


157

Public Property RowFilter As System.String

C#

public System.string RowFilter {get; set;}

Remarks

The syntax of filter expression is the same as for WHERE clause of Definition, with the only

exception that column names should reference C1DataView columns while column names in

Definition reference columns of base DataTable objects.

There are some semantic differences in the calculation of this filter condition compared to

expressions used View Definition Statements:

The <match_expression> [ NOT ] LIKE <pattern_expression> [ ESCAPE <escape_character>

] comparison condition mimics the behavior of this condition in the

System.Data.DataColumn.Expression, that is, supports '*' char as an alternative to standard

'%' char in a matching pattern and doesn't support '_' char. In addition to

DataColumn.Expression implementation it supports 'Escape' clause and allows '*' or '%' char

in any place of a matching pattern. The reason for following the DataColumn.Expression

behavior in RowFilter implementation is that a value of the latter property can be set by

user interface control via the IBindingListView.Filter property, but user interface control

usually expects the behavior specific to the DataColumn.Expression property in this case.




See Also

Reference

C1DataView Class

C1DataView Members

Sort Property

Gets or sets a string defining a sort order of rows in this C1DataView.

Syntax


158

Public Property Sort As System.String

C#

public System.string Sort {get; set;}

Remarks

Sort order is defined as a list of view column names breaked by comma, with optional sort direction

qualifier "ASC" (ascending) or "DESC" (descending) that follows the column name. If this qualifier is

omited then the ascending order is supposed. Column names can be wrapped in square brackets

("[]").

For example:

"OrderID, ProductID DESC, [UnitPrice] ASC"

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

ViewName Property

Gets or sets the name of the C1DataView.

Syntax


Public Property ViewName As System.String

C#

public System.string ViewName {get; set;}

Remarks

159

This property value should be assigned to the DataMember property of data bound control (while

the control's DataSource property references C1DataViewSet that this C1DataView belongs to) to

connect that control to this view.

It also can be used to find this view by name in the C1DataViewSet.Views collection.

If this property value was not set explicitly, C1DataView generates its unique name automatically.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

ViewSet Property

Gets the C1DataViewSet object that this C1DataView belongs to.

Syntax


Public ReadOnly Property ViewSet As C1DataViewSet

C#

public C1DataViewSet ViewSet {get;}

Property Value

If this C1DataView is added to the C1DataViewSet.Views collection, returns the C1DataViewSet that

this C1DataView belongs to, otherwise returns a null value.

Requirements




160

See Also

Reference

C1DataView Class

C1DataView Members

VirtualMode Property

Indicates whether Virtual Mode should be used for this C1DataView.

Syntax


Public Property VirtualMode As VirtualModeEnum

C#

public VirtualModeEnum VirtualMode {get; set;}

Remarks

If this property is set to the VirtualModeEnum.KeySet value, then the view initially fetches only a

minimal set of columns for DataTables the view is based on. In the simplest case this minimal set

consist solely of primary key columns. It can be expanded by columns referenced in view's sort and

filter conditions. This approach minimizes the time necessary to perform initial fetching of data for a

view. When the view row is later accessed by an application, the rest of the columns of the base

DataRows that have not been fetched yet are fetched automatically.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

Events


161

Public Events

Name Description

CalculateColumn Occurs when the C1ViewColumn value is being retrieved.


C1ViewRow.


C1ViewRow.


C1DataView has been changed.



ListChanged





Top

See Also

Reference

C1DataView Class


C1.C1DataExtender.2~C1.C1DataExtender.C1DataView~Disposed_EV.html

162

CalculateColumn Event

Occurs when the C1ViewColumn value is being retrieved.

Syntax


Public Event CalculateColumn As C1ViewColumnCalculateEventHandler

C#

public event C1ViewColumnCalculateEventHandler CalculateColumn

Event Data

The event handler receives an argument of type C1ViewColumnCalculateEventArgs containing data

related to this event. The following C1ViewColumnCalculateEventArgs properties provide

information specific to this event.


Column Gets the C1ViewColumn object for which a value is being calculated.

Row Gets the C1ViewRow in which the C1ViewColumn value is being calculated.

Value Gets or sets the calculated value of the column.

Remarks

This is the same event as C1DataViewSet.CalculateColumn, see the C1DataViewSet.CalculateColumn

event description for details on this event.

Note that this event is triggered on C1DataView first and then on C1DataViewSet.

Requirements




See Also

163

Reference

C1DataView Class

C1DataView Members

ColumnChanged Event

Occurs after a value has been changed for the specified C1ViewColumn in a C1ViewRow.

Syntax


Public Event ColumnChanged As C1ViewColumnChangeEventHandler

C#

public event C1ViewColumnChangeEventHandler ColumnChanged

Event Data

The event handler receives an argument of type C1ViewColumnChangeEventArgs containing data

related to this event. The following C1ViewColumnChangeEventArgs properties provide



Column Gets the C1ViewColumn which value is being changed.

NewValue Gets or sets a new proposed value for the C1ViewColumn which is being

changed.

OldValue Gets an old column value.

Row Gets the C1ViewRow in which C1ViewColumn is being changed.

Remarks

This is the same event as C1DataViewSet.ColumnChanged, see C1DataViewSet.ColumnChanged


Note that this event is triggered on C1DataView first and than on C1DataViewSet.

164

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

ColumnChanging Event

Occurs when a value is being changed for specified C1ViewColumn in a C1ViewRow.

Syntax


Public Event ColumnChanging As C1ViewColumnChangeEventHandler

C#

public event C1ViewColumnChangeEventHandler ColumnChanging

Event Data







changed.


165


Remarks

This is the same event as C1DataViewSet.ColumnChanging, see C1DataViewSet.ColumnChanging



Requirements




See Also

Reference

C1DataView Class

C1DataView Members

CurrentChanged Event

Occurs when row or values of the current C1ViewRow belonging to this C1DataView has been

changed.

Syntax


Public Event CurrentChanged As C1ViewCurrentChangedEventHandler

C#

public event C1ViewCurrentChangedEventHandler CurrentChanged

Event Data

The event handler receives an argument of type C1ViewCurrentChangedEventArgs containing data

related to this event. The following C1ViewCurrentChangedEventArgs properties provide



166

Reason Gets the reason why this event has been triggered.

View Gets the C1DataView that event occurred in.

Remarks

This is the same event as C1DataViewSet.CurrentChanged, see C1DataViewSet.CurrentChanged



Requirements




See Also

Reference

C1DataView Class

C1DataView Members

FilterRow Event

Allows to filter out C1DataView rows on a client in code.

Syntax


Public Event FilterRow As C1ViewFilterRowEventHandler

C#

public event C1ViewFilterRowEventHandler FilterRow

Event Data

The event handler receives an argument of type C1ViewFilterRowEventArgs containing data related

to this event. The following C1ViewFilterRowEventArgs properties provide information specific to

this event.

167


Accept Allows to accept row (true) or filter it out (false).

Row Gets a row whose filter conditions are being checked.

Remarks

This is the same event as C1DataViewSet.FilterRow, see C1DataViewSet.FilterRow event description

for details on this event.

Note that this event is triggered first on C1DataView and then on C1DataViewSet.

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

ListChanged Event

Syntax


Public Event ListChanged As System.ComponentModel.ListChangedEventHandler

C#

public event System.ComponentModel.ListChangedEventHandler ListChanged

Event Data

The event handler receives an argument of type System.ComponentModel.ListChangedEventArgs

containing data related to this event. The following ListChangedEventArgs properties provide


168


ListChangedType

NewIndex

OldIndex

PropertyDescriptor

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

PositionChanged Event

Occurs when Position property has been changed for this C1DataView.

Syntax


Public Event PositionChanged As System.EventHandler

C#

public event System.EventHandler PositionChanged

Remarks

This is the same event as C1DataViewSet.PositionChanged, with the only difference that event data

in C1DataViewSet has the additional C1ViewPositionChangedEventArgs.View property that specify

in what C1DataView this has occured. See C1DataViewSet.PositionChanged event description for

details on this event.

169


Requirements




See Also

Reference

C1DataView Class

C1DataView Members

RowAddNew Event

Occurs when the AddNew method is being called.

Syntax


Public Event RowAddNew As C1ViewRowAddNewEventHandler

C#

public event C1ViewRowAddNewEventHandler RowAddNew

Event Data

The event handler receives an argument of type C1ViewRowAddNewEventArgs containing data

related to this event. The following C1ViewRowAddNewEventArgs properties provide information

specific to this event.


Row Gets the C1ViewRow that is being added.

Remarks

This is the same event as C1DataViewSet.RowAddNew, see C1DataViewSet.RowAddNew event

description for details on this event.

Note that this event is triggered first on C1DataView and then on C1DataViewSet.

170

Requirements




See Also

Reference

C1DataView Class

C1DataView Members

RowChanged Event

Occurs after editing of C1ViewRow has been successfully finished.

Syntax


Public Event RowChanged As C1ViewRowChangeEventHandler

C#

public event C1ViewRowChangeEventHandler RowChanged

Event Data

The event handler receives an argument of type C1ViewRowChangeEventArgs containing data

related to this event. The following C1ViewRowChangeEventArgs properties provide information



Action Gets the type of change occurred on the C1ViewRow.

Row Gets the C1ViewRow that is being changed.

Remarks

This is the same event as C1DataViewSet.RowChanged, see C1DataViewSet.RowChanged event


171


Requirements




See Also

Reference

C1DataView Class

C1DataView Members

RowChanging Event

Occurs before editing of C1ViewRow will be finished.

Syntax


Public Event RowChanging As C1ViewRowChangeEventHandler

C#

public event C1ViewRowChangeEventHandler RowChanging

Event Data







Remarks

172

This is the same event as C1DataViewSet.RowChanging, see C1DataViewSet.RowChanging event



Requirements




See Also

Reference

C1DataView Class

C1DataView Members

C1DataViewCollection

Represents the collection of C1DataView objects belonging to C1DataViewSet.

Object Model

Syntax


Public Class C1DataViewCollection

Inherits System.Collections.CollectionBase

C#

public class C1DataViewCollection : System.Collections.CollectionBase


System.Object

System.Collections.CollectionBase

C1.C1DataExtender.C1DataViewCollection

Requirements

173




See Also

Reference

C1DataViewCollection Members


Overview

Represents the collection of C1DataView objects belonging to C1DataViewSet.

Object Model

Syntax


Public Class C1DataViewCollection


C#

public class C1DataViewCollection : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.C1DataViewCollection

Requirements




See Also

174

Reference



Members

Properties Methods

The following tables list the members exposed by C1DataViewCollection.

Public Properties

Name Description

Capacity (Inherited from System.Collections.CollectionBase)

Count (Inherited from System.Collections.CollectionBase)

Item Overloaded. Gets the C1DataView object at the specified index.

Top

Public Methods

Name Description

Add Adds the specified C1DataView to the collection.

Clear (Inherited from System.Collections.CollectionBase)

Contains Returns a value indicating whether the specified C1DataView object belongs

to the collection.

GetEnumerator (Inherited from System.Collections.CollectionBase)

Remove Removes the specified C1DataView from the collection.

RemoveAt (Inherited from System.Collections.CollectionBase)

Top

175

See Also

Reference

C1DataViewCollection Class


Methods

For a list of all members of this type, see C1DataViewCollection members.

Public Methods

Name Description

Add Adds the specified C1DataView to the collection.


Contains Returns a value indicating whether the specified C1DataView object belongs

to the collection.


Remove Removes the specified C1DataView from the collection.


Top

See Also

Reference



Add Method

The C1DataView to add.

Adds the specified C1DataView to the collection.

Syntax

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewCollection~RemoveAt.html

176


Public Function Add( _

ByVal dataView As C1DataView _

) As System.Integer

C#

public System.int Add(

C1DataView dataView

)

Parameters

dataView

The C1DataView to add.

Return Value

Returns an index of newly added C1DataView in the collection.

Requirements




See Also

Reference



Contains Method

The C1DataView object to find.

Returns a value indicating whether the specified C1DataView object belongs to the collection.

Syntax


Public Function Contains( _

177


) As System.Boolean

C#

public System.bool Contains(

C1DataView dataView

)

Parameters

dataView

The C1DataView object to find.

Return Value

True if the specified C1DataView exists; otherwise, false.

Requirements




See Also

Reference



Remove Method

The C1DataView to remove.

Removes the specified C1DataView from the collection.

Syntax


Public Sub Remove( _


)

178

C#

public void Remove(

C1DataView dataView

)

Parameters

dataView

The C1DataView to remove.

Remarks

If the specified C1DataView doesn't belong to the collection then do nothing.

Requirements




See Also

Reference



Properties

For a list of all members of this type, see C1DataViewCollection members.

Public Properties

Name Description



Item Overloaded. Gets the C1DataView object at the specified index.

Top

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewCollection~Capacity.html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewCollection~Count.html

179

See Also

Reference



Item Property

Gets the C1DataView object at the specified index.

Overload List


Item(Int32) Gets the C1DataView object at the specified index.

Item(String) Gets the C1DataView object with the specified name.

Requirements




See Also

Reference




The zero-based index of the C1DataView to get.

Gets the C1DataView object at the specified index.

Syntax




180

) As C1DataView

C#

public C1DataView Item(

System.int index

) {get;}

Parameters

index

The zero-based index of the C1DataView to get.

Property Value

A C1DataView.

Requirements




See Also

Reference



Overload List


The name of C1DataView to find.

Gets the C1DataView object with the specified name.

Syntax



ByVal name As System.String _

) As C1DataView

181

C#

public C1DataView Item(

System.string name

) {get;}

Parameters

name

The name of C1DataView to find.

Property Value

If C1DataView with the specified name is contained in the collection then returns it, otherwise

returns a null value.

Requirements




See Also

Reference



Overload List

C1DataViewSet

Represents a set of related C1DataView objects constituting a client's data model.

Object Model

Syntax


Public Class C1DataViewSet

Inherits System.ComponentModel.Component

182

C#

public class C1DataViewSet : System.ComponentModel.Component


System.Object

System.MarshalByRefObject

System.ComponentModel.Component

C1.C1DataExtender.C1DataViewSet

C1.C1DataExtender.C1TypedDataViewSet

Requirements




See Also

Reference

C1DataViewSet Members


Overview

Represents a set of related C1DataView objects constituting a client's data model.

Object Model

Syntax


Public Class C1DataViewSet

Inherits System.ComponentModel.Component

C#

public class C1DataViewSet : System.ComponentModel.Component

183


System.Object





Requirements




See Also

Reference



Members


The following tables list the members exposed by C1DataViewSet.

Public Constructors

Name Description

C1DataViewSet Constructor Initializes a new instance of the C1DataViewSet class.

Top

Public Properties

Name Description

AutoFetch Turns on or off autofetching for all C1DataView objects in

C1DataViewSet.

184

AutoFetchParentsForOrphans Indicates whether automatic fetching of an absent on a client

parent row for an existing child row is permitted in order to

prevent foreign key constraint violation in the underlying

DataSet.

CaseSensitive Allows you to consistently change the CaseSensitive property

value of an underlying DataSet in run-time.

ColumnStyleRules Represents a collection of rules used to map global styles to

columns.

ColumnStyles Represents a global collection of column styles.

Connection Gets DbConnection object used to connect to database in the

case when data source is defined by means of ConnectionString

and ConnectionProvider properties. Allows you to set up data

source via existing DbConnection derived component in run

time.

ConnectionAddTablePrefixes Indicates whether catalog name prefixes specified in the

ConnectionCatalogs collection will be added to names of

imported DataTables, in the case where C1DataViewSet is

connected to a data source via the ConnectionString property.

ConnectionCatalogs Defines a set of catalogs (databases) that should be retrieved

from server when C1DataViewSet is connected to a data source

via the ConnectionString property and ConnectionProvider is

SqlClient provider.

ConnectionProvider Gets or sets an invariant name of ADO.NET Data Provider that

C1DataViewSet uses when connecting to database denoted by

the ConnectionString property value.

ConnectionString Gets or sets a connection string to a database which should be

used as a data source, using syntax and conventions of

185

connection string definition peculiar to ADO.NET Data Provider

denoted by the ConnectionProvider property.

Container (Inherited from System.ComponentModel.Component)

DataSet Gets or sets the source System.Data.DataSet which data this

C1DataViewSet represents.

DataSetShared Allows to specify a DataSet which is situated beyond a Form

where this C1DataViewSet is placed as a data source.

Locale Allows you to consistently change the Locale property value of

an underlying DataSet in run time.

Relations Gets the collection of C1ViewRelation objects that link

C1DataView objects contained in C1DataViewSet and

establishing master-detail relationships between them.

SchemaExtender Gets or sets DataSet Extender that is used along with this

C1DataViewSet.

Site (Inherited from System.ComponentModel.Component)

Views Gets the collection of C1DataView objects constituting this

C1DataViewSet.

Top

Public Methods

Name Description

CreateObjRef (Inherited from System.MarshalByRefObject)

Dispose (Inherited from System.ComponentModel.Component)

186

Fill Overloaded. Refetch data represented by constituting C1DataView

objects from database server.

GetLifetimeService (Inherited from System.MarshalByRefObject)

InitializeLifetimeService (Inherited from System.MarshalByRefObject)

IsDataTableFilling Indicates whether the specified DataTable is currently filling with

data from server by some C1DataView of some C1DataViewSet.

ToString (Inherited from System.ComponentModel.Component)

Update Commit data changes made in contained C1DataView objects and

underlying DataTable objects back to database server.

Top

Public Events

Name Description

CalculateColumn Occurs when C1ViewColumn value is being retrieved.

ColumnChanged Occurs after a value has been changed for the specified C1ViewColumn in

a C1ViewRow.


C1ViewRow.

ConnectionOpening Occurs before C1DataViewSet opens a connection for data and schema

fetching or data updating. This event allows you to set up connection

properties such as login attributes before it will be opened.

CurrentChanged Occurs when values of the current C1ViewRow belonging to the specified

C1DataView have been changed, either because another row becomes the

current one or because values of the current row have been changed.

187

Disposed (Inherited from System.ComponentModel.Component)


PositionChanged Occurs when Position property has been changed for the specified

C1DataView object.




ViewListChanged Occurs on any change in rows of the specified C1DataView.

Top

See Also

Reference

C1DataViewSet Class


C1DataViewSet Constructor

Initializes a new instance of the C1DataViewSet class.

Syntax



C#

public C1DataViewSet()

Requirements

188




See Also

Reference

C1DataViewSet Class


Methods

For a list of all members of this type, see C1DataViewSet members.

Public Methods

Name Description




objects from database server.



IsDataTableFilling Indicates whether the specified DataTable is currently filling with

data from server by some C1DataView of some C1DataViewSet.



underlying DataTable objects back to database server.

Top

See Also

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewSet~CreateObjRef.html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewSet~Dispose().html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewSet~GetLifetimeService.html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewSet~InitializeLifetimeService.html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewSet~ToString.html

189

Reference

C1DataViewSet Class


Fill Method

Refetch data represented by constituting C1DataView objects from database server.

Overload List


Fill() Refetch data represented by constituting C1DataView objects from database

server.

Fill(Boolean) Re-fetch data represented by constituting C1DataView objects from database

server.

Fill(Boolean,Boolean) Re-fetch data represented by constituting C1DataView objects from database

server.

Requirements




See Also

Reference

C1DataViewSet Class


Fill() Method

Refetch data represented by constituting C1DataView objects from database server.

Syntax


190

Public Overloads Sub Fill()

C#

public void Fill()

Remarks

This method is equivalent to C1DataViewSet.Fill(False).

Requirements




See Also

Reference

C1DataViewSet Class


Overload List

Fill(Boolean) Method


Re-fetch data represented by constituting C1DataView objects from database server.

Syntax



ByVal includingLookupTables As System.Boolean _

)

C#

public void Fill(

System.bool includingLookupTables

)

Parameters

191



Remarks

This method calls the C1DataView.Fill method for each constituent C1DataView passing

includingLookupTables as a parameter value.

Requirements




See Also

Reference

C1DataViewSet Class


Overload List

Fill(Boolean,Boolean) Method


Indicates whether data should be fetched even it has been fetched before by fetch requests from

another views.

Re-fetch data represented by constituting C1DataView objects from database server.

Syntax



ByVal includingLookupTables As System.Boolean, _


)

C#

public void Fill(

System.bool includingLookupTables,

192


)

Parameters



forceFetch

Indicates whether data should be fetched even it has been fetched before by fetch requests

from another views.

Requirements




See Also

Reference

C1DataViewSet Class


Overload List

IsDataTableFilling Method

The DataTable in question.

Indicates whether the specified DataTable is currently filling with data from server by some

C1DataView of some C1DataViewSet.

Syntax


Public Shared Function IsDataTableFilling( _

ByVal table As System.Data.DataTable _

) As System.Boolean

C#

public static System.bool IsDataTableFilling(

193

System.Data.DataTable table

)

Parameters

table

The DataTable in question.

Return Value

True if the specified DataTable is currently filling; otherwise, false.

Requirements




See Also

Reference

C1DataViewSet Class


Update Method

Commit data changes made in contained C1DataView objects and underlying DataTable objects

back to database server.

Syntax


Public Sub Update()

C#

public void Update()

Remarks

When performing database update, C1DataViewSet takes in account types of corrections

performed on data rows and interrelations between DataTable objects of an underlying DataSet so

as to commit data rows in a correct order, preventing possible conflicts on a server.

194

For newly added rows which has a server-side autogenerated primary key, C1DataViewSet retrieve

(if possible, see below) this value from server and update corresponding row column on a client

with this value. If such a row has child rows from another DataTable, C1DataViewSet updates their

foreign key values with the new value as well, and only after it commit those child rows to server,

which guarantee that child rows are committed with correct foreign key values.

Because some values of committing row can be changed on a server during update process,

C1DataViewSet retrieve values of each committed row back to a client and updates client row

values.

Different database servers provides different ways to retrieve generated autoincrement values. The

details of how autoincrement values can be retrieved from server can be defined for a specific

server in DataSet Extender, see the

C1.C1DataExtender.SchemaExtender.DataTableExtender.ConnectionInfo property description

for details. Note that for some types of database servers with which C1DataExtender is familiar this

information is detected automatically, so you could not set up it manually. Examples of such servers

are Access, MS SQL and Oracle.

Example

The following example uses a button control to implement the Update method:

Visual Basic Private Sub Button1_Click(sender As Object, e As EventArgs) C1DataViewSet1.Update() End Sub

C# private void button1_Click(object sender, EventArgs e) { C1DataViewSet1.Update(); }




See Also

Reference

C1DataViewSet Class


Properties


Public Properties

195

Name Description


C1DataViewSet.




DataSet.


value of an underlying DataSet in run-time.


columns.

ColumnStyles Represents a global collection of column styles.





time.








SqlClient provider.


196


the ConnectionString property value.




denoted by the ConnectionProvider property.



C1DataViewSet represents.


where this C1DataViewSet is placed as a data source.


an underlying DataSet in run time.



establishing master-detail relationships between them.


C1DataViewSet.



C1DataViewSet.

Top

See Also

Reference

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewSet~Container.html

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewSet~Site.html

197

C1DataViewSet Class


AutoFetch Property

Turns on or off autofetching for all C1DataView objects in C1DataViewSet.

Syntax


Public Property AutoFetch As AutoFetchModeEnum

C#

public AutoFetchModeEnum AutoFetch {get; set;}

Remarks

This property defines a default autofetching mode for all C1DataView objects of C1DataViewSet. It

affect only C1DataView that has AutoFetch set to AutoFetchModeEnum.Default. This property never

return the AutoFetchModeEnum.Default value. Assigning it to the AutoFetchModeEnum.Default

value is equivalent to setting it to AutoFetchModeEnum.Yes.

Requirements




See Also

Reference

C1DataViewSet Class


AutoFetchParentsForOrphans Property

Indicates whether automatic fetching of an absent on a client parent row for an existing child row is

permitted in order to prevent foreign key constraint violation in the underlying DataSet.

Syntax


198

Public Property AutoFetchParentsForOrphans As AutoFetchParentsModeEnum

C#

public AutoFetchParentsModeEnum AutoFetchParentsForOrphans {get; set;}

Remarks

Since C1DataView performs server side filtering when its definition statement contains the WHERE

clause, there is a chance that some rows of a child DataTable in a C1DataViewSet's underlying

DataSet have no corresponding rows in a parent DataTable. Not because this is actually the case,

but due to specific filter conditions defined in WHERE clauses of views' definition statements. This

situation causes a foreign key constraint violation on a client, which is logically wrong because a

corresponding parent row really exists on a server. To bypass this issue, C1DataViewSet

automatically detects orphan child rows and makes an attempt to fetch a correspondig parent row

from a server. Note that those "redundant" rows fetched from server to a parent DataTable for the

sake of preventing a foreign key constraint violation will not affect rowsets of C1DataViews based

on this table because a filter condition specified in the WHERE clause of such C1DataView is

evaluated on a client as well. You can turn this behaviour on or off for C1DataViewSet using its

AutoFetchParentsForOrphans property, by setting it to AutoFetchParentsModeEnum.Yes to turn on

auto fetching and to AutoFetchParentsModeEnum.No to turn it off. If this property is assigned to

AutoFetchParentsModeEnum.Default value (which is the default) then permission to fetch rows in a

certain DataTable (to satisfy orphan rows in its child tables) is determined by settings in DataSet

Extender that are referenced by C1DataViewSet in the SchemaExtender property. Each table

(C1.C1DataExtender.SchemaExtender.DataTableExtender class) in DataSet Extender has the

C1.C1DataExtender.SchemaExtender.DataTableExtender.AutoFetchParentsForOrphans

property that enables (true) or disables (false) auto fetching rows for this table. If C1DataViewSet

doesn't reference any DataSet Extender then AutoFetchParentsModeEnum.Default value of the

AutoFetchParentsForOrphans property is treated as being set to Yes.

Requirements




See Also

Reference

C1DataViewSet Class


199

CaseSensitive Property

Allows you to consistently change the CaseSensitive property value of an underlying DataSet in run-

time.

Syntax


Public Property CaseSensitive As System.Boolean

C#

public System.bool CaseSensitive {get; set;}

Remarks

This property allows you to set CaseSensitive in run time, changing in turn CaseSensitive property

of the underlying DataSet. This change must be performed via this property (instead of changing it

at DataSet) because C1DataViewSet can't detect the fact of changing it at DataSet. In design time

CaseSensitive should be set at an underlying DataSet.

Requirements




See Also

Reference

C1DataViewSet Class


ColumnStyleRules Property

Represents a collection of rules used to map global styles to columns.

Syntax


Public ReadOnly Property ColumnStyleRules As ColumnStyleRuleCollection

200

C#

public ColumnStyleRuleCollection ColumnStyleRules {get;}

Requirements




See Also

Reference

C1DataViewSet Class


ColumnStyles Property

Represents a global collection of column styles.

Syntax


Public ReadOnly Property ColumnStyles As ViewSetColumnStyleCollection

C#

public ViewSetColumnStyleCollection ColumnStyles {get;}

Requirements




See Also

Reference

C1DataViewSet Class


201

Connection Property

Gets DbConnection object used to connect to database in the case when data source is defined by

means of ConnectionString and ConnectionProvider properties. Allows you to set up data source

via existing DbConnection derived component in run time.

Syntax


Public Property Connection As System.Data.Common.DbConnection

C#

public System.Data.Common.DbConnection Connection {get; set;}

Remarks

This property is related to ConnectionString and ConnectionProvider properties, which allows you

to denote data source via connection string, see C1DataViewSet Data Sources for details on this

type of data source.

If ConnectionString property set to a non empty value, C1DataViewSet creates a DbConnection

derived object of the type corresponding to the value of the ConnectionProvider property, which is

accessible via this property.

This property can be set directly in run time to an instance of a DbConnection derived object

denoting a desired database. In this case values of ConnectionString and ConnectionProvider are

updated accordingly.

Requirements




See Also

Reference

C1DataViewSet Class


202

ConnectionAddTablePrefixes Property

Indicates whether catalog name prefixes specified in the ConnectionCatalogs collection will be

added to names of imported DataTables, in the case where C1DataViewSet is connected to a data

source via the ConnectionString property.

Syntax


Public Property ConnectionAddTablePrefixes As System.Boolean

C#

public System.bool ConnectionAddTablePrefixes {get; set;}

Remarks

See the ConnectionCatalogs property description for details.

Requirements




See Also

Reference

C1DataViewSet Class


ConnectionCatalogs Property

Defines a set of catalogs (databases) that should be retrieved from server when C1DataViewSet is

connected to a data source via the ConnectionString property and ConnectionProvider is SqlClient

provider.

Syntax


Public ReadOnly Property ConnectionCatalogs As CatalogCollection

203

C#

public CatalogCollection ConnectionCatalogs {get;}

Remarks

The ConnectionCatalogs property has an effect only if C1DataViewSet is connected to a data source

via the ConnectionString property and ConnectionProvider is SqlClient provider. In all other cases

this property is ignored.

If this collection is empty then data is retrieved from a catalog specified in the "Initial Catalog"

parameter of the ConnectionString property. Each item of the collection is a name of a catalog

(database) from the server referenced in the ConnectionString property, or a catalog name from a

linked server registered on the server referenced in the ConnectionString property. In the letter case

the name must be specified in the form of linked_server_name.catalog_name. An empty item

denotes a default catalog specified in the "Initial Catalog" parameter of the ConnectionString

property.

For example, let's suppose that ConnectionString is set to "Data Source=(local);Initial

Catalog=NorthWind;Integrated Security=True" and ConnectionCatalogs has the following list of

items: "" (empty string), "AdventureWorks" and "LinkedServer.NorthWind". In this case the following

databases will be retrieved to C1DataViewSet respectively: local NorthWind database, local

AdventureWorks database and the NorthWind database from the linked server LinkedServer

registered on the local server.

In order to provide an ability to commit data changes to databases from linked servers, make sure

that the following conditions are satisfied:

Microsoft Distributed Transaction Coordinator is started for SQL Server that C1DataViewSet

is connected to.

RPC calls to the linked server are allowed in the linked server definition. To enable it in the

SQL Server 2008 Management Studio, in the linked server properties window, "Server

Options" page, set the "RPC Out" option to true.

By default, when C1DataViewSet imports DataSet structure from server, it adds the catalog name

prefixes to created DataTables' names, with dots replaced by underscores. For example, a DataTable

representing the Customers table from the "LinkedServer.NorthWind" database will get the

"LinkedServer_NorthWind_Customers" name. The tables corresponding to the default catalog

(denoted by an empty string item in the ConnectionCatalogs collection) doesn't get such a prefix.

This behavior can be changed by setting the ConnectionAddTablePrefixes property to false, in this

case the prefixes will not be added to the DataTable names. In case of name conflicts, that is when a

table with the same name exists in multiple referenced catalogs, the name of each conflicting table

will be suffixed with and unique number. For the example above, the Customers table from the local

204

server will be named "Customers", and the Customers table from the linked server will be named

"Customers2". Note that the catalogs are processed in the same order as they go in the collection.

Any change in the ConnectionCatalogs collection causes C1DataViewSet to re-fetch the whole

DataSet structure. If in run-time you need to perform multiple changes to the collection at once

then it's recommended to wrap those changes with the BeginUpdate and EndUpdate method calls,

in this case the data fetching will be performed only once after the EndUpdate method is called,

which will cut down the time necessary to perform this operation.

Requirements




See Also

Reference

C1DataViewSet Class


ConnectionProvider Property

Gets or sets an invariant name of ADO.NET Data Provider that C1DataViewSet uses when

connecting to database denoted by the ConnectionString property value.

Syntax


Public Property ConnectionProvider As System.String

C#

public System.string ConnectionProvider {get; set;}

Remarks

See the ConnectionString property description for details on connecting to data source using

connection string.

When this property value is changed, the ConnectionString property value is reset to an empty

string.

205

An invariant name of data provider (that must be specified as this property value) corresponds to a

value of the "InvariantName" column of DataRow representing this adapter from DataTable

returning by the DbProviderFactories.GetFactoryClasses method.

Requirements




See Also

Reference

C1DataViewSet Class


ConnectionString Property

Gets or sets a connection string to a database which should be used as a data source, using syntax

and conventions of connection string definition peculiar to ADO.NET Data Provider denoted by the

ConnectionProvider property.

Syntax


Public Property ConnectionString As System.String

C#

public System.string ConnectionString {get; set;}

Remarks

By setting this property to a non-empty value you can define a database denoted by the specified

connection string as a data source for this C1DataViewSet. In this case C1DataViewSet retrieve

database schema information and creates internal DataSet object with DataTable, DataRelation,

DataColumn objects and constraints which reflect the schema of specified database, see

C1DataViewSet Data Sources for details. This DataSet object is accessible via the DataSet property.

If at this moment C1DataViewSet is connected to an instance of DataSet via the DataSet property,

the usage of those Dataset as a data source is stopped.

206

In case where the SqlClient provider is used to connect to a server, it's possible to retrieve schema

and data from multiple catalogs, including catalogs on linked servers, by specifying the catalog

names in the ConnectionCatalogs collection property.

The specified connection string must follow syntax and conventions stated by an ADO.NET Data

Provider specified in the ConnectionProvider property. When this property is set to non-empty

value, C1DataViewSet creates a DbConnection derived object corresponding to the specified Data

Provider and assigns its ConnectionString property with the provided value. This connection object

is accessible via the Connection property.

To stop using the specified database as C1DataViewSet data source set this property value to an

empty string.

Requirements




See Also

Reference

C1DataViewSet Class


DataSet Property

Gets or sets the source System.Data.DataSet which data this C1DataViewSet represents.

Syntax


Public Property DataSet As System.Data.DataSet

C#

public System.Data.DataSet DataSet {get; set;}

Remarks

This property value can be set to an instance of typed or untyped DataSet.

If data source is defined by means of ConnectionString and ConnectionProvider properties, this

property returns a reference to an internally created DataSet.

207

See C1DataViewSet Data Sources for details.

Requirements




See Also

Reference

C1DataViewSet Class


DataSetShared Property

Allows to specify a DataSet which is situated beyond a Form where this C1DataViewSet is placed as

a data source.

Syntax


Public Property DataSetShared As System.String

C#

public System.string DataSetShared {get; set;}

Remarks

This property allows you to define a path to some static (shared in VB) public property or field or its

nested property that references an object of DataSet derived type. The path definition has the

following structure: [NameSpace.]TypeName.StaticPropertyName[.SubPropertyPath] , where the

parts in square brackets are optional. [NameSpace.]TypeName - a name of a type that contains a

static property, with an optional namespace. StaticPropertyName[.SubPropertyPath] - a name of

static property or field of the type, with optional path to subproperty. All the properties or fields in

the path must be public. The final property or field of the path must return an object of DataSet

derived type.

Requirements

208




See Also

Reference

C1DataViewSet Class


Locale Property

Allows you to consistently change the Locale property value of an underlying DataSet in run time.

Syntax


Public Property Locale As System.Globalization.CultureInfo

C#

public System.Globalization.CultureInfo Locale {get; set;}

Remarks

This property allows you to set locale in run time, changing in turn Locale property of underlying

DataSet. This change must be performed via this property (instead of changing it directly in

DataSet) because C1DataViewSet can't detect the fact of changing it at DataSet. In design time

Locale should be set at an underlying DataSet.

Requirements




See Also

Reference

C1DataViewSet Class


209

Relations Property

Gets the collection of C1ViewRelation objects that link C1DataView objects contained in

C1DataViewSet and establishing master-detail relationships between them.

Syntax


Public ReadOnly Property Relations As C1ViewRelationCollection

C#

public C1ViewRelationCollection Relations {get;}

Requirements




See Also

Reference

C1DataViewSet Class


SchemaExtender Property

Gets or sets DataSet Extender that is used along with this C1DataViewSet.

Syntax


Public Property SchemaExtender As DataSetExtender

C#

public DataSetExtender SchemaExtender {get; set;}

Remarks

This property allows you to define DataSet Extender for this C1DataViewSet, see DataSetExtender

for details on what DataSet Extender is.

210

This property never returns null. If it's not set or set to a null (Nothing in VB) value, a default

DataSet Extender is created and returned by this property.

Requirements




See Also

Reference

C1DataViewSet Class


Views Property

Gets the collection of C1DataView objects constituting this C1DataViewSet.

Syntax


Public ReadOnly Property Views As C1DataViewCollection

C#

public C1DataViewCollection Views {get;}

Requirements




See Also

Reference

C1DataViewSet Class


Events


211

Public Events

Name Description

CalculateColumn Occurs when C1ViewColumn value is being retrieved.


a C1ViewRow.


C1ViewRow.



properties such as login attributes before it will be opened.







C1DataView object.




ViewListChanged Occurs on any change in rows of the specified C1DataView.

Top

C1.C1DataExtender.2~C1.C1DataExtender.C1DataViewSet~Disposed_EV.html

212

See Also

Reference

C1DataViewSet Class


CalculateColumn Event

Occurs when C1ViewColumn value is being retrieved.

Syntax


Public Event CalculateColumn As C1ViewColumnCalculateEventHandler

C#

public event C1ViewColumnCalculateEventHandler CalculateColumn

Event Data

The event handler receives an argument of type C1ViewColumnCalculateEventArgs containing data

related to this event. The following C1ViewColumnCalculateEventArgs properties provide






Remarks

This event allows you to calculate C1ViewColumn value in code. It is triggered when column value is

being read by a client code for columns having the C1ViewColumn.RaiseCalculateColumnEvents

property value set to true. To define a calculated column value the

C1ViewColumnCalculateEventArgs.Value must be set. See the Defining Column Value Calculations

topic for details on C1ViewColumn value calculation.

213

Requirements




See Also

Reference

C1DataViewSet Class


ColumnChanged Event

Occurs after a value has been changed for the specified C1ViewColumn in a C1ViewRow.

Syntax


Public Event ColumnChanged As C1ViewColumnChangeEventHandler

C#

public event C1ViewColumnChangeEventHandler ColumnChanged

Event Data







changed.


214


Remarks

This event is triggered after new proposed value for a C1ViewColumn of a C1ViewRow has been

actually stored in a row.

Note that this event is thrown only when change of a value is being made via C1ViewRow object,

it's not triggered when changing is performing directly in DataRow object on which C1ViewRow is

based.

Requirements




See Also

Reference

C1DataViewSet Class


ColumnChanging Event

Occurs when a value is being changed for specified C1ViewColumn in a C1ViewRow.

Syntax


Public Event ColumnChanging As C1ViewColumnChangeEventHandler

C#

public event C1ViewColumnChangeEventHandler ColumnChanging

Event Data




215




changed.



Remarks

This event is triggered before new proposed value for a C1ViewColumn of a C1ViewRow is actually

stored in a row.

You can substitute a proposed value with another one by setting the

C1ViewColumnChangeEventArgs.NewValue property value in passed event arguments.

Raising an exception in this event prevents from storing of a new value in a row.

Note that this event is thrown only when change of a value is being made via C1ViewRow object,

it's not triggered when changing is performing directly in DataRow object on which C1ViewRow is

based.

Requirements




See Also

Reference

C1DataViewSet Class


ConnectionOpening Event

Occurs before C1DataViewSet opens a connection for data and schema fetching or data updating.

This event allows you to set up connection properties such as login attributes before it will be

opened.

216

Syntax


Public Event ConnectionOpening As ConnectionOpeningEventHandler

C#

public event ConnectionOpeningEventHandler ConnectionOpening

Event Data

The event handler receives an argument of type ConnectionOpeningEventArgs containing data

related to this event. The following ConnectionOpeningEventArgs properties provide information



Connection Gets the connection that is about to be opened.

Remarks

This event is mainly intended to define login attributes in the connection string of the opening

connection, but the other properties can be changed as well.

To make the process of updating the connection string simple and safe you can use an object of

the System.Data.Common.DbConnectionStringBuilder type or of a derived class which is

appropriate to the type of connection, for example

System.Data.SqlClient.SqlConnectionStringBuilder for the System.Data.SqlClient.SqlConnection.

Requirements




See Also

Reference

C1DataViewSet Class


217

CurrentChanged Event

Occurs when values of the current C1ViewRow belonging to the specified C1DataView have been

changed, either because another row becomes the current one or because values of the current row

have been changed.

Syntax


Public Event CurrentChanged As C1ViewCurrentChangedEventHandler

C#

public event C1ViewCurrentChangedEventHandler CurrentChanged

Event Data

The event handler receives an argument of type C1ViewCurrentChangedEventArgs containing data

related to this event. The following C1ViewCurrentChangedEventArgs properties provide





Remarks

This event is triggered when one of the following occurs:

Another row becomes the current row of the specified C1DataView. Current row is

accessible via the C1DataView.Current property.

Values of the current C1DataView row have been changed.

The reason for triggering this event can be determined via the

C1ViewListChangedEventHandler.Reason property.

This event is useful if you need to provide a custom processing of current row changing

independently of the reason of this change.

Requirements

218




See Also

Reference

C1DataViewSet Class


FilterRow Event

Allows to filter out C1DataView rows on a client in code.

Syntax


Public Event FilterRow As C1ViewFilterRowEventHandler

C#

public event C1ViewFilterRowEventHandler FilterRow

Event Data

The event handler receives an argument of type C1ViewFilterRowEventArgs containing data related

to this event. The following C1ViewFilterRowEventArgs properties provide information specific to

this event.




Remarks

An event argument of this event handler has the C1ViewFilterRowEventArgs.Accept property that

should be set to true to accept row or to false to reject it. To enable triggering of this event for a

view the C1DataView.RaiseFilterRow property of this view must be set to true (the default is false

due to performance reasons). Note that this event is raised only for rows that satisfy filter

conditions specified in a view definition's WHERE clause and in the RowFilter property, that is the

219

FilterRow event doesn't allow enabling rows that have been rejected by those conditions. Because a

filter condition that is coded in the FilterRow event handler may depend on data that is beyond the

checking row's data (say some property of some object), you should call the C1DataView.Reset

method to force the view to reapply filter conditions coded in the FilterRow event handler. This

method doesn't causes refetching the view's data from server, it only forces the view to rebuild its

rowset.

Requirements




See Also

Reference

C1DataViewSet Class


PositionChanged Event

Occurs when Position property has been changed for the specified C1DataView object.

Syntax


Public Event PositionChanged As C1ViewPositionChangedEventHandler

C#

public event C1ViewPositionChangedEventHandler PositionChanged

Event Data

The event handler receives an argument of type C1ViewPositionChangedEventArgs containing data

related to this event. The following C1ViewPositionChangedEventArgs properties provide



View Gets the C1DataView object in which position has been changed.

220

Requirements




See Also

Reference

C1DataViewSet Class


RowAddNew Event

Occurs when the AddNew method is being called.

Syntax


Public Event RowAddNew As C1ViewRowAddNewEventHandler

C#

public event C1ViewRowAddNewEventHandler RowAddNew

Event Data

The event handler receives an argument of type C1ViewRowAddNewEventArgs containing data

related to this event. The following C1ViewRowAddNewEventArgs properties provide information




Remarks

In contrast to the RowChanging and RowChanged events, which are raised when editing of a newly

added row is being finished, this event is raised just after a new row has been created.

This event is an appropriate place to define default values for the row columns in code.

Raising an exception in this event handler prevents a new row from being added to C1DataView.

221

Requirements




See Also

Reference

C1DataViewSet Class


RowChanged Event

Occurs after editing of C1ViewRow has been successfully finished.

Syntax


Public Event RowChanged As C1ViewRowChangeEventHandler

C#

public event C1ViewRowChangeEventHandler RowChanged

Event Data







Remarks

This event is triggered after editing of C1ViewRow belonging to a C1DataView contained in this

C1DataViewSet has been successfully finished, i.e. the C1ViewRow.EndEdit method has been called

222

for the row when it was in editing state (row is switched to an editing state by call of the

C1ViewRow.BeginEdit method).

Note that this event is not triggered when changes are made directly to DataRow objects on which

C1ViewRow is based. To process this case you should use ViewListChanged event.

Requirements




See Also

Reference

C1DataViewSet Class


RowChanging Event

Occurs before editing of C1ViewRow will be finished.

Syntax


Public Event RowChanging As C1ViewRowChangeEventHandler

C#

public event C1ViewRowChangeEventHandler RowChanging

Event Data







223

Remarks

This event is triggered when editing of C1ViewRow belonging to a C1DataView contained in this

C1DataViewSet is finishing, that is, the C1ViewRow.EndEdit method has been called for the row

when it was in editing state (row is switched to an editing state by call of the C1ViewRow.BeginEdit

method).

Raising an exception in this event prevents a row from leaving of editing state.

Note that this event is not triggered when changes are made directly to DataRow objects on which

C1ViewRow is based. To process this case you should use ViewListChanged event.

Requirements




See Also

Reference

C1DataViewSet Class


ViewListChanged Event

Occurs on any change in rows of the specified C1DataView.

Syntax


Public Event ViewListChanged As C1ViewListChangedEventHandler

C#

public event C1ViewListChangedEventHandler ViewListChanged

Event Data

The event handler receives an argument of type C1ViewListChangedEventArgs containing data

related to this event. The following C1ViewListChangedEventArgs properties provide information


224


ListChangedType (Inherited from System.ComponentModel.ListChangedEventArgs)

NewIndex (Inherited from System.ComponentModel.ListChangedEventArgs)

OldIndex (Inherited from System.ComponentModel.ListChangedEventArgs)

PropertyDescriptor (Inherited from System.ComponentModel.ListChangedEventArgs)

View Gets the

C1DataView

in which

event

occurred.

Remarks

This event is triggered independently of a reason of row changes, whether changes was made via

C1ViewRow of base DataRow objects. Note that in the case of composite view, changing of a single

DataRow can cause changing of multiple C1ViewRow objects based on that DataRow. In this case

event will be thrown for each C1ViewRow affected by this change.

This event provides event arguments parameter of type C1ViewListChangedEventArgs which is

derived from the System.ComponentModel.ListChangedEventArgs class. It adds the single View

parameter which references the C1DataView object which row set has been changed.

Requirements




See Also

Reference

C1DataViewSet Class


C1.C1DataExtender.2~C1.C1DataExtender.C1ViewListChangedEventArgs~ListChangedType.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewListChangedEventArgs~NewIndex.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewListChangedEventArgs~OldIndex.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewListChangedEventArgs~PropertyDescriptor.html

225

C1ExpressionDef

Defines a programming language and text of expression.

Object Model

Syntax


Public Class C1ExpressionDef

C#

public class C1ExpressionDef


System.Object

C1.C1DataExtender.C1ExpressionDef

Requirements




See Also

Reference

C1ExpressionDef Members


Overview

Defines a programming language and text of expression.

Object Model

Syntax

226


Public Class C1ExpressionDef

C#

public class C1ExpressionDef


System.Object

C1.C1DataExtender.C1ExpressionDef

Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by C1ExpressionDef.

Public Properties

Name Description

Language Gets or sets the name of the .NET Framework programming language used

to define an expression.

Text Gets or sets the expression text , which must conform to the language

defined in the Language property.

Top

227

Public Methods

Name Description

GetAvailableLanguages Returns the list of names of available languages. These are language

names which can be assigned to the Language property.

Top

See Also

Reference

C1ExpressionDef Class


Methods

For a list of all members of this type, see C1ExpressionDef members.

Public Methods

Name Description

GetAvailableLanguages Returns the list of names of available languages. These are language

names which can be assigned to the Language property.

Top

See Also

Reference



GetAvailableLanguages Method

Returns the list of names of available languages. These are language names which can be assigned

to the Language property.

Syntax

228


Public Function GetAvailableLanguages() As System.String()

C#

public System.string[] GetAvailableLanguages()

Return Value

An array of invariant names of available programming languages.

Requirements




See Also

Reference



Properties

>

Name Description

Language

Gets or sets the name of the .NET Framework programming language used

to define an expression.

Text

Gets or sets the expression text , which must conform to the language

defined in the Language property.

Top

See Also

Reference



229

Language Property

Gets or sets the name of the .NET Framework programming language used to define an expression.

Syntax


Public Property Language As System.String

C#

public System.string Language {get; set;}

Remarks

The names of programming languages supported on a host computer can be retrieved with the

GetAvailableLanguages method.

Requirements




See Also

Reference



Text Property

Gets or sets the expression text , which must conform to the language defined in the Language

property.

Syntax


Public Property Text As System.String

C#

public System.string Text {get; set;}

230

Remarks

Expression text is treated as code from a class method, returning a value (function); therefore,

expression code must have a line which returns a value from the method (for example, "return"

statement for Visual Basic and C#).

Requirements




See Also

Reference



C1NameValueCollection<TValue>

Object Model

Syntax


Public Class C1NameValueCollection(Of TValue)

Inherits System.Collections.Specialized.NameObjectCollectionBase

C#

public class C1NameValueCollection<TValue> :

System.Collections.Specialized.NameObjectCollectionBase

Type Parameters

TValue


231

System.Object


C1.C1DataExtender.C1NameValueCollection<TValue>

Requirements




See Also

Reference

C1NameValueCollection<TValue> Members


Overview

Object Model

Syntax


Public Class C1NameValueCollection(Of TValue)

Inherits System.Collections.Specialized.NameObjectCollectionBase

C#

public class C1NameValueCollection<TValue> :


Type Parameters

TValue


System.Object


C1.C1DataExtender.C1NameValueCollection<TValue>

232

Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by C1NameValueCollection<TValue>.

Public Constructors

Name Description

C1NameValueCollection<TValue> Constructor

Top

Public Properties

Name Description

Count (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

Item Overloaded.

Keys (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

Top

Public Methods

Name Description

233

Add

Clear

CopyTo

GetEnumerator (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

GetKeyAt

GetObjectData (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

GetValues

IndexOfKey

OnDeserialization (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

RemoveAt

Top

See Also

Reference

C1NameValueCollection<TValue> Class


C1NameValueCollection<TValue> Constructor

Syntax



C#

public C1NameValueCollection<TValue>()

234

Requirements




See Also

Reference



Methods

>

Name Description

Add

Clear

CopyTo

GetEnumerator (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

GetKeyAt

GetObjectData (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

GetValues

IndexOfKey

OnDeserialization (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

RemoveAt

Top

See Also

Reference

C1.C1DataExtender.2~C1.C1DataExtender.C1NameValueCollection%601~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.C1NameValueCollection%601~GetObjectData.html

C1.C1DataExtender.2~C1.C1DataExtender.C1NameValueCollection%601~OnDeserialization.html

235



Add Method

Syntax


Public Sub Add( _

ByVal value As TValue, _

ByVal key As System.String _

)

C#

public void Add(

TValue value,

System.string key

)

Parameters

value

key

Requirements




See Also

Reference



Clear Method

Syntax


236

Public Sub Clear()

C#

public void Clear()

Requirements




See Also

Reference



CopyTo Method

Syntax





)

C#

public void CopyTo(

System.Array array,

System.int index

)

Parameters

array

index

Requirements

237




See Also

Reference



GetKeyAt Method

Syntax


Public Function GetKeyAt( _


) As System.String

C#

public System.string GetKeyAt(

System.int index

)

Parameters

index

Requirements




See Also

Reference



238

GetValues Method

Syntax


Public Function GetValues() As System.Object()

C#

public System.object[] GetValues()

Requirements




See Also

Reference



IndexOfKey Method

Syntax


Public Function IndexOfKey( _


) As System.Integer

C#

public System.int IndexOfKey(

System.string key

)

Parameters

key

Requirements

239




See Also

Reference



RemoveAt Method

Syntax


Public Sub RemoveAt( _


)

C#

public void RemoveAt(

System.int index

)

Parameters

index

Requirements




See Also

Reference



240

Properties

For a list of all members of this type, see C1NameValueCollection<TValue> members.

Public Properties

Name Description

Count (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

Item Overloaded.

Keys (Inherited from System.Collections.Specialized.NameObjectCollectionBase)

Top

See Also

Reference



Item Property

Overload List


Item(Int32)

Item(String)

Requirements




See Also

Reference

C1.C1DataExtender.2~C1.C1DataExtender.C1NameValueCollection%601~Count.html

C1.C1DataExtender.2~C1.C1DataExtender.C1NameValueCollection%601~Keys.html

241




Syntax


Public Overloads Property Item( _


) As TValue

C#

public TValue Item(

System.int index

) {get; set;}

Parameters

index

Requirements




See Also

Reference



Overload List


Syntax




242

) As TValue

C#

public TValue Item(

System.string key

) {get; set;}

Parameters

key

Requirements




See Also

Reference



Overload List

C1TypedDataView

The base class for a typed DataView.

Object Model

Syntax


Public Class C1TypedDataView

Inherits C1DataView

C#

public class C1TypedDataView : C1DataView

243


System.Object




Requirements




See Also

Reference

C1TypedDataView Members


Overview

The base class for a typed DataView.

Object Model

Syntax


Public Class C1TypedDataView

Inherits C1DataView

C#

public class C1TypedDataView : C1DataView


System.Object


244



Requirements




See Also

Reference



Members


The following tables list the members exposed by C1TypedDataView.

Public Constructors

Name Description

C1TypedDataView Constructor

Top

Public Properties

Name Description


this C1DataView. (Inherited from C1.C1DataExtender.C1DataView)


that belong to this C1DataView is permitted. (Inherited from

C1.C1DataExtender.C1DataView)


245

for this C1DataView. (Inherited from C1.C1DataExtender.C1DataView)

AutoFetch Controls the autofetching behavior for this C1DataView. (Inherited from






(Inherited from C1.C1DataExtender.C1DataView)


Definition property. (Inherited from C1.C1DataExtender.C1DataView)


C1DataView. (Inherited from C1.C1DataExtender.C1DataView)

ConstraintExpression Defines a row level constraint. (Inherited from



Count Returns a number of rows in the C1DataView. (Inherited from





Definition Gets or sets view definition statement. (Inherited from



Definition property. (Inherited from C1.C1DataExtender.C1DataView)

246



data according to its Definition. (Inherited from


Item Returns a C1ViewRow object at the specified index. (Inherited from






of this view. (Inherited from C1.C1DataExtender.C1DataView)

RaiseFilterRowEvent Indicates whether the FilterRow event should be fired. (Inherited from


RowFilter Gets or sets an expression used to filter rows in C1DataView. (Inherited

from C1.C1DataExtender.C1DataView)




ViewName Gets or sets the name of the C1DataView. (Inherited from






247

Top

Public Methods

Name Description

AddNew Adds a new row to this C1DataView. (Inherited from


Delete Deletes C1ViewRow at the specified index. (Inherited from




server. (Inherited from C1.C1DataExtender.C1DataView)

Find Overloaded. Finds a row in this C1DataView by the specified sort key value.



value. (Inherited from C1.C1DataExtender.C1DataView)

GetEnumerator Gets a C1ViewRow enumerator for this C1DataView. (Inherited from



Reset Rebuilds the Rows collection and sends Reset notification. (Inherited from




ToString (Inherited from C1.C1DataExtender.C1DataView)

Top

248

Public Events

Name Description

CalculateColumn Occurs when the C1ViewColumn value is being retrieved. (Inherited from



C1ViewRow. (Inherited from C1.C1DataExtender.C1DataView)


C1ViewRow. (Inherited from C1.C1DataExtender.C1DataView)


C1DataView has been changed. (Inherited from



FilterRow Allows to filter out C1DataView rows on a client in code. (Inherited from


ListChanged (Inherited from C1.C1DataExtender.C1DataView)



RowAddNew Occurs when the AddNew method is being called. (Inherited from


RowChanged Occurs after editing of C1ViewRow has been successfully finished. (Inherited

from C1.C1DataExtender.C1DataView)

RowChanging Occurs before editing of C1ViewRow will be finished. (Inherited from


249

Top

See Also

Reference

C1TypedDataView Class


C1TypedDataView Constructor

Syntax



C#

public C1TypedDataView()

Requirements




See Also

Reference

C1TypedDataView Class


C1TypedDataViewSet

The base class for a typed ViewSet.

Object Model

Syntax


250

Public Class C1TypedDataViewSet

Inherits C1DataViewSet

C#

public class C1TypedDataViewSet : C1DataViewSet


System.Object





Requirements




See Also

Reference

C1TypedDataViewSet Members


Overview

The base class for a typed ViewSet.

Object Model

Syntax


Public Class C1TypedDataViewSet

Inherits C1DataViewSet

251

C#

public class C1TypedDataViewSet : C1DataViewSet


System.Object





Requirements




See Also

Reference



Members


The following tables list the members exposed by C1TypedDataViewSet.

Public Constructors

Name Description

C1TypedDataViewSet Constructor

Top

Public Properties

Name Description

252


C1DataViewSet. (Inherited from

C1.C1DataExtender.C1DataViewSet)




DataSet. (Inherited from C1.C1DataExtender.C1DataViewSet)


value of an underlying DataSet in run-time. (Inherited from



columns. (Inherited from C1.C1DataExtender.C1DataViewSet)

ColumnStyles Represents a global collection of column styles. (Inherited from






time. (Inherited from C1.C1DataExtender.C1DataViewSet)





(Inherited from C1.C1DataExtender.C1DataViewSet)




SqlClient provider. (Inherited from

253




the ConnectionString property value. (Inherited from





denoted by the ConnectionProvider property. (Inherited from




C1DataViewSet represents. (Inherited from



where this C1DataViewSet is placed as a data source. (Inherited

from C1.C1DataExtender.C1DataViewSet)


an underlying DataSet in run time. (Inherited from




establishing master-detail relationships between them. (Inherited




254






Top

Public Methods

Name Description




objects from database server. (Inherited from






underlying DataTable objects back to database server. (Inherited from


Top

Public Events

Name Description

255

CalculateColumn Occurs when C1ViewColumn value is being retrieved. (Inherited from



a C1ViewRow. (Inherited from C1.C1DataExtender.C1DataViewSet)


C1ViewRow. (Inherited from C1.C1DataExtender.C1DataViewSet)



properties such as login attributes before it will be opened. (Inherited







FilterRow Allows to filter out C1DataView rows on a client in code. (Inherited from



C1DataView object. (Inherited from C1.C1DataExtender.C1DataViewSet)

RowAddNew Occurs when the AddNew method is being called. (Inherited from




RowChanging Occurs before editing of C1ViewRow will be finished. (Inherited from

256


ViewListChanged Occurs on any change in rows of the specified C1DataView. (Inherited


Top

See Also

Reference

C1TypedDataViewSet Class


C1TypedDataViewSet Constructor

Syntax



C#

public C1TypedDataViewSet()

Requirements




See Also

Reference

C1TypedDataViewSet Class


C1TypedViewRow

The base class for a typed ViewRow.

Object Model

257

Syntax


Public Class C1TypedViewRow

Inherits C1ViewRow

Implements IRowAccessor

C#

public class C1TypedViewRow : C1ViewRow, IRowAccessor


System.Object

C1.C1DataExtender.C1ViewRow

C1.C1DataExtender.C1TypedViewRow

Requirements




See Also

Reference

C1TypedViewRow Members


Overview

The base class for a typed ViewRow.

Object Model

Syntax

258


Public Class C1TypedViewRow

Inherits C1ViewRow


C#

public class C1TypedViewRow : C1ViewRow, IRowAccessor


System.Object



Requirements




See Also

Reference

C1TypedViewRow Members


Members

Properties Methods

The following tables list the members exposed by C1TypedViewRow.

Public Properties

Name Description

BaseRows Gets the collection of System.Data.DataRow objects referenced in this

C1ViewRow. (Inherited from C1.C1DataExtender.C1ViewRow)

Item Overloaded. Gets or sets the value stored in the specified C1ViewColumn of

259

this row. (Inherited from C1.C1DataExtender.C1ViewRow)

ItemArray Gets or sets the column values of this row through an array. (Inherited from

C1.C1DataExtender.C1ViewRow)

PrimaryKeyValue Returns an array of values representing a primary key of the row. (Inherited

from C1.C1DataExtender.C1ViewRow)

SortKeyValue Returns an array of values representing a sort key of the row. (Inherited from


View Gets the C1DataView that this row belongs to. (Inherited from


Top

Public Methods

Name Description

BeginEdit Starts an editing of the row. (Inherited from C1.C1DataExtender.C1ViewRow)

CancelEdit Cancels current row editing. (Inherited from C1.C1DataExtender.C1ViewRow)

Delete Deletes this row. (Inherited from C1.C1DataExtender.C1ViewRow)

EndEdit Finishes current row editing. (Inherited from C1.C1DataExtender.C1ViewRow)

GetChildRows Overloaded. Gets the child rows of this C1ViewRow using the specified

C1ViewRelation. (Inherited from C1.C1DataExtender.C1ViewRow)

GetParentRow Gets a parent C1ViewRow for this row. (Inherited from


GetParentRows Gets an array of parent rows of this C1ViewRow. (Inherited from


260

IsNull Overloaded. Gets a value that indicates whether the specified C1ViewColumn

contains a null value. (Inherited from C1.C1DataExtender.C1ViewRow)

Top

See Also

Reference

C1TypedViewRow Class


C1ViewColumn

Represents a column of C1DataView.

Object Model

Syntax


Public Class C1ViewColumn

C#

public class C1ViewColumn


System.Object

C1.C1DataExtender.C1ViewColumn

Requirements




See Also

Reference

261

C1ViewColumn Members


Overview

Represents a column of C1DataView.

Object Model

Syntax


Public Class C1ViewColumn

C#

public class C1ViewColumn


System.Object

C1.C1DataExtender.C1ViewColumn

Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by C1ViewColumn.

Public Properties

262

Name Description

AutoFetchLookupTable Controls the autofetching behavior of this column foreign key

lookup DataTable.

CalculationExpression Defines an expression used to calculate a value returning for this

C1ViewColumn.

Caption Gets or sets the caption of this column.

ColumnName Gets the name of this C1ViewColumn.

ColumnStyle Represents Column Style definition - a set of properties that

affects column data representation in ComponentOne user

interface controls.

ConstraintExpression Defines a column level constraint.

DataColumn Gets the System.Data.DataColumn that this C1ViewColumn

represents in the C1DataView.

DataType Gets the type of data stored in the column.

DataView Gets the C1DataView that this column belongs to.

DefaultValue Gets or sets the default value for this column when creating new

row.

IsCalculated Gets a value indicating whether this C1ViewColumn is

calculated.

RaiseCalculateColumnEvents Gets or sets a value indicating whether

C1DataViewSet.CalculateColumn and

C1DataView.CalculateColumn events must be triggered.

263

ReadOnly Gets or sets the value indicating wheather this column is read

only or modifiable.

Top

Public Methods

Name Description

FillLookupTable Overloaded. Re-fetches a foreign key lookup DataTable of this

C1ViewColumn.

ToString

Top

See Also

Reference

C1ViewColumn Class


Methods

For a list of all members of this type, see C1ViewColumn members.

Public Methods

Name Description

FillLookupTable Overloaded. Re-fetches a foreign key lookup DataTable of this

C1ViewColumn.

ToString

Top

See Also

Reference

264

C1ViewColumn Class


FillLookupTable Method

Re-fetches a foreign key lookup DataTable of this C1ViewColumn.

Overload List


FillLookupTable() Re-fetches a foreign key lookup DataTable of this C1ViewColumn.

FillLookupTable(Boolean) Re-fetches a foreign key lookup DataTable of this C1ViewColumn.

Requirements




See Also

Reference

C1ViewColumn Class


FillLookupTable() Method


Syntax


Public Overloads Sub FillLookupTable()

C#

public void FillLookupTable()

Remarks

265


ColumnStyleBase.ItemListType property is assigned with ItemListTypeEnum.ForeignKey value.

See the Data Fetching topic for details.

Requirements




See Also

Reference

C1ViewColumn Class


Overload List

FillLookupTable(Boolean) Method


Syntax


Public Overloads Sub FillLookupTable( _


)

C#

public void FillLookupTable(


)

Parameters

forceFetch

Remarks



266


Requirements




See Also

Reference

C1ViewColumn Class


Overload List

ToString Method

Syntax



C#


Requirements




See Also

Reference

C1ViewColumn Class


Properties

For a list of all members of this type, see C1ViewColumn members.

Public Properties

267

Name Description

AutoFetchLookupTable Controls the autofetching behavior of this column foreign key

lookup DataTable.

CalculationExpression Defines an expression used to calculate a value returning for this

C1ViewColumn.

Caption Gets or sets the caption of this column.

ColumnName Gets the name of this C1ViewColumn.

ColumnStyle Represents Column Style definition - a set of properties that

affects column data representation in ComponentOne user

interface controls.

ConstraintExpression Defines a column level constraint.

DataColumn Gets the System.Data.DataColumn that this C1ViewColumn

represents in the C1DataView.

DataType Gets the type of data stored in the column.

DataView Gets the C1DataView that this column belongs to.

DefaultValue Gets or sets the default value for this column when creating new

row.

IsCalculated Gets a value indicating whether this C1ViewColumn is

calculated.

RaiseCalculateColumnEvents Gets or sets a value indicating whether

C1DataViewSet.CalculateColumn and


268

ReadOnly Gets or sets the value indicating wheather this column is read

only or modifiable.

Top

See Also

Reference

C1ViewColumn Class


AutoFetchLookupTable Property

Controls the autofetching behavior of this column foreign key lookup DataTable.

Syntax


Public Property AutoFetchLookupTable As AutoFetchModeEnum

C#

public AutoFetchModeEnum AutoFetchLookupTable {get; set;}

Remarks

This property has an effect only if the column represents a foreign key DataColumn and its


It allows to turn on (AutoFetchModeEnum.Yes) or off (AutoFetchModeEnum.No) automatic data

fetching for foreign key lookup table of this column. If AutoFetch is set to

AutoFetchModeEnum.Default (which is the default) then the effective value is determined by the

AutoFetch property value of an owning C1DataView.


Requirements




See Also

269

Reference

C1ViewColumn Class


CalculationExpression Property

Defines an expression used to calculate a value returning for this C1ViewColumn.

Syntax


Public ReadOnly Property CalculationExpression As C1ExpressionDef

C#

public C1ExpressionDef CalculationExpression {get;}

Remarks

See the Defining Column Value Calculations topic for more details.

Requirements




See Also

Reference

C1ViewColumn Class


Caption Property

Gets or sets the caption of this column.

Syntax


Public Property Caption As System.String

270

C#

public System.string Caption {get; set;}

Remarks

This property allows you to override the Caption property value of the underlying DataColumn. If

Caption property was explicitly set to value other then null or "", then this value is used as the

property value. If it's not the case then looks for DataColumn.Caption property value, and it it's

different from DataColumn.ColumnName then returns Caption of DataColumn. Otherwise, returns

the ColumnName property value of this C1ViewColumn object.

Requirements




See Also

Reference

C1ViewColumn Class


ColumnName Property

Gets the name of this C1ViewColumn.

Syntax


Public ReadOnly Property ColumnName As System.String

C#

public System.string ColumnName {get;}

Requirements




271

See Also

Reference

C1ViewColumn Class


ColumnStyle Property

Represents Column Style definition - a set of properties that affects column data representation in

ComponentOne user interface controls.

Syntax


Public ReadOnly Property ColumnStyle As ViewSetColumnStyle

C#

public ViewSetColumnStyle ColumnStyle {get;}

Remarks

See the Defining Column Styles topic for details.

Requirements




See Also

Reference

C1ViewColumn Class


ConstraintExpression Property

Defines a column level constraint.

Syntax

272


Public ReadOnly Property ConstraintExpression As ConstraintExpression

C#

public ConstraintExpression ConstraintExpression {get;}

Remarks

See the Row and Column Level Constraints topic for details.

Requirements




See Also

Reference

C1ViewColumn Class


DataColumn Property

Gets the System.Data.DataColumn that this C1ViewColumn represents in the C1DataView.

Syntax


Public ReadOnly Property DataColumn As System.Data.DataColumn

C#

public System.Data.DataColumn DataColumn {get;}

Requirements




273

See Also

Reference

C1ViewColumn Class


DataType Property

Gets the type of data stored in the column.

Syntax


Public ReadOnly Property DataType As System.Type

C#

public System.Type DataType {get;}

Requirements




See Also

Reference

C1ViewColumn Class


DataView Property

Gets the C1DataView that this column belongs to.

Syntax


Public ReadOnly Property DataView As C1DataView

C#

274

public C1DataView DataView {get;}

Requirements




See Also

Reference

C1ViewColumn Class


DefaultValue Property

Gets or sets the default value for this column when creating new row.

Syntax


Public Property DefaultValue As System.Object

C#

public System.object DefaultValue {get; set;}

Remarks

If this property is assigned to an empty value (null or empty string) then it returns the DefaultValue

property value of the underlying DataColumn; otherwise, returns an assigned value.

Requirements




See Also

Reference

275

C1ViewColumn Class


IsCalculated Property

Gets a value indicating whether this C1ViewColumn is calculated.

Syntax


Public ReadOnly Property IsCalculated As System.Boolean

C#

public System.bool IsCalculated {get;}

Remarks

A calculated column is a column that is defined via expression in the Definition property, as

opposite to columns that represents a certain System.DataColumn. See C1DataView Definitions

topic for details on calculated columns.

Requirements




See Also

Reference

C1ViewColumn Class


RaiseCalculateColumnEvents Property

Gets or sets a value indicating whether C1DataViewSet.CalculateColumn and


Syntax


Public Property RaiseCalculateColumnEvents As System.Boolean

276

C#

public System.bool RaiseCalculateColumnEvents {get; set;}

Requirements




See Also

Reference

C1ViewColumn Class


ReadOnly Property

Gets or sets the value indicating wheather this column is read only or modifiable.

Syntax


Public Property ReadOnly As System.Boolean

C#

public System.bool ReadOnly {get; set;}

Remarks

The default value of this property is determined as follows. If one of the following conditions are

satisfied then default value is true:

If the ReadOnly property value of the underlying DataColumn is true.

If the C1DataView.AllowEdit property value of the owning C1DataView is false.

If the C1.C1DataExtender.SchemaExtender.DataTableExtender.AllowEdit property value

is false for the C1.C1DataExtender.SchemaExtender.DataTableExtender that represents

the DataTable containing the underlying DataColumn for this C1ViewColumn.

You can change this property value (to true) only if its default value is false, changing of default true

to false is ignored.

277

Requirements




See Also

Reference

C1ViewColumn Class


C1ViewColumnCalculateEventArgs

Provides data for the C1ViewColumnCalculateEventHandler delegate.

Object Model

Syntax


Public Class C1ViewColumnCalculateEventArgs

Inherits System.EventArgs

C#

public class C1ViewColumnCalculateEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewColumnCalculateEventArgs

Requirements




278

See Also

Reference

C1ViewColumnCalculateEventArgs Members


Overview

Provides data for the C1ViewColumnCalculateEventHandler delegate.

Object Model

Syntax


Public Class C1ViewColumnCalculateEventArgs


C#

public class C1ViewColumnCalculateEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewColumnCalculateEventArgs

Requirements




See Also

Reference



279

Members

Properties

The following tables list the members exposed by C1ViewColumnCalculateEventArgs.

Public Properties

Name Description




Top

See Also

Reference

C1ViewColumnCalculateEventArgs Class


Properties

For a list of all members of this type, see C1ViewColumnCalculateEventArgs members.

Public Properties

Name Description




Top

See Also

Reference

280



Column Property

Gets the C1ViewColumn object for which a value is being calculated.

Syntax


Public ReadOnly Property Column As C1ViewColumn

C#

public C1ViewColumn Column {get;}

Requirements




See Also

Reference



Row Property

Gets the C1ViewRow in which the C1ViewColumn value is being calculated.

Syntax


Public ReadOnly Property Row As C1ViewRow

C#

public C1ViewRow Row {get;}

Requirements

281




See Also

Reference



Value Property

Gets or sets the calculated value of the column.

Syntax


Public Property Value As System.Object

C#

public System.object Value {get; set;}

Remarks

This property should be set to a value which becomes a final value of the column. See the Defining

Column Value Calculations topic for details.

Requirements




See Also

Reference



C1ViewColumnChangeEventArgs

Provides data for the C1ViewColumnChangeEventHandler delegate.

282

Object Model

Syntax


Public Class C1ViewColumnChangeEventArgs


C#

public class C1ViewColumnChangeEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewColumnChangeEventArgs

Requirements




See Also

Reference

C1ViewColumnChangeEventArgs Members


Overview

Provides data for the C1ViewColumnChangeEventHandler delegate.

Object Model

Syntax

283


Public Class C1ViewColumnChangeEventArgs


C#

public class C1ViewColumnChangeEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewColumnChangeEventArgs

Requirements




See Also

Reference



Members

Properties

The following tables list the members exposed by C1ViewColumnChangeEventArgs.

Public Properties

Name Description



changed.

284



Top

See Also

Reference

C1ViewColumnChangeEventArgs Class


Properties

For a list of all members of this type, see C1ViewColumnChangeEventArgs members.

Public Properties

Name Description



changed.



Top

See Also

Reference



Column Property

Gets the C1ViewColumn which value is being changed.

Syntax

285


Public ReadOnly Property Column As C1ViewColumn

C#

public C1ViewColumn Column {get;}

Requirements




See Also

Reference



NewValue Property

Gets or sets a new proposed value for the C1ViewColumn which is being changed.

Syntax


Public Property NewValue As System.Object

C#

public System.object NewValue {get; set;}

Remarks

If another value is assigned to this property in the C1DataViewSet.ColumnChanging event handler

then this value becomes a new value of a column.

Requirements




286

See Also

Reference



OldValue Property

Gets an old column value.

Syntax


Public ReadOnly Property OldValue As System.Object

C#

public System.object OldValue {get;}

Requirements




See Also

Reference



Row Property

Gets the C1ViewRow in which C1ViewColumn is being changed.

Syntax



C#

287


Requirements




See Also

Reference



C1ViewColumnCollection

Represents the collection of C1ViewColumn objects for the C1DataViewSet.

Object Model

Syntax


Public Class C1ViewColumnCollection

Inherits C1ViewColumnCollectionBase

C#

public class C1ViewColumnCollection : C1ViewColumnCollectionBase


System.Object


C1.C1DataExtender.C1ViewColumnCollectionBase

C1.C1DataExtender.C1ViewColumnCollection

Requirements

288




See Also

Reference

C1ViewColumnCollection Members


Overview

Represents the collection of C1ViewColumn objects for the C1DataViewSet.

Object Model

Syntax


Public Class C1ViewColumnCollection

Inherits C1ViewColumnCollectionBase

C#

public class C1ViewColumnCollection : C1ViewColumnCollectionBase


System.Object




Requirements




See Also

289

Reference

C1ViewColumnCollection Members


Members

Properties Methods

The following tables list the members exposed by C1ViewColumnCollection.

Public Properties

Name Description





Item Overloaded. Gets the C1ViewColumn object at the specified index. (Inherited

from C1.C1DataExtender.C1ViewColumnCollectionBase)



Top

Public Methods

Name Description






290



Top

See Also

Reference

C1ViewColumnCollection Class


C1ViewColumnCollectionBase

The base class of the collection of C1ViewColumn objects for the C1DataViewSet.

Object Model

Syntax


Public MustInherit Class C1ViewColumnCollectionBase


C#

public abstract class C1ViewColumnCollectionBase : ImmutableKeyedCollectionBase


System.Object




Requirements




291

See Also

Reference

C1ViewColumnCollectionBase Members


Overview

The base class of the collection of C1ViewColumn objects for the C1DataViewSet.

Object Model

Syntax


Public MustInherit Class C1ViewColumnCollectionBase


C#

public abstract class C1ViewColumnCollectionBase : ImmutableKeyedCollectionBase


System.Object




Requirements




See Also

Reference

292



Members

Properties Methods

The following tables list the members exposed by C1ViewColumnCollectionBase.

Public Properties

Name Description





Item Overloaded. Gets the C1ViewColumn object at the specified index.



Top

Public Methods

Name Description








293

Top

See Also

Reference

C1ViewColumnCollectionBase Class


Properties

For a list of all members of this type, see C1ViewColumnCollectionBase members.

Public Properties

Name Description





Item Overloaded. Gets the C1ViewColumn object at the specified index.



Top

See Also

Reference



Item Property

Gets the C1ViewColumn object at the specified index.

Overload List

294


Item(Int32) Gets the C1ViewColumn object at the specified index.

Item(String) Gets the C1ViewColumn object with the specified name.

Requirements




See Also

Reference




An index of C1ViewColumn.

Gets the C1ViewColumn object at the specified index.

Syntax




) As C1ViewColumn

C#

public C1ViewColumn Item(

System.int index

) {get;}

Parameters

index

An index of C1ViewColumn.

295

Property Value

A C1ViewColumn.

Requirements




See Also

Reference



Overload List


A name of C1ViewColumn.

Gets the C1ViewColumn object with the specified name.

Syntax



ByVal columnName As System.String _

) As C1ViewColumn

C#

public C1ViewColumn Item(

System.string columnName

) {get;}

Parameters

columnName

A name of C1ViewColumn.

Property Value

296

If C1ViewColumn object with the specified name is contained in the collection then returns

this column; otherwise, a null value.

Requirements




See Also

Reference



Overload List

C1ViewCurrentChangedEventArgs

Provides data for the C1ViewCurrentChangedEventHandler delegate.

Object Model

Syntax


Public Class C1ViewCurrentChangedEventArgs


C#

public class C1ViewCurrentChangedEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewCurrentChangedEventArgs

Requirements

297




See Also

Reference

C1ViewCurrentChangedEventArgs Members


Overview

Provides data for the C1ViewCurrentChangedEventHandler delegate.

Object Model

Syntax


Public Class C1ViewCurrentChangedEventArgs


C#

public class C1ViewCurrentChangedEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewCurrentChangedEventArgs

Requirements




See Also

298

Reference



Members

Properties

The following tables list the members exposed by C1ViewCurrentChangedEventArgs.

Public Properties

Name Description



Top

See Also

Reference

C1ViewCurrentChangedEventArgs Class


Properties

For a list of all members of this type, see C1ViewCurrentChangedEventArgs members.

Public Properties

Name Description



Top

See Also

Reference

299



Reason Property

Gets the reason why this event has been triggered.

Syntax


Public ReadOnly Property Reason As C1CurrentChangedReasonEnum

C#

public C1CurrentChangedReasonEnum Reason {get;}

Requirements




See Also

Reference



View Property

Gets the C1DataView that event occurred in.

Syntax


Public ReadOnly Property View As C1DataView

C#

public C1DataView View {get;}

Requirements

300




See Also

Reference



C1ViewFilterRowEventArgs

Provides data for the C1ViewFilterRowEventHandler delegate.

Object Model

Syntax


Public Class C1ViewFilterRowEventArgs


C#

public class C1ViewFilterRowEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewFilterRowEventArgs

Requirements




See Also

301

Reference

C1ViewFilterRowEventArgs Members


Overview

Provides data for the C1ViewFilterRowEventHandler delegate.

Object Model

Syntax


Public Class C1ViewFilterRowEventArgs


C#

public class C1ViewFilterRowEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewFilterRowEventArgs

Requirements




See Also

Reference



Members

Properties

302

The following tables list the members exposed by C1ViewFilterRowEventArgs.

Public Properties

Name Description



Top

See Also

Reference

C1ViewFilterRowEventArgs Class


Properties

For a list of all members of this type, see C1ViewFilterRowEventArgs members.

Public Properties

Name Description



Top

See Also

Reference



Accept Property

Allows to accept row (true) or filter it out (false).

303

Syntax


Public Property Accept As System.Boolean

C#

public System.bool Accept {get; set;}

Requirements




See Also

Reference



Row Property

Gets a row whose filter conditions are being checked.

Syntax



C#


Requirements




See Also

304

Reference



C1ViewListChangedEventArgs

Provides data for the C1ViewListChangedEventHandler delegate.

Object Model

Syntax


Public Class C1ViewListChangedEventArgs

Inherits System.ComponentModel.ListChangedEventArgs

C#

public class C1ViewListChangedEventArgs :

System.ComponentModel.ListChangedEventArgs

Remarks

A data provided by this class has the same meaning as in the base

System.ComponentModel.ListChangedEventArgs class. In addition it has the View property

referencing the C1DataView object in which event occurred.


System.Object

System.EventArgs


C1.C1DataExtender.C1ViewListChangedEventArgs

Requirements




305

See Also

Reference

C1ViewListChangedEventArgs Members


Overview

Provides data for the C1ViewListChangedEventHandler delegate.

Object Model

Syntax


Public Class C1ViewListChangedEventArgs

Inherits System.ComponentModel.ListChangedEventArgs

C#

public class C1ViewListChangedEventArgs :


Remarks

A data provided by this class has the same meaning as in the base

System.ComponentModel.ListChangedEventArgs class. In addition it has the View property

referencing the C1DataView object in which event occurred.


System.Object

System.EventArgs


C1.C1DataExtender.C1ViewListChangedEventArgs

Requirements

306




See Also

Reference



Members

Properties

The following tables list the members exposed by C1ViewListChangedEventArgs.

Public Properties

Name Description





View Gets the C1DataView in which event occurred.

Top

See Also

Reference

C1ViewListChangedEventArgs Class


Properties

For a list of all members of this type, see C1ViewListChangedEventArgs members.

Public Properties

307

Name Description





View Gets the C1DataView in which event occurred.

Top

See Also

Reference



View Property

Gets the C1DataView in which event occurred.

Syntax



C#


Requirements




See Also

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewListChangedEventArgs~ListChangedType.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewListChangedEventArgs~NewIndex.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewListChangedEventArgs~OldIndex.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewListChangedEventArgs~PropertyDescriptor.html

308

Reference



C1ViewModel

Provides an object model for View Definition Language.

Object Model

Syntax


Public Class C1ViewModel

C#

public class C1ViewModel

Remarks

The C1ViewModel an object model for View Definition Language. The latter is the SQL-like

language that is used to define the C1DataView structure in the Definition property. The

corresponding instance of the C1ViewModel class is accessible via the C1DataView.DefinitionModel

property. When the view definition in the Definition property is changed, the

C1DataView.DefinitionModel is changed automatically to be in sync with the view definition, and

vice versa, changes in C1DataView.DefinitionModel automatically updates the Definition property

value.


System.Object

C1.C1DataExtender.C1ViewModel

Requirements




309

See Also

Reference

C1ViewModel Members


Overview

Provides an object model for View Definition Language.

Object Model

Syntax


Public Class C1ViewModel

C#

public class C1ViewModel

Remarks

The C1ViewModel an object model for View Definition Language. The latter is the SQL-like

language that is used to define the C1DataView structure in the Definition property. The

corresponding instance of the C1ViewModel class is accessible via the C1DataView.DefinitionModel

property. When the view definition in the Definition property is changed, the

C1DataView.DefinitionModel is changed automatically to be in sync with the view definition, and

vice versa, changes in C1DataView.DefinitionModel automatically updates the Definition property

value.


System.Object

C1.C1DataExtender.C1ViewModel

Requirements

310




See Also

Reference

C1ViewModel Members


Members

Properties Methods

The following tables list the members exposed by C1ViewModel.

Public Properties

Name Description

ColumnsDefined Represents a collection of ViewModelColumn objects defining the list of

view columns. Each ViewModelColumn can define both the specific column

(the ColumnName property is defined) and all the columns of ViewNode (the

ColumnName property is empty). If this collection is empty this means that

all columns of all ViewNode objects should be included in the column list. To

get actual list of columns begotten by this definition use the

ColumnsEffective collection.

ColumnsEffective The read-only collection of ViewModelColumn objects representing the

actual list of view columns begotten from definition specified in the

ColumnsDefined collection. Each item in this collection represents a single

specific column, and all the properties of ViewModelColumn objects are not

empty. This collection is empty if view model is inconsistent.

FilterCondition Gets or sets the filter expression defined in the WHERE clause of View

Definition Language.

RootNode Gets or sets a root node of the C1ViewModel.

Top

311

Public Methods

Name Description

BeginUpdate Starts a batch update cycle during which multiple changes can be made in

the view without recreating an owner C1DataView's rowset. The update cycle

must be finished with the EndUpdate method call.

EndUpdate Finishes an update cycle started by the BeginUpdate method call.

Top

See Also

Reference

C1ViewModel Class


Methods

>

Name Description

BeginUpdate

Starts a batch update cycle during which multiple changes can be made in

the view without recreating an owner C1DataView's rowset. The update cycle

must be finished with the EndUpdate method call.

EndUpdate Finishes an update cycle started by the BeginUpdate method call.

Top

See Also

Reference

C1ViewModel Class


BeginUpdate Method

Starts a batch update cycle during which multiple changes can be made in the view without

recreating an owner C1DataView's rowset. The update cycle must be finished with the EndUpdate

method call.

312

Syntax


Public Sub BeginUpdate()

C#

public void BeginUpdate()

Requirements




See Also

Reference

C1ViewModel Class

C1ViewModel Members

EndUpdate Method

Finishes an update cycle started by the BeginUpdate method call.

Syntax


Public Sub EndUpdate()

C#

public void EndUpdate()

Requirements




See Also

313

Reference

C1ViewModel Class

C1ViewModel Members

Properties

For a list of all members of this type, see C1ViewModel members.

Public Properties

Name Description

ColumnsDefined Represents a collection of ViewModelColumn objects defining the list of

view columns. Each ViewModelColumn can define both the specific column

(the ColumnName property is defined) and all the columns of ViewNode (the

ColumnName property is empty). If this collection is empty this means that

all columns of all ViewNode objects should be included in the column list. To

get actual list of columns begotten by this definition use the

ColumnsEffective collection.

ColumnsEffective The read-only collection of ViewModelColumn objects representing the

actual list of view columns begotten from definition specified in the

ColumnsDefined collection. Each item in this collection represents a single

specific column, and all the properties of ViewModelColumn objects are not


FilterCondition Gets or sets the filter expression defined in the WHERE clause of View

Definition Language.

RootNode Gets or sets a root node of the C1ViewModel.

Top

See Also

Reference

C1ViewModel Class


314

ColumnsDefined Property

Represents a collection of ViewModelColumn objects defining the list of view columns. Each

ViewModelColumn can define both the specific column (the ColumnName property is defined) and

all the columns of ViewNode (the ColumnName property is empty). If this collection is empty this

means that all columns of all ViewNode objects should be included in the column list. To get actual

list of columns begotten by this definition use the ColumnsEffective collection.

Syntax


Public ReadOnly Property ColumnsDefined As ViewModelColumnDefinitionCollection

C#

public ViewModelColumnDefinitionCollection ColumnsDefined {get;}

Requirements




See Also

Reference

C1ViewModel Class

C1ViewModel Members

ColumnsEffective Property

The read-only collection of ViewModelColumn objects representing the actual list of view columns

begotten from definition specified in the ColumnsDefined collection. Each item in this collection

represents a single specific column, and all the properties of ViewModelColumn objects are not


Syntax


Public ReadOnly Property ColumnsEffective As ViewModelColumnEffectiveCollection

C#

315

public ViewModelColumnEffectiveCollection ColumnsEffective {get;}

Requirements




See Also

Reference

C1ViewModel Class

C1ViewModel Members

FilterCondition Property

Gets or sets the filter expression defined in the WHERE clause of View Definition Language.

Syntax


Public Property FilterCondition As System.String

C#

public System.string FilterCondition {get; set;}

Requirements




See Also

Reference

C1ViewModel Class

C1ViewModel Members

RootNode Property

Gets or sets a root node of the C1ViewModel.

Syntax

316


Public Property RootNode As ViewNode

C#

public ViewNode RootNode {get; set;}

Requirements




See Also

Reference

C1ViewModel Class

C1ViewModel Members

C1ViewPositionChangedEventArgs

Provides data for the C1ViewPositionChangedEventHandler delegate.

Object Model

Syntax


Public Class C1ViewPositionChangedEventArgs


C#

public class C1ViewPositionChangedEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewPositionChangedEventArgs

317

Requirements




See Also

Reference

C1ViewPositionChangedEventArgs Members


Overview

Provides data for the C1ViewPositionChangedEventHandler delegate.

Object Model

Syntax


Public Class C1ViewPositionChangedEventArgs


C#

public class C1ViewPositionChangedEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewPositionChangedEventArgs

Requirements




318

See Also

Reference



Members

Properties

The following tables list the members exposed by C1ViewPositionChangedEventArgs.

Public Properties

Name Description


Top

See Also

Reference

C1ViewPositionChangedEventArgs Class


Properties

>

Name Description


Top

See Also

Reference



View Property

Gets the C1DataView object in which position has been changed.

319

Syntax



C#


Requirements




See Also

Reference



C1ViewRelation

Represents a master-detail relationship between two C1DataView objects in the C1DataViewSet.

Object Model

Syntax


Public Class C1ViewRelation

C#

public class C1ViewRelation

Remarks

To define a relationship between two C1DataView objects of the C1DataViewSet you should create

an instance of C1ViewRelation, add it to the C1DataViewSet.Relations collection and specify parent

320

and child (master and detail in other words) C1DataView objects connecting by this C1ViewRelation

via the ParentView and ChildView properties.

In some cases you should additionally define the DataSetRelation (or DataSetRelationName as an

alternative), ParentTableAlias and ChildTableAlias properties, see the C1DataView Relations topic for

details.


System.Object

C1.C1DataExtender.C1ViewRelation

Requirements




See Also

Reference

C1ViewRelation Members


Overview

Represents a master-detail relationship between two C1DataView objects in the C1DataViewSet.

Object Model

Syntax


Public Class C1ViewRelation

C#

public class C1ViewRelation

Remarks

321

To define a relationship between two C1DataView objects of the C1DataViewSet you should create

an instance of C1ViewRelation, add it to the C1DataViewSet.Relations collection and specify parent

and child (master and detail in other words) C1DataView objects connecting by this C1ViewRelation

via the ParentView and ChildView properties.

In some cases you should additionally define the DataSetRelation (or DataSetRelationName as an

alternative), ParentTableAlias and ChildTableAlias properties, see the C1DataView Relations topic for

details.


System.Object

C1.C1DataExtender.C1ViewRelation

Requirements




See Also

Reference



Members

Properties

The following tables list the members exposed by C1ViewRelation.

Public Constructors

Name Description

C1ViewRelation Constructor Overloaded.

Top

Public Properties

Name Description

322

ChildColumns Gets an array of C1ViewColumn objects from the ChildView which are

the child columns of this relation.

ChildTableAlias Gets or sets the alias of child DataTable.

ChildView Gets or sets the child (detail) C1DataView of the relation.

DataSetRelation Gets or sets the base DataRelation.

DataSetRelationName Gets or sets the base DataRelation by its name.

IsActive Indicates whether relation is active, that is actually establish the

relationship between C1DataView objects.

ParentColumns Gets an array of C1ViewColumn objects from the ParentView which are

the parent columns of this relation.

ParentTableAlias Gets or sets the alias of parent DataTable.

ParentView Gets or sets the parent (master) C1DataView of the relation.

Top

See Also

Reference

C1ViewRelation Class


C1ViewRelation Constructor

Overload List


C1ViewRelation Constructor(C1DataView,C1DataView,String,String,String) Initializes a new

instance of the

323

C1ViewRelation.

C1ViewRelation Constructor(C1DataView,C1DataView,DataRelation,String,String) Initializes a new

instance of the

C1ViewRelation.

C1ViewRelation Constructor() Initializes a new

instance of the

C1ViewRelation.

C1ViewRelation Constructor(C1DataView,C1DataView) Initializes a new

instance of the

C1ViewRelation.

C1ViewRelation Constructor(C1DataView,C1DataView,DataRelation) Initializes a new

instance of the

C1ViewRelation.

C1ViewRelation Constructor(C1DataView,C1DataView,String) Initializes a new

instance of the

C1ViewRelation.

Requirements




See Also

Reference



C1ViewRelation Constructor(C1DataView,C1DataView,String,String,String)

Initializes a new instance of the C1ViewRelation.

Syntax

324



ByVal parentView As C1DataView, _

ByVal childView As C1DataView, _

ByVal dataSetRelationName As System.String, _

ByVal parentTableAlias As System.String, _

ByVal childTableAlias As System.String _

)

C#

public C1ViewRelation(

C1DataView parentView,

C1DataView childView,

System.string dataSetRelationName,

System.string parentTableAlias,

System.string childTableAlias

)

Parameters

parentView

childView

dataSetRelationName

parentTableAlias

childTableAlias

Remarks

After the C1ViewRelation has been created you should at least add it to

the C1DataViewSet.Relations collection and specify parent and child

C1DataView objects connecting by this C1ViewRelation via the

ParentView and ChildView properties, until that relationship will not be

activated.

See the C1DataView Relations topic for details on the C1ViewRelation

definition.

Requirements

325

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP

SP3, Windows Server 2008 (Server Core not supported), Windows Server

2008 R2 (Server Core supported with SP1 or later), Windows Server 2003

SP2

See Also

Reference



Overload List

C1ViewRelation Constructor(C1DataView,C1DataView,DataRelation,String,String)

The parent C1DataView.

The child C1DataView.

The System.Data.DataRelation object that this C1ViewRelation is based on. If null is passed as the

parameter value then base DataRelation is detected automatically.

The alias of the base DataTable which identify parent rows of relation.

The alias of the base DataTable which identify child rows of relation.


Syntax





ByVal dataSetRelation As System.Data.DataRelation, _

ByVal parentTableAlias As System.String, _


)

C#




326

System.Data.DataRelation dataSetRelation,

System.string parentTableAlias,


)

Parameters

parentView


childView


dataSetRelation

The System.Data.DataRelation object that this C1ViewRelation is based on. If null is passed

as the parameter value then base DataRelation is detected automatically.

parentTableAlias

The alias of the base DataTable which identify parent rows of relation.

childTableAlias

The alias of the base DataTable which identify child rows of relation.

Remarks

After the C1ViewRelation has been created you should add it to the

C1DataViewSet.Relations collection, until that relationship will not be

activated.

See the C1DataView Relations topic for details on the C1ViewRelation

definition.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP

SP3, Windows Server 2008 (Server Core not supported), Windows Server

2008 R2 (Server Core supported with SP1 or later), Windows Server 2003

SP2

See Also

Reference

327



Overload List

C1ViewRelation Constructor()


Syntax



C#

public C1ViewRelation()

Remarks

After the C1ViewRelation has been created you should at least add it to the

C1DataViewSet.Relations collection and specify parent and child C1DataView objects connecting by

this C1ViewRelation via the ParentView and ChildView properties, until that relationship will not be

activated.

See the C1DataView Relations topic for details on the C1ViewRelation definition.

Requirements




See Also

Reference



Overload List

C1ViewRelation Constructor(C1DataView,C1DataView)



328


Syntax




ByVal childView As C1DataView _

)

C#



C1DataView childView

)

Parameters

parentView


childView


Remarks


C1DataViewSet.Relations collection, until that relationship will not be activated.


Requirements




See Also

Reference

329



Overload List

C1ViewRelation Constructor(C1DataView,C1DataView,DataRelation)



The System.Data.DataRelation object that this C1ViewRelation is based on. If null is passed as the

parameter value then base DataRelation is detected automatically.


Syntax





ByVal dataSetRelation As System.Data.DataRelation _

)

C#




System.Data.DataRelation dataSetRelation

)

Parameters

parentView


childView


dataSetRelation

The System.Data.DataRelation object that this C1ViewRelation is based on. If null is passed

as the parameter value then base DataRelation is detected automatically.

330

Remarks




Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3,

Windows Server 2008 (Server Core not supported), Windows Server 2008 R2

(Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference



Overload List

C1ViewRelation Constructor(C1DataView,C1DataView,String)



The name of System.Data.DataRelation object that this C1ViewRelation is based on. If null or empty

string is passed as the parameter value then base DataRelation is detected automatically.


Syntax





ByVal dataSetRelationName As System.String _

)

C#


331



System.string dataSetRelationName

)

Parameters

parentView


childView


dataSetRelationName

The name of System.Data.DataRelation object that this C1ViewRelation is based on. If null

or empty string is passed as the parameter value then base DataRelation is detected

automatically.

Remarks




Requirements




See Also

Reference



Overload List

Properties

For a list of all members of this type, see C1ViewRelation members.

Public Properties

332

Name Description

ChildColumns Gets an array of C1ViewColumn objects from the ChildView which are

the child columns of this relation.

ChildTableAlias Gets or sets the alias of child DataTable.

ChildView Gets or sets the child (detail) C1DataView of the relation.

DataSetRelation Gets or sets the base DataRelation.

DataSetRelationName Gets or sets the base DataRelation by its name.

IsActive Indicates whether relation is active, that is actually establish the

relationship between C1DataView objects.

ParentColumns Gets an array of C1ViewColumn objects from the ParentView which are

the parent columns of this relation.

ParentTableAlias Gets or sets the alias of parent DataTable.

ParentView Gets or sets the parent (master) C1DataView of the relation.

Top

See Also

Reference



ChildColumns Property

Gets an array of C1ViewColumn objects from the ChildView which are the child columns of this

relation.

Syntax

333


Public ReadOnly Property ChildColumns As C1ViewColumn()

C#

public C1ViewColumn[] ChildColumns {get;}

Requirements




See Also

Reference



ChildTableAlias Property

Gets or sets the alias of child DataTable.

Syntax


Public Property ChildTableAlias As System.String

C#

public System.string ChildTableAlias {get; set;}

Remarks


If you set this property value to a null or empty string value then a child table alias will be detected

automatically.

Requirements

334




See Also

Reference



ChildView Property

Gets or sets the child (detail) C1DataView of the relation.

Syntax


Public Property ChildView As C1DataView

C#

public C1DataView ChildView {get; set;}

Remarks


Requirements




See Also

Reference



DataSetRelation Property

Gets or sets the base DataRelation.

335

Syntax


Public Property DataSetRelation As System.Data.DataRelation

C#

public System.Data.DataRelation DataSetRelation {get; set;}

Remarks


The DataSetRelation and DataSetRelationName are interchangeable; you can define base

DataRelation directly or by its name, and in any case the other property will get an appropriate

value.

If you set this property value to null then a base DataRelation will be detected automatically.

Requirements




See Also

Reference



DataSetRelationName Property

Gets or sets the base DataRelation by its name.

Syntax


Public Property DataSetRelationName As System.String

C#

336

public System.string DataSetRelationName {get; set;}

Remarks


The DataSetRelation and DataSetRelationName are interchangeable; you can define base

DataRelation directly or by its name, and in any case the other property will get an appropriate

value.

If you set this property value to a null or empty string value then a base DataRelation will be

detected automatically.

Requirements




See Also

Reference



IsActive Property

Indicates whether relation is active, that is actually establish the relationship between C1DataView

objects.

Syntax


Public ReadOnly Property IsActive As System.Boolean

C#

public System.bool IsActive {get;}

Remarks

C1ViewRelation is active if all of the following conditions are satisfied:

C1ViewRelation is added to the C1DataViewSet.Relations collection.

337

Its ParentView and ChildView properties reference active C1DataView objects (i.e. which

C1DataView.IsActive is true) belonging to the same C1DataViewSet.

The System.Data.DataRelation property references the DataRelation that actually

connects DataTable objects, one the base for the ParentView and other the base for the

ChildView.




See Also

Reference



ParentColumns Property

Gets an array of C1ViewColumn objects from the ParentView which are the parent columns of this

relation.

Syntax


Public ReadOnly Property ParentColumns As C1ViewColumn()

C#

public C1ViewColumn[] ParentColumns {get;}

Requirements




See Also

Reference



338

ParentTableAlias Property

Gets or sets the alias of parent DataTable.

Syntax


Public Property ParentTableAlias As System.String

C#

public System.string ParentTableAlias {get; set;}

Remarks

See C1DataView Relations topic for details on C1ViewRelation definition.

If you set this property value to a null or empty string value then a parent table alias will be

detected automatically.

Requirements




See Also

Reference



ParentView Property

Gets or sets the parent (master) C1DataView of the relation.

Syntax


Public Property ParentView As C1DataView

C#

339

public C1DataView ParentView {get; set;}

Remarks


Requirements




See Also

Reference



C1ViewRelationCollection

Represents a collection of C1ViewRelation objects contained in the C1DataViewSet.

Object Model

Syntax


Public Class C1ViewRelationCollection


C#

public class C1ViewRelationCollection : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.C1ViewRelationCollection

340

Requirements




See Also

Reference

C1ViewRelationCollection Members


Overview

Represents a collection of C1ViewRelation objects contained in the C1DataViewSet.

Object Model

Syntax


Public Class C1ViewRelationCollection


C#

public class C1ViewRelationCollection : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.C1ViewRelationCollection

Requirements




341

See Also

Reference



Members

Properties Methods

The following tables list the members exposed by C1ViewRelationCollection.

Public Properties

Name Description



Item Overloaded. Gets the C1ViewRelation at the specified index.

Top

Public Methods

Name Description

Add Adds the specified C1ViewRelation to the collection.


Contains Indicates whether the specified C1ViewRelation is contained in the

collection.


IndexOf

342

Remove Removes the specified C1ViewRelation from the collection.


Top

See Also

Reference

C1ViewRelationCollection Class


Methods

For a list of all members of this type, see C1ViewRelationCollection members.

Public Methods

Name Description

Add Adds the specified C1ViewRelation to the collection.


Contains Indicates whether the specified C1ViewRelation is contained in the

collection.


IndexOf

Remove Removes the specified C1ViewRelation from the collection.


Top

See Also

Reference

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewRelationCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewRelationCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewRelationCollection~RemoveAt.html

343



Add Method

The C1ViewRelation to add.

Adds the specified C1ViewRelation to the collection.

Syntax



ByVal viewRelation As C1ViewRelation _

) As System.Integer

C#


C1ViewRelation viewRelation

)

Parameters

viewRelation

The C1ViewRelation to add.

Return Value

An index of newly added C1ViewRelation in the collection.

Requirements




See Also

Reference



344

Contains Method

The C1ViewRelation to find.

Indicates whether the specified C1ViewRelation is contained in the collection.

Syntax




) As System.Boolean

C#



)

Parameters

viewRelation

The C1ViewRelation to find.

Return Value

true if the collection contains the specified C1ViewRelation; otherwise, false.

Requirements




See Also

Reference



IndexOf Method

Syntax

345


Public Function IndexOf( _


) As System.Integer

C#

public System.int IndexOf(


)

Parameters

viewRelation

Requirements




See Also

Reference



Remove Method

The C1ViewRelation to remove.

Removes the specified C1ViewRelation from the collection.

Syntax




)

C#

346

public void Remove(


)

Parameters

viewRelation

The C1ViewRelation to remove.

Requirements




See Also

Reference



Properties

For a list of all members of this type, see C1ViewRelationCollection members.

Public Properties

Name Description



Item Overloaded. Gets the C1ViewRelation at the specified index.

Top

See Also

Reference



C1.C1DataExtender.2~C1.C1DataExtender.C1ViewRelationCollection~Capacity.html

C1.C1DataExtender.2~C1.C1DataExtender.C1ViewRelationCollection~Count.html

347

Item Property

Gets the C1ViewRelation at the specified index.

Overload List


Item(Int32) Gets the C1ViewRelation at the specified index.

Item(C1DataView,C1DataView)

Requirements




See Also

Reference




An index.

Gets the C1ViewRelation at the specified index.

Syntax




) As C1ViewRelation

C#

public C1ViewRelation Item(

System.int index

) {get;}

348

Parameters

index

An index.

Property Value

A C1ViewRelation object.

Requirements




See Also

Reference



Overload List

Item(C1DataView,C1DataView) Property

Syntax




ByVal childView As C1DataView _

) As C1ViewRelation

C#

public C1ViewRelation Item(


C1DataView childView

) {get;}

Parameters

parentView

349

childView

Requirements




See Also

Reference



Overload List

C1ViewRow

Represents a row of C1DataView.

Object Model

Syntax


Public Class C1ViewRow


C#

public class C1ViewRow : IRowAccessor


System.Object



Requirements

350




See Also

Reference

C1ViewRow Members


Overview

Represents a row of C1DataView.

Object Model

Syntax


Public Class C1ViewRow


C#

public class C1ViewRow : IRowAccessor


System.Object



Requirements




See Also

351

Reference

C1ViewRow Members


Members

Properties Methods

The following tables list the members exposed by C1ViewRow.

Public Properties

Name Description


C1ViewRow.


this row.

ItemArray Gets or sets the column values of this row through an array.

PrimaryKeyValue Returns an array of values representing a primary key of the row.

SortKeyValue Returns an array of values representing a sort key of the row.

View Gets the C1DataView that this row belongs to.

Top

Public Methods

Name Description

BeginEdit Starts an editing of the row.

CancelEdit Cancels current row editing.

Delete Deletes this row.

352

EndEdit Finishes current row editing.


C1ViewRelation.

GetParentRow Gets a parent C1ViewRow for this row.

GetParentRows Gets an array of parent rows of this C1ViewRow.


contains a null value.

Top

See Also

Reference

C1ViewRow Class


Methods

For a list of all members of this type, see C1ViewRow members.

Public Methods

Name Description

BeginEdit Starts an editing of the row.

CancelEdit Cancels current row editing.

Delete Deletes this row.

EndEdit Finishes current row editing.


C1ViewRelation.

353

GetParentRow Gets a parent C1ViewRow for this row.

GetParentRows Gets an array of parent rows of this C1ViewRow.



Top

See Also

Reference

C1ViewRow Class


BeginEdit Method

Starts an editing of the row.

Syntax


Public Sub BeginEdit()

C#

public void BeginEdit()

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

354

CancelEdit Method

Cancels current row editing.

Syntax


Public Sub CancelEdit()

C#

public void CancelEdit()

Remarks

If this method is called after the call of the BeginEdit method, all the changes made to the row after

BeginEdit call are discarded.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Delete Method

Deletes this row.

Syntax


Public Sub Delete()

C#

public void Delete()

355

Remarks

See the Composite View Definition topic for details on view row deletion.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

EndEdit Method

Finishes current row editing.

Syntax


Public Sub EndEdit()

C#

public void EndEdit()

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

356

GetChildRows Method

Gets the child rows of this C1ViewRow using the specified C1ViewRelation.

Overload List


GetChildRows(C1ViewRelation) Gets the child rows of this C1ViewRow using the specified

C1ViewRelation.

GetChildRows() Gets the child rows of this C1ViewRow using the first meat child

C1ViewRelation

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

GetChildRows(C1ViewRelation) Method

The C1ViewRelation to use.

Gets the child rows of this C1ViewRow using the specified C1ViewRelation.

Syntax


Public Overloads Function GetChildRows( _

ByVal relation As C1ViewRelation _

) As C1ViewRow()

C#

public C1ViewRow[] GetChildRows(

357

C1ViewRelation relation

)

Parameters

relation

The C1ViewRelation to use.

Return Value

An array of child C1ViewRow objects.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Overload List

GetChildRows() Method

Gets the child rows of this C1ViewRow using the first meat child C1ViewRelation

Syntax


Public Overloads Function GetChildRows() As C1ViewRow()

C#

public C1ViewRow[] GetChildRows()

Return Value

An array of child C1ViewRow objects.

Remarks

358

This method is useful when owning C1DataView has a single child C1ViewRelation.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Overload List

GetParentRow Method

Gets a parent C1ViewRow for this row.

Syntax


Public Function GetParentRow() As C1ViewRow

C#

public C1ViewRow GetParentRow()

Return Value

A parent C1ViewRow or a null value if there is no such a row.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

359

GetParentRows Method

Gets an array of parent rows of this C1ViewRow.

Syntax


Public Function GetParentRows() As C1ViewRow()

C#

public C1ViewRow[] GetParentRows()

Return Value

An array of parent rows.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

IsNull Method

Gets a value that indicates whether the specified C1ViewColumn contains a null value.

Overload List


IsNull(C1ViewColumn) Gets a value that indicates whether the specified C1ViewColumn contains a

null value.

IsNull(Int32) Gets a value that indicates whether the column at the specified index


360

IsNull(String) Gets a value that indicates whether the column with the specified name


Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

IsNull(C1ViewColumn) Method

A C1ViewColumn.

Gets a value that indicates whether the specified C1ViewColumn contains a null value.

Syntax


Public Overloads Function IsNull( _

ByVal column As C1ViewColumn _

) As System.Boolean

C#

public System.bool IsNull(

C1ViewColumn column

)

Parameters

column

A C1ViewColumn.

Return Value

true if the column contains a null value; otherwise, false.

361

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Overload List

IsNull(Int32) Method

The zero-based index of the column.

Gets a value that indicates whether the column at the specified index contains a null value.

Syntax



ByVal columnIndex As System.Integer _

) As System.Boolean

C#


System.int columnIndex

)

Parameters

columnIndex

The zero-based index of the column.

Return Value


Requirements

362




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Overload List

IsNull(String) Method

The name of the column.

Gets a value that indicates whether the column with the specified name contains a null value.

Syntax




) As System.Boolean

C#



)

Parameters

columnName

The name of the column.

Return Value


Requirements

363




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Overload List

Properties

For a list of all members of this type, see C1ViewRow members.

Public Properties

Name Description


C1ViewRow.


this row.

ItemArray Gets or sets the column values of this row through an array.

PrimaryKeyValue Returns an array of values representing a primary key of the row.

SortKeyValue Returns an array of values representing a sort key of the row.

View Gets the C1DataView that this row belongs to.

Top

See Also

Reference

C1ViewRow Class


364

BaseRows Property

Gets the collection of System.Data.DataRow objects referenced in this C1ViewRow.

Syntax


Public ReadOnly Property BaseRows As BaseRowCollection

C#

public BaseRowCollection BaseRows {get;}

Remarks

The order of DataRow objects in this collection corresponds to the order of DataTable objects in the

BaseTables collection. If there is no base DataRow for the certain DataTable then corresponding

collection item contains null. See the Composite View Definition topic for details on view rows.

The base DataRow also can be retrieved using an alias of base table.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Item Property

Gets or sets the value stored in the specified C1ViewColumn of this row.

Overload List


Item(C1ViewColumn) Gets or sets the value stored in the specified C1ViewColumn of this row.

365

Item(Int32) Gets or sets the value stored in the column with the specified index.

Item(String) Gets or sets the value stored in the column with the specified name.

Remarks

If row is not in the editing state when column value is being assigned, that is the BeginEdit method

was not called for this row, then BeginEdit method is called automatically, column value is assigned,

after that the EndEdit method is called.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Item(C1ViewColumn) Property

The C1ViewColumn that stores the value.

Gets or sets the value stored in the specified C1ViewColumn of this row.

Syntax



ByVal column As C1ViewColumn _

) As System.Object

C#

public System.object Item(

C1ViewColumn column

) {get; set;}

Parameters

366

column

The C1ViewColumn that stores the value.

Property Value

The column value.

Remarks

If row is not in the editing state when column value is being assigned, that is the BeginEdit

method was not called for this row, then BeginEdit method is called automatically, column

value is assigned, after that the EndEdit method is called.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Overload List


The index of the C1ViewColumn that stores the value.

Gets or sets the value stored in the column with the specified index.

Syntax



ByVal columnIndex As System.Integer _

) As System.Object

C#


367

System.int columnIndex

) {get; set;}

Parameters

columnIndex

The index of the C1ViewColumn that stores the value.

Property Value

The column value.

Remarks




Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Overload List


The name of the C1ViewColumn that stores the value.

Gets or sets the value stored in the column with the specified name.

Syntax




) As System.Object

368

C#



) {get; set;}

Parameters

columnName

The name of the C1ViewColumn that stores the value.

Property Value

The column value.

Remarks




Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

Overload List

ItemArray Property

Gets or sets the column values of this row through an array.

Syntax


Public Property ItemArray As System.Object()

369

C#

public System.object[] ItemArray {get; set;}

Remarks

The order of elements in the assigning or returning array coresponds to the order of

C1ViewColumn objects in the C1DataView.Columns collection of the owning C1DataView.

When this property value is set, a null value in the assigning array means that value is not specified

(setting a value to the corresponding column is skipped). You should specify a System.DbNull value

instead of a null value to set a column to null. In the same manner read only columns are skipped

as well.

A number of items in the assigning array can be less than a number of columns in the owning

C1DataView, in this case the values of the rest of columns not covered by array values are not

changed.

If row is not in the editing state when column value is being assigned, that is the BeginEdit method

was not called for this row, then BeginEdit method is called automatically, column values are

assigned, after that the EndEdit method is called. If row is in the editing state before an assignment

then it stays in the same state after it.

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

PrimaryKeyValue Property

Returns an array of values representing a primary key of the row.

Syntax


Public ReadOnly Property PrimaryKeyValue As System.Object()

370

C#

public System.object[] PrimaryKeyValue {get;}

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

SortKeyValue Property

Returns an array of values representing a sort key of the row.

Syntax


Public ReadOnly Property SortKeyValue As System.Object()

C#

public System.object[] SortKeyValue {get;}

Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

View Property

Gets the C1DataView that this row belongs to.

371

Syntax



C#


Requirements




See Also

Reference

C1ViewRow Class

C1ViewRow Members

C1ViewRowAddNewEventArgs

Provides data for the C1ViewRowAddNewEventHandler delegate.

Object Model

Syntax


Public Class C1ViewRowAddNewEventArgs


C#

public class C1ViewRowAddNewEventArgs : System.EventArgs


372

System.Object

System.EventArgs

C1.C1DataExtender.C1ViewRowAddNewEventArgs

Requirements




See Also

Reference

C1ViewRowAddNewEventArgs Members


Overview

Provides data for the C1ViewRowAddNewEventHandler delegate.

Object Model

Syntax


Public Class C1ViewRowAddNewEventArgs


C#

public class C1ViewRowAddNewEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewRowAddNewEventArgs

Requirements

373




See Also

Reference



Members

Properties

The following tables list the members exposed by C1ViewRowAddNewEventArgs.

Public Properties

Name Description


Top

See Also

Reference

C1ViewRowAddNewEventArgs Class


Properties

For a list of all members of this type, see C1ViewRowAddNewEventArgs members.

Public Properties

Name Description


Top

See Also

374

Reference



Row Property

Gets the C1ViewRow that is being added.

Syntax



C#


Requirements




See Also

Reference



C1ViewRowChangeEventArgs

Provides data for the C1ViewRowChangeEventHandler delegate.

Object Model

Syntax


Public Class C1ViewRowChangeEventArgs

375


C#

public class C1ViewRowChangeEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.C1ViewRowChangeEventArgs

Requirements




See Also

Reference

C1ViewRowChangeEventArgs Members


Overview

Provides data for the C1ViewRowChangeEventHandler delegate.

Object Model

Syntax


Public Class C1ViewRowChangeEventArgs


C#

public class C1ViewRowChangeEventArgs : System.EventArgs


376

System.Object

System.EventArgs

C1.C1DataExtender.C1ViewRowChangeEventArgs

Requirements




See Also

Reference



Members

Properties

The following tables list the members exposed by C1ViewRowChangeEventArgs.

Public Properties

Name Description



Top

See Also

Reference

C1ViewRowChangeEventArgs Class


Properties

For a list of all members of this type, see C1ViewRowChangeEventArgs members.

Public Properties

377

Name Description



Top

See Also

Reference



Action Property

Gets the type of change occurred on the C1ViewRow.

Syntax


Public ReadOnly Property Action As C1ViewRowActionEnum

C#

public C1ViewRowActionEnum Action {get;}

Requirements




See Also

Reference



Row Property

Gets the C1ViewRow that is being changed.

378

Syntax



C#


Requirements




See Also

Reference



C1ViewSchemaTableCollection

Represents the collection of C1.C1DataExtender.SchemaExtender.DataTableExtender objects

corresponding to base DataTable objects.

Object Model

Syntax


Public Class C1ViewSchemaTableCollection


C#

public class C1ViewSchemaTableCollection : ImmutableKeyedCollectionBase


379

System.Object


C1.C1DataExtender.C1ViewSchemaTableCollection

Requirements




See Also

Reference

C1ViewSchemaTableCollection Members


Overview

Represents the collection of C1.C1DataExtender.SchemaExtender.DataTableExtender objects

corresponding to base DataTable objects.

Object Model

Syntax


Public Class C1ViewSchemaTableCollection


C#

public class C1ViewSchemaTableCollection : ImmutableKeyedCollectionBase


System.Object



Requirements

380




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by C1ViewSchemaTableCollection.

Public Properties

Name Description





Item Overloaded. Gets the

C1.C1DataExtender.SchemaExtender.DataTableExtender object at the

specified index.



Top

Public Methods

Name Description


381







Top

See Also

Reference

C1ViewSchemaTableCollection Class


Properties

For a list of all members of this type, see C1ViewSchemaTableCollection members.

Public Properties

Name Description





Item Overloaded. Gets the

C1.C1DataExtender.SchemaExtender.DataTableExtender object at the

specified index.



Top

382

See Also

Reference



Item Property

Gets the C1.C1DataExtender.SchemaExtender.DataTableExtender object at the specified index.

Overload List


Item(Int32) Gets the C1.C1DataExtender.SchemaExtender.DataTableExtender object at

the specified index.

Item(String) Gets the C1.C1DataExtender.SchemaExtender.DataTableExtender object

corresponding to the table with the specified alias.

Requirements




See Also

Reference




An index of C1.C1DataExtender.SchemaExtender.DataTableExtender in the collection.

Gets the C1.C1DataExtender.SchemaExtender.DataTableExtender object at the specified index.

Syntax


383



) As DataTableExtender

C#

public DataTableExtender Item(

System.int index

) {get;}

Parameters

index

An index of C1.C1DataExtender.SchemaExtender.DataTableExtender in the collection.

Property Value

A C1.C1DataExtender.SchemaExtender.DataTableExtender object at the specified index.

Requirements




See Also

Reference



Overload List


An alias of the base table which C1.C1DataExtender.SchemaExtender.DataTableExtender is

should be retrieved.

Gets the C1.C1DataExtender.SchemaExtender.DataTableExtender object corresponding to the

table with the specified alias.

Syntax


384



) As DataTableExtender

C#

public DataTableExtender Item(


) {get;}

Parameters

tableAlias

An alias of the base table which

C1.C1DataExtender.SchemaExtender.DataTableExtender is should be retrieved.

Property Value

If base DataTable with the specified alias exists then returns the corresponding

C1.C1DataExtender.SchemaExtender.DataTableExtender object; otherwise, a null value is

returning.

Requirements




See Also

Reference



Overload List

CatalogCollection

Represents a collection of SQL Server catalog names for the C1DataViewSet.ConnectionCatalogs

property.

Object Model

385

Syntax


Public Class CatalogCollection

Inherits System.Collections.ObjectModel.Collection(Of String)

C#

public class CatalogCollection :

System.Collections.ObjectModel.Collection<string>


System.Object

System.Collections.ObjectModel.Collection<T>

C1.C1DataExtender.CatalogCollection

Requirements




See Also

Reference

CatalogCollection Members


Overview

Represents a collection of SQL Server catalog names for the C1DataViewSet.ConnectionCatalogs

property.

Object Model

Syntax


386

Public Class CatalogCollection

Inherits System.Collections.ObjectModel.Collection(Of String)

C#

public class CatalogCollection :

System.Collections.ObjectModel.Collection<string>


System.Object


C1.C1DataExtender.CatalogCollection

Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by CatalogCollection.

Public Constructors

Name Description

CatalogCollection Constructor

Top

Public Properties

Name Description

387

Count (Inherited from System.Collections.ObjectModel.Collection<string>)

Item (Inherited from System.Collections.ObjectModel.Collection<string>)

Top

Public Methods

Name Description

Add (Inherited from System.Collections.ObjectModel.Collection<string>)

BeginUpdate Starts the collection update mode, thus preventing C1DataViewSet from re-

fetching DataSet schema on each collection's change. The update mode

must be finished by the EndUpdate method call after all necessary changes

to the collection are completed.

Clear (Inherited from System.Collections.ObjectModel.Collection<string>)

Contains (Inherited from System.Collections.ObjectModel.Collection<string>)

CopyTo (Inherited from System.Collections.ObjectModel.Collection<string>)

EndUpdate Ends the collection update mode started by the BeginUpdate method and

forces C1DataViewSet to re-fetch a DataSet schema from server.

GetEnumerator (Inherited from System.Collections.ObjectModel.Collection<string>)

IndexOf (Inherited from System.Collections.ObjectModel.Collection<string>)

Insert (Inherited from System.Collections.ObjectModel.Collection<string>)

Remove (Inherited from System.Collections.ObjectModel.Collection<string>)

RemoveAt (Inherited from System.Collections.ObjectModel.Collection<string>)

Top

388

See Also

Reference

CatalogCollection Class


CatalogCollection Constructor

Syntax



C#

public CatalogCollection()

Requirements




See Also

Reference



Methods

For a list of all members of this type, see CatalogCollection members.

Public Methods

Name Description

Add (Inherited from System.Collections.ObjectModel.Collection<string>)

BeginUpdate Starts the collection update mode, thus preventing C1DataViewSet from re-

fetching DataSet schema on each collection's change. The update mode

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~Add.html

389

must be finished by the EndUpdate method call after all necessary changes

to the collection are completed.

Clear (Inherited from System.Collections.ObjectModel.Collection<string>)

Contains (Inherited from System.Collections.ObjectModel.Collection<string>)

CopyTo (Inherited from System.Collections.ObjectModel.Collection<string>)

EndUpdate Ends the collection update mode started by the BeginUpdate method and

forces C1DataViewSet to re-fetch a DataSet schema from server.

GetEnumerator (Inherited from System.Collections.ObjectModel.Collection<string>)

IndexOf (Inherited from System.Collections.ObjectModel.Collection<string>)

Insert (Inherited from System.Collections.ObjectModel.Collection<string>)

Remove (Inherited from System.Collections.ObjectModel.Collection<string>)

RemoveAt (Inherited from System.Collections.ObjectModel.Collection<string>)

Top

See Also

Reference



BeginUpdate Method

Starts the collection update mode, thus preventing C1DataViewSet from re-fetching DataSet

schema on each collection's change. The update mode must be finished by the EndUpdate method

call after all necessary changes to the collection are completed.

Syntax

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~Contains.html

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~CopyTo.html

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~IndexOf.html

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~Insert.html

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~Remove.html

C1.C1DataExtender.2~C1.C1DataExtender.CatalogCollection~RemoveAt.html

390


Public Sub BeginUpdate()

C#

public void BeginUpdate()

Requirements




See Also

Reference



EndUpdate Method

Ends the collection update mode started by the BeginUpdate method and forces C1DataViewSet to

re-fetch a DataSet schema from server.

Syntax


Public Sub EndUpdate()

C#

public void EndUpdate()

Requirements




See Also

Reference

391



ColumnStyle

Represents a base for classes defining a column style on a column level.

Object Model

Syntax


Public MustInherit Class ColumnStyle

Inherits ColumnStyleBase

C#

public abstract class ColumnStyle : ColumnStyleBase


System.Object

C1.C1DataExtender.ColumnStyleBase

C1.C1DataExtender.ColumnStyle

C1.C1DataExtender.ViewSetColumnStyle

Requirements




See Also

Reference

ColumnStyle Members


Overview

Represents a base for classes defining a column style on a column level.

392

Object Model

Syntax


Public MustInherit Class ColumnStyle


C#

public abstract class ColumnStyle : ColumnStyleBase


System.Object




Requirements




See Also

Reference

ColumnStyle Members


Members

Properties

The following tables list the members exposed by ColumnStyle.

Public Properties

393

Name Description

BaseStyleName Defines a name of a base global style from which this style inherits its

property values.

DateTimeInput Indicates whether a special date-time edit mode is used. (Inherited from

C1.C1DataExtender.ColumnStyleBase)

DecimalLength Reserved for future use. (Inherited from


EditMask Defines an edit mask for a column value. (Inherited from


Format Defines a format string for a column value. (Inherited from


HorizontalAlignment (Inherited from C1.C1DataExtender.ColumnStyleBase)

Inherit Defines what style properties inherit their values from the base style.

IntegralLength Reserved for future use. (Inherited from


ItemList Defines a collection of items for an explicitly defined item list. (Inherited

from C1.C1DataExtender.ColumnStyleBase)

ItemListEffective Returns an actually used ColumnStyleBase.ItemList depending on the

Inherit property value. (Inherited from


ItemListType Defines the type of item list for this column. (Inherited from


ItemListValidate Indicates whether the user interface control should check that the value

394

entered by the user is present as a LookupItem.Value in

ColumnStyleBase.ItemList. (Inherited from


NullText Defines a string that is displayed by user interface controls for null values.

(Inherited from C1.C1DataExtender.ColumnStyleBase)

NumericAutoMask Reserved for future use. (Inherited from


NumericInput Indicates whether a special numeric edit mode is used. (Inherited from


Visible Indicates whether the column is visible in user interface. (Inherited from


Width Specifies preferred width (in characters) that user interface controls

should allocate for this column. (Inherited from


Top

See Also

Reference

ColumnStyle Class


Properties

For a list of all members of this type, see ColumnStyle members.

Public Properties

Name Description


property values.

395















ItemListEffective Returns an actually used ColumnStyleBase.ItemList depending on the

Inherit property value. (Inherited from





entered by the user is present as a LookupItem.Value in

ColumnStyleBase.ItemList. (Inherited from



396











Top

See Also

Reference

ColumnStyle Class


BaseStyleName Property

Defines a name of a base global style from which this style inherits its property values.

Syntax


Public Property BaseStyleName As System.String

C#

public System.string BaseStyleName {get; set;}

Requirements

397




See Also

Reference

ColumnStyle Class

ColumnStyle Members

Inherit Property

Defines what style properties inherit their values from the base style.

Syntax


Public Property Inherit As ColumnStylePropertyFlags

C#

public ColumnStylePropertyFlags Inherit {get; set;}

Requirements




See Also

Reference

ColumnStyle Class

ColumnStyle Members

ColumnStyleBase

The base class that represents Column Style - a set of properties that affects C1ViewColumn data


Object Model

398

Syntax


Public MustInherit Class ColumnStyleBase

C#

public abstract class ColumnStyleBase

Remarks



System.Object



C1.C1DataExtender.GlobalColumnStyleBase

Requirements




See Also

Reference

ColumnStyleBase Members


Overview

The base class that represents Column Style - a set of properties that affects C1ViewColumn data


Object Model

Syntax

399


Public MustInherit Class ColumnStyleBase

C#

public abstract class ColumnStyleBase

Remarks



System.Object




Requirements




See Also

Reference



Members

Properties

The following tables list the members exposed by ColumnStyleBase.

Public Properties

Name Description

DateTimeInput Indicates whether a special date-time edit mode is used.

400

DecimalLength Reserved for future use.

EditMask Defines an edit mask for a column value.

Format Defines a format string for a column value.

HorizontalAlignment

IntegralLength Reserved for future use.

ItemList Defines a collection of items for an explicitly defined item list.

ItemListEffective Returns an actually used ItemList depending on the Inherit property

value.

ItemListType Defines the type of item list for this column.


entered by the user is present as a LookupItem.Value in ItemList.

NullText Defines a string that is displayed by user interface controls for null

values.

NumericAutoMask Reserved for future use.

NumericInput Indicates whether a special numeric edit mode is used.

Visible Indicates whether the column is visible in user interface.


should allocate for this column.

Top

See Also

Reference

401

ColumnStyleBase Class


Properties

For a list of all members of this type, see ColumnStyleBase members.

Public Properties

Name Description

DateTimeInput Indicates whether a special date-time edit mode is used.

DecimalLength Reserved for future use.

EditMask Defines an edit mask for a column value.

Format Defines a format string for a column value.

HorizontalAlignment

IntegralLength Reserved for future use.

ItemList Defines a collection of items for an explicitly defined item list.


value.

ItemListType Defines the type of item list for this column.



NullText Defines a string that is displayed by user interface controls for null

values.

NumericAutoMask Reserved for future use.

402

NumericInput Indicates whether a special numeric edit mode is used.

Visible Indicates whether the column is visible in user interface.


should allocate for this column.

Top

See Also

Reference



DateTimeInput Property

Indicates whether a special date-time edit mode is used.

Syntax


Public Property DateTimeInput As System.Boolean

C#

public System.bool DateTimeInput {get; set;}

Requirements




See Also

Reference



403

DecimalLength Property

Reserved for future use.

Syntax


Public Property DecimalLength As System.Integer

C#

public System.int DecimalLength {get; set;}

Requirements




See Also

Reference



EditMask Property

Defines an edit mask for a column value.

Syntax


Public Property EditMask As System.String

C#

public System.string EditMask {get; set;}

Requirements




404

See Also

Reference



Format Property

Defines a format string for a column value.

Syntax


Public Property Format As System.String

C#

public System.string Format {get; set;}

Requirements




See Also

Reference



HorizontalAlignment Property

Syntax


Public Property HorizontalAlignment As HorizontalAlignmentEnum

C#

public HorizontalAlignmentEnum HorizontalAlignment {get; set;}

405

Requirements




See Also

Reference



IntegralLength Property


Syntax


Public Property IntegralLength As System.Integer

C#

public System.int IntegralLength {get; set;}

Requirements




See Also

Reference



ItemList Property

Defines a collection of items for an explicitly defined item list.

Syntax

406


Public ReadOnly Property ItemList As LookupItemList

C#

public LookupItemList ItemList {get;}

Remarks

ItemList is used to define a list of items when the ItemListType property is set to

ItemListTypeEnum.FixedValues or ItemListTypeEnum.FixedLookup value.

When ItemListType is set to ItemListTypeEnum.FixedValues only the LookupItem.Value property is

used, which defines a possible value that can be entered in a column by selecting it from the list.

If ItemListType value is ItemListTypeEnum.FixedLookup then list represents a lookup, where

LookupItem.Value represents a key that is matched against a column value, and

LookupItem.DisplayValue defines a string that will be displayed instead of an actual column value.

Requirements




See Also

Reference



ItemListEffective Property

Returns an actually used ItemList depending on the Inherit property value.

Syntax


Public ReadOnly Property ItemListEffective As LookupItemList

C#

407

public LookupItemList ItemListEffective {get;}

Requirements




See Also

Reference



ItemListType Property

Defines the type of item list for this column.

Syntax


Public Property ItemListType As ItemListTypeEnum

C#

public ItemListTypeEnum ItemListType {get; set;}

Remarks

See ItemListTypeEnum for details.

Requirements




See Also

Reference



408

ItemListValidate Property

Indicates whether the user interface control should check that the value entered by the user is

present as a LookupItem.Value in ItemList.

Syntax


Public Property ItemListValidate As System.Boolean

C#

public System.bool ItemListValidate {get; set;}

Requirements




See Also

Reference



NullText Property

Defines a string that is displayed by user interface controls for null values.

Syntax


Public Property NullText As System.String

C#

public System.string NullText {get; set;}

Requirements

409




See Also

Reference



NumericAutoMask Property


Syntax


Public Property NumericAutoMask As System.Boolean

C#

public System.bool NumericAutoMask {get; set;}

Requirements




See Also

Reference



NumericInput Property

Indicates whether a special numeric edit mode is used.

Syntax


410

Public Property NumericInput As System.Boolean

C#

public System.bool NumericInput {get; set;}

Requirements




See Also

Reference



Visible Property

Indicates whether the column is visible in user interface.

Syntax


Public Property Visible As System.Boolean

C#

public System.bool Visible {get; set;}

Requirements




See Also

Reference



411

Width Property

Specifies preferred width (in characters) that user interface controls should allocate for this column.

Syntax


Public Property Width As System.Integer

C#

public System.int Width {get; set;}

Requirements




See Also

Reference



ColumnStyleRule

Object Model

Syntax


Public Class ColumnStyleRule

C#

public class ColumnStyleRule


412

System.Object

C1.C1DataExtender.ColumnStyleRule

Requirements




See Also

Reference

ColumnStyleRule Members


Overview

Object Model

Syntax


Public Class ColumnStyleRule

C#

public class ColumnStyleRule


System.Object

C1.C1DataExtender.ColumnStyleRule

Requirements




See Also

413

Reference



Members

Properties

The following tables list the members exposed by ColumnStyleRule.

Public Constructors

Name Description

ColumnStyleRule Constructor

Top

Public Properties

Name Description

ColumnStyleName

ColumnType

Rule

Top

See Also

Reference

ColumnStyleRule Class


ColumnStyleRule Constructor

Syntax


414


C#

public ColumnStyleRule()

Requirements




See Also

Reference



Properties

For a list of all members of this type, see ColumnStyleRule members.

Public Properties

Name Description

ColumnStyleName

ColumnType

Rule

Top

See Also

Reference



ColumnStyleName Property

Syntax

415


Public Property ColumnStyleName As System.String

C#

public System.string ColumnStyleName {get; set;}

Requirements




See Also

Reference



ColumnType Property

Syntax


Public Property ColumnType As System.Type

C#

public System.Type ColumnType {get; set;}

Requirements




See Also

Reference



416

Rule Property

Syntax


Public Property Rule As ColumnStyleRuleEnum

C#

public ColumnStyleRuleEnum Rule {get; set;}

Requirements




See Also

Reference



ColumnStyleRuleCollection

Object Model

Syntax


Public Class ColumnStyleRuleCollection


C#

public class ColumnStyleRuleCollection : System.Collections.CollectionBase


417

System.Object


C1.C1DataExtender.ColumnStyleRuleCollection

Requirements




See Also

Reference

ColumnStyleRuleCollection Members


Overview

Object Model

Syntax


Public Class ColumnStyleRuleCollection


C#

public class ColumnStyleRuleCollection : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.ColumnStyleRuleCollection

Requirements

418




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by ColumnStyleRuleCollection.

Public Constructors

Name Description

ColumnStyleRuleCollection Constructor

Top

Public Properties

Name Description



Item

Top

Public Methods

Name Description

Add

419




Top

See Also

Reference

ColumnStyleRuleCollection Class


ColumnStyleRuleCollection Constructor

Syntax



C#

public ColumnStyleRuleCollection()

Requirements




See Also

Reference



Methods

>

420

Name Description

Add




Top

See Also

Reference



Add Method

Syntax



ByVal rule As ColumnStyleRule _

) As System.Integer

C#


ColumnStyleRule rule

)

Parameters

rule

Requirements




C1.C1DataExtender.2~C1.C1DataExtender.ColumnStyleRuleCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.ColumnStyleRuleCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.ColumnStyleRuleCollection~RemoveAt.html

421

See Also

Reference



Properties

For a list of all members of this type, see ColumnStyleRuleCollection members.

Public Properties

Name Description



Item

Top

See Also

Reference



Item Property

Syntax




) As ColumnStyleRule

C#

public ColumnStyleRule this[

System.int index

C1.C1DataExtender.2~C1.C1DataExtender.ColumnStyleRuleCollection~Capacity.html

C1.C1DataExtender.2~C1.C1DataExtender.ColumnStyleRuleCollection~Count.html

422

]; {get;}

Parameters

index

Requirements




See Also

Reference



ConnectionOpeningEventArgs

Provides data for the ConnectionOpeningEventHandler delegate.

Object Model

Syntax


Public Class ConnectionOpeningEventArgs


C#

public class ConnectionOpeningEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.ConnectionOpeningEventArgs

Requirements

423




See Also

Reference

ConnectionOpeningEventArgs Members


Overview

Provides data for the ConnectionOpeningEventHandler delegate.

Object Model

Syntax


Public Class ConnectionOpeningEventArgs


C#

public class ConnectionOpeningEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.ConnectionOpeningEventArgs

Requirements




See Also

424

Reference



Members

Properties

The following tables list the members exposed by ConnectionOpeningEventArgs.

Public Properties

Name Description


Top

See Also

Reference

ConnectionOpeningEventArgs Class


Properties

>

Name Description


Top

See Also

Reference



Connection Property

Gets the connection that is about to be opened.

Syntax

425


Public ReadOnly Property Connection As System.Data.Common.DbConnection

C#

public System.Data.Common.DbConnection Connection {get;}

Requirements




See Also

Reference



ConstraintExpression

Object Model

Syntax


Public Class ConstraintExpression

C#

public class ConstraintExpression


System.Object

C1.C1DataExtender.ConstraintExpression

Requirements

426




See Also

Reference

ConstraintExpression Members


Overview

Object Model

Syntax


Public Class ConstraintExpression

C#

public class ConstraintExpression


System.Object

C1.C1DataExtender.ConstraintExpression

Requirements




See Also

Reference



427

Members

Properties

The following tables list the members exposed by ConstraintExpression.

Public Properties

Name Description

ErrorDescription

Expression

Top

See Also

Reference

ConstraintExpression Class


Properties

>

Name Description

ErrorDescription

Expression

Top

See Also

Reference



ErrorDescription Property

Syntax

428


Public Property ErrorDescription As System.String

C#

public System.string ErrorDescription {get; set;}

Requirements




See Also

Reference



Expression Property

Syntax


Public ReadOnly Property Expression As C1ExpressionDef

C#

public C1ExpressionDef Expression {get;}

Requirements




See Also

Reference



429

DataColumnExpressionImplBase

Object Model

Syntax


Public MustInherit Class DataColumnExpressionImplBase

Inherits DataRowExpressionImplBase

C#

public abstract class DataColumnExpressionImplBase : DataRowExpressionImplBase


System.Object

C1.C1DataExtender.DataColumnExpressionImplBase

Requirements




See Also

Reference

DataColumnExpressionImplBase Members


Overview

Object Model

Syntax

430


Public MustInherit Class DataColumnExpressionImplBase

Inherits DataRowExpressionImplBase

C#

public abstract class DataColumnExpressionImplBase : DataRowExpressionImplBase


System.Object

C1.C1DataExtender.DataColumnExpressionImplBase

Requirements




See Also

Reference



Members

Properties

The following tables list the members exposed by DataColumnExpressionImplBase.

Public Properties

Name Description

baseValue

column Note: starts with lowercase letter to mimic a method parameter name.

newValue

Top

431

See Also

Reference

DataColumnExpressionImplBase Class


Properties

>

Name Description

baseValue

column Note: starts with lowercase letter to mimic a method parameter name.

newValue

Top

See Also

Reference



baseValue Property

Syntax


Public ReadOnly Property baseValue As System.Object

C#

public System.object baseValue {get;}

Requirements




432

See Also

Reference



column Property

Note: starts with lowercase letter to mimic a method parameter name.

Syntax


Public Property column As System.Data.DataColumn

C#

public System.Data.DataColumn column {get; set;}

Requirements




See Also

Reference



newValue Property

Syntax


Public Property newValue As System.Object

C#

public System.object newValue {get; set;}

433

Requirements




See Also

Reference



DataColumnTypeTypeConverter

Object Model

Syntax


Public Class DataColumnTypeTypeConverter

Inherits TypeTypeConverter

C#

public class DataColumnTypeTypeConverter : TypeTypeConverter


System.Object

System.ComponentModel.TypeConverter

C1.C1DataExtender.TypeTypeConverter

C1.C1DataExtender.DataColumnTypeTypeConverter

Requirements




See Also

434

Reference

DataColumnTypeTypeConverter Members


Overview

Object Model

Syntax


Public Class DataColumnTypeTypeConverter

Inherits TypeTypeConverter

C#

public class DataColumnTypeTypeConverter : TypeTypeConverter


System.Object




Requirements




See Also

Reference



Members

Methods

435

The following tables list the members exposed by DataColumnTypeTypeConverter.

Public Constructors

Name Description

DataColumnTypeTypeConverter Constructor

Top

Public Methods

Name Description

CanConvertFrom Overloaded. (Inherited from

C1.C1DataExtender.TypeTypeConverter)

CanConvertTo Overloaded. (Inherited from


ConvertFrom Overloaded. (Inherited from


ConvertFromInvariantString Overloaded. (Inherited from

System.ComponentModel.TypeConverter)

ConvertFromString Overloaded. (Inherited from


ConvertTo Overloaded. (Inherited from


ConvertToInvariantString Overloaded. (Inherited from


ConvertToString Overloaded. (Inherited from

436


CreateInstance Overloaded. (Inherited from


GetCreateInstanceSupported Overloaded. (Inherited from


GetProperties Overloaded. (Inherited from


GetPropertiesSupported Overloaded. (Inherited from


GetStandardValues Overloaded. Overridden.

GetStandardValuesExclusive Overloaded. (Inherited from


GetStandardValuesSupported Overloaded. (Inherited from


IsValid Overloaded. (Inherited from


Top

See Also

Reference

DataColumnTypeTypeConverter Class


DataColumnTypeTypeConverter Constructor

Syntax

437



C#

public DataColumnTypeTypeConverter()

Requirements




See Also

Reference



Methods

>

Name Description

CanConvertFrom

Overloaded. (Inherited from


CanConvertTo



ConvertFrom



ConvertFromInvariantString



ConvertFromString



ConvertTo



C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~ConvertFromInvariantString.html

C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~ConvertFromString.html

438

ConvertToInvariantString



ConvertToString



CreateInstance



GetCreateInstanceSupported



GetProperties



GetPropertiesSupported



GetStandardValues Overloaded. Overridden.

GetStandardValuesExclusive



GetStandardValuesSupported



IsValid



Top

See Also

Reference



GetStandardValues Method

Overload List


C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~ConvertToInvariantString.html

C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~ConvertToString.html

C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~CreateInstance.html

C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~GetCreateInstanceSupported.html

C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~GetProperties.html

C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~GetPropertiesSupported.html

C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~IsValid.html

439

GetStandardValues(ITypeDescriptorContext)

GetStandardValues() (Inherited from


Requirements




See Also

Reference



GetStandardValues(ITypeDescriptorContext) Method

Syntax


Public Overloads Overrides Function GetStandardValues( _

ByVal context As System.ComponentModel.ITypeDescriptorContext _

) As System.ComponentModel.TypeConverter.StandardValuesCollection

C#

public override System.ComponentModel.TypeConverter.StandardValuesCollection

GetStandardValues(

System.ComponentModel.ITypeDescriptorContext context

)

Parameters

context

Requirements




C1.C1DataExtender.2~C1.C1DataExtender.DataColumnTypeTypeConverter~GetStandardValues().html

440

See Also

Reference



Overload List

EomColumnRef

The base class for defining of reference to table column.

Object Model

Syntax


Public MustInherit Class EomColumnRef

Inherits EomOperandElement

C#

public abstract class EomColumnRef : EomOperandElement


System.Object

C1.C1DataExtender.EomElement

C1.C1DataExtender.EomOperandElement

C1.C1DataExtender.EomColumnRef

Requirements




See Also

Reference

441

EomColumnRef Members


Overview

The base class for defining of reference to table column.

Object Model

Syntax


Public MustInherit Class EomColumnRef


C#

public abstract class EomColumnRef : EomOperandElement


System.Object




Requirements




See Also

Reference



Members

Properties Methods

442

The following tables list the members exposed by EomColumnRef.

Public Properties

Name Description

ColumnNameTarget

OperandType Gets or sets the returning type of operand. (Inherited from

C1.C1DataExtender.EomOperandElement)

Parent If this operand is Left or Right of EomOperation element, returns that

EomOperation element. (Inherited from


Top

Public Methods

Name Description

Clone Ensure Parent is null in the clone. (Inherited from


Top

See Also

Reference

EomColumnRef Class


Properties

For a list of all members of this type, see EomColumnRef members.

Public Properties

Name Description

443

ColumnNameTarget






Top

See Also

Reference

EomColumnRef Class


ColumnNameTarget Property

Syntax


Public MustOverride ReadOnly Property ColumnNameTarget As System.String

C#

public abstract System.string ColumnNameTarget {get;}

Requirements




See Also

Reference

EomColumnRef Class


444

EomConstant

Object Model

Syntax


Public Class EomConstant


C#

public class EomConstant : EomOperandElement


System.Object



C1.C1DataExtender.EomConstant

Requirements




See Also

Reference

EomConstant Members


Overview

Object Model

Syntax

445


Public Class EomConstant


C#

public class EomConstant : EomOperandElement


System.Object




Requirements




See Also

Reference

EomConstant Members


Members

Properties Methods

The following tables list the members exposed by EomConstant.

Public Constructors

Name Description

EomConstant Constructor

Top

Public Properties

446

Name Description

CanConvertValue Indicates whether Value can be converted to OperandType, and thus usage

of the ConvertedValue property is permitted.

ConvertedValue Returns the Value converted to OperandType, in case when

CanConvertValue returns true. If CanConvertValue is false then returns null.

OperandType Overridden. The target type of value, to which Value is converted when call

to ConvertedValue property occurs.




Value Original value of the constant, from expression source.

Top

Public Methods

Name Description

CanConvertToType



GetConvertedValue Returns Value converted to the specified targetType, or null if converion is

impossible.

Top

See Also

Reference

447

EomConstant Class


EomConstant Constructor

Syntax



ByVal value As System.Object, _

ByVal targetType As System.Type _

)

C#

public EomConstant(

System.object value,

System.Type targetType

)

Parameters

value

targetType

Requirements




See Also

Reference

EomConstant Class

EomConstant Members

Methods

For a list of all members of this type, see EomConstant members.

Public Methods

448

Name Description

CanConvertToType



GetConvertedValue Returns Value converted to the specified targetType, or null if converion is

impossible.

Top

See Also

Reference

EomConstant Class


CanConvertToType Method

Syntax


Public Function CanConvertToType( _


) As System.Boolean

C#

public System.bool CanConvertToType(


)

Parameters

targetType

Requirements

449




See Also

Reference

EomConstant Class

EomConstant Members

GetConvertedValue Method

Returns Value converted to the specified targetType, or null if converion is impossible.

Syntax


Public Function GetConvertedValue( _


) As System.Object

C#

public System.object GetConvertedValue(


)

Parameters

targetType

Requirements




See Also

Reference

EomConstant Class

EomConstant Members

450

Properties

For a list of all members of this type, see EomConstant members.

Public Properties

Name Description

CanConvertValue Indicates whether Value can be converted to OperandType, and thus usage

of the ConvertedValue property is permitted.

ConvertedValue Returns the Value converted to OperandType, in case when

CanConvertValue returns true. If CanConvertValue is false then returns null.

OperandType Overridden. The target type of value, to which Value is converted when call

to ConvertedValue property occurs.




Value Original value of the constant, from expression source.

Top

See Also

Reference

EomConstant Class


CanConvertValue Property

Indicates whether Value can be converted to OperandType, and thus usage of the ConvertedValue

property is permitted.

Syntax


Public ReadOnly Property CanConvertValue As System.Boolean

451

C#

public System.bool CanConvertValue {get;}

Requirements




See Also

Reference

EomConstant Class

EomConstant Members

ConvertedValue Property

Returns the Value converted to OperandType, in case when CanConvertValue returns true. If

CanConvertValue is false then returns null.

Syntax


Public ReadOnly Property ConvertedValue As System.Object

C#

public System.object ConvertedValue {get;}

Requirements




See Also

Reference

EomConstant Class

EomConstant Members

452

OperandType Property

The target type of value, to which Value is converted when call to ConvertedValue property occurs.

Syntax


Public Overrides Property OperandType As System.Type

C#

public override System.Type OperandType {get; set;}

Requirements




See Also

Reference

EomConstant Class

EomConstant Members

Value Property

Original value of the constant, from expression source.

Syntax



C#


Requirements




453

See Also

Reference

EomConstant Class

EomConstant Members

EomElement

The base class for all elements of EOM

Object Model

Syntax


Public MustInherit Class EomElement

C#

public abstract class EomElement


System.Object


C1.C1DataExtender.EomMarkupElement


Requirements




See Also

Reference

EomElement Members


454

Overview

The base class for all elements of EOM

Object Model

Syntax


Public MustInherit Class EomElement

C#

public abstract class EomElement


System.Object




Requirements




See Also

Reference

EomElement Members


Members

Methods

The following tables list the members exposed by EomElement.

Public Methods

455

Name Description

Clone Performs memberwise clone. Must be overridden in complex derived

classes.

Top

See Also

Reference

EomElement Class


Methods

>

Name Description

Clone

Performs memberwise clone. Must be overridden in complex derived

classes.

Top

See Also

Reference

EomElement Class


Clone Method

Performs memberwise clone. Must be overridden in complex derived classes.

Syntax


Public Overridable Function Clone() As EomElement

C#

public virtual EomElement Clone()

456

Requirements




See Also

Reference

EomElement Class

EomElement Members

EomElementCollection

Object Model

Syntax


Public Class EomElementCollection

Inherits System.Collections.ObjectModel.Collection(Of EomElement)

C#

public class EomElementCollection :

System.Collections.ObjectModel.Collection<EomElement>


System.Object


C1.C1DataExtender.EomElementCollection

Requirements




See Also

457

Reference

EomElementCollection Members


Overview

Object Model

Syntax


Public Class EomElementCollection

Inherits System.Collections.ObjectModel.Collection(Of EomElement)

C#

public class EomElementCollection :

System.Collections.ObjectModel.Collection<EomElement>


System.Object


C1.C1DataExtender.EomElementCollection

Requirements




See Also

Reference



Members

Properties Methods

458

The following tables list the members exposed by EomElementCollection.

Public Constructors

Name Description

EomElementCollection Constructor

Top

Public Properties

Name Description

Count (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Item (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Top

Public Methods

Name Description

Add (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Clear (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Clone

Contains (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

CopyTo (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

GetEnumerator (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

IndexOf (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

459

Insert (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Remove (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

RemoveAt (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Top

See Also

Reference

EomElementCollection Class


EomElementCollection Constructor

Syntax



C#

public EomElementCollection()

Requirements




See Also

Reference



Methods

>

460

Name Description

Add (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Clear (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Clone

Contains (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

CopyTo (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

GetEnumerator (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

IndexOf (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Insert (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Remove (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

RemoveAt (Inherited from System.Collections.ObjectModel.Collection<EomElement>)

Top

See Also

Reference



Clone Method

Syntax


Public Function Clone() As EomElementCollection

C#

public EomElementCollection Clone()

Requirements

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~Add.html

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~Contains.html

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~CopyTo.html

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~IndexOf.html

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~Insert.html

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~Remove.html

C1.C1DataExtender.2~C1.C1DataExtender.EomElementCollection~RemoveAt.html

461




See Also

Reference



EomFunctionCall

Represents a call to a function with a list of actual parameters in "expression tree". For "plain

structure" use the EomFunctionCallSymbol class.

Object Model

Syntax


Public Class EomFunctionCall


C#

public class EomFunctionCall : EomOperandElement


System.Object



C1.C1DataExtender.EomFunctionCall

Requirements




462

See Also

Reference

EomFunctionCall Members


Overview

Represents a call to a function with a list of actual parameters in "expression tree". For "plain

structure" use the EomFunctionCallSymbol class.

Object Model

Syntax


Public Class EomFunctionCall


C#

public class EomFunctionCall : EomOperandElement


System.Object




Requirements




See Also

Reference

463



Members

Properties Methods

The following tables list the members exposed by EomFunctionCall.

Public Constructors

Name Description

EomFunctionCall Constructor

Top

Public Properties

Name Description

FunctionName The name of function.



Parameters The list of actual parameters.




SpecialFunction For special SQL operators like "IS NULL", "LIKE" and so on returns a value

denoting such an operator. Returns "No" for regular functions.

Top

Public Methods

Name Description

464

Clone Overridden.

Top

See Also

Reference

EomFunctionCall Class


EomFunctionCall Constructor

Syntax



C#

public EomFunctionCall()

Requirements




See Also

Reference



Methods

For a list of all members of this type, see EomFunctionCall members.

Public Methods

Name Description

465

Clone Overridden.

Top

See Also

Reference



Clone Method

Syntax


Public Overrides Function Clone() As EomElement

C#

public override EomElement Clone()

Requirements




See Also

Reference



Properties

For a list of all members of this type, see EomFunctionCall members.

Public Properties

Name Description

466









denoting such an operator. Returns "No" for regular functions.

Top

See Also

Reference



FunctionName Property

The name of function.

Syntax


Public Property FunctionName As System.String

C#

public System.string FunctionName {get; set;}

Requirements




467

See Also

Reference



Parameters Property

The list of actual parameters.

Syntax


Public ReadOnly Property Parameters As EomOperandCollection

C#

public EomOperandCollection Parameters {get;}

Requirements




See Also

Reference



SpecialFunction Property

For special SQL operators like "IS NULL", "LIKE" and so on returns a value denoting such an

operator. Returns "No" for regular functions.

Syntax


Public Property SpecialFunction As EomSpecialSqlFunctionEnum

468

C#

public EomSpecialSqlFunctionEnum SpecialFunction {get; set;}

Requirements




See Also

Reference



EomFunctionCallSymbol

Represents function call in "plain structure". For "expression tree" use the EomFunctionCall class.

Object Model

Syntax


Public Class EomFunctionCallSymbol

Inherits EomMarkupElement

C#

public class EomFunctionCallSymbol : EomMarkupElement


System.Object



C1.C1DataExtender.EomFunctionCallSymbol

Requirements

469




See Also

Reference

EomFunctionCallSymbol Members


Overview

Represents function call in "plain structure". For "expression tree" use the EomFunctionCall class.

Object Model

Syntax


Public Class EomFunctionCallSymbol


C#

public class EomFunctionCallSymbol : EomMarkupElement


System.Object




Requirements




See Also

470

Reference



Members

Properties Methods

The following tables list the members exposed by EomFunctionCallSymbol.

Public Constructors

Name Description

EomFunctionCallSymbol Constructor

Top

Public Properties

Name Description




denoting such an operator. Returns No for regular functions.

Top

Public Methods

Name Description

Clone Overridden.

GetSpecialFunctionFormatString

Top

471

See Also

Reference

EomFunctionCallSymbol Class


EomFunctionCallSymbol Constructor

Syntax



C#

public EomFunctionCallSymbol()

Requirements




See Also

Reference



Methods

For a list of all members of this type, see EomFunctionCallSymbol members.

Public Methods

Name Description

Clone Overridden.

GetSpecialFunctionFormatString

Top

472

See Also

Reference



Clone Method

Syntax



C#


Requirements




See Also

Reference



GetSpecialFunctionFormatString Method

Syntax


Public Shared Function GetSpecialFunctionFormatString( _

ByVal func As EomSpecialSqlFunctionEnum, _

ByVal paramCount As System.Integer _

) As System.String

C#

473

public static System.string GetSpecialFunctionFormatString(

EomSpecialSqlFunctionEnum func,

System.int paramCount

)

Parameters

func

paramCount

Requirements




See Also

Reference



Properties

For a list of all members of this type, see EomFunctionCallSymbol members.

Public Properties

Name Description




denoting such an operator. Returns No for regular functions.

Top

See Also

Reference

474



FunctionName Property

The name of function.

Syntax


Public Property FunctionName As System.String

C#

public System.string FunctionName {get; set;}

Requirements




See Also

Reference



Parameters Property

The list of actual parameters.

Syntax


Public Property Parameters As EomElementCollection()

C#

public EomElementCollection[] Parameters {get; set;}

Requirements

475




See Also

Reference



SpecialFunction Property

For special SQL operators like "IS NULL", "LIKE" and so on returns a value denoting such an

operator. Returns No for regular functions.

Syntax


Public Property SpecialFunction As EomSpecialSqlFunctionEnum

C#

public EomSpecialSqlFunctionEnum SpecialFunction {get; set;}

Requirements




See Also

Reference



EomLParen

Represents "(".

Object Model

476

Syntax


Public Class EomLParen


C#

public class EomLParen : EomMarkupElement


System.Object



C1.C1DataExtender.EomLParen

Requirements




See Also

Reference

EomLParen Members


Overview

Represents "(".

Object Model

Syntax


477

Public Class EomLParen


C#

public class EomLParen : EomMarkupElement


System.Object




Requirements




See Also

Reference

EomLParen Members


Members

Methods

The following tables list the members exposed by EomLParen.

Public Constructors

Name Description

EomLParen Constructor

Top

Public Methods

Name Description

478

Clone Performs memberwise clone. Must be overridden in complex derived classes.

(Inherited from C1.C1DataExtender.EomElement)

Top

See Also

Reference

EomLParen Class


EomLParen Constructor

Syntax



C#

public EomLParen()

Requirements




See Also

Reference

EomLParen Class

EomLParen Members

EomMarkupElement

The base class for elements which are not operands, such as parentheses and operation signs.

Object Model

479

Syntax


Public MustInherit Class EomMarkupElement

Inherits EomElement

C#

public abstract class EomMarkupElement : EomElement


System.Object





C1.C1DataExtender.EomOperatorSymbol

C1.C1DataExtender.EomRParen

Requirements




See Also

Reference

EomMarkupElement Members


Overview

The base class for elements which are not operands, such as parentheses and operation signs.

Object Model

Syntax

480


Public MustInherit Class EomMarkupElement

Inherits EomElement

C#

public abstract class EomMarkupElement : EomElement


System.Object







Requirements




See Also

Reference

EomMarkupElement Members


Members

Methods

The following tables list the members exposed by EomMarkupElement.

Public Methods

Name Description


481


Top

See Also

Reference

EomMarkupElement Class


EomOperandCollection

Object Model

Syntax


Public Class EomOperandCollection

Inherits System.Collections.ObjectModel.Collection(Of EomOperandElement)

C#

public class EomOperandCollection :

System.Collections.ObjectModel.Collection<EomOperandElement>


System.Object


C1.C1DataExtender.EomOperandCollection

Requirements




See Also

Reference

482

EomOperandCollection Members


Overview

Object Model

Syntax


Public Class EomOperandCollection

Inherits System.Collections.ObjectModel.Collection(Of EomOperandElement)

C#

public class EomOperandCollection :

System.Collections.ObjectModel.Collection<EomOperandElement>


System.Object


C1.C1DataExtender.EomOperandCollection

Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by EomOperandCollection.

483

Public Constructors

Name Description

EomOperandCollection Constructor

Top

Public Properties

Name Description

Count (Inherited from

System.Collections.ObjectModel.Collection<EomOperandElement>)

Item (Inherited from


Top

Public Methods

Name Description

Add (Inherited from


Clear (Inherited from


Clone

Contains (Inherited from


CopyTo (Inherited from


484

GetEnumerator (Inherited from


IndexOf (Inherited from


Insert (Inherited from


Remove (Inherited from


RemoveAt (Inherited from


Top

See Also

Reference

EomOperandCollection Class


EomOperandCollection Constructor

Syntax



C#

public EomOperandCollection()

Requirements




485

See Also

Reference



Methods

>

Name Description

Add

(Inherited from


Clear

(Inherited from


Clone

Contains

(Inherited from


CopyTo

(Inherited from


GetEnumerator

(Inherited from


IndexOf

(Inherited from


Insert

(Inherited from


Remove

(Inherited from


RemoveAt

(Inherited from


Top

See Also

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~Add.html

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~Contains.html

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~CopyTo.html

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~IndexOf.html

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~Insert.html

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~Remove.html

C1.C1DataExtender.2~C1.C1DataExtender.EomOperandCollection~RemoveAt.html

486

Reference



Clone Method

Syntax


Public Function Clone() As EomOperandCollection

C#

public EomOperandCollection Clone()

Requirements




See Also

Reference



EomOperandElement

The base class for all elements representing operands of an expression.

Object Model

Syntax


Public MustInherit Class EomOperandElement

Inherits EomElement

487

C#

public abstract class EomOperandElement : EomElement


System.Object






C1.C1DataExtender.EomOperation

Requirements




See Also

Reference

EomOperandElement Members


Overview

The base class for all elements representing operands of an expression.

Object Model

Syntax


Public MustInherit Class EomOperandElement

Inherits EomElement

C#

488

public abstract class EomOperandElement : EomElement


System.Object







Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by EomOperandElement.

Public Properties

Name Description

OperandType Gets or sets the returning type of operand.


EomOperation element.

Top

Public Methods

489

Name Description

Clone Overridden. Ensure Parent is null in the clone.

Top

See Also

Reference

EomOperandElement Class


Methods

>

Name Description

Clone Overridden. Ensure Parent is null in the clone.

Top

See Also

Reference



Clone Method

Ensure Parent is null in the clone.

Syntax



C#


Requirements

490




See Also

Reference



Properties

>

Name Description

OperandType Gets or sets the returning type of operand.

Parent

If this operand is Left or Right of EomOperation element, returns that

EomOperation element.

Top

See Also

Reference



OperandType Property

Gets or sets the returning type of operand.

Syntax


Public Overridable Property OperandType As System.Type

C#

public virtual System.Type OperandType {get; set;}

Requirements

491




See Also

Reference



Parent Property

If this operand is Left or Right of EomOperation element, returns that EomOperation element.

Syntax


Public ReadOnly Property Parent As EomOperation

C#

public EomOperation Parent {get;}

Requirements




See Also

Reference



EomOperation

Represents an operation, in the form Left Operator Right. To define unary operation set Left to null.

Object Model

492

Syntax


Public Class EomOperation


C#

public class EomOperation : EomOperandElement


System.Object




Requirements




See Also

Reference

EomOperation Members


Overview

Represents an operation, in the form Left Operator Right. To define unary operation set Left to null.

Object Model

Syntax


493

Public Class EomOperation


C#

public class EomOperation : EomOperandElement


System.Object




Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by EomOperation.

Public Constructors

Name Description

EomOperation Constructor Overloaded.

Top

Public Properties

Name Description

494

IsUnary Indicates whether operation is unary (true) or binary (false), the first case is

defined by setting Left to null.

Left Left operand of the operation, or null for unary operation.



Operator The operator of the operation.




Right Right operand of the operation

Top

Public Methods

Name Description

Clone Overridden. Left and Right are nulls

Top

See Also

Reference

EomOperation Class


EomOperation Constructor

Overload List

Overload Descriptio

n

495

EomOperation

Constructor(EomOperandElement,EomOperatorSymbol,EomOperandElement)

EomOperation Constructor(EomOperatorSymbol,EomOperandElement)

EomOperation Constructor()

Requirements




See Also

Reference

EomOperation Class


EomOperation Constructor(EomOperandElement,EomOperatorSymbol,EomOperandElement)

Syntax



ByVal left As EomOperandElement, _

ByVal op As EomOperatorSymbol, _

ByVal right As EomOperandElement _

)

C#

public EomOperation(

EomOperandElement left,

EomOperatorSymbol op,

EomOperandElement right

)

Parameters

left

496

op

right

Requirements




See Also

Reference

EomOperation Class


Overload List

EomOperation Constructor(EomOperatorSymbol,EomOperandElement)

Syntax



ByVal op As EomOperatorSymbol, _

ByVal right As EomOperandElement _

)

C#

public EomOperation(

EomOperatorSymbol op,

EomOperandElement right

)

Parameters

op

right

Requirements

497




See Also

Reference

EomOperation Class


Overload List

EomOperation Constructor()

Syntax



C#

public EomOperation()

Requirements




See Also

Reference

EomOperation Class


Overload List

Methods

>

Name Description

Clone Overridden. Left and Right are nulls

Top

498

See Also

Reference

EomOperation Class


Clone Method

Left and Right are nulls

Syntax



C#


Requirements




See Also

Reference

EomOperation Class


Properties

>

Name Description

IsUnary

Indicates whether operation is unary (true) or binary (false), the first case is

defined by setting Left to null.

Left Left operand of the operation, or null for unary operation.

OperandType

Gets or sets the returning type of operand. (Inherited from

499


Operator The operator of the operation.

Parent

If this operand is Left or Right of EomOperation element, returns that



Right Right operand of the operation

Top

See Also

Reference

EomOperation Class


IsUnary Property

Indicates whether operation is unary (true) or binary (false), the first case is defined by setting Left

to null.

Syntax


Public ReadOnly Property IsUnary As System.Boolean

C#

public System.bool IsUnary {get;}

Requirements




See Also

Reference

EomOperation Class


500

Left Property

Left operand of the operation, or null for unary operation.

Syntax


Public Property Left As EomOperandElement

C#

public EomOperandElement Left {get; set;}

Requirements




See Also

Reference

EomOperation Class


Operator Property

The operator of the operation.

Syntax


Public Property Operator As EomOperatorSymbol

C#

public EomOperatorSymbol Operator {get; set;}

Requirements




501

See Also

Reference

EomOperation Class


Right Property

Right operand of the operation

Syntax


Public Property Right As EomOperandElement

C#

public EomOperandElement Right {get; set;}

Requirements




See Also

Reference

EomOperation Class


EomOperatorSymbol

Represents an operator symbol.

Object Model

Syntax


502

Public Class EomOperatorSymbol


C#

public class EomOperatorSymbol : EomMarkupElement


System.Object




Requirements




See Also

Reference

EomOperatorSymbol Members


Overview

Represents an operator symbol.

Object Model

Syntax


Public Class EomOperatorSymbol


C#

503

public class EomOperatorSymbol : EomMarkupElement


System.Object




Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by EomOperatorSymbol.

Public Constructors

Name Description

EomOperatorSymbol Constructor Overloaded.

Top

Public Properties

Name Description

IsArithmeticOperator

IsBinaryLogicalOperator

504

IsComparisonOperator

Operator

Priority Returns the operator priority

Top

Public Methods

Name Description



Top

See Also

Reference

EomOperatorSymbol Class


EomOperatorSymbol Constructor

Overload List


EomOperatorSymbol Constructor()

EomOperatorSymbol Constructor(EomOperatorEnum)

Requirements




See Also

505

Reference



EomOperatorSymbol Constructor()

Syntax



C#

public EomOperatorSymbol()

Requirements




See Also

Reference



Overload List

EomOperatorSymbol Constructor(EomOperatorEnum)

Syntax



ByVal operatorSymbol As EomOperatorEnum _

)

C#

public EomOperatorSymbol(

EomOperatorEnum operatorSymbol

506

)

Parameters

operatorSymbol

Requirements




See Also

Reference



Overload List

Properties

>

Name Description

IsArithmeticOperator

IsBinaryLogicalOperator

IsComparisonOperator

Operator

Priority Returns the operator priority

Top

See Also

Reference



507

IsArithmeticOperator Property

Syntax


Public ReadOnly Property IsArithmeticOperator As System.Boolean

C#

public System.bool IsArithmeticOperator {get;}

Requirements




See Also

Reference



IsBinaryLogicalOperator Property

Syntax


Public ReadOnly Property IsBinaryLogicalOperator As System.Boolean

C#

public System.bool IsBinaryLogicalOperator {get;}

Requirements




See Also

Reference

508



IsComparisonOperator Property

Syntax


Public ReadOnly Property IsComparisonOperator As System.Boolean

C#

public System.bool IsComparisonOperator {get;}

Requirements




See Also

Reference



Operator Property

Syntax


Public Property Operator As EomOperatorEnum

C#

public EomOperatorEnum Operator {get; set;}

Requirements




509

See Also

Reference



Priority Property

Returns the operator priority

Syntax


Public ReadOnly Property Priority As System.Integer

C#

public System.int Priority {get;}

Requirements




See Also

Reference



EomRParen

Represents ")".

Object Model

Syntax


510

Public Class EomRParen


C#

public class EomRParen : EomMarkupElement


System.Object




Requirements




See Also

Reference

EomRParen Members


Overview

Represents ")".

Object Model

Syntax


Public Class EomRParen


C#

511

public class EomRParen : EomMarkupElement


System.Object




Requirements




See Also

Reference

EomRParen Members


Members

Methods

The following tables list the members exposed by EomRParen.

Public Constructors

Name Description

EomRParen Constructor

Top

Public Methods

Name Description



Top

512

See Also

Reference

EomRParen Class


EomRParen Constructor

Syntax



C#

public EomRParen()

Requirements




See Also

Reference

EomRParen Class

EomRParen Members

EomUtils

Object Model

Syntax


Public MustInherit NotInheritable Class EomUtils

513

C#

public static class EomUtils


System.Object

C1.C1DataExtender.EomUtils

Requirements




See Also

Reference

EomUtils Members


Overview

Object Model

Syntax


Public MustInherit NotInheritable Class EomUtils

C#

public static class EomUtils


System.Object

C1.C1DataExtender.EomUtils

Requirements

514




See Also

Reference

EomUtils Members


Members

Methods

The following tables list the members exposed by EomUtils.

Public Methods

Name Description

BuildExpressionTree Returns "expression tree" for the specified "plain expression". Returning

"expression tree" takes into account operators' priorities.

plainExpression must represent a valid infix expression (or empty

expression), in other case result is unpredictable. Returning "expression

tree" contains clones of "plain expression" elements.

Top

See Also

Reference

EomUtils Class


Methods

For a list of all members of this type, see EomUtils members.

Public Methods

Name Description

515

BuildExpressionTree Returns "expression tree" for the specified "plain expression". Returning

"expression tree" takes into account operators' priorities.

plainExpression must represent a valid infix expression (or empty

expression), in other case result is unpredictable. Returning "expression

tree" contains clones of "plain expression" elements.

Top

See Also

Reference

EomUtils Class


BuildExpressionTree Method

Returns "expression tree" for the specified "plain expression". Returning "expression tree" takes into

account operators' priorities. plainExpression must represent a valid infix expression (or empty

expression), in other case result is unpredictable. Returning "expression tree" contains clones of

"plain expression" elements.

Syntax


Public Shared Function BuildExpressionTree( _

ByVal plainExpression As EomElementCollection _

) As EomOperandElement

C#

public static EomOperandElement BuildExpressionTree(

EomElementCollection plainExpression

)

Parameters

plainExpression

Requirements

516




See Also

Reference

EomUtils Class

EomUtils Members

FieldTypes

Object Model

Syntax


Public Class FieldTypes

C#

public class FieldTypes


System.Object

C1.C1DataExtender.FieldTypes

Requirements




See Also

Reference

FieldTypes Members


517

Overview

Object Model

Syntax


Public Class FieldTypes

C#

public class FieldTypes


System.Object

C1.C1DataExtender.FieldTypes

Requirements




See Also

Reference

FieldTypes Members


Members

Methods

The following tables list the members exposed by FieldTypes.

Public Constructors

Name Description

518

FieldTypes Constructor

Top

Public Methods

Name Description

OleDBTypeToStdType

StdTypeToDBType

StdTypeToOleDBType

Top

See Also

Reference

FieldTypes Class


FieldTypes Constructor

Syntax



C#

public FieldTypes()

Requirements




See Also

519

Reference

FieldTypes Class

FieldTypes Members

Methods

For a list of all members of this type, see FieldTypes members.

Public Methods

Name Description

OleDBTypeToStdType

StdTypeToDBType

StdTypeToOleDBType

Top

See Also

Reference

FieldTypes Class


OleDBTypeToStdType Method

Syntax


Public Shared Function OleDBTypeToStdType( _

ByVal oledbType As System.Data.OleDb.OleDbType _

) As System.Type

C#

public static System.Type OleDBTypeToStdType(

System.Data.OleDb.OleDbType oledbType

)

Parameters

520

oledbType

Requirements




See Also

Reference

FieldTypes Class

FieldTypes Members

StdTypeToDBType Method

Syntax


Public Shared Function StdTypeToDBType( _

ByVal stdType As System.Type _

) As System.Data.DbType

C#

public static System.Data.DbType StdTypeToDBType(

System.Type stdType

)

Parameters

stdType

Requirements




See Also

Reference

521

FieldTypes Class

FieldTypes Members

StdTypeToOleDBType Method

Syntax


Public Shared Function StdTypeToOleDBType( _

ByVal stdType As System.Type _

) As System.Data.OleDb.OleDbType

C#

public static System.Data.OleDb.OleDbType StdTypeToOleDBType(

System.Type stdType

)

Parameters

stdType

Requirements




See Also

Reference

FieldTypes Class

FieldTypes Members

FilterRowEventArgs

Object Model

Syntax

522


Public Class FilterRowEventArgs


C#

public class FilterRowEventArgs : System.EventArgs


System.Object

System.EventArgs

C1.C1DataExtender.FilterRowEventArgs

Requirements




See Also

Reference

FilterRowEventArgs Members


Overview

Object Model

Syntax


Public Class FilterRowEventArgs


C#

public class FilterRowEventArgs : System.EventArgs

523


System.Object

System.EventArgs

C1.C1DataExtender.FilterRowEventArgs

Requirements




See Also

Reference



Members

The following tables list the members exposed by FilterRowEventArgs.

Public Constructors

Name Description

FilterRowEventArgs Constructor

Top

See Also

Reference

FilterRowEventArgs Class


FilterRowEventArgs Constructor

Syntax


524


C#

public FilterRowEventArgs()

Requirements




See Also

Reference

FilterRowEventArgs Class


GlobalColumnStyleBase

Base class for all global column styles

Object Model

Syntax


Public MustInherit Class GlobalColumnStyleBase


C#

public abstract class GlobalColumnStyleBase : ColumnStyleBase


System.Object



C1.C1DataExtender.ViewSetGlobalColumnStyle

525

Requirements




See Also

Reference

GlobalColumnStyleBase Members


Overview

Base class for all global column styles

Object Model

Syntax


Public MustInherit Class GlobalColumnStyleBase


C#

public abstract class GlobalColumnStyleBase : ColumnStyleBase


System.Object




Requirements




526

See Also

Reference



Members

Properties

The following tables list the members exposed by GlobalColumnStyleBase.

Public Properties

Name Description















value. (Inherited from C1.C1DataExtender.ColumnStyleBase)

527






Name












Top

See Also

Reference

GlobalColumnStyleBase Class


Properties

For a list of all members of this type, see GlobalColumnStyleBase members.

Public Properties

528

Name Description





















Name


529











Top

See Also

Reference



Name Property

Syntax


Public Property Name As System.String

C#

public System.string Name {get; set;}

Requirements




530

See Also

Reference



GlobalColumnStyleCollectionBase

The base class for global column style collections.

Object Model

Syntax


Public MustInherit Class GlobalColumnStyleCollectionBase


C#

public abstract class GlobalColumnStyleCollectionBase :



System.Object


C1.C1DataExtender.GlobalColumnStyleCollectionBase

C1.C1DataExtender.ViewSetColumnStyleCollection

Requirements




See Also

Reference

531

GlobalColumnStyleCollectionBase Members


Overview

The base class for global column style collections.

Object Model

Syntax


Public MustInherit Class GlobalColumnStyleCollectionBase


C#

public abstract class GlobalColumnStyleCollectionBase :



System.Object




Requirements




See Also

Reference



Members

Properties Methods

532

The following tables list the members exposed by GlobalColumnStyleCollectionBase.

Public Properties

Name Description



Top

Public Methods

Name Description

Add Adds a GlobalColumnStyleBase object in the collection.



Insert Inserts a GlobalColumnStyleBase object at the specified position in the

collection.


Top

See Also

Reference

GlobalColumnStyleCollectionBase Class


Methods

>

Name Description

533

Add Adds a GlobalColumnStyleBase object in the collection.



Insert

Inserts a GlobalColumnStyleBase object at the specified position in the

collection.


Top

See Also

Reference



Add Method

A GlobalColumnStyleBase.

Adds a GlobalColumnStyleBase object in the collection.

Syntax



ByVal style As GlobalColumnStyleBase _

) As System.Integer

C#


GlobalColumnStyleBase style

)

Parameters

style


Return Value

C1.C1DataExtender.2~C1.C1DataExtender.GlobalColumnStyleCollectionBase~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.GlobalColumnStyleCollectionBase~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.GlobalColumnStyleCollectionBase~RemoveAt.html

534

An index of newly added object in the collection.

Requirements




See Also

Reference



Insert Method

An index of GlobalColumnStyleBase in the collection.


Inserts a GlobalColumnStyleBase object at the specified position in the collection.

Syntax


Public Sub Insert( _

ByVal index As System.Integer, _

ByVal style As GlobalColumnStyleBase _

)

C#

public void Insert(

System.int index,

GlobalColumnStyleBase style

)

Parameters

index

An index of GlobalColumnStyleBase in the collection.

style

535


Requirements




See Also

Reference



ImmutableCollectionBase

Object Model

Syntax


Public Class ImmutableCollectionBase

C#

public class ImmutableCollectionBase


System.Object

C1.C1DataExtender.ImmutableCollectionBase

Requirements




See Also

536

Reference

ImmutableCollectionBase Members


Overview

Object Model

Syntax


Public Class ImmutableCollectionBase

C#

public class ImmutableCollectionBase


System.Object

C1.C1DataExtender.ImmutableCollectionBase

Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by ImmutableCollectionBase.

Public Constructors

537

Name Description

ImmutableCollectionBase Constructor

Top

Public Properties

Name Description

Count

IsSynchronized

SyncRoot

Top

Public Methods

Name Description

CopyTo

GetEnumerator

Top

See Also

Reference

ImmutableCollectionBase Class


ImmutableCollectionBase Constructor

Syntax


538


C#

public ImmutableCollectionBase()

Requirements




See Also

Reference



Methods

>

Name Description

CopyTo

GetEnumerator

Top

See Also

Reference



CopyTo Method

Syntax




539


)

C#

public void CopyTo(

System.Array array,

System.int index

)

Parameters

array

index

Requirements




See Also

Reference




Syntax



C#


Requirements




540

See Also

Reference



Properties

For a list of all members of this type, see ImmutableCollectionBase members.

Public Properties

Name Description

Count

IsSynchronized

SyncRoot

Top

See Also

Reference



Count Property

Syntax



C#


Requirements

541




See Also

Reference



IsSynchronized Property

Syntax


Public ReadOnly Property IsSynchronized As System.Boolean

C#

public System.bool IsSynchronized {get;}

Requirements




See Also

Reference



SyncRoot Property

Syntax


Public ReadOnly Property SyncRoot As System.Object

C#

542

public System.object SyncRoot {get;}

Requirements




See Also

Reference



ImmutableKeyedCollectionBase

Represents a read-only collection that provides an access to items by a key or an index.

Object Model

Syntax


Public Class ImmutableKeyedCollectionBase

C#

public class ImmutableKeyedCollectionBase


System.Object





Requirements

543




See Also

Reference

ImmutableKeyedCollectionBase Members


Overview

Represents a read-only collection that provides an access to items by a key or an index.

Object Model

Syntax


Public Class ImmutableKeyedCollectionBase

C#

public class ImmutableKeyedCollectionBase


System.Object





Requirements




See Also

544

Reference



Members

Properties Methods

The following tables list the members exposed by ImmutableKeyedCollectionBase.

Public Constructors

Name Description

ImmutableKeyedCollectionBase Constructor Creates a new instance of the

ImmutableKeyedCollectionBase class.

Top

Public Properties

Name Description

Count Gets a number of element in the collection.

IsSynchronized Implements the IList.IsSynchronized property.

SyncRoot Implements the IList.SyncRoot property.

Top

Public Methods

Name Description


index in the target array.

GetEnumerator Gets a collection enumerator.

545

IndexOfKey Gets and index of an item with the specified key.

Top

See Also

Reference

ImmutableKeyedCollectionBase Class


ImmutableKeyedCollectionBase Constructor

Creates a new instance of the ImmutableKeyedCollectionBase class.

Syntax



C#

public ImmutableKeyedCollectionBase()

Requirements




See Also

Reference



Methods

>

Name Description

CopyTo

Copies the collection items to the specified array starting from the specified

index in the target array.

546

GetEnumerator Gets a collection enumerator.

IndexOfKey Gets and index of an item with the specified key.

Top

See Also

Reference



CopyTo Method

The array to copy items to.

The starting index in the target array.

Copies the collection items to the specified array starting from the specified index in the target

array.

Syntax





)

C#

public void CopyTo(

System.Array array,

System.int index

)

Parameters

array

The array to copy items to.

index

The starting index in the target array.

547

Requirements




See Also

Reference




Gets a collection enumerator.

Syntax



C#


Requirements




See Also

Reference



IndexOfKey Method

The key of the interested item.

Gets and index of an item with the specified key.

548

Syntax


Public Function IndexOfKey( _


) As System.Integer

C#

public System.int IndexOfKey(

System.string key

)

Parameters

key

The key of the interested item.

Return Value

The index of the item with the specified key if such item exists; otherwise, -1.

Requirements




See Also

Reference



Properties

For a list of all members of this type, see ImmutableKeyedCollectionBase members.

Public Properties

Name Description

549

Count Gets a number of element in the collection.

IsSynchronized Implements the IList.IsSynchronized property.

SyncRoot Implements the IList.SyncRoot property.

Top

See Also

Reference



Count Property

Gets a number of element in the collection.

Syntax



C#


Requirements




See Also

Reference



IsSynchronized Property

Implements the IList.IsSynchronized property.

550

Syntax


Public ReadOnly Property IsSynchronized As System.Boolean

C#

public System.bool IsSynchronized {get;}

Requirements




See Also

Reference



SyncRoot Property

Implements the IList.SyncRoot property.

Syntax


Public ReadOnly Property SyncRoot As System.Object

C#

public System.object SyncRoot {get;}

Requirements




See Also

551

Reference



LookupItem

Represents an item of LookupItemList collection.

Object Model

Syntax


Public Class LookupItem

C#

public class LookupItem


System.Object

C1.C1DataExtender.LookupItem

Requirements




See Also

Reference

LookupItem Members


Overview

Represents an item of LookupItemList collection.

Object Model

552

Syntax


Public Class LookupItem

C#

public class LookupItem


System.Object

C1.C1DataExtender.LookupItem

Requirements




See Also

Reference

LookupItem Members


Members

Properties

The following tables list the members exposed by LookupItem.

Public Properties

Name Description

DisplayValue Gets or sets a display string showing in the user interface.

Value Gets or sets a value matching a C1ViewColumn value.

553

Top

See Also

Reference

LookupItem Class


Properties

For a list of all members of this type, see LookupItem members.

Public Properties

Name Description

DisplayValue Gets or sets a display string showing in the user interface.

Value Gets or sets a value matching a C1ViewColumn value.

Top

See Also

Reference

LookupItem Class


DisplayValue Property

Gets or sets a display string showing in the user interface.

Syntax


Public Property DisplayValue As System.Object

C#

public System.object DisplayValue {get; set;}

Requirements

554




See Also

Reference

LookupItem Class

LookupItem Members

Value Property

Gets or sets a value matching a C1ViewColumn value.

Syntax



C#


Requirements




See Also

Reference

LookupItem Class

LookupItem Members

LookupItemList

Represents a collection of LookupItem objects for the ColumnStyleBase.ItemList property.

Object Model

555

Syntax


Public Class LookupItemList


C#

public class LookupItemList : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.LookupItemList

Requirements




See Also

Reference

LookupItemList Members


Overview

Represents a collection of LookupItem objects for the ColumnStyleBase.ItemList property.

Object Model

Syntax


Public Class LookupItemList

556


C#

public class LookupItemList : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.LookupItemList

Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by LookupItemList.

Public Properties

Name Description



Item Gets the LookupItem object at the specified index.

Top

Public Methods

557

Name Description

Add Adds a LookupItem object to the collection.




Top

See Also

Reference

LookupItemList Class


Methods

For a list of all members of this type, see LookupItemList members.

Public Methods

Name Description

Add Adds a LookupItem object to the collection.




Top

See Also

Reference

C1.C1DataExtender.2~C1.C1DataExtender.LookupItemList~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.LookupItemList~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.LookupItemList~RemoveAt.html

558



Add Method

A LookupItem.

Adds a LookupItem object to the collection.

Syntax



ByVal item As LookupItem _

) As System.Integer

C#


LookupItem item

)

Parameters

item

A LookupItem.

Return Value

An index of added LookupItem in the collection.

Requirements




See Also

Reference



559

Properties

For a list of all members of this type, see LookupItemList members.

Public Properties

Name Description



Item Gets the LookupItem object at the specified index.

Top

See Also

Reference



Item Property

An index of LookupItem.

Gets the LookupItem object at the specified index.

Syntax




) As LookupItem

C#

public LookupItem this[

System.int index

]; {get;}

Parameters

C1.C1DataExtender.2~C1.C1DataExtender.LookupItemList~Capacity.html

C1.C1DataExtender.2~C1.C1DataExtender.LookupItemList~Count.html

560

index

An index of LookupItem.

Property Value

A LookupItem.

Requirements




See Also

Reference



RowDisplayBase

Defines a pattern used to construct a string that represents a table row in lookup list.

Object Model

Syntax


Public MustInherit Class RowDisplayBase

C#

public abstract class RowDisplayBase


System.Object

C1.C1DataExtender.RowDisplayBase

Requirements

561




See Also

Reference

RowDisplayBase Members


Overview

Defines a pattern used to construct a string that represents a table row in lookup list.

Object Model

Syntax


Public MustInherit Class RowDisplayBase

C#

public abstract class RowDisplayBase


System.Object

C1.C1DataExtender.RowDisplayBase

Requirements




See Also

Reference

562



Members

Properties

The following tables list the members exposed by RowDisplayBase.

Public Properties

Name Description

RowDisplayColumns Defines a collection of column names whose values constitute a row

representation string.

RowDisplayFormat Defines a formatting based on columns specified in the

RowDisplayColumns collection.

SortByDisplayValue Indicates whether items in lookup list should be sorted by row display

values.

Top

See Also

Reference

RowDisplayBase Class


Properties

For a list of all members of this type, see RowDisplayBase members.

Public Properties

Name Description

RowDisplayColumns Defines a collection of column names whose values constitute a row

representation string.

563

RowDisplayFormat Defines a formatting based on columns specified in the

RowDisplayColumns collection.

SortByDisplayValue Indicates whether items in lookup list should be sorted by row display

values.

Top

See Also

Reference



RowDisplayColumns Property

Defines a collection of column names whose values constitute a row representation string.

Syntax


Public ReadOnly Property RowDisplayColumns As RowDisplayColumnCollection

C#

public RowDisplayColumnCollection RowDisplayColumns {get;}

Remarks

If RowDisplayFormat property value is empty then row display string is constructed as specified

column values separated by space, in order as they go in this collection. If this collection is empty

then a column representing a row is determined automatically. Presence of a column name in the

collection is synchronazed with the DataColumnExtender.RowDisplayValue property value of the

corresponding DataColumnExtender object. If column name is in the collection then

DataColumnExtender.RowDisplayValue is true, if not in the collection then false. The change can

be performed by adding/removing the column name from the collection or by changing the

DataColumnExtender.RowDisplayValue property value.

Requirements

564




See Also

Reference



RowDisplayFormat Property

Defines a formatting based on columns specified in the RowDisplayColumns collection.

Syntax


Public Property RowDisplayFormat As System.String

C#

public System.string RowDisplayFormat {get; set;}

Remarks

This property value represents a format string (with syntax defined by the String.Format() method)

that defines the formatting of the row display string. Format specifications ({0}, {1} , and so on) in

this format string correspond to columns in the RowDisplayColumns collection.

Requirements




See Also

Reference



SortByDisplayValue Property

Indicates whether items in lookup list should be sorted by row display values.

565

Syntax


Public Property SortByDisplayValue As System.Boolean

C#

public System.bool SortByDisplayValue {get; set;}

Requirements




See Also

Reference



RowDisplayColumnCollection

Object Model

Syntax


Public Class RowDisplayColumnCollection


C#

public class RowDisplayColumnCollection : System.Collections.CollectionBase


566

System.Object


C1.C1DataExtender.RowDisplayColumnCollection

Requirements




See Also

Reference

RowDisplayColumnCollection Members


Overview

Object Model

Syntax


Public Class RowDisplayColumnCollection


C#

public class RowDisplayColumnCollection : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.RowDisplayColumnCollection

Requirements

567




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by RowDisplayColumnCollection.

Public Properties

Name Description



Item Overloaded.

Top

Public Methods

Name Description

Add


Contains


568

Remove


Top

See Also

Reference

RowDisplayColumnCollection Class


Methods

>

Name Description

Add


Contains


Remove


Top

See Also

Reference



Add Method

Syntax


C1.C1DataExtender.2~C1.C1DataExtender.RowDisplayColumnCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.RowDisplayColumnCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.RowDisplayColumnCollection~RemoveAt.html

569


ByVal columnRef As RowDisplayColumnRef _

) As System.Integer

C#


RowDisplayColumnRef columnRef

)

Parameters

columnRef

Requirements




See Also

Reference



Contains Method

Syntax




) As System.Boolean

C#



)

Parameters

columnName

570

Requirements




See Also

Reference



Remove Method

Syntax




)

C#

public void Remove(


)

Parameters

columnName

Requirements




See Also

Reference



571

Properties

For a list of all members of this type, see RowDisplayColumnCollection members.

Public Properties

Name Description



Item Overloaded.

Top

See Also

Reference



Item Property

Overload List


Item(Int32)

Item(String)

Requirements




See Also

Reference

C1.C1DataExtender.2~C1.C1DataExtender.RowDisplayColumnCollection~Capacity.html

C1.C1DataExtender.2~C1.C1DataExtender.RowDisplayColumnCollection~Count.html

572




Syntax




) As RowDisplayColumnRef

C#

public RowDisplayColumnRef Item(

System.int index

) {get;}

Parameters

index

Requirements




See Also

Reference



Overload List


Syntax




573

) As RowDisplayColumnRef

C#

public RowDisplayColumnRef Item(


) {get;}

Parameters

columnName

Requirements




See Also

Reference



Overload List

RowDisplayColumnRef

Object Model

Syntax


Public Class RowDisplayColumnRef

C#

public class RowDisplayColumnRef


574

System.Object

C1.C1DataExtender.RowDisplayColumnRef

Requirements




See Also

Reference

RowDisplayColumnRef Members


Overview

Object Model

Syntax


Public Class RowDisplayColumnRef

C#

public class RowDisplayColumnRef


System.Object

C1.C1DataExtender.RowDisplayColumnRef

Requirements




See Also

575

Reference



Members

Properties Methods

The following tables list the members exposed by RowDisplayColumnRef.

Public Properties

Name Description

ColumnName

Top

Public Methods

Name Description

ToString

Top

See Also

Reference

RowDisplayColumnRef Class


Methods

>

Name Description

ToString

Top

See Also

576

Reference



ToString Method

Syntax



C#


Requirements




See Also

Reference



Properties

>

Name Description

ColumnName

Top

See Also

Reference



577

ColumnName Property

Syntax


Public Property ColumnName As System.String

C#

public System.string ColumnName {get; set;}

Requirements




See Also

Reference



TypeTypeConverter

Base class that provides a converter for properties of the Type type. Notes to inheritor:

GetStandardValues method must be overridden to return a list of standard types.

Object Model

Syntax


Public MustInherit Class TypeTypeConverter

Inherits System.ComponentModel.TypeConverter

C#

public abstract class TypeTypeConverter : System.ComponentModel.TypeConverter

578


System.Object




Requirements




See Also

Reference

TypeTypeConverter Members


Overview

Base class that provides a converter for properties of the Type type. Notes to inheritor:

GetStandardValues method must be overridden to return a list of standard types.

Object Model

Syntax


Public MustInherit Class TypeTypeConverter

Inherits System.ComponentModel.TypeConverter

C#

public abstract class TypeTypeConverter : System.ComponentModel.TypeConverter


System.Object


579



Requirements




See Also

Reference



Members

Methods

The following tables list the members exposed by TypeTypeConverter.

Public Methods

Name Description

CanConvertFrom Overloaded. Overridden.

CanConvertTo Overloaded. Overridden.

ConvertFrom Overloaded. Overridden.





ConvertTo Overloaded. Overridden.


580












GetStandardValues Overloaded. (Inherited from


GetStandardValuesExclusive Overloaded. Overridden.

GetStandardValuesSupported Overloaded. Overridden.



Top

See Also

Reference

TypeTypeConverter Class


Methods

For a list of all members of this type, see TypeTypeConverter members.

581

Public Methods

Name Description

CanConvertFrom Overloaded. Overridden.

CanConvertTo Overloaded. Overridden.

ConvertFrom Overloaded. Overridden.





ConvertTo Overloaded. Overridden.













C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~ConvertFromInvariantString.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~ConvertFromString.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~ConvertToInvariantString.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~ConvertToString.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~CreateInstance.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~GetCreateInstanceSupported.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~GetProperties.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~GetPropertiesSupported.html

582

GetStandardValues Overloaded. (Inherited from


GetStandardValuesExclusive Overloaded. Overridden.

GetStandardValuesSupported Overloaded. Overridden.



Top

See Also

Reference



CanConvertFrom Method

Overload List


CanConvertFrom(ITypeDescriptorContext,Type)

CanConvertFrom(Type) (Inherited from


Requirements




See Also

Reference

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~GetStandardValues.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~IsValid.html

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~CanConvertFrom(Type).html

583



CanConvertFrom(ITypeDescriptorContext,Type) Method

Syntax


Public Overloads Overrides Function CanConvertFrom( _

ByVal context As System.ComponentModel.ITypeDescriptorContext, _

ByVal sourceType As System.Type _

) As System.Boolean

C#

public override System.bool CanConvertFrom(

System.ComponentModel.ITypeDescriptorContext context,

System.Type sourceType

)

Parameters

context

sourceType

Requirements




See Also

Reference



Overload List

CanConvertTo Method

Overload List

584


CanConvertTo(ITypeDescriptorContext,Type)

CanConvertTo(Type) (Inherited from


Requirements




See Also

Reference



CanConvertTo(ITypeDescriptorContext,Type) Method

Syntax


Public Overloads Overrides Function CanConvertTo( _


ByVal destinationType As System.Type _

) As System.Boolean

C#

public override System.bool CanConvertTo(


System.Type destinationType

)

Parameters

context

destinationType

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~CanConvertTo(Type).html

585

Requirements




See Also

Reference



Overload List

ConvertFrom Method

Overload List


ConvertFrom(ITypeDescriptorContext,CultureInfo,Object

)

ConvertFrom(Object) (Inherited from


)

Requirements




See Also

Reference



ConvertFrom(ITypeDescriptorContext,CultureInfo,Object) Method

Syntax

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~ConvertFrom(Object).html

586


Public Overloads Overrides Function ConvertFrom( _


ByVal culture As System.Globalization.CultureInfo, _

ByVal value As System.Object _

) As System.Object

C#

public override System.object ConvertFrom(


System.Globalization.CultureInfo culture,

System.object value

)

Parameters

context

culture

value

Requirements




See Also

Reference



Overload List

ConvertTo Method

Overload List


587

ConvertTo(ITypeDescriptorContext,CultureInfo,Object,Typ

e)

ConvertTo(Object,Type) (Inherited from

System.ComponentModel.TypeConverte

r)

Requirements




See Also

Reference



ConvertTo(ITypeDescriptorContext,CultureInfo,Object,Type) Method

Syntax


Public Overloads Overrides Function ConvertTo( _


ByVal culture As System.Globalization.CultureInfo, _

ByVal value As System.Object, _

ByVal destinationType As System.Type _

) As System.Object

C#

public override System.object ConvertTo(


System.Globalization.CultureInfo culture,

System.object value,

System.Type destinationType

)

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~ConvertTo(Object,Type).html

588

Parameters

context

culture

value

destinationType

Requirements




See Also

Reference



Overload List

GetStandardValuesExclusive Method

Overload List


GetStandardValuesExclusive(ITypeDescriptorContext)

GetStandardValuesExclusive() (Inherited from


Requirements




See Also

Reference

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~GetStandardValuesExclusive().html

589



GetStandardValuesExclusive(ITypeDescriptorContext) Method

Syntax


Public Overloads Overrides Function GetStandardValuesExclusive( _


) As System.Boolean

C#

public override System.bool GetStandardValuesExclusive(


)

Parameters

context

Requirements




See Also

Reference



Overload List

GetStandardValuesSupported Method

Overload List


GetStandardValuesSupported(ITypeDescriptorContext)

590

GetStandardValuesSupported() (Inherited from


Requirements




See Also

Reference



GetStandardValuesSupported(ITypeDescriptorContext) Method

Syntax


Public Overloads Overrides Function GetStandardValuesSupported( _


) As System.Boolean

C#

public override System.bool GetStandardValuesSupported(


)

Parameters

context

Requirements




See Also

C1.C1DataExtender.2~C1.C1DataExtender.TypeTypeConverter~GetStandardValuesSupported().html

591

Reference



Overload List

ViewJoin

Represents a join between two base DataTables in the C1ViewModel.

Object Model

Syntax


Public Class ViewJoin

C#

public class ViewJoin


System.Object

C1.C1DataExtender.ViewJoin

Requirements




See Also

Reference

ViewJoin Members


Overview

Represents a join between two base DataTables in the C1ViewModel.

592

Object Model

Syntax


Public Class ViewJoin

C#

public class ViewJoin


System.Object

C1.C1DataExtender.ViewJoin

Requirements




See Also

Reference

ViewJoin Members


Members

Properties

The following tables list the members exposed by ViewJoin.

Public Constructors

Name Description

ViewJoin Constructor Overloaded.

593

Top

Public Properties

Name Description

ChildNode References the child ViewNode of the ViewJoin.

JoinRelation References the DataRelation represented by the ViewJoin.

JoinRelationName Gets the name of the DataRelation represented by the ViewJoin.

JoinSemantics Gets the semantics of the join.

JoinType Gets or sets the type of the ViewJoin.

ParentNode References the parent ViewNode of the ViewJoin.

Top

See Also

Reference

ViewJoin Class


ViewJoin Constructor

Overload List


ViewJoin Constructor(DataRelation,DataTable,String) Creates a new instance of the ViewJoin class

with the ChildNode representing the specified

DataTable and referencing by the specified

alias, where the join parameters corresponds

to the specified DataRelation.

594

ViewJoin Constructor(DataRelation,DataTable) Creates a new instance of the ViewJoin class

with the ChildNode representing the specified

DataTable, where the join parameters

corresponds to the specified DataRelation.

ViewJoin Constructor(String,String,String) Creates a new instance of the ViewJoin class

with the ChildNode representing the

DataTable with specified name and

referencing by the specified alias, where the

join parameters corresponds to the

DataRelation with the specified relation

name.

ViewJoin Constructor(String,String) Creates a new instance of the ViewJoin class

with the ChildNode representing the

DataTable with specified name , where the

join parameters corresponds to the

DataRelation with the specified relation

name.

Requirements




See Also

Reference

ViewJoin Class

ViewJoin Members

ViewJoin Constructor(DataRelation,DataTable,String)

The DataRelation that the ViewJoin represents.

The DataTable that is represented by the ChildNode of the ViewJoin.

The alias that is used to reference ChildNode.

595

Creates a new instance of the ViewJoin class with the ChildNode representing the specified

DataTable and referencing by the specified alias, where the join parameters corresponds to the

specified DataRelation.

Syntax



ByVal childRelation As System.Data.DataRelation, _

ByVal childTable As System.Data.DataTable, _


)

C#

public ViewJoin(

System.Data.DataRelation childRelation,

System.Data.DataTable childTable,


)

Parameters

childRelation


childTable

The DataTable that is represented by the ChildNode of the ViewJoin.

childTableAlias


Requirements




See Also

Reference

596

ViewJoin Class

ViewJoin Members

Overload List

ViewJoin Constructor(DataRelation,DataTable)


The DataTable that is represented by the ChildNode

Creates a new instance of the ViewJoin class with the ChildNode representing the specified

DataTable, where the join parameters corresponds to the specified DataRelation.

Syntax



ByVal childRelation As System.Data.DataRelation, _

ByVal childTable As System.Data.DataTable _

)

C#

public ViewJoin(

System.Data.DataRelation childRelation,

System.Data.DataTable childTable

)

Parameters

childRelation


childTable

The DataTable that is represented by the ChildNode

Requirements




See Also

597

Reference

ViewJoin Class

ViewJoin Members

Overload List

ViewJoin Constructor(String,String,String)

The name of the DataRelation that the ViewJoin represents.

The name of the DataTable that is represented by the ChildNode.


Creates a new instance of the ViewJoin class with the ChildNode representing the DataTable with

specified name and referencing by the specified alias, where the join parameters corresponds to the

DataRelation with the specified relation name.

Syntax



ByVal childRelationName As System.String, _

ByVal childTableName As System.String, _


)

C#

public ViewJoin(

System.string childRelationName,

System.string childTableName,


)

Parameters

childRelationName


childTableName

The name of the DataTable that is represented by the ChildNode.

childTableAlias

598


Requirements




See Also

Reference

ViewJoin Class

ViewJoin Members

Overload List

ViewJoin Constructor(String,String)


The name of the DataTable that is represented by the

Creates a new instance of the ViewJoin class with the ChildNode representing the DataTable with

specified name , where the join parameters corresponds to the DataRelation with the specified

relation name.

Syntax



ByVal childRelationName As System.String, _

ByVal childTableName As System.String _

)

C#

public ViewJoin(

System.string childRelationName,

System.string childTableName

)

Parameters

childRelationName

599


childTableName

The name of the DataTable that is represented by the

Requirements




See Also

Reference

ViewJoin Class

ViewJoin Members

Overload List

Properties

For a list of all members of this type, see ViewJoin members.

Public Properties

Name Description

ChildNode References the child ViewNode of the ViewJoin.

JoinRelation References the DataRelation represented by the ViewJoin.

JoinRelationName Gets the name of the DataRelation represented by the ViewJoin.

JoinSemantics Gets the semantics of the join.

JoinType Gets or sets the type of the ViewJoin.

ParentNode References the parent ViewNode of the ViewJoin.

Top

See Also

600

Reference

ViewJoin Class


ChildNode Property

References the child ViewNode of the ViewJoin.

Syntax


Public ReadOnly Property ChildNode As ViewNode

C#

public ViewNode ChildNode {get;}

Requirements




See Also

Reference

ViewJoin Class

ViewJoin Members

JoinRelation Property

References the DataRelation represented by the ViewJoin.

Syntax


Public ReadOnly Property JoinRelation As System.Data.DataRelation

C#

public System.Data.DataRelation JoinRelation {get;}

Requirements

601




See Also

Reference

ViewJoin Class

ViewJoin Members

JoinRelationName Property

Gets the name of the DataRelation represented by the ViewJoin.

Syntax


Public ReadOnly Property JoinRelationName As System.String

C#

public System.string JoinRelationName {get;}

Requirements




See Also

Reference

ViewJoin Class

ViewJoin Members

JoinSemantics Property

Gets the semantics of the join.

Syntax


602

Public ReadOnly Property JoinSemantics As JoinSemanticsEnum

C#

public JoinSemanticsEnum JoinSemantics {get;}

Requirements




See Also

Reference

ViewJoin Class

ViewJoin Members

JoinType Property

Gets or sets the type of the ViewJoin.

Syntax


Public Property JoinType As JoinTypeEnum

C#

public JoinTypeEnum JoinType {get; set;}

Requirements




See Also

Reference

ViewJoin Class

ViewJoin Members

603

ParentNode Property

References the parent ViewNode of the ViewJoin.

Syntax


Public ReadOnly Property ParentNode As ViewNode

C#

public ViewNode ParentNode {get;}

Requirements




See Also

Reference

ViewJoin Class

ViewJoin Members

ViewJoinCollection

Object Model

Syntax


Public Class ViewJoinCollection


C#

public class ViewJoinCollection : System.Collections.CollectionBase


604

System.Object


C1.C1DataExtender.ViewJoinCollection

Requirements




See Also

Reference

ViewJoinCollection Members


Overview

Object Model

Syntax


Public Class ViewJoinCollection


C#

public class ViewJoinCollection : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.ViewJoinCollection

Requirements

605




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by ViewJoinCollection.

Public Properties

Name Description



Item

Top

Public Methods

Name Description

Add



IndexOf

606

Remove


Top

See Also

Reference

ViewJoinCollection Class


Methods

For a list of all members of this type, see ViewJoinCollection members.

Public Methods

Name Description

Add



IndexOf

Remove


Top

See Also

Reference



C1.C1DataExtender.2~C1.C1DataExtender.ViewJoinCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.ViewJoinCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.ViewJoinCollection~RemoveAt.html

607

Add Method

Syntax



ByVal join As ViewJoin _

) As System.Integer

C#


ViewJoin join

)

Parameters

join

Requirements




See Also

Reference



IndexOf Method

Syntax




) As System.Integer

C#

608


ViewJoin join

)

Parameters

join

Requirements




See Also

Reference



Remove Method

Syntax




)

C#

public void Remove(

ViewJoin join

)

Parameters

join

Requirements

609




See Also

Reference



Properties

For a list of all members of this type, see ViewJoinCollection members.

Public Properties

Name Description



Item

Top

See Also

Reference



Item Property

Syntax




) As ViewJoin

C1.C1DataExtender.2~C1.C1DataExtender.ViewJoinCollection~Capacity.html

C1.C1DataExtender.2~C1.C1DataExtender.ViewJoinCollection~Count.html

610

C#

public ViewJoin this[

System.int index

]; {get;}

Parameters

index

Requirements




See Also

Reference



ViewModelColumn

Represents a column defined for a view in the C1ViewModel.

Object Model

Syntax


Public Class ViewModelColumn

C#

public class ViewModelColumn


System.Object

C1.C1DataExtender.ViewModelColumn

611

Requirements




See Also

Reference

ViewModelColumn Members


Overview

Represents a column defined for a view in the C1ViewModel.

Object Model

Syntax


Public Class ViewModelColumn

C#

public class ViewModelColumn


System.Object

C1.C1DataExtender.ViewModelColumn

Requirements




See Also

612

Reference



Members

Properties Methods

The following tables list the members exposed by ViewModelColumn.

Public Constructors

Name Description

ViewModelColumn Constructor Overloaded.

Top

Public Properties

Name Description

ColumnAlias Gets the alias used to reference this ViewModelColumn by name.

ColumnExpression Gets an expression used to calculate the column value in case when this

ViewModelColumn represents a calculated column.

DataColumn Gets the DataColumn repesented by this ViewModelColumn.

DataColumnName Gets the name of the DataColumn repesented by this ViewModelColumn,

or denotes all columns of ViewNode in case when its value is not set (null

or empty string).

IsCalculated Indicates wheather the ViewModelColumn represents a calculated column.

ViewNode References the ViewNode whose column(s) represented by this

ViewModelColumn.

Top

613

Public Methods

Name Description

Clone Gets a copy of this ViewModelColumn.

Top

See Also

Reference

ViewModelColumn Class


ViewModelColumn Constructor

Overload List


ViewModelColumn Constructor(ViewNode) Creates a new instance of the

ViewModelColumn referencing a

column of the specified

ViewNode.

ViewModelColumn Constructor(ViewNode,DataColumn) Creates a new instance of the

ViewModelColumn referencing the

specified DataColumn of the

DataTable represented by the

specified ViewNode.

ViewModelColumn Constructor(ViewNode,String) Creates a new instance of the


DataColumn with the specified

name that belongs to the


specified ViewNode.

614

ViewModelColumn Constructor(ViewNode,DataColumn,String) Creates a new instance of the


specified DataColumn of the


specified ViewNode, and provides it

with the specified alias that is used

to reference the column.

ViewModelColumn Constructor(ViewNode,String,String) Creates a new instance of the


DataColumn with the specified

name that belongs to the


specified ViewNode, and provides it

with the specified alias that is used

to reference the column.

ViewModelColumn Constructor(String,String) Creates a new instance of the

ViewModelColumn class that

represents a calculated column with

the specified calculation expression

and alias.

Requirements




See Also

Reference



ViewModelColumn Constructor(ViewNode)

The ViewNode whose column is referenced by this ViewModelColumn.

615

Creates a new instance of the ViewModelColumn referencing a column of the specified ViewNode.

Syntax



ByVal viewNode As ViewNode _

)

C#

public ViewModelColumn(

ViewNode viewNode

)

Parameters

viewNode

The ViewNode whose column is referenced by this ViewModelColumn.

Requirements




See Also

Reference



Overload List

ViewModelColumn Constructor(ViewNode,DataColumn)

The ViewNode whose column is referenced by this ViewNode.

The DataColumn represented by this ViewNode.

Creates a new instance of the ViewModelColumn referencing the specified DataColumn of the

DataTable represented by the specified ViewNode.

Syntax

616



ByVal viewNode As ViewNode, _

ByVal dataColumn As System.Data.DataColumn _

)

C#


ViewNode viewNode,

System.Data.DataColumn dataColumn

)

Parameters

viewNode


dataColumn


Requirements




See Also

Reference



Overload List

ViewModelColumn Constructor(ViewNode,String)


The name of the DataColumn represented by this ViewNode.

Creates a new instance of the ViewModelColumn referencing the DataColumn with the specified

name that belongs to the DataTable represented by the specified ViewNode.

617

Syntax




ByVal dataColumnName As System.String _

)

C#


ViewNode viewNode,

System.string dataColumnName

)

Parameters

viewNode


dataColumnName


Requirements




See Also

Reference



Overload List

ViewModelColumn Constructor(ViewNode,DataColumn,String)



618

The that is used to reference the column.

Creates a new instance of the ViewModelColumn referencing the specified DataColumn of the

DataTable represented by the specified ViewNode, and provides it with the specified alias that is

used to reference the column.

Syntax




ByVal dataColumn As System.Data.DataColumn, _

ByVal columnAlias As System.String _

)

C#


ViewNode viewNode,

System.Data.DataColumn dataColumn,

System.string columnAlias

)

Parameters

viewNode


dataColumn


columnAlias


Requirements




See Also

619

Reference



Overload List

ViewModelColumn Constructor(ViewNode,String,String)




Creates a new instance of the ViewModelColumn referencing the DataColumn with the specified

name that belongs to the DataTable represented by the specified ViewNode, and provides it with

the specified alias that is used to reference the column.

Syntax




ByVal dataColumnName As System.String, _


)

C#


ViewNode viewNode,

System.string dataColumnName,


)

Parameters

viewNode


dataColumnName


columnAlias

620


Requirements




See Also

Reference



Overload List

ViewModelColumn Constructor(String,String)

The expression that is used to calculate the column value.


Creates a new instance of the ViewModelColumn class that represents a calculated column with the

specified calculation expression and alias.

Syntax



ByVal columnExpression As System.String, _


)

C#


System.string columnExpression,


)

Parameters

columnExpression

The expression that is used to calculate the column value.

621

columnAlias


Requirements




See Also

Reference



Overload List

Methods

>

Name Description

Clone Gets a copy of this ViewModelColumn.

Top

See Also

Reference



Clone Method

Gets a copy of this ViewModelColumn.

Syntax


Public Function Clone() As ViewModelColumn

C#

622

public ViewModelColumn Clone()

Requirements




See Also

Reference



Properties

For a list of all members of this type, see ViewModelColumn members.

Public Properties

Name Description

ColumnAlias Gets the alias used to reference this ViewModelColumn by name.

ColumnExpression Gets an expression used to calculate the column value in case when this

ViewModelColumn represents a calculated column.

DataColumn Gets the DataColumn repesented by this ViewModelColumn.

DataColumnName Gets the name of the DataColumn repesented by this ViewModelColumn,

or denotes all columns of ViewNode in case when its value is not set (null

or empty string).

IsCalculated Indicates wheather the ViewModelColumn represents a calculated column.

ViewNode References the ViewNode whose column(s) represented by this

ViewModelColumn.

Top

623

See Also

Reference



ColumnAlias Property

Gets the alias used to reference this ViewModelColumn by name.

Syntax


Public ReadOnly Property ColumnAlias As System.String

C#

public System.string ColumnAlias {get;}

Remarks

If this property contains an empty value while the ViewModelColumn is the item of the

C1ViewModel.ColumnsDefined collection then corresponding ViewModelColumn object of the

C1ViewModel.ColumnsEffective collection contains automatically generated value. This value is

equal to ColumnName of representing DataColumn or is some modification of it which is necessary

to ensure column name uniqueness.

Requirements




See Also

Reference



ColumnExpression Property

Gets an expression used to calculate the column value in case when this ViewModelColumn

represents a calculated column.

624

Syntax


Public ReadOnly Property ColumnExpression As System.String

C#

public System.string ColumnExpression {get;}

Requirements




See Also

Reference



DataColumn Property

Gets the DataColumn repesented by this ViewModelColumn.

Syntax


Public ReadOnly Property DataColumn As System.Data.DataColumn

C#

public System.Data.DataColumn DataColumn {get;}

Requirements




See Also

625

Reference



DataColumnName Property

Gets the name of the DataColumn repesented by this ViewModelColumn, or denotes all columns of

ViewNode in case when its value is not set (null or empty string).

Syntax


Public ReadOnly Property DataColumnName As System.String

C#

public System.string DataColumnName {get;}

Requirements




See Also

Reference



IsCalculated Property

Indicates wheather the ViewModelColumn represents a calculated column.

Syntax


Public ReadOnly Property IsCalculated As System.Boolean

C#

public System.bool IsCalculated {get;}

626

Requirements




See Also

Reference



ViewNode Property

References the ViewNode whose column(s) represented by this ViewModelColumn.

Syntax


Public ReadOnly Property ViewNode As ViewNode

C#

public ViewNode ViewNode {get;}

Remarks

This property value is never the null for non-calculated column, and the null for the calculated one.

Requirements




See Also

Reference



627

ViewModelColumnCollectionBase

Represents a base class for collections of ViewModelColumn objects.

Object Model

Syntax


Public Class ViewModelColumnCollectionBase


C#

public class ViewModelColumnCollectionBase : System.Collections.CollectionBase


System.Object


C1.C1DataExtender.ViewModelColumnCollectionBase

C1.C1DataExtender.ViewModelColumnDefinitionCollection

C1.C1DataExtender.ViewModelColumnEffectiveCollection

Requirements




See Also

Reference

ViewModelColumnCollectionBase Members


Overview

Represents a base class for collections of ViewModelColumn objects.

Object Model

628

Syntax


Public Class ViewModelColumnCollectionBase


C#

public class ViewModelColumnCollectionBase : System.Collections.CollectionBase


System.Object





Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by ViewModelColumnCollectionBase.

Public Properties

Name Description

629



Item Gets the ViewModelColumn object at the specified index.

Top

Public Methods

Name Description




Top

See Also

Reference

ViewModelColumnCollectionBase Class


Properties

For a list of all members of this type, see ViewModelColumnCollectionBase members.

Public Properties

Name Description



Item Gets the ViewModelColumn object at the specified index.

C1.C1DataExtender.2~C1.C1DataExtender.ViewModelColumnCollectionBase~Capacity.html

C1.C1DataExtender.2~C1.C1DataExtender.ViewModelColumnCollectionBase~Count.html

630

Top

See Also

Reference



Item Property

The index of the ViewModelColumn object.

Gets the ViewModelColumn object at the specified index.

Syntax




) As ViewModelColumn

C#

public ViewModelColumn this[

System.int index

]; {get;}

Parameters

index

The index of the ViewModelColumn object.

Property Value

ViewModelColumn object at the specified index.

Requirements




See Also

631

Reference



ViewModelColumnDefinitionCollection

Represents a collection of ViewModelColumn objects intended to define the list of C1ViewModel

columns.

Object Model

Syntax


Public Class ViewModelColumnDefinitionCollection

Inherits ViewModelColumnCollectionBase

C#

public class ViewModelColumnDefinitionCollection : ViewModelColumnCollectionBase


System.Object




Requirements




See Also

Reference

ViewModelColumnDefinitionCollection Members


632

Overview

Represents a collection of ViewModelColumn objects intended to define the list of C1ViewModel

columns.

Object Model

Syntax


Public Class ViewModelColumnDefinitionCollection


C#

public class ViewModelColumnDefinitionCollection : ViewModelColumnCollectionBase


System.Object




Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by ViewModelColumnDefinitionCollection.

633

Public Properties

Name Description



Item Gets the ViewModelColumn object at the specified index. (Inherited from

C1.C1DataExtender.ViewModelColumnCollectionBase)

Top

Public Methods

Name Description

Add



IndexOf

Insert

Remove


Top

See Also

Reference

ViewModelColumnDefinitionCollection Class


634

Methods

>

Name Description

Add



IndexOf

Insert

Remove


Top

See Also

Reference



Add Method

Syntax



ByVal viewColumn As ViewModelColumn _

) As System.Integer

C#


ViewModelColumn viewColumn

)

Parameters

C1.C1DataExtender.2~C1.C1DataExtender.ViewModelColumnDefinitionCollection~Clear.html

C1.C1DataExtender.2~C1.C1DataExtender.ViewModelColumnDefinitionCollection~GetEnumerator.html

C1.C1DataExtender.2~C1.C1DataExtender.ViewModelColumnDefinitionCollection~RemoveAt.html

635

viewColumn

Requirements




See Also

Reference



IndexOf Method

Syntax




) As System.Integer

C#



)

Parameters

viewColumn

Requirements




See Also

Reference

636



Insert Method

Syntax


Public Sub Insert( _

ByVal index As System.Integer, _


)

C#

public void Insert(

System.int index,


)

Parameters

index

viewColumn

Requirements




See Also

Reference



Remove Method

Syntax


637



)

C#

public void Remove(


)

Parameters

viewColumn

Requirements




See Also

Reference



ViewModelColumnEffectiveCollection

Represents a read-only collection of ViewModelColumn objects denoting actual list of

C1ViewModel columns.

Object Model

Syntax


Public Class ViewModelColumnEffectiveCollection


C#

638

public class ViewModelColumnEffectiveCollection : ViewModelColumnCollectionBase


System.Object




Requirements




See Also

Reference

ViewModelColumnEffectiveCollection Members


Overview

Represents a read-only collection of ViewModelColumn objects denoting actual list of

C1ViewModel columns.

Object Model

Syntax


Public Class ViewModelColumnEffectiveCollection


C#

public class ViewModelColumnEffectiveCollection : ViewModelColumnCollectionBase


639

System.Object




Requirements




See Also

Reference

ViewModelColumnEffectiveCollection Members


Members

Properties Methods

The following tables list the members exposed by ViewModelColumnEffectiveCollection.

Public Properties

Name Description



Item Gets the ViewModelColumn object at the specified index. (Inherited from

C1.C1DataExtender.ViewModelColumnCollectionBase)

Top

Public Methods

Name Description


640

Top

See Also

Reference

ViewModelColumnEffectiveCollection Class


ViewNode

Represents a reference to a base DataTable in the C1ViewModel.

Object Model

Syntax


Public Class ViewNode

C#

public class ViewNode


System.Object

C1.C1DataExtender.ViewNode

Requirements




See Also

Reference

ViewNode Members


641

Overview

Represents a reference to a base DataTable in the C1ViewModel.

Object Model

Syntax


Public Class ViewNode

C#

public class ViewNode


System.Object

C1.C1DataExtender.ViewNode

Requirements




See Also

Reference

ViewNode Members


Members

Properties

The following tables list the members exposed by ViewNode.

Public Constructors

Name Description

642

ViewNode Constructor Overloaded.

Top

Public Properties

Name Description

Joins Gets a collection of joins with child ViewNode objects.

ParentJoin Gets a join with parent ViewNode objects.

Table References the DataTable represented by this ViewNode.

TableAlias Gets the alias used to reference this ViewNode.

TableName Gets the name of the DataTable represented by this ViewNode.

Top

See Also

Reference

ViewNode Class


ViewNode Constructor

Overload List


ViewNode Constructor(DataTable) Creates a new instance of the ViewNode class that

represents a specified DataTable.

ViewNode Constructor(DataTable,String) Creates a new instance of the ViewNode class that

represents a specified DataTable with a specified alias

used to reference this node in the owner C1ViewModel.

643

ViewNode Constructor(String) Creates a new instance of the ViewNode class that

represents a DataTable with a specified name.

ViewNode Constructor(String,String) Creates a new instance of the ViewNode class that

represents a DataTable with a specified name and alias

used to reference this node in the owner C1ViewModel..

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

ViewNode Constructor(DataTable)

Specify a DataTable that is represented by this ViewNode.

Creates a new instance of the ViewNode class that represents a specified DataTable.

Syntax



ByVal dataTable As System.Data.DataTable _

)

C#

public ViewNode(

System.Data.DataTable dataTable

)

Parameters

dataTable

644


Remarks

Constructor should be only used to create ViewNode that will be assigned to the

C1ViewModel.RootNode property. Any other ViewNode of the C1ViewModel is created as a

ChildNode object of ViewJoin automatically when ViewJoin is being created.

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

Overload List

ViewNode Constructor(DataTable,String)


Defines an alias that is used to reference this ViewNode.

Creates a new instance of the ViewNode class that represents a specified DataTable with a specified

alias used to reference this node in the owner C1ViewModel.

Syntax



ByVal dataTable As System.Data.DataTable, _


)

C#

public ViewNode(

System.Data.DataTable dataTable,

645


)

Parameters

dataTable


tableAlias


Remarks


C1ViewModel.RootNode property. Any other ViewNode of the C1ViewModel is created

as a ChildNode object of ViewJoin automatically when ViewJoin is being created.

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

Overload List

ViewNode Constructor(String)

Defines a name of DataTable that is represented by this ViewNode.

Creates a new instance of the ViewNode class that represents a DataTable with a specified name.

Syntax



ByVal dataTableName As System.String _

)

646

C#

public ViewNode(

System.string dataTableName

)

Parameters

dataTableName


Remarks


C1ViewModel.RootNode property. Any other ViewNode of the C1ViewModel is created as a

ChildNode object of ViewJoin automatically when ViewJoin is being created.

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

Overload List

ViewNode Constructor(String,String)



Creates a new instance of the ViewNode class that represents a DataTable with a specified name

and alias used to reference this node in the owner C1ViewModel..

Syntax


647


ByVal dataTableName As System.String, _


)

C#

public ViewNode(

System.string dataTableName,


)

Parameters

dataTableName


tableAlias


Remarks


C1ViewModel.RootNode property. Any other ViewNode of the C1ViewModel is created

as a ChildNode object of ViewJoin automatically when ViewJoin is being created.

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

Overload List

Properties

For a list of all members of this type, see ViewNode members.

648

Public Properties

Name Description

Joins Gets a collection of joins with child ViewNode objects.

ParentJoin Gets a join with parent ViewNode objects.

Table References the DataTable represented by this ViewNode.

TableAlias Gets the alias used to reference this ViewNode.

TableName Gets the name of the DataTable represented by this ViewNode.

Top

See Also

Reference

ViewNode Class


Joins Property

Gets a collection of joins with child ViewNode objects.

Syntax


Public ReadOnly Property Joins As ViewJoinCollection

C#

public ViewJoinCollection Joins {get;}

Requirements




649

See Also

Reference

ViewNode Class

ViewNode Members

ParentJoin Property

Gets a join with parent ViewNode objects.

Syntax


Public ReadOnly Property ParentJoin As ViewJoin

C#

public ViewJoin ParentJoin {get;}

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

Table Property

References the DataTable represented by this ViewNode.

Syntax


Public ReadOnly Property Table As System.Data.DataTable

C#

650

public System.Data.DataTable Table {get;}

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

TableAlias Property

Gets the alias used to reference this ViewNode.

Syntax


Public Property TableAlias As System.String

C#

public System.string TableAlias {get; set;}

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

TableName Property

Gets the name of the DataTable represented by this ViewNode.

Syntax

651


Public ReadOnly Property TableName As System.String

C#

public System.string TableName {get;}

Requirements




See Also

Reference

ViewNode Class

ViewNode Members

ViewSetColumnStyle

Represents Column Style definition for C1ViewColumn - a set of properties that affects

C1ViewColumn data representation in ComponentOne user interface controls.

Object Model

Syntax


Public Class ViewSetColumnStyle

Inherits ColumnStyle

C#

public class ViewSetColumnStyle : ColumnStyle

Remarks

See Defining Column Styles topic for details.

652


System.Object




Requirements




See Also

Reference

ViewSetColumnStyle Members


Overview

Represents Column Style definition for C1ViewColumn - a set of properties that affects


Object Model

Syntax


Public Class ViewSetColumnStyle

Inherits ColumnStyle

C#

public class ViewSetColumnStyle : ColumnStyle

Remarks

See Defining Column Styles topic for details.

653


System.Object




Requirements




See Also

Reference



Members

Properties

The following tables list the members exposed by ViewSetColumnStyle.

Public Properties

Name Description

BaseColumnStyle Defines the way to determine a base style, the one that this style

properties are inherited from.


property values. (Inherited from C1.C1DataExtender.ColumnStyle)





654







(Inherited from C1.C1DataExtender.ColumnStyle)



ItemList














655






Top

See Also

Reference

ViewSetColumnStyle Class


Properties

For a list of all members of this type, see ViewSetColumnStyle members.

Public Properties

Name Description

BaseColumnStyle Defines the way to determine a base style, the one that this style

properties are inherited from.


property values. (Inherited from C1.C1DataExtender.ColumnStyle)







656





(Inherited from C1.C1DataExtender.ColumnStyle)



ItemList
















C1.C1DataExtender.2~C1.C1DataExtender.ViewSetColumnStyle~Inherit.html

657




Top

See Also

Reference



BaseColumnStyle Property

Defines the way to determine a base style, the one that this style properties are inherited from.

Syntax


Public Property BaseColumnStyle As BaseColumnStyleEnum

C#

public BaseColumnStyleEnum BaseColumnStyle {get; set;}

Remarks

Based on this property value, base column style is determined as follows:

(1) If BaseColumnStyle = BaseColumnStyleEnum.None, base column style is determined by the

BaseStyleName property. Non-empty BaseStyleName explicitly specifies a base column style from

the global C1DataViewSet.ColumnStyles and C1DataViewSet.SchemaExtender.ColumnStyles

column style collections (C1DataViewSet.ColumnStyles collection is looked up first). Empty

BaseStyleName means there is no base column style.

(2) If BaseColumnStyle = BaseColumnStyleEnum.ColumnStyleDefault, base column style is

determined by column styles mapping rules defined in C1DataViewSet.ColumnStyleRules and

C1DataViewSet.SchemaExtender.ColumnStyleRules (C1DataViewSet.ColumnStyleRules has a

priority).

(3) If BaseColumnStyle = BaseColumnStyleEnum.BaseField, base column style is the style of

corresponding C1.C1DataExtender.SchemaExtender.DataColumnExtender from

C1.C1DataExtender.2~C1.C1DataExtender.ViewSetColumnStyle~BaseStyleName.html



658

SchemaExtender. If SchemaExtender is not defined then base style is determined as described for

BaseColumnStyleEnum.ColumnStyleDefault value.

Requirements




See Also

Reference



ItemList Property

Syntax


Public Shadows ReadOnly Property ItemList As LookupItemList

C#

public new LookupItemList ItemList {get;}

Requirements




See Also

Reference



ViewSetColumnStyleCollection

Represents a collection of ViewSetGlobalColumnStyle objects for the C1DataViewSet.ColumnStyles

property.

659

Object Model

Syntax


Public Class ViewSetColumnStyleCollection

Inherits GlobalColumnStyleCollectionBase

C#

public class ViewSetColumnStyleCollection : GlobalColumnStyleCollectionBase


System.Object




Requirements




See Also

Reference

ViewSetColumnStyleCollection Members


Overview

Represents a collection of ViewSetGlobalColumnStyle objects for the C1DataViewSet.ColumnStyles

property.

Object Model

660

Syntax


Public Class ViewSetColumnStyleCollection

Inherits GlobalColumnStyleCollectionBase

C#

public class ViewSetColumnStyleCollection : GlobalColumnStyleCollectionBase


System.Object




Requirements




See Also

Reference



Members

Properties Methods

The following tables list the members exposed by ViewSetColumnStyleCollection.

Public Properties

Name Description


661


Item Overloaded. Gets a ViewSetGlobalColumnStyle at the specified index.

Top

Public Methods

Name Description

Add Adds a GlobalColumnStyleBase object in the collection. (Inherited from

C1.C1DataExtender.GlobalColumnStyleCollectionBase)



Insert Inserts a GlobalColumnStyleBase object at the specified position in the

collection. (Inherited from

C1.C1DataExtender.GlobalColumnStyleCollectionBase)


Top

See Also

Reference

ViewSetColumnStyleCollection Class


Properties

For a list of all members of this type, see ViewSetColumnStyleCollection members.

Public Properties

Name Description

662



Item Overloaded. Gets a ViewSetGlobalColumnStyle at the specified index.

Top

See Also

Reference



Item Property

Gets a ViewSetGlobalColumnStyle at the specified index.

Overload List


Item(Int32) Gets a ViewSetGlobalColumnStyle at the specified index.

Item(String) Gets a ViewSetGlobalColumnStyle with the specified name.

Requirements




See Also

Reference




An index of ViewSetGlobalColumnStyle.

C1.C1DataExtender.2~C1.C1DataExtender.ViewSetColumnStyleCollection~Capacity.html

C1.C1DataExtender.2~C1.C1DataExtender.ViewSetColumnStyleCollection~Count.html

663

Gets a ViewSetGlobalColumnStyle at the specified index.

Syntax


Public Overloads Shadows ReadOnly Property Item( _


) As ViewSetGlobalColumnStyle

C#

public new ViewSetGlobalColumnStyle Item(

System.int index

) {get;}

Parameters

index

An index of ViewSetGlobalColumnStyle.

Property Value

A ViewSetGlobalColumnStyle.

Requirements




See Also

Reference



Overload List


A name of ViewSetGlobalColumnStyle.

Gets a ViewSetGlobalColumnStyle with the specified name.

664

Syntax


Public Overloads Shadows ReadOnly Property Item( _

ByVal name As System.String _

) As ViewSetGlobalColumnStyle

C#

public new ViewSetGlobalColumnStyle Item(

System.string name

) {get;}

Parameters

name

A name of ViewSetGlobalColumnStyle.

Property Value

A ViewSetGlobalColumnStyle with the specified name if exists; otherwise, a null value.

Requirements




See Also

Reference



Overload List

ViewSetGlobalColumnStyle

Represents a global Column Style definition for C1DataViewSet - a set of properties that affects


Object Model

665

Syntax


Public Class ViewSetGlobalColumnStyle

Inherits GlobalColumnStyleBase

C#

public class ViewSetGlobalColumnStyle : GlobalColumnStyleBase

Remarks

The style objects represented by this class are items of C1DataViewSet.ColumnStyles collection.

These styles are used as base styles for the C1ViewColumn.ColumnStyle styles. These styles, in turn,

can inherit their values from styles defined in the C1DataViewSet.SchemaExtender.ColumnStyles

collection.


System.Object




Requirements




See Also

Reference

ViewSetGlobalColumnStyle Members


Overview

Represents a global Column Style definition for C1DataViewSet - a set of properties that affects


666

Object Model

Syntax


Public Class ViewSetGlobalColumnStyle

Inherits GlobalColumnStyleBase

C#

public class ViewSetGlobalColumnStyle : GlobalColumnStyleBase

Remarks

The style objects represented by this class are items of C1DataViewSet.ColumnStyles collection.

These styles are used as base styles for the C1ViewColumn.ColumnStyle styles. These styles, in turn,

can inherit their values from styles defined in the C1DataViewSet.SchemaExtender.ColumnStyles

collection.


System.Object




Requirements




See Also

Reference



667

Members

Properties

The following tables list the members exposed by ViewSetGlobalColumnStyle.

Public Constructors

Name Description

ViewSetGlobalColumnStyle Constructor

Top

Public Properties

Name Description

BaseStyleName Defines a name of a base global style of the

C1.C1DataExtender.SchemaExtender.DataSetExtender.ColumnStyles

collection from which this style inherits its property values.











668












Name (Inherited from C1.C1DataExtender.GlobalColumnStyleBase)












Top

669

See Also

Reference

ViewSetGlobalColumnStyle Class


ViewSetGlobalColumnStyle Constructor

Syntax



C#

public ViewSetGlobalColumnStyle()

Requirements




See Also

Reference



Properties

For a list of all members of this type, see ViewSetGlobalColumnStyle members.

Public Properties

Name Description

BaseStyleName Defines a name of a base global style of the

C1.C1DataExtender.SchemaExtender.DataSetExtender.ColumnStyles

collection from which this style inherits its property values.

670






















Name (Inherited from C1.C1DataExtender.GlobalColumnStyleBase)


671











Top

See Also

Reference



BaseStyleName Property

Defines a name of a base global style of the

C1.C1DataExtender.SchemaExtender.DataSetExtender.ColumnStyles collection from which this

style inherits its property values.

Syntax


Public Property BaseStyleName As System.String

C#

public System.string BaseStyleName {get; set;}

Requirements

672




See Also

Reference



Inherit Property

Defines what style properties inherit their values from the base style.

Syntax


Public Property Inherit As ColumnStylePropertyFlags

C#

public ColumnStylePropertyFlags Inherit {get; set;}

Requirements




See Also

Reference



Enumerations

AutoFetchModeEnum

Describes the possible autofetching modes.

Syntax

673


Public Enum AutoFetchModeEnum

Inherits System.Enum

C#

public enum AutoFetchModeEnum : System.Enum

Members

Member Description

Default Indicates that autofetching mode is the same as for owning object.

No Autofetching is turned off.

Yes Autofetching is turned on.

YesIfNoData Fetch is performed only if corresponding DataTables has not been filled with

data before.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.AutoFetchModeEnum

Requirements




See Also

Reference


674

AutoFetchParentsModeEnum

Describes the possible autofetching modes for orphan rows' parents.

Syntax


Public Enum AutoFetchParentsModeEnum


C#

public enum AutoFetchParentsModeEnum : System.Enum

Members

Member Description

Default Indicates that autofetching mode is specified in DataSet Extender.

No Autofetching is turned off.

Yes Autofetching is turned on.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.AutoFetchParentsModeEnum

Requirements




See Also

Reference


675

BaseColumnStyleEnum

Defines the possible types of base column style determination strategies.

Syntax


Public Enum BaseColumnStyleEnum


C#

public enum BaseColumnStyleEnum : System.Enum

Members

Member Description

BaseField Base column style is in a corresponding

C1.C1DataExtender.SchemaExtender.DataColumnExtender.

ColumnStyleDefault Base column style is determined by style mapping rules.

None Base column style is defined explicitly.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.BaseColumnStyleEnum

Requirements




See Also

Reference

676


C1CurrentChangedReasonEnum

This enum contains members specifying the reason for the triggering of

C1DataViewSet.CurrentChanged and C1DataView.CurrentChanged events.

Syntax


Public Enum C1CurrentChangedReasonEnum


C#

public enum C1CurrentChangedReasonEnum : System.Enum

Members

Member Description

AnotherCurrentRow Another row became the current one.

ColumnValueChange Some column values of current row have been changed.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.C1CurrentChangedReasonEnum

Requirements




See Also

Reference


677

C1ViewRowActionEnum

Describes an action performed on a C1ViewRow.

Syntax


Public Enum C1ViewRowActionEnum


C#

public enum C1ViewRowActionEnum : System.Enum

Members

Member Description

Add Row has been added to the view.

Change Row values have been changed.

Delete Row has been deleted from the view.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.C1ViewRowActionEnum

Requirements




See Also

Reference


678

ColumnStylePropertyFlags

Enumerates inheritable properties of column style.

Syntax


Public Enum ColumnStylePropertyFlags


C#

public enum ColumnStylePropertyFlags : System.Enum

Members

Member Description

DateTimeInput

DecimalLength

EditMask

Format

HorizontalAlignment

InheritAll All the properties are inherited.

InheritNone None of the properties are inherited.

IntegralLength

ItemList

ItemListType

679

ItemListValidate

NullText

NumericAutoMask

NumericInput

Visible

Width


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.ColumnStylePropertyFlags

Requirements




See Also

Reference


ColumnStyleRuleEnum

Syntax


Public Enum ColumnStyleRuleEnum


C#

680

public enum ColumnStyleRuleEnum : System.Enum

Members

Member Description

ForeignKey

PrimaryKey

TypeBased


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.ColumnStyleRuleEnum

Requirements




See Also

Reference


DataAccessModeEnum

Syntax


Public Enum DataAccessModeEnum


C#

681

public enum DataAccessModeEnum : System.Enum

Members

Member Description

Static

VirtualKeySet


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.DataAccessModeEnum

Requirements




See Also

Reference


DuplicateKeyOccurenceEnum

Describes a place of a row in a list of rows with the same key.

Syntax


Public Enum DuplicateKeyOccurenceEnum


C#

public enum DuplicateKeyOccurenceEnum : System.Enum

682

Members

Member Description

Accidental A row place in the list is not guaranteed.

First The first row of the list.

Last The last row of the list.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.DuplicateKeyOccurenceEnum

Requirements




See Also

Reference


EomOperatorEnum

Syntax


Public Enum EomOperatorEnum


C#

public enum EomOperatorEnum : System.Enum

Members

683

Member Description

And

Divide

Equal

GreaterThan

GreaterThanOrEqual

LessThan

LessThanOrEqual

Minus

Multiply

Not

NotEqual

Or

Plus


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.EomOperatorEnum

Requirements

684




See Also

Reference


EomSpecialSqlFunctionEnum

Syntax


Public Enum EomSpecialSqlFunctionEnum


C#

public enum EomSpecialSqlFunctionEnum : System.Enum

Members

Member Description

IsNotNull

IsNull

Like

No

NotLike


System.Object

System.ValueType

685

System.Enum

C1.C1DataExtender.EomSpecialSqlFunctionEnum

Requirements




See Also

Reference


HorizontalAlignmentEnum

Defines the possible types of text alignment.

Syntax


Public Enum HorizontalAlignmentEnum


C#

public enum HorizontalAlignmentEnum : System.Enum

Members

Member Description

Center Aligns text to the center.

Far Aligns cell text to the far side (right side in left-to-right mode).

General Sets text to be left-aligned and numbers to be right-aligned.

Justify Spreads text throughout.

686

Near Aligns text to the near side (left side in left-to-right mode).


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.HorizontalAlignmentEnum

Requirements




See Also

Reference


IdentityColumnRetrieveModeEnum

Describes the possible moments when

DataConnectionExtenderBase.IdentityColumnLastValueSelect statement must be passed to a

database server.

Syntax


Public Enum IdentityColumnRetrieveModeEnum


C#

public enum IdentityColumnRetrieveModeEnum : System.Enum

Members

Member Description

AfterInsertCommand Statement is passed after INSERT statement.

687

BeforeInsertCommand Statement is passed before INSERT statement.

InInsertCommand Statement is passed in one batch with INSERT statement.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.IdentityColumnRetrieveModeEnum

Requirements




See Also

Reference


ItemListTypeEnum

Defines the possible types of item list for a column style.

Syntax


Public Enum ItemListTypeEnum


C#

public enum ItemListTypeEnum : System.Enum

Members

Member Description

688

FixedLookup List of items is explicitly defined by the ColumnStyleBase.ItemList property. The

list is treated as a lookup, that is, ItemList[i].Value defines a column value, and

ItemList[i].DisplayValue defines its display string presentation.

FixedValues List of items is explicitly defined by the ColumnStyleBase.ItemList property. The

Value property of each item defines both column value and display value.

DisplayValue is ignored.

ForeignKey ColumnStyleBase.ItemList is built dynamically at run time. It contains values and

display values from the parent table corresponding to this foreign key column.

If this field is not a foreign key, then this value is treated as None.

None There is no item list for this column.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.ItemListTypeEnum

Requirements




See Also

Reference


JoinSemanticsEnum

Specify the possible types of ViewJoin semantics.

Syntax


689

Public Enum JoinSemanticsEnum


C#

public enum JoinSemanticsEnum : System.Enum

Members

Member Description

Lookup Join is lookup.

Main Join is main.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.JoinSemanticsEnum

Requirements




See Also

Reference


JoinTypeEnum

Specify the possible types of ViewJoin.

Syntax


Public Enum JoinTypeEnum

690


C#

public enum JoinTypeEnum : System.Enum

Members

Member Description

Inner Inner join, which corresponds to SQL Inner join.

Outer Outer join, which corresponds to SQL Outer join.


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.JoinTypeEnum

Requirements




See Also

Reference


VirtualModeEnum

Defines the possible Virtual Modes of a view.

Syntax


Public Enum VirtualModeEnum


691

C#

public enum VirtualModeEnum : System.Enum

Members

Member Description

KeySet Virtual KeySet mode is used

None Virtual Mode is not used


System.Object

System.ValueType

System.Enum

C1.C1DataExtender.VirtualModeEnum

Requirements




See Also

Reference


Interfaces

IRowAccessor

This interface is necessary to pass CompositeViewRow (which is internal) to expression

implementation class, which is situated in another assembly.

Object Model

Syntax

692


Public Interface IRowAccessor

C#

public interface IRowAccessor

Requirements




See Also

Reference

IRowAccessor Members


Overview

This interface is necessary to pass CompositeViewRow (which is internal) to expression

implementation class, which is situated in another assembly.

Object Model

Syntax


Public Interface IRowAccessor

C#

public interface IRowAccessor

Requirements




693

See Also

Reference



Members

Properties

The following tables list the members exposed by IRowAccessor.

Public Properties

Name Description

Item

Top

See Also

Reference

IRowAccessor Interface


Properties

For a list of all members of this type, see IRowAccessor members.

Public Properties

Name Description

Item

Top

See Also

Reference



694

Item Property

Syntax


ReadOnly Default Property Item( _


) As System.Object

C#

System.object this[


]; {get;}

Parameters

columnName

Requirements




See Also

Reference



Delegates

C1ViewColumnCalculateEventHandler

The source of the event.

Event data.

Represents the method that handles the C1DataView.CalculateColumn event.

Syntax


695

Public Delegate Sub C1ViewColumnCalculateEventHandler( _

ByVal sender As System.Object, _

ByVal e As C1ViewColumnCalculateEventArgs _

)

C#

public delegate void C1ViewColumnCalculateEventHandler(

System.object sender,

C1ViewColumnCalculateEventArgs e

)

Parameters

sender


e

Event data.

Requirements




See Also

Reference

C1ViewColumnCalculateEventHandler Members


C1ViewColumnChangeEventHandler


Event data.

Represents the method that handles the C1DataViewSet.ColumnChanging,

C1DataViewSet.ColumnChanged, C1DataView.ColumnChanging and C1DataView.ColumnChanged

events.

Syntax

696


Public Delegate Sub C1ViewColumnChangeEventHandler( _


ByVal e As C1ViewColumnChangeEventArgs _

)

C#

public delegate void C1ViewColumnChangeEventHandler(


C1ViewColumnChangeEventArgs e

)

Parameters

sender


e

Event data.

Requirements




See Also

Reference

C1ViewColumnChangeEventHandler Members


C1ViewCurrentChangedEventHandler


Event data.

Represents the method that handles the C1DataViewSet.CurrentChanged and


697

Syntax


Public Delegate Sub C1ViewCurrentChangedEventHandler( _


ByVal e As C1ViewCurrentChangedEventArgs _

)

C#

public delegate void C1ViewCurrentChangedEventHandler(


C1ViewCurrentChangedEventArgs e

)

Parameters

sender


e

Event data.

Requirements




See Also

Reference

C1ViewCurrentChangedEventHandler Members


C1ViewFilterRowEventHandler


Event data.

Represents the method that handles the C1DataViewSet.FilterRow event.

698

Syntax


Public Delegate Sub C1ViewFilterRowEventHandler( _


ByVal e As C1ViewFilterRowEventArgs _

)

C#

public delegate void C1ViewFilterRowEventHandler(


C1ViewFilterRowEventArgs e

)

Parameters

sender


e

Event data.

Requirements




See Also

Reference

C1ViewFilterRowEventHandler Members


C1ViewListChangedEventHandler


Event data.

Represents the method that handles the ViewListChanged event.

699

Syntax


Public Delegate Sub C1ViewListChangedEventHandler( _


ByVal e As C1ViewListChangedEventArgs _

)

C#

public delegate void C1ViewListChangedEventHandler(


C1ViewListChangedEventArgs e

)

Parameters

sender


e

Event data.

Requirements




See Also

Reference

C1ViewListChangedEventHandler Members


C1ViewPositionChangedEventHandler


Event data.

Represents the method that handles the C1DataViewSet.PositionChanged event.

700

Syntax


Public Delegate Sub C1ViewPositionChangedEventHandler( _


ByVal e As C1ViewPositionChangedEventArgs _

)

C#

public delegate void C1ViewPositionChangedEventHandler(


C1ViewPositionChangedEventArgs e

)

Parameters

sender


e

Event data.

Requirements




See Also

Reference

C1ViewPositionChangedEventHandler Members


C1ViewRowAddNewEventHandler


Event data.

701

Represents the method that handles the C1DataViewSet.RowAddNew and

C1DataView.RowAddNew events.

Syntax


Public Delegate Sub C1ViewRowAddNewEventHandler( _


ByVal e As C1ViewRowAddNewEventArgs _

)

C#

public delegate void C1ViewRowAddNewEventHandler(


C1ViewRowAddNewEventArgs e

)

Parameters

sender


e

Event data.

Requirements




See Also

Reference

C1ViewRowAddNewEventHandler Members


C1ViewRowChangeEventHandler

Represents the method that handles the RowChanging, RowChanged, C1DataView.RowChanging

and C1DataView.RowChanged events.

702

Syntax


Public Delegate Sub C1ViewRowChangeEventHandler( _


ByVal e As C1ViewRowChangeEventArgs _

)

C#

public delegate void C1ViewRowChangeEventHandler(


C1ViewRowChangeEventArgs e

)

Parameters

sender

e

Requirements




See Also

Reference

C1ViewRowChangeEventHandler Members


ConnectionOpeningEventHandler


Event data.

Represents the method that handles the C1DataViewSet.ConnectionOpening event.

Syntax

703


Public Delegate Sub ConnectionOpeningEventHandler( _


ByVal e As ConnectionOpeningEventArgs _

)

C#

public delegate void ConnectionOpeningEventHandler(


ConnectionOpeningEventArgs e

)

Parameters

sender


e

Event data.

Requirements




See Also

Reference

ConnectionOpeningEventHandler Members


FilterRowEventHandler

Syntax


Public Delegate Sub FilterRowEventHandler( _


704

ByVal e As System.Data.FillErrorEventArgs _

)

C#

public delegate void FilterRowEventHandler(


System.Data.FillErrorEventArgs e

)

Parameters

sender

e

Requirements




See Also

Reference

FilterRowEventHandler Members
