IBindingList Rozhraní
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Poskytuje funkce potřebné k podpoře složitých i jednoduchých scénářů při vazbě ke zdroji dat.
public interface class IBindingList : System::Collections::IList
public interface IBindingList : System.Collections.IList
type IBindingList = interface
interface ICollection
interface IEnumerable
interface IList
type IBindingList = interface
interface IList
interface ICollection
interface IEnumerable
Public Interface IBindingList
Implements IList
- Odvozené
- Implementuje
Příklady
Následující příklad poskytuje jednoduchou implementaci IBindingList rozhraní. Třída CustomerList ukládá informace o zákazníci do seznamu. Tento příklad předpokládá, že jste použili Customer třídu, která se dá najít v příkladu IEditableObject ve třídě.
public ref class CustomersList: public CollectionBase, public IBindingList
{
private:
ListChangedEventArgs^ resetEvent;
ListChangedEventHandler^ onListChanged;
virtual event ListChangedEventHandler^ ListChanged;
public:
property bool AllowEdit
{
// Implements IBindingList.
virtual bool get() sealed
{
return true;
}
}
virtual property bool AllowNew
{
bool get()
{
return true;
}
}
property bool AllowRemove
{
virtual bool get()
{
return true;
}
}
property bool SupportsChangeNotification
{
virtual bool get()
{
return true;
}
}
property bool SupportsSearching
{
virtual bool get()
{
return true;
}
}
property bool SupportsSorting
{
virtual bool get()
{
return true;
}
}
// Methods.
virtual Object^ AddNew()
{
Customer^ c = gcnew Customer( this->Count->ToString() );
List->Add( c );
return c;
}
property bool IsSorted
{
// Unsupported properties.
virtual bool get()
{
throw gcnew NotSupportedException;
return false;
}
}
property ListSortDirection SortDirection
{
virtual ListSortDirection get()
{
throw gcnew NotSupportedException;
return ListSortDirection::Ascending;
}
}
property PropertyDescriptor^ SortProperty
{
virtual PropertyDescriptor^ get()
{
throw gcnew NotSupportedException;
return nullptr;
}
}
// Unsupported Methods.
virtual void AddIndex( PropertyDescriptor^ property )
{
throw gcnew NotSupportedException;
}
virtual void ApplySort( PropertyDescriptor^ property, ListSortDirection direction )
{
throw gcnew NotSupportedException;
}
virtual int Find( PropertyDescriptor^ property, Object^ key )
{
throw gcnew NotSupportedException;
return 0;
}
virtual void RemoveIndex( PropertyDescriptor^ property )
{
throw gcnew NotSupportedException;
}
virtual void RemoveSort()
{
throw gcnew NotSupportedException;
}
// Worker functions to populate the list with data.
static Customer^ ReadCustomer1()
{
Customer^ cust = gcnew Customer( "536-45-1245" );
cust->FirstName = "Jo";
cust->LastName = "Brown";
return cust;
}
static Customer^ ReadCustomer2()
{
Customer^ cust = gcnew Customer( "246-12-5645" );
cust->FirstName = "Robert";
cust->LastName = "Brown";
return cust;
}
protected:
virtual void OnListChanged( ListChangedEventArgs^ ev )
{
if ( onListChanged != nullptr )
{
onListChanged( this, ev );
}
}
virtual void OnClear() override
{
List->Clear();
}
virtual void OnClearComplete() override
{
OnListChanged( resetEvent );
}
virtual void OnInsertComplete( int index, Object^ value ) override
{
Customer^ c = safe_cast<Customer^>(value);
c->Parent = this;
OnListChanged( gcnew ListChangedEventArgs( ListChangedType::ItemAdded,index ) );
}
virtual void OnRemoveComplete( int index, Object^ value ) override
{
Customer^ c = safe_cast<Customer^>(value);
c->Parent = this;
OnListChanged( gcnew ListChangedEventArgs( ListChangedType::ItemDeleted,index ) );
}
virtual void OnSetComplete( int index, Object^ oldValue, Object^ newValue ) override
{
if ( oldValue != newValue )
{
Customer^ oldcust = safe_cast<Customer^>(oldValue);
Customer^ newcust = safe_cast<Customer^>(newValue);
oldcust->Parent = 0;
newcust->Parent = this;
OnListChanged( gcnew ListChangedEventArgs( ListChangedType::ItemAdded,index ) );
}
}
public:
// Constructor
CustomersList()
{
resetEvent = gcnew ListChangedEventArgs( ListChangedType::Reset,-1 );
}
void LoadCustomers()
{
IList^ l = static_cast<IList^>(this);
l->Add( ReadCustomer1() );
l->Add( ReadCustomer2() );
OnListChanged( resetEvent );
}
property Object^ Item [int]
{
Object^ get( int index )
{
return static_cast<Customer^>(List->Item[ index ]);
}
void set( int index, Object^ value )
{
List->Item[ index ] = value;
}
}
int Add( Customer^ value )
{
return List->Add( value );
}
Customer^ AddNew()
{
return safe_cast<Customer^>(static_cast<IBindingList^>(this)->AddNew());
}
void Remove( Customer^ value )
{
List->Remove( value );
}
internal:
// Called by Customer when it changes.
void CustomerChanged( Customer^ cust )
{
int index = List->IndexOf( cust );
OnListChanged( gcnew ListChangedEventArgs( ListChangedType::ItemChanged,index ) );
}
};
public class CustomersList : CollectionBase, IBindingList
{
readonly ListChangedEventArgs resetEvent = new(ListChangedType.Reset, -1);
ListChangedEventHandler onListChanged;
public void LoadCustomers()
{
IList l = this;
_ = l.Add(ReadCustomer1());
_ = l.Add(ReadCustomer2());
OnListChanged(resetEvent);
}
public Customer this[int index]
{
get => (Customer)List[index]; set => List[index] = value;
}
public int Add(Customer value) => List.Add(value);
public Customer AddNew() => (Customer)((IBindingList)this).AddNew();
public void Remove(Customer value) => List.Remove(value);
protected virtual void OnListChanged(ListChangedEventArgs ev) => onListChanged?.Invoke(this, ev);
protected override void OnClear()
{
foreach (Customer c in List)
{
c.Parent = null;
}
}
protected override void OnClearComplete() => OnListChanged(resetEvent);
protected override void OnInsertComplete(int index, object value)
{
Customer c = (Customer)value;
c.Parent = this;
OnListChanged(new ListChangedEventArgs(ListChangedType.ItemAdded, index));
}
protected override void OnRemoveComplete(int index, object value)
{
Customer c = (Customer)value;
c.Parent = this;
OnListChanged(new ListChangedEventArgs(ListChangedType.ItemDeleted, index));
}
protected override void OnSetComplete(int index, object oldValue, object newValue)
{
if (oldValue != newValue)
{
Customer oldcust = (Customer)oldValue;
Customer newcust = (Customer)newValue;
oldcust.Parent = null;
newcust.Parent = this;
OnListChanged(new ListChangedEventArgs(ListChangedType.ItemAdded, index));
}
}
// Called by Customer when it changes.
internal void CustomerChanged(Customer cust)
{
int index = List.IndexOf(cust);
OnListChanged(new ListChangedEventArgs(ListChangedType.ItemChanged, index));
}
// Implements IBindingList.
bool IBindingList.AllowEdit => true;
bool IBindingList.AllowNew => true;
bool IBindingList.AllowRemove => true;
bool IBindingList.SupportsChangeNotification => true;
bool IBindingList.SupportsSearching => false;
bool IBindingList.SupportsSorting => false;
// Events.
public event ListChangedEventHandler ListChanged
{
add => onListChanged += value; remove => onListChanged -= value;
}
// Methods.
object IBindingList.AddNew()
{
Customer c = new(Count.ToString());
_ = List.Add(c);
return c;
}
// Unsupported properties.
bool IBindingList.IsSorted => throw new NotSupportedException();
ListSortDirection IBindingList.SortDirection => throw new NotSupportedException();
PropertyDescriptor IBindingList.SortProperty => throw new NotSupportedException();
// Unsupported Methods.
void IBindingList.AddIndex(PropertyDescriptor property) => throw new NotSupportedException();
void IBindingList.ApplySort(PropertyDescriptor property, ListSortDirection direction) => throw new NotSupportedException();
int IBindingList.Find(PropertyDescriptor property, object key) => throw new NotSupportedException();
void IBindingList.RemoveIndex(PropertyDescriptor property) => throw new NotSupportedException();
void IBindingList.RemoveSort() => throw new NotSupportedException();
// Worker functions to populate the list with data.
static Customer ReadCustomer1() => new("536-45-1245")
{
FirstName = "Jo",
LastName = "Brown"
};
static Customer ReadCustomer2()
{
Customer cust = new("246-12-5645")
{
FirstName = "Robert",
LastName = "Brown"
};
return cust;
}
}
Public Class CustomersList
Inherits CollectionBase
Implements IBindingList
Private resetEvent As New ListChangedEventArgs(ListChangedType.Reset, -1)
Private onListChanged1 As ListChangedEventHandler
Public Sub LoadCustomers()
Dim l As IList = CType(Me, IList)
l.Add(ReadCustomer1())
l.Add(ReadCustomer2())
OnListChanged(resetEvent)
End Sub
Default Public Property Item(ByVal index As Integer) As Customer
Get
Return CType(List(index), Customer)
End Get
Set(ByVal Value As Customer)
List(index) = Value
End Set
End Property
Public Function Add(ByVal value As Customer) As Integer
Return List.Add(value)
End Function
Public Function AddNew2() As Customer
Return CType(CType(Me, IBindingList).AddNew(), Customer)
End Function
Public Sub Remove(ByVal value As Customer)
List.Remove(value)
End Sub
Protected Overridable Sub OnListChanged(ByVal ev As ListChangedEventArgs)
If (onListChanged1 IsNot Nothing) Then
onListChanged1(Me, ev)
End If
End Sub
Protected Overrides Sub OnClear()
Dim c As Customer
For Each c In List
c.parent = Nothing
Next c
End Sub
Protected Overrides Sub OnClearComplete()
OnListChanged(resetEvent)
End Sub
Protected Overrides Sub OnInsertComplete(ByVal index As Integer, ByVal value As Object)
Dim c As Customer = CType(value, Customer)
c.parent = Me
OnListChanged(New ListChangedEventArgs(ListChangedType.ItemAdded, index))
End Sub
Protected Overrides Sub OnRemoveComplete(ByVal index As Integer, ByVal value As Object)
Dim c As Customer = CType(value, Customer)
c.parent = Me
OnListChanged(New ListChangedEventArgs(ListChangedType.ItemDeleted, index))
End Sub
Protected Overrides Sub OnSetComplete(ByVal index As Integer, ByVal oldValue As Object, ByVal newValue As Object)
If oldValue <> newValue Then
Dim oldcust As Customer = CType(oldValue, Customer)
Dim newcust As Customer = CType(newValue, Customer)
oldcust.parent = Nothing
newcust.parent = Me
OnListChanged(New ListChangedEventArgs(ListChangedType.ItemAdded, index))
End If
End Sub
' Called by Customer when it changes.
Friend Sub CustomerChanged(ByVal cust As Customer)
Dim index As Integer = List.IndexOf(cust)
OnListChanged(New ListChangedEventArgs(ListChangedType.ItemChanged, index))
End Sub
' Implements IBindingList.
ReadOnly Property AllowEdit() As Boolean Implements IBindingList.AllowEdit
Get
Return True
End Get
End Property
ReadOnly Property AllowNew() As Boolean Implements IBindingList.AllowNew
Get
Return True
End Get
End Property
ReadOnly Property AllowRemove() As Boolean Implements IBindingList.AllowRemove
Get
Return True
End Get
End Property
ReadOnly Property SupportsChangeNotification() As Boolean Implements IBindingList.SupportsChangeNotification
Get
Return True
End Get
End Property
ReadOnly Property SupportsSearching() As Boolean Implements IBindingList.SupportsSearching
Get
Return False
End Get
End Property
ReadOnly Property SupportsSorting() As Boolean Implements IBindingList.SupportsSorting
Get
Return False
End Get
End Property
' Events.
Public Event ListChanged As ListChangedEventHandler Implements IBindingList.ListChanged
' Methods.
Function AddNew() As Object Implements IBindingList.AddNew
Dim c As New Customer(Me.Count.ToString())
List.Add(c)
Return c
End Function
' Unsupported properties.
ReadOnly Property IsSorted() As Boolean Implements IBindingList.IsSorted
Get
Throw New NotSupportedException()
End Get
End Property
ReadOnly Property SortDirection() As ListSortDirection Implements IBindingList.SortDirection
Get
Throw New NotSupportedException()
End Get
End Property
ReadOnly Property SortProperty() As PropertyDescriptor Implements IBindingList.SortProperty
Get
Throw New NotSupportedException()
End Get
End Property
' Unsupported Methods.
Sub AddIndex(ByVal prop As PropertyDescriptor) Implements IBindingList.AddIndex
Throw New NotSupportedException()
End Sub
Sub ApplySort(ByVal prop As PropertyDescriptor, ByVal direction As ListSortDirection) Implements IBindingList.ApplySort
Throw New NotSupportedException()
End Sub
Function Find(ByVal prop As PropertyDescriptor, ByVal key As Object) As Integer Implements IBindingList.Find
Throw New NotSupportedException()
End Function
Sub RemoveIndex(ByVal prop As PropertyDescriptor) Implements IBindingList.RemoveIndex
Throw New NotSupportedException()
End Sub
Sub RemoveSort() Implements IBindingList.RemoveSort
Throw New NotSupportedException()
End Sub
' Worker functions to populate the list with data.
Private Shared Function ReadCustomer1() As Customer
Dim cust As New Customer("536-45-1245")
cust.FirstName = "Jo"
cust.LastName = "Brown"
Return cust
End Function
Private Shared Function ReadCustomer2() As Customer
Dim cust As New Customer("246-12-5645")
cust.FirstName = "Robert"
cust.LastName = "Brown"
Return cust
End Function
End Class
Poznámky
Toto rozhraní je implementováno DataView třídou. Implementace metody by měla vykazovat stejné chování jako implementace této metody ve DataView třídě.
Při volání ApplySort metod nebo RemoveSort metod byste měli vyvolat ListChanged událost s výčtem Reset .
Při volání AddNew metody byste měli vyvolat ListChanged událost s ItemAdded výčtem, který obsahuje příslušný index. Přidaný řádek je ve stavu, kdy stisknutím klávesy ESC na ovládacím DataGridView prvku můžete nový řádek odebrat. ListChanged Zvýšení události s výčtem ItemAdded podruhé na tomto řádku označuje, že položka je nyní řádek, který není ve stavu "nový".
Když odeberete položku nebo zavoláte metodu CancelEdit na novém řádku (pokud tento řádek implementuje IEditableObject), měli byste vyvolat ListChanged událost s výčtem ItemDeleted obsahujícím příslušný index.
Vlastnosti
| Name | Description |
|---|---|
| AllowEdit |
Získá, zda lze aktualizovat položky v seznamu. |
| AllowNew |
Získá zda lze přidat položky do seznamu pomocí AddNew(). |
| AllowRemove |
Získá, zda lze odebrat položky ze seznamu, pomocí Remove(Object) nebo RemoveAt(Int32). |
| Count |
Získá počet prvků obsažených v ICollection. (Zděděno od ICollection) |
| IsFixedSize |
Získá hodnotu určující, zda IList má pevnou velikost. (Zděděno od IList) |
| IsReadOnly |
Získá hodnotu určující, zda je jen pro IList čtení. (Zděděno od IList) |
| IsSorted |
Získá, zda jsou položky v seznamu seřazeny. |
| IsSynchronized |
Získá hodnotu označující, zda je přístup k ICollection této synchronizaci (bezpečné vlákno). (Zděděno od ICollection) |
| Item[Int32] |
Získá nebo nastaví prvek v zadaném indexu. (Zděděno od IList) |
| SortDirection |
Získá směr řazení. |
| SortProperty |
PropertyDescriptor Získá tu, která se používá k řazení. |
| SupportsChangeNotification |
Získá, zda ListChanged je událost vyvolána při změně seznamu nebo položky v seznamu změn. |
| SupportsSearching |
Získá zda seznam podporuje vyhledávání pomocí Find(PropertyDescriptor, Object) metody. |
| SupportsSorting |
Získá, zda seznam podporuje řazení. |
| SyncRoot |
Získá objekt, který lze použít k synchronizaci přístupu k ICollection. (Zděděno od ICollection) |
Metody
| Name | Description |
|---|---|
| Add(Object) |
Přidá položku do objektu IList. (Zděděno od IList) |
| AddIndex(PropertyDescriptor) |
PropertyDescriptor Přidá indexy použité k vyhledávání. |
| AddNew() |
Přidá do seznamu novou položku. |
| ApplySort(PropertyDescriptor, ListSortDirection) |
Seřadí seznam podle a PropertyDescriptorListSortDirection. |
| Clear() |
Odebere všechny položky z IList. (Zděděno od IList) |
| Contains(Object) |
Určuje, zda IList obsahuje konkrétní hodnotu. (Zděděno od IList) |
| CopyTo(Array, Int32) |
Zkopíruje prvky do objektu ICollectionArray, počínaje konkrétním Array indexem. (Zděděno od ICollection) |
| Find(PropertyDescriptor, Object) |
Vrátí index řádku, který má danou PropertyDescriptorhodnotu . |
| GetEnumerator() |
Vrátí enumerátor, který iteruje kolekcí. (Zděděno od IEnumerable) |
| IndexOf(Object) |
Určuje index konkrétní položky v objektu IList. (Zděděno od IList) |
| Insert(Int32, Object) |
Vloží položku do IList v zadaném indexu. (Zděděno od IList) |
| Remove(Object) |
Odebere první výskyt konkrétního objektu z objektu IList. (Zděděno od IList) |
| RemoveAt(Int32) |
Odebere IList položku v zadaném indexu. (Zděděno od IList) |
| RemoveIndex(PropertyDescriptor) |
Odebere PropertyDescriptor z indexů použitých k hledání. |
| RemoveSort() |
Odebere jakékoli řazení použité pomocí ApplySort(PropertyDescriptor, ListSortDirection). |
Událost
| Name | Description |
|---|---|
| ListChanged |
Nastane, když se změní seznam nebo položka v seznamu se změní. |
Metody rozšíření
| Name | Description |
|---|---|
| AsParallel(IEnumerable) |
Umožňuje paralelizaci dotazu. |
| AsQueryable(IEnumerable) |
Převede IEnumerable na IQueryable. |
| Cast<TResult>(IEnumerable) |
Přetypuje prvky IEnumerable na zadaný typ. |
| OfType<TResult>(IEnumerable) |
Filtruje prvky IEnumerable na základě zadaného typu. |