Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the delegate that handles the BindingComplete event.

public delegate void BindingCompleteEventHandler(Object sender, BindingCompleteEventArgs e)

Public Delegate Sub BindingCompleteEventHandler(ByVal sender As [Object], ByVal e As BindingCompleteEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the simple binding between the property value of an object and the property value of a IBindableComponent.

public class Binding : Binding, IBinding

Public Class Binding
    Inherits Binding
    Implements IBinding

Constructors

Binding(propertyName, dataSource, dataMember)

Initializes a new instance of the Binding class that simple-binds the indicated control property to the specified data member of the data source.

Throws:

• Exception propertyName is neither a valid property of a control nor an empty string ("").

• ArgumentException The property given by propertyName does not exist on the control.

Binding(propertyName, dataSource, dataMember, formattingEnabled)

Initializes a new instance of the Binding class that binds the indicated control property to the specified data member of the data source, and optionally enables formatting to be applied.

Throws:

• ArgumentException The property given by propertyName does not exist on the control; or the property given is a read-only property.

• Exception Formatting is disabled and propertyName is neither a valid property of a control nor an empty string ("").

Initializes a new instance of the Binding class that binds the specified control property to the specified data member of the specified data source. Optionally enables formatting and propagates values to the data source based on the specified update setting.

Throws:

• ArgumentException The property given by propertyName does not exist on the control; or the data source or data member or control property specified are associated with another binding in the collection.

Initializes a new instance of the Binding class that binds the indicated control property to the specified data member of the specified data source. Optionally enables formatting, propagates values to the data source based on the specified update setting, and sets the property to the specified value when a DBNull is returned from the data source.

Throws:

• ArgumentException The property given by propertyName does not exist on the control; or the data source or data member or control property specified are associated with another binding in the collection.

Initializes a new instance of the Binding class that binds the specified control property to the specified data member of the specified data source. Optionally enables formatting with the specified format string; propagates values to the data source based on the specified update setting; and sets the property to the specified value when a DBNull is returned from the data source.

Throws:

• ArgumentException The property given by propertyName does not exist on the control; or the data source or data member or control property specified are associated with another binding in the collection.

Initializes a new instance of the Binding class with the specified control property to the specified data member of the specified data source. Optionally enables formatting with the specified format string; propagates values to the data source based on the specified update setting; enables formatting with the specified format string; sets the property to the specified value when a DBNull is returned from the data source; and sets the specified format provider.

Throws:

• ArgumentException The property given by propertyName does not exist on the control; or the data source or data member or control property specified are associated with another binding in the collection.

Properties

IBindableComponent: Returns the IBindableComponent this Binding is associated with. (Default: null)

BindingMemberInfo: Return the binding information based on the dataMember parameter in the #ctor constructor.

Control: Returns the control that the binding belongs to. (Default: null)

ControlUpdateMode: Returns or sets when changes to the data source are propagated to the bound control property. (Default: OnPropertyChanged)

Object: Returns the data source for this binding.

Object: Returns or sets the value to be stored in the data source if the control value is null or empty.

DataSourceUpdateMode: Returns or sets a value that indicates when changes to the bound control property are propagated to the data source. (Default: OnValidation)

IFormatProvider: Returns or sets the IFormatProvider that provides custom formatting behavior. (Default: null)

String: Returns or sets the format specifier characters that indicate how a value is to be displayed.

Boolean: Returns or sets a value indicating whether type conversion and formatting is applied to the control property data. (Default: False)

Boolean: Returns whether the binding is active.

Object: Returns or sets the Object to be set as the control property when the data source contains a DBNull value.

String: Returns the name of the control's data-bound property. (Default: "")

Methods

Sets the control property to the value read from the data source.

Reads the current value from the control property and writes it to the data source.

Events

BindingCompleteEventHandler Fired when the FormattingEnabled property true and a binding operation is completed.

ConvertEventHandler Fired when the property of a control is bound to a data value.

ConvertEventHandler Fired when the value of a data-bound control changes.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that will handle the event.

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Manages the collection of objects for any object that inherits from the class.

Constructors

BindingContext()

Creates a new instance of .

Properties

IsReadOnly

: Returns whether the collection is read-only.

Item(dataSource)

: Returns the that is associated with the data source.

Item(dataSource, dataMember)

Throws:

Methods

Events

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Implements the ICommand interface wrapping execute and canExecute actions.

public class Command : ICommand

Public Class Command
    Inherits ICommand

You can use this class and Command to wrap custom commands to bind to controls that implement the ICommandSource interface. A view model class can expose as many commands as you like. You can bind (or assign) a command to the Command property (see Command for example).

public CommandDemoViewModel : INotifyPropertyChanged
{
  public event PropertyChangedEventHandler PropertyChanged;
  
  public int Number { ... }
  
  public Wisej.Web.ICommand AddCommand { get; }
  
  public CommandDemoViewModel()
  {
    this.AddCommand = new Command(args => this.Number++);
    
    // Or
    this.AddCommand = new Command(
      execute: args => this.Number++,
      canExecute: args => this.Number < 10
    );
  }
}

Now you can use data binding or a code assignment to connect the view model's Add command to a button's Command property.

Constructors

Initializes a new Command wrapping am execute method and an canExecute method.

Initializes a new Command wrapping am execute method and an canExecute method.

Methods

Executes a method that determines whether the command can execute in its current state.

Returns: Boolean. true if this command can be executed; otherwise, false.

Executes the command method.

Fires the CanExecuteChanged event.

Events

EventHandler Fired when the result of the CanExecute method changes.

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Manages all Binding objects that are bound to the same data source and data member.

public class BindingManagerBase

Public Class BindingManagerBase

Properties

Bindings

BindingsCollection: Returns the collection of bindings being managed.

Count

Int32: Returns the number of items in the list.

Current

Object: Returns the current item in the list.

IsBindingSuspended

Boolean: Returns whether binding is suspended.

Position

Int32: Returns or sets the position of the data binding source within the list.

Methods

Adds a new item to the underlying list.

Throws:

• NotSupportedException The underlying data source does not implement IBindingList, or the data source has thrown an exception because the user has attempted to add a row to a read-only or fixed-size DataView.

Cancels the current edit operation.

Ends the current edit operation.

Returns the property descriptor collection for the underlying list.

Returns: PropertyDescriptorCollection. A PropertyDescriptorCollection for the list.

Removes the item at the specified index.

Throws:

• IndexOutOfRangeException There is no row at the specified index .

Causes a control bound to this data source to re-read the current item and refresh the displayed value.

Causes a control bound to this data source to re-read the item at the specified itemIndex and refresh the displayed value.

Resumes data binding.

Suspends data binding to prevents changes from updating the bound data source.

Reads the current values from the data source and sends them to the control.

Events

BindingCompleteEventHandler Fired at the completion of a data-binding operation.

EventHandler Fired when the currently bound item changes.

EventHandler Fired when the state of the currently bound item changes.

BindingManagerDataErrorEventHandler Fired when an Exception is silently handled by the BindingManagerBase.

EventHandler Fired after the value of the Position property has changed.

Inherited By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Indicates the result of a binding operation.

public enum BindingCompleteState : Enum

Public Enum BindingCompleteState As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents typed data passed to .

Parameters

Constructors

CommandArgs()

Initializes a new .

CommandArgs(args)

Initializes a new .

Properties

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.

Constructors

BindingNavigator(bindingSource)

Initializes a new instance of the class with the specified as the data source.

BindingNavigator(addStandardItems)

Initializes a new instance of the class, indicating whether to display the standard navigation user interface (UI).

Properties

When the control is docked, this property is managed automatically.

Methods

Disables updates to the controls of during the component's initialization.

Enables updates to the controls after the component's initialization has completed.

Causes validation to occur and returns whether validation was successful.

Events

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Implements the interface wrapping execute and canExecute actions.

You can use this class to wrap custom commands to bind to controls that implement the interface and need to access the typed data source records. In the snippet below, the CommandDemoViewModel class derives from BindingList<Customer> and allows the commands to directly interact with the typed property.

Parameters

Constructors

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Contains information that enables a to resolve a data binding to either the property of an object or the property of the current object in a list of objects.

Constructors

BindingMemberInfo(dataMember)

Initializes a new instance of the class.

Properties

BindingField

: Returns the property name of the data-bound object.

BindingMember

: Returns the information that is used to specify the property name of the data-bound object.

BindingPath

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Specifies the direction of the binding operation.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Base for the specialized convert event handlers.

public class ConvertEventArgs : EventArgs

Public Class ConvertEventArgs
    Inherits EventArgs

Constructors

ConvertEventArgs(value, desiredType)

Initializes a new instance of the ConvertEventArgs class.

Properties

DesiredType

Type: Returns the data type of the desired value.

Value

Object: Returns or sets the value of the ConvertEventArgs.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the BindingComplete event.

public class BindingCompleteEventArgs : CancelEventArgs

Public Class BindingCompleteEventArgs
    Inherits CancelEventArgs

Constructors

BindingCompleteEventArgs(binding, state, context, errorText, exception, cancel)

Initializes a new instance of the BindingCompleteEventArgs class with the specified binding, error state and text, binding context, exception, and whether the binding should be canceled.

BindingCompleteEventArgs(binding, state, context, errorText, exception)

Initializes a new instance of the BindingCompleteEventArgs class with the specified binding, error state and text, binding context, and exception.

Initializes a new instance of the BindingCompleteEventArgs class with the specified binding, error state and text, and binding context.

Initializes a new instance of the BindingCompleteEventArgs class with the specified binding, error state, and binding context.

Properties

Binding: Returns the binding associated with this occurrence of a BindingComplete event.

BindingCompleteContext: Returns the direction of the binding operation.

BindingCompleteState: Returns the completion state of the binding operation.

String: Returns the text description of the error that occurred during the binding operation.

Exception: Returns the exception that occurred during the binding operation.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Encapsulates the data source for a data-bound component.

Constructors

BindingSource()

Initializes a new instance of the class to the default property values.

BindingSource(container)

Initializes a new instance of the class and adds the to the specified container.

BindingSource(dataSource, dataMember)

Initializes a new instance of the class with the specified data source and data member.

BindingSource(dataSource)

Properties

Throws:

Throws:

• Negative values are treated as 0.

This option fixes a long standing "feature" of the default BindingSource where the property that is the source of a value change is not refreshed automatically after it updates the bound data source. In a scenario where the data source "transforms" the value received from a data-bound control, the source property is not updated while all other bound properties are.

Methods

Sorts the data source using the specified property descriptor and sort direction.

Sorts the data source with the specified sort descriptions.

Cancels the current edit operation.

Removes all elements from the list.

Applies pending changes to the underlying data source.

Returns the index of the item in the list with the specified propertyName and value .

Throws:

Searches for the index of the that has the given value in the specified property .

Throws:

Returns the name of the list supplying data for the binding operations.

Throws:

Throws:

Resumes data binding.

Suspends data binding to prevent changes from updating the data-bound data source.

Events

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the method that handles the and events of a .

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the collection of data bindings for a .

Constructors

ControlBindingsCollection(component)

Initializes a new instance of the class with the specified bindable control.

Properties

BindableComponent

: Returns the associated the binding collection.

Control

: Returns the that the collection belongs to.

DefaultDataSourceUpdateMode

Throws:

Methods

Throws:

Throws:

Creates a binding with the specified control property name, data source, data member, and information about whether formatting is enabled, and adds the binding to the collection.

Throws:

Creates a binding with the specified control property name, data source, data member, and information about whether formatting is enabled, and adds the binding to the collection.

Throws:

Creates a binding with the specified control property name, data source, data member, and information about whether formatting is enabled, and adds the binding to the collection.

Throws:

Creates a binding that binds the specified control property to the specified data member of the specified data source, optionally enabling formatting, propagating values to the data source based on the specified update setting, and adding the binding to the collection.

Throws:

Throws:

Throws:

Throws:

Removes all bindings in the collection.

Throws:

Throws:

Events

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents data passed to .

Constructors

CommandArgs(dataItem, commandSource, bindingContext, currencyManager)

Initializes a new instance of .

All arguments are optional.

Properties

BindingContext

: Returns or sets the current .

Inherited By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Keeps data-bound controls synchronized with each other: showing data from the same record.

Properties

Count

: Returns the number of items in the list.

Current

: Returns the current item in the list.

List

: Returns the list for this .

Position

Methods

Adds a new item to the underlying list.

Throws:

Forces a refresh of the data-bound list.

Causes a control bound to this data source to re-read the current item and refresh the displayed value.

Causes a control bound to this data source to re-read the item at the specified itemIndex and refresh the displayed value.

Resumes data binding.

Suspends data binding to prevents changes from updating the bound data source.

Events

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Defines a component's binding instance.

Properties

BindableComponent

: Returns the .

BindingMemberInfo

: Return the binding information based on the dataMember parameter in the constructor.

ControlUpdateMode

: Returns or sets when changes to the data source are propagated to the bound control property.

DataSource

: Returns the data source for this binding.

DataSourceNullValue

Methods

Sets the target property to the value read from the data source.

Reads the current value from the target property and writes it to the data source.

Implemented By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Specifies when a data source is updated when the bound control properties are changed.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Bindable components implement this interface.

Properties

BindingContext

: Returns or sets the collection of currency managers for the .

DataBindings

: Returns the collection of data-binding objects for this .

HasBindingContext

: Returns whether the has its own .

Owner

: Returns or sets the owner of this component.

Implemented By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents a collection of objects for a control.

Properties

Count

: Returns the total number of bindings in the collection.

Item(index)

: Returns the at the specified index.

Throws:

• The collection doesn't contain an item at the specified index.

Methods

ReadValues()

Reads the current values from the data source and sends them to the control.

Takes the current values from the control and writes them to the data source.

Events

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the DataError event.

Constructors

BindingManagerDataErrorEventArgs(exception)

Initializes a new instance of the class.

Properties

Exception

: Returns the caught in the binding process.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Supports the implementations.

Methods

RefreshCommands()

Causes all the components to refresh their commands by invoking the method.

Events

CanExecute

Fired when a invokes its command's method.

Execute

Fired when a invokes its command's method.