Class VisuallyInheritableList
An ArrayListExt derived class that supports creating "visually inheritable lists".
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Collections
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class VisuallyInheritableList : ArrayListExt, IList, ICollection, IEnumerable, ICloneable
Remarks
A "visually inheritable list" is one that keeps track of and persists in code, the incremental changes applied on the list in a derived class's designer.
You should typically not use the methods and properties exposed by this class in your code. The properties are meant to be used during design-time to store the incremental changes done at design-time.
Constructors
VisuallyInheritableList()
Overloaded. Creates a new instance of the VisuallyInheritableList without any support for visual inheritance.
Declaration
public VisuallyInheritableList()
VisuallyInheritableList(IDesignable)
Creates a new instance of the VisuallyInheritableList with support for visual inheritance provided based on the specified parent's design state.
Declaration
public VisuallyInheritableList(IDesignable parent)
Parameters
Type | Name | Description |
---|---|---|
IDesignable | parent | A reference to the IDesignable interface that typically contains this collection. |
Remarks
This list keeps track of the incremental changes happening in a designer by following the parent's DesignMode property.
VisuallyInheritableList(Object[])
Creates a new instance of the VisuallyInheritableList class and inserts the items specified in the array into the VisuallyInheritableList without any support for visual inheritance.
Declaration
public VisuallyInheritableList(object[] items)
Parameters
Type | Name | Description |
---|---|---|
System.Object[] | items | An array of objects. |
Properties
DesignTimeChanges
Gets / sets the incremental changes done at design-time.
Declaration
public IntListDesignTime DesignTimeChanges { get; set; }
Property Value
Type |
---|
IntListDesignTime |
Parent
Gets / sets the associated parent.
Declaration
public IDesignable Parent { get; set; }
Property Value
Type |
---|
IDesignable |
Methods
GetDesignTimeChanges()
Returns a list representing the incremental changes made at design-time.
Declaration
protected virtual IntListDesignTime GetDesignTimeChanges()
Returns
Type | Description |
---|---|
IntListDesignTime | A list representing the new position of the items based on the position of the items in the base class. |
Remarks
This list will be provided in a call to SetDesignTimeChanges(ArrayList) to reapply the changes done during this design-time.
IsIdenticalObjects(Object, Object)
Compares two objects for equality.
Declaration
protected virtual bool IsIdenticalObjects(object item1, object item2)
Parameters
Type | Name | Description |
---|---|---|
System.Object | item1 | Object 1. |
System.Object | item2 | Object 2. |
Returns
Type | Description |
---|---|
System.Boolean | True if identical; False otherwise. |
Remarks
The base class version uses the "==" operator to perform the comparison. This could be overridden to support boxed types (int, for example), where 2 integers should be compared based on their value rather than the boxed object instance.
OnCollectionChanged(CollectionChangeEventArgs)
Declaration
protected override void OnCollectionChanged(CollectionChangeEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
System.ComponentModel.CollectionChangeEventArgs | args |
Overrides
OnCollectionChanging()
Overridden. See Syncfusion.Collections.ArrayListExt.OnCollectionChanged.
Declaration
protected override void OnCollectionChanging()
Overrides
ReinitBaseClassCopy()
Declaration
public void ReinitBaseClassCopy()
SetDesignTimeChanges(ArrayList)
Called to apply the changes made in the previous design-time invoke.
Declaration
protected virtual void SetDesignTimeChanges(ArrayList newPositionList)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.ArrayList | newPositionList | A list specifying the new positions based on the positions of the exisiting items set in the base class. |
ShouldContinueIfItemsCountChanged()
Indicates whether to continue applying incremental-changes done in the previous design-time invocation.
Declaration
protected virtual bool ShouldContinueIfItemsCountChanged()
Returns
Type | Description |
---|---|
System.Boolean | True to continue; False otherwise. |
Remarks
This method is called if it seems like items were removed in the base class since the last invoke of this design-time.