The CAddress type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| CheckAndModifyEditStatus |
Sets the EditStatus to Modified if it is Unchanged
(Inherited from iboBase.) | |
| Delete |
Marks the address for deletion. It won't actually be deleted until Save is called.
(Overrides iboBase..::.Delete()()().) | |
| Equals | (Inherited from Object.) | |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| FormatBarCode |
Creates the US Postal Service BarCode from a US ZIP code (PostalCode)
(Inherited from CAddressBasic.) | |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| ToString | (Inherited from Object.) | |
| Validate |
Makes sure that all of the property data passes the iMIS business rules.
(Overrides CAddressBasic..::.Validate()()().) |
Fields
| Name | Description | |
|---|---|---|
| m_blnAddressDirty |
Tracks whether the address has been changed but not committed.
(Inherited from CAddressBasic.) | |
| m_strAddrLine1 |
Address line 1
(Inherited from CAddressBasic.) | |
| m_strAddrLine2 |
Address line 2
(Inherited from CAddressBasic.) | |
| m_strAddrLine3 |
Address line 3
(Inherited from CAddressBasic.) | |
| m_strBarCode |
Barcode
(Inherited from CAddressBasic.) | |
| m_strCity |
Address city
(Inherited from CAddressBasic.) | |
| m_strCountry |
Address Country
(Inherited from CAddressBasic.) | |
| m_strCounty |
Address county
(Inherited from CAddressBasic.) | |
| m_strCRRT |
CRRT
(Inherited from CAddressBasic.) | |
| m_strDPB |
DPB
(Inherited from CAddressBasic.) | |
| m_strFullAddress |
Full address
(Inherited from CAddressBasic.) | |
| m_strMailCode |
Address Mail code
(Inherited from CAddressBasic.) | |
| m_strPostalCode |
this is the ZIP code
For the anonymous user, this value is set to "Guest" iboMCommon.gc_strAnonUserPostalCode
CStdOrder tests for this value and skips automatic freight calculation
(Inherited from CAddressBasic.) | |
| m_strStateProvince |
Address StateProvince
(Inherited from CAddressBasic.) | |
| mAddressFormatCode |
Format code
(Inherited from CAddressBasic.) | |
| mDirections |
Directions
(Inherited from CAddressBasic.) | |
| mEditStatus | The edit status (unchanged, modified, etc) of this record. (Inherited from iboBase.) | |
| mErrors | The current list of errors encountered by this class instance during processing. (Inherited from iboBase.) | |
| mValidateLongAddressLines |
DT 2098: Indicates whether to validate address lines to a longer length
(Inherited from CAddressBasic.) |
Properties
| Name | Description | |
|---|---|---|
| Address1 |
Gets or sets the first line of the physical address.
(Inherited from CAddressBasic.) | |
| Address2 |
Gets or sets the second line of the physical address.
(Inherited from CAddressBasic.) | |
| Address3 |
Gets or sets the third line of the physical address.
(Inherited from CAddressBasic.) | |
| AddressFormatCode |
Gets or sets a reference to the address format to use when creating the FormattedAddress out of the various physical address components.
(Inherited from CAddressBasic.) | |
| AddressNumber |
The Key to the Address record. This value is generated and should not normally be changed.
| |
| AddressPurpose |
The purpose/name/type of the address. For example, "Home", "Work", "Vacation", etc. Must be one of those defined
in iMIS. See AddressPurposes
NOTE:
To change the Purpose of the main adress (the one pointed to by CContact.AddressNum1), create
a new address, set its purpose to MainAddressPrompt (which removes
the original CAddress from CContact.AddressNum1) and then change the purpose of the original CAddress
| |
| BadAddressReasonCode |
If set to anything other than the empty string, it means the address is "bad". The value indicates what is
wrong with the address. A list of possible values can be found in BadAddressReasons.
| |
| BadAddressReasonDescription |
The description that goes along with the BadAddressReasonCode if it is set.
| |
| Barcode |
Gets the US Postal Service Barcode representation of the address's ZIP or ZIP+4
(Inherited from CAddressBasic.) | |
| CarrierRoute |
Gets or sets the carrier route data used by the USPS to sort mail.
(Inherited from CAddressBasic.) | |
| City |
Gets or sets the city (town, village, etc.) of the physical address.
(Inherited from CAddressBasic.) | |
| ContactId |
The ContactId of the Contact associated with this address
| |
| Country |
Gets or sets the name of the Country where the physical or non-physical address is located.
(Inherited from CAddressBasic.) | |
| County |
Gets or sets the county in which the physical address is located.
(Inherited from CAddressBasic.) | |
| DeliveryPointBarcode |
Gets or sets the machine readable representation of an 11 digit ZIP code used by the USPS to sort mail.
(Inherited from CAddressBasic.) | |
| Directions |
Gets or sets driving/delivery directions to the physical address.
(Inherited from CAddressBasic.) | |
| EditStatus |
Indicates the current edit status of this object, i.e., New, Modified, Deleted, or Unchanged. See EEditStatus (Inherited from iboBase.) | |
| EmailAddress |
The email address associated with the address. For example, a home email address would be on the "Home" address while a
work email address would be on the "Work" address.
| |
| Errors |
The collection of CError objects (error and warning messages) associated with this object instance
(Inherited from iboBase.) | |
| ErrorsCount |
Gets the number of error and warning messages that have been set on this object.
(Inherited from iboBase.) | |
| Fax |
The Fax (Facimile) telephone number associated with the address.
| |
| FormattedAddress |
Gets or sets the full, formatted physical address.
(Inherited from CAddressBasic.) | |
| InstituteName |
The Institute/Company Name associated with this address, if any.
| |
| IsPreferredBill |
Indicates whether or not this is the Contact's preferred billing address (address at which he/she/it wishes
to receive bills). NOTE: PreferredBill can only be set to true. When one is set to true, all others are set to false.
| |
| IsPreferredMail |
Indicates whether or not this is the Contact's preferred mailing address (address at which he/she/it wishes
to receive mail). NOTE: PreferredMail can only be set to true. When one is set to true, all others are set to false.
| |
| IsPreferredShip |
Indicates whether or not this is the Contact's preferred shipping address (address at which he/she/it wishes
to receive orders). NOTE: PreferredShip can only be set to true. When one is set to true, all others are set to false.
| |
| LastQASBatchDateTime |
Gets or sets the date and time of the last QAS address verification run that successfully verified this address.
| |
| LastVerifiedOn |
The date and time that the address was last verified (normally via a 3rd party tool like Accumail)
| |
| LocalGovernmentDistrict1 |
The local government district in which this physical address is located. For example, in the US this would
represent the State Senate District. This property is normally set by a 3rd party address verification app
like Accumail.
| |
| LocalGovernmentDistrict2 |
A second local government district in which this physical address is located. For example, in the US this would
represent the State House District. This property is normally set by a 3rd party address verification app
like Accumail.
| |
| MailCode |
Gets or sets the Mail Code associated with this address, for sorting in large mailings.
(Inherited from CAddressBasic.) | |
| NationalGovernmentDistrict |
The National government district in which this physical address is located. For example, in the US this would
represent the US Congressional District. This property is normally set by a 3rd party address verification app
like Accumail.
| |
| Note |
Any notes (free form text) associated with this address
| |
| Phone |
The Telephone number associated with this address
| |
| PostalCode |
Gets or sets the postal code (zip code, post code) associated with the physical address.
(Inherited from CAddressBasic.) | |
| SkipAutoVerifyFlag |
Gets or sets an indicator of whether or not this address should be skipped during verification by 3rd party address verification tools.
| |
| StateProvince |
Gets or sets the State, Province, or equivelent in which the physical address is located.
(Inherited from CAddressBasic.) | |
| TollFree |
The Toll Free telephone number associated with the address
| |
| UpdatedOn |
The date and time that the address was last updated
| |
| ValidateLongAddressLines |
Gets or sets an indication of whether address lines should be validated
to a longer or shorter length.
(Inherited from CAddressBasic.) |