The CAddress type exposes the following members.

Methods

  NameDescription
Protected methodCheckAndModifyEditStatus
Sets the EditStatus to Modified if it is Unchanged
(Inherited from iboBase.)
Public methodDelete
Marks the address for deletion. It won't actually be deleted until Save is called.
(Overrides iboBase..::..Delete()()()().)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodFormatBarCode()()()()
Creates the US Postal Service BarCode from a US ZIP code (PostalCode)
(Inherited from CAddressBasic.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodValidate
Makes sure that all of the property data passes the iMIS business rules.
(Overrides CAddressBasic..::..Validate()()()().)

Fields

  NameDescription
Protected fieldm_blnAddressDirty
Tracks whether the address has been changed but not committed.
(Inherited from CAddressBasic.)
Protected fieldm_strAddrLine1
Address line 1
(Inherited from CAddressBasic.)
Protected fieldm_strAddrLine2
Address line 2
(Inherited from CAddressBasic.)
Protected fieldm_strAddrLine3
Address line 3
(Inherited from CAddressBasic.)
Protected fieldm_strBarCode
Barcode
(Inherited from CAddressBasic.)
Protected fieldm_strCity
Address city
(Inherited from CAddressBasic.)
Protected fieldm_strCountry
Address Country
(Inherited from CAddressBasic.)
Protected fieldm_strCounty
Address county
(Inherited from CAddressBasic.)
Protected fieldm_strCRRT
CRRT
(Inherited from CAddressBasic.)
Protected fieldm_strDPB
DPB
(Inherited from CAddressBasic.)
Protected fieldm_strFullAddress
Full address
(Inherited from CAddressBasic.)
Protected fieldm_strMailCode
Address Mail code
(Inherited from CAddressBasic.)
Protected fieldm_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.)
Protected fieldm_strStateProvince
Address StateProvince
(Inherited from CAddressBasic.)
Protected fieldmAddressFormatCode
Format code
(Inherited from CAddressBasic.)
Protected fieldmDirections
Directions
(Inherited from CAddressBasic.)
Protected fieldmEditStatus
The edit status (unchanged, modified, etc) of this record.
(Inherited from iboBase.)
Protected fieldmErrors
The current list of errors encountered by this class instance during processing.
(Inherited from iboBase.)
Protected fieldmValidateLongAddressLines
DT 2098: Indicates whether to validate address lines to a longer length
(Inherited from CAddressBasic.)

Properties

  NameDescription
Public propertyAddress1
Gets or sets the first line of the physical address.
(Inherited from CAddressBasic.)
Public propertyAddress2
Gets or sets the second line of the physical address.
(Inherited from CAddressBasic.)
Public propertyAddress3
Gets or sets the third line of the physical address.
(Inherited from CAddressBasic.)
Public propertyAddressFormatCode
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.)
Public propertyAddressNumber
The Key to the Address record. This value is generated and should not normally be changed.
Public propertyAddressPurpose
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
Public propertyBadAddressReasonCode
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.
Public propertyBadAddressReasonDescription
The description that goes along with the BadAddressReasonCode if it is set.
Public propertyBarcode
Gets the US Postal Service Barcode representation of the address's ZIP or ZIP+4
(Inherited from CAddressBasic.)
Public propertyCarrierRoute
Gets or sets the carrier route data used by the USPS to sort mail.
(Inherited from CAddressBasic.)
Public propertyCity
Gets or sets the city (town, village, etc.) of the physical address.
(Inherited from CAddressBasic.)
Public propertyContactId
The ContactId of the Contact associated with this address
Public propertyCountry
Gets or sets the name of the Country where the physical or non-physical address is located.
(Inherited from CAddressBasic.)
Public propertyCounty
Gets or sets the county in which the physical address is located.
(Inherited from CAddressBasic.)
Public propertyDeliveryPointBarcode
Gets or sets the machine readable representation of an 11 digit ZIP code used by the USPS to sort mail.
(Inherited from CAddressBasic.)
Public propertyDirections
Gets or sets driving/delivery directions to the physical address.
(Inherited from CAddressBasic.)
Public propertyEditStatus
Indicates the current edit status of this object, i.e., New, Modified, Deleted, or Unchanged. See EEditStatus
(Inherited from iboBase.)
Public propertyEmailAddress
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.
Public propertyErrors
The collection of CError objects (error and warning messages) associated with this object instance
(Inherited from iboBase.)
Public propertyErrorsCount
Gets the number of error and warning messages that have been set on this object.
(Inherited from iboBase.)
Public propertyFax
The Fax (Facimile) telephone number associated with the address.
Public propertyFormattedAddress
Gets or sets the full, formatted physical address.
(Inherited from CAddressBasic.)
Public propertyInstituteName
The Institute/Company Name associated with this address, if any.
Public propertyIsPreferredBill
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.
Public propertyIsPreferredMail
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.
Public propertyIsPreferredShip
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.
Public propertyLastQASBatchDateTime
Gets or sets the date and time of the last QAS address verification run that successfully verified this address.
Public propertyLastVerifiedOn
The date and time that the address was last verified (normally via a 3rd party tool like Accumail)
Public propertyLocalGovernmentDistrict1
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.
Public propertyLocalGovernmentDistrict2
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.
Public propertyMailCode
Gets or sets the Mail Code associated with this address, for sorting in large mailings.
(Inherited from CAddressBasic.)
Public propertyNationalGovernmentDistrict
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.
Public propertyNote
Any notes (free form text) associated with this address
Public propertyPhone
The Telephone number associated with this address
Public propertyPostalCode
Gets or sets the postal code (zip code, post code) associated with the physical address.
(Inherited from CAddressBasic.)
Public propertySkipAutoVerifyFlag
Gets or sets an indicator of whether or not this address should be skipped during verification by 3rd party address verification tools.
Public propertyStateProvince
Gets or sets the State, Province, or equivelent in which the physical address is located.
(Inherited from CAddressBasic.)
Public propertyTollFree
The Toll Free telephone number associated with the address
Public propertyUpdatedOn
The date and time that the address was last updated
Public propertyValidateLongAddressLines
Gets or sets an indication of whether address lines should be validated to a longer or shorter length.
(Inherited from CAddressBasic.)

See Also