XPCollection.Add(Object) Method

Adds the specified persistent object to the XPCollection.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v20.2.dll

NuGet Package: DevExpress.Xpo

NuGet Packages: DevExpress.WindowsDesktop.Xpo, DevExpress.Xpo

Declaration

C#

public int Add(
    object newObject
)

VB.NET

Public Function Add(
    newObject As Object
) As Integer

Parameters

Name	Type	Description
newObject	Object	The persistent object to add to the collection.

Returns

Type	Description
Int32	The zero-based index position at which the new element is inserted.

Remarks

A persistent object is an object that implements the IXPSimpleObject interface or has the PersistentAttribute attribute.

You cannot add an object whose type is not the same or not inherited from the type specified by the XPCollection.ObjectClassInfo property. Also you cannot add the same object more than once. Doing so does not lead to an exception, however the object will not be added to the collection.

While the XPCollection is loading, it contains objects that match specific criteria. When you add an object, the collection does not check whether it matches the criteria or not.

Example

The following example demonstrates how to implement a one-to-many relationship between persistent objects, so that child objects are considered a part of their owner (when an owner is deleted, its aggregated objects will be automatically deleted; similarly, when an object is saved its aggregated objects will also be saved).

A one-to-many relationship is set up using the AssociationAttribute attribute. The AggregatedAttribute attribute is used to implement aggregation.

In this example, a Person object can have multiple addresses that are stored in the Person.Addresses collection. Each address in this collection is represented by an Address persistent class. The Person.Addresses property is marked with the AssociationAttribute and AggregatedAttribute attributes.

If you run the code below as is, the console output will be:

7654 Amsterdam Ave, New York, NY 555 Harbor Way, Santa Barbara, CA

If you remove the Aggregated attribute, the output will change to:

7654 Amsterdam Ave, New York, NY 7654 Amsterdam Ave, New York, NY

C#

using System;
using System.Collections.Generic;
using System.Linq;
using DevExpress.Xpo;

namespace ConsoleApplication1 {
    public class Person : XPObject {
        public string Name {
            get { return fName; }
            set { SetPropertyValue(nameof(Name), ref fName, value); }
        }
        string fName;

        [Association("PersonAddresses"), Aggregated]
        public XPCollection<Address> Addresses {
            get { return GetCollection<Address>(nameof(Addresses)); }
        }
    }

    public class Address : XPObject {
        [Association("PersonAddresses")]
        public Person Owner {
            get { return fOwner; }
            set { SetPropertyValue(nameof(Owner), ref fOwner, value); }
        }
        Person fOwner;

        public string AddressInfo {
            get { return fAddressInfo; }
            set { SetPropertyValue(nameof(AddressInfo), ref fAddressInfo, value); }
        }
        string fAddressInfo;

    }

    class Program {
        static void Main(string[] args) {
            // Create a new instance of the Person class
            Person person = new Person() { Name = "Andrew Smith" };
            // Add an address for the person.
            Address address = new Address() { AddressInfo = "7654 Amsterdam Ave, New York, NY" };
            person.Addresses.Add(address);

            // Save the created Person object. The contents of the Addresses collection will be saved as well.
            person.Save();
            // Reload the object to verify if changes were saved.
            address.Reload();
            Console.WriteLine(address.AddressInfo);

            address.AddressInfo = "555 Harbor Way, Santa Barbara, CA";
            person.Save();
            // Reload the object to verify if changes were saved.
            address.Reload();
            Console.WriteLine(address.AddressInfo);

            Console.ReadKey();
        }
    }
}

VB.NET

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports DevExpress.Xpo

Namespace ConsoleApplication1
    Public Class Person
        Inherits XPObject

        Public Property Name() As String
            Get
                Return fName
            End Get
            Set(ByVal value as String)
                SetPropertyValue(NameOf(Name), fName, value)
            End Set
        End Property
        Private fName As String

        <Association("PersonAddresses"), Aggregated> _
        Public ReadOnly Property Addresses() As XPCollection(Of Address)
            Get
                Return GetCollection(Of Address)(NameOf(Addresses))
            End Get
        End Property
    End Class

    Public Class Address
        Inherits XPObject

        <Association("PersonAddresses")> _
        Public Property Owner() As Person
            Get
                Return fOwner
            End Get
            Set(ByVal value as Person)
                SetPropertyValue(NameOf(Owner), fOwner, value)
            End Set
        End Property
        Private fOwner As Person

        Public Property AddressInfo() As String
            Get
                Return fAddressInfo
            End Get
            Set(ByVal value as String)
                SetPropertyValue(NameOf(AddressInfo), fAddressInfo, value)
            End Set
        End Property
        Private fAddressInfo As String

    End Class

    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            ' Create a new instance of the Person class
            Dim person As New Person() With {.Name = "Andrew Smith"}
            ' Add an address for the person.
            Dim address As New Address() With {.AddressInfo = "7654 Amsterdam Ave, New York, NY"}
            person.Addresses.Add(address)

            ' Save the created Person object. The contents of the Addresses collection will be saved as well.
            person.Save()
            ' Reload the object to verify if changes were saved.
            address.Reload()
            Console.WriteLine(address.AddressInfo)

            address.AddressInfo = "555 Harbor Way, Santa Barbara, CA"
            person.Save()
            ' Reload the object to verify if changes were saved.
            address.Reload()
            Console.WriteLine(address.AddressInfo)

            Console.ReadKey()
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(Object) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XPO_tutorial-3-querying-data-e4559/CS/XpoTutorial3/XtraForm1.cs#L24

customer1.Save();
xpCollection1.Add(customer1);
var customer2 = new Customer(session1);

XPO_how-to-display-a-complex-propertys-subproperties-in-data-bound-controls-e742/CS/Form1.cs#L229

person.Save();
xpCollection1.Add(person);

XPO_how-to-create-a-self-referenced-collection-and-apply-a-specific-criteria-to-it-e328/CS/Form1.cs#L32

    b.Save();
    xpCollection1.Add(b);
}

XPO_how-to-use-the-containsoperator-for-objects-in-a-many-to-many-relationship-e988/CS/A2404/Form1.cs#L38

XPCollection<Role> roles = new XPCollection<Role>();
foreach (User user in users) user.Roles.Add(user.Oid % 4 == 0 ? roles[0] : roles[1]);
XpoDefault.Session.Save(users);

XPO_how-to-view-persistent-objects-in-the-xtragrid-and-edit-them-in-a-separate-window-e771/CS/FormEditOrder.cs#L23

xpCollection1.Add(theOrder);
gridControlOrderDetails.DataSource = theOrder.OrderDetails;

VB.NET

XPO_tutorial-3-querying-data-e4559/VB/XpoTutorial3/XtraForm1.vb#L26

customer1.Save()
xpCollection1.Add(customer1)
Dim customer2 = New Customer(session1)

XPO_tutorial-2-relations-one-to-many-e4557/VB/XpoTutorial2/XtraForm1.vb#L22

customer1.Save()
xpCollection1.Add(customer1)

XPO_how-to-display-a-complex-propertys-subproperties-in-data-bound-controls-e742/VB/Form1.vb#L219

person.Save()
xpCollection1.Add(person)

how-to-use-two-grid-controls-to-display-one-to-many-relationship-e798/VB/Form1.vb#L214

    detail.Quantity = rnd.Next(10) + 1
    order.Details.Add(detail)
Next k

Reporting_embedded-end-user-report-designer-demonstration-e20017/VB/Contacts/Controls/PersonControl.vb#L95

collectionPerson.Add(p)
If p.Oid < 0 Then