The ICartellaPositionedRelations<(Of <(<'TOwner, TTarget>)>)> type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Add(T) | Adds an item to the ICollection<(Of <(<'T>)>)>. (Inherited from ICollection<(Of <(<'KeyValuePair<(Of <(<'String, TTarget>)>)>>)>)>.) |
| Add(TKey, TValue) | Adds an element with the provided key and value to the IDictionary<(Of <(<'TKey, TValue>)>)>. (Inherited from IDictionary<(Of <(<'String, TTarget>)>)>.) |
| AddRelation(TTarget) |
Add a relation entry to the collection.
If the collection is not editable, exception will be thrown.
If the target unique ID already exists in the keys collection, exception will be thrown.
It will also fire the "TargetAdded" event if successful
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| AddRelation(TTarget, TTarget, Boolean) |
Add target to relation. Using another target as reference point
|
| Clear | Removes all items from the ICollection<(Of <(<'T>)>)>. (Inherited from ICollection<(Of <(<'KeyValuePair<(Of <(<'String, TTarget>)>)>>)>)>.) |
| ClearRelations |
Clear all target item mappings in the relations
(Inherited from ICartellaRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| Contains | Determines whether the ICollection<(Of <(<'T>)>)> contains a specific value. (Inherited from ICollection<(Of <(<'KeyValuePair<(Of <(<'String, TTarget>)>)>>)>)>.) |
| ContainsKey | Determines whether the IDictionary<(Of <(<'TKey, TValue>)>)> contains an element with the specified key. (Inherited from IDictionary<(Of <(<'String, TTarget>)>)>.) |
| Convert<(Of <<'(TNewOwner, TNewTarget>)>>)()()()() |
Casting operation, convert both owner and target objects to a differnt types.
If casting of the owner or targets to new types are not successful,
exception will be thrown
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| Convert<(Of <<'(TNewOwner, TNewTarget>)>>)()()()() |
Casting operation, convert both owner and target objects to a differnt types.
If casting of the owner or targets to new types are not successful,
exception will be thrown
|
| ConvertOwner<(Of <<'(TNewOwner>)>>)()()()() |
Casting operation, convert the owner object to a differnt type.
If casting of the owner to new type is not successful,
exception will be thrown
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| ConvertOwner<(Of <<'(TNewOwner>)>>)()()()() |
Casting operation, convert the owner object to a differnt type.
If casting of the owner to new type is not successful,
exception will be thrown
|
| ConvertTarget<(Of <<'(TNewTarget>)>>)()()()() |
Casting operation, convert the target objects to a differnt type.
If casting of the targets to new type are not successful,
exception will be thrown
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| ConvertTarget<(Of <<'(TNewTarget>)>>)()()()() |
Casting operation, convert the target objects to a differnt type.
If casting of the targets to new type are not successful,
exception will be thrown
|
| CopyTo | Copies the elements of the ICollection<(Of <(<'T>)>)> to an Array, starting at a particular Array index. (Inherited from ICollection<(Of <(<'KeyValuePair<(Of <(<'String, TTarget>)>)>>)>)>.) |
| GetEnumerator()()()() | Returns an enumerator that iterates through the collection. (Inherited from IEnumerable<(Of <(<'KeyValuePair<(Of <(<'String, TTarget>)>)>>)>)>.) |
| GetEnumerator()()()() | Returns an enumerator that iterates through a collection. (Inherited from IEnumerable.) |
| IndexOf | |
| MoveRelation |
Move target to a different position
|
| Remove(TKey) | Removes the element with the specified key from the IDictionary<(Of <(<'TKey, TValue>)>)>. (Inherited from IDictionary<(Of <(<'String, TTarget>)>)>.) |
| Remove(T) | Removes the first occurrence of a specific object from the ICollection<(Of <(<'T>)>)>. (Inherited from ICollection<(Of <(<'KeyValuePair<(Of <(<'String, TTarget>)>)>>)>)>.) |
| RemoveRelation(TTarget) |
Remove a target off the relation.
If collection is not editable, exception will be thrown.
Target doesn't exist will not cause any exceptions.
It will fire the "TargetRemoved" event is removal is successful.
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| RemoveRelation(Int32) |
Remove target from relations by positioning index of the target
|
| SetupDelegates(InsertRelationsProcedure, RemoveRelationsProcedure) |
Setup the data procedure delegates for insert and removal of targets
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| SetupDelegates(InsertRelationsProcedure, RemoveRelationsProcedure, UpdateRelationPositionsProcedure) |
Setup data procedures delegates for the relations object
|
| TryGetValue | Gets the value associated with the specified key. (Inherited from IDictionary<(Of <(<'String, TTarget>)>)>.) |
Properties
| Name | Description | |
|---|---|---|
 | CollectionOwner |
Get the owner of the collection
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| Count | Gets the number of elements contained in the ICollection<(Of <(<'T>)>)>. (Inherited from ICollection<(Of <(<'KeyValuePair<(Of <(<'String, TTarget>)>)>>)>)>.) |
| Editable |
Get the information is the collection editable.
Non-Editable relations will throw exception, when AddRelation and RemoveRelation methods are called.
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| IsReadOnly | Gets a value indicating whether the ICollection<(Of <(<'T>)>)> is read-only. (Inherited from ICollection<(Of <(<'KeyValuePair<(Of <(<'String, TTarget>)>)>>)>)>.) |
| Item[([( TKey])]) | Gets or sets the element with the specified key. (Inherited from IDictionary<(Of <(<'String, TTarget>)>)>.) |
| Item[([( Int32])]) |
Get the target at given positioning index
|
| Keys | Gets an ICollection<(Of <(<'T>)>)> containing the keys of the IDictionary<(Of <(<'TKey, TValue>)>)>. (Inherited from IDictionary<(Of <(<'String, TTarget>)>)>.) |
| Manager |
Get the manager of current object type.
e.g. Folio object will return IFolioManager type, cast down to ICartellaObjectManager
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| Procedure_UpdatePositions |
Get/Set the procedure delegate for updating positions
|
| SiteManager |
Get the Site Manager of current instance.
This site manager is the one created all the object manager instances
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| TargetType |
Get the object type definition of the target
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| Values | Gets an ICollection<(Of <(<'T>)>)> containing the values in the IDictionary<(Of <(<'TKey, TValue>)>)>. (Inherited from IDictionary<(Of <(<'String, TTarget>)>)>.) |
Events
| Name | Description | |
|---|---|---|
 | PositionChanged |
Event to fire, when target positions are changed. Only get fired when "MoveRelation"
method is executed.
Add and Remove also trigger positioning changes, but will not fire this event.
|
| TargetAdded |
Event to fire, when a target is added to the collection
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
| TargetRemoved |
Event to fire, when a target is removed from the collection
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.) |
