Aggregate Property

The entire address.

Syntax

• C#
• VB.NET

public string Aggregate { get; set; }

Public Property Aggregate As String

Default Value

""

Remarks

An aggregate consisting of the entire address, formatted as XML without end tags. Address properties of the various components accept and return data in this format exclusively.

When this property is read, an aggregate is formed from the value of all the other properties. When the property is written, the input is parsed and the various properties are set. Reading or writing the value of this property will also escape or unescape special characters such as '&', as appropriate.

There is generally no need to generate or inspect the value of Aggregate by hand. This property allows the user to easily pass data between instances of an Address component, or between an Address component and a QuickBooks object component.

It is, however, possible, to generate the value by hand, and use this value directly in other components as an alternative to using the Address component. The formatting is as in QBXML; any or all fields may be left out:

<Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>