smartDBforms.NET API Reference

Adillis.SmartDBForms Namespace

The root namespace for smartDBforms.NET. Contains the classes for constructing database forms.

Namespace hierarchy

Classes

Class Description
AdHocProperty The item used in the AdHocProperties collection.
BaseSmartDBControl This is the base class for SmartDBControl and SmartDBLabel. It provides the functionality for template rendering and databinding. BaseSmartDBControl requires its container to be SmartDBView. According to the CurrentMode value BaseSmartDBControl renders user interface for editing or read only user interface.
BaseSmartDBControlCustomEventArgs Argument for the CustomEvent event.
CustomCommand This is the base class for values that are past as custom commands.
CustomEvent The base class for object passed as arguments for the CustomEvent.
DataBindItem This class is the DataItem used during databinding the templates of TemplateHolder. You can use its properties in simplified data-binding operations. For example ToolTip='<%# Eval("Description") %>' and Text='<%# Bind("ValueNonNull") %>'. When simplified data-binding operations are not appropriate you can reference the current DataBindItem in this way Enabled="<%# !DataBindItem.IsReadOnly %>". This is possible because the base TemplatesUserControl provides the DataBindItem property.
FieldSchema Represents the meta data for a database field. Provides information such as DataType, AllowDBNull
NameItem The type that is used in the NateItemCollection
NameItemCollection<ItemType> A generic collection used for storing items with Name property.
OperationStatus OperationStatus displays success and error messages after SmartDBView completes a operation . The ControlIDToHandle property specifies the ID of a SmartDBView control.
OperationStatus.DataItemClass Represents the data type which is used during data binding of the SuccessTemplate and ErrorTemplate
SampleTemplateIDSelector This is a compiled template selector for the default template ascx file. It has the same implementation as the SelectTemplateID method in the standard smartDBtemplates/TemplatesStorage.ascx file.
SmartDBControl SmartDBControl generates the user interface for the database field specified by the Field property. SmartDBControl requires its container to be SmartDBView. See BaseSmartDBControl for more information. On insert and update operations SmartDBView asks SmartDBControl for the values entered by user.
SmartDBLabel SmartDBLabel generates the label user interface for the database field specified by the Field property. SmartDBLabel requires its container to be SmartDBView. See BaseSmartDBControl for more information.
SmartDBLinkedLabel This web server control accompanies SmartDBControl. SmartDBLinkedLabel serves as a placeholder for the label user interface that the referenced SmartDBControl generates. SmartDBLinkedLabel is used in cases when the label user interface for a SmartDBControl has to be displayed at another place.
SmartDBView SmartDBView is databound container, which displays the values of a single record from a data source. SmartDBView allows you to display, edit, delete and insert records.
SmartDBViewCompletedArgs This is the base class for several event argument classes, which are used to mark and database operation as completed.
SmartDBViewDeleteArgs Provides data for the ItemDeleting event. You can use the Cancel property to cancel the mode change.
SmartDBViewDeletedArgs Provides data for the ItemDeleted event.
SmartDBViewExtractedArgs Provides data for the ValuesExtracted event.
SmartDBViewInsertArgs Provides data for the ItemInserting event. You can use the Cancel property to cancel the mode change.
SmartDBViewInsertedArgs Provides data for the ItemInserted event.
SmartDBViewModeChangedArgs Provides data for the ModeChanged event
SmartDBViewModeChangingArgs Provides data for the ModeChanging event. You can use the Cancel property to cancel the mode change.
SmartDBViewSelectErrorArgs Provides data for the SelectError event.
SmartDBViewUpdateArgs Provides data for the ItemUpdating event. You can use the Cancel property to cancel the mode change.
SmartDBViewUpdatedArgs Provides data for the ItemUpdated event.
SmartPager SmartPager is a pager control. The ControlIDToPage property specifies the ID of a SmartDBView control, which SmartPager will control. SmartPager allows the user to control the current data record displayed by SmartDBView.
SmartPager.PagerDataItem Represents the data type which is used during data binding of the PagerTemplate template.
SmartPager.PagerDataItem.PageNumber Represents one page number in the group of visible page numbers.
SmartPagerPageChangingArgs Provides data for the PageChanging event. You can use the Cancel property to cancel the operation..
ValidateCustomEvent An implementation of CustomEvent. This event can be fired when the current value should be validated. If validation fails, you can set IsValid to false and set ErrorMessage to a value describing the validation problem. The template should show the error message to the user.

Interfaces

Interface Description
ITemplateSelector A class implementing this interface can be registered as compiled template selector. The compiled template selectors have the advantage that they can be used not only in runtime but in design time also.

Delegates

Delegate Description
BaseSmartDBControlCustomEventHandler Represents the method that will handle the CustomEvent event.
SmartDBViewDataBindingChildren Represents the method that handles the DataBindingChildren event of a SmartDBView control.
SmartDBViewDeletedEventHandler Represents the method that handles the ItemDeleted event of a SmartDBView control.
SmartDBViewDeleteEventHandler Represents the method that handles the ItemDeleting event of a SmartDBView control.
SmartDBViewExtractedEventHandler Represents the method that handles the ValuesExtracted event of a SmartDBView control.
SmartDBViewInsertedEventHandler Represents the method that handles the ItemInserted event of a SmartDBView control.
SmartDBViewInsertEventHandler Represents the method that handles the ItemInserting event of a SmartDBView control.
SmartDBViewModeChangedEventHandler Represents the method that handles the ModeChanged event of a SmartDBView control.
SmartDBViewModeChangingEventHandler Represents the method that handles the ModeChanging event of a SmartDBView control.
SmartDBViewSelectErrorEventHandler Represents the method that handles the SelectError event of a SmartDBView control.
SmartDBViewUpdatedEventHandler Represents the method that handles the ItemUpdated event of a SmartDBView control.
SmartDBViewUpdateEventHandler Represents the method that handles the ItemUpdating event of a SmartDBView control.
SmartPagerPageChangingEventHandler Represents the method that handles the PageChanging event of a SmartPager control.

Enumerations

Enumeration Description
ControlRenderMode Determines if the root html element of the control will be DIV or SPAN
OperationStatus.ShowUntilEnum The different ways of displaying the status message.
SmartDBView.OnEmptyDataEnum Enumeration for the different behaviour of SmartDBView when the data source returns no records
SmartDBView.StoreInitialValuesEnum The values of StoreInitialValues.
SmartDBViewMode Enumeration for the different modes of SmartDBView.
SmartPagerType Defines the different built-in user interface types for the SmartPager control.