Click or drag to resize

IContact Interface

Contacts represent companies in the user interface.

Namespace:  SuperOffice.COM.SuperOfficeDB
Assembly:  SuperOfficeDB.Interop (in SuperOfficeDB.Interop.dll) Version: 8.0.0.0
Syntax
public interface IContact : IModelBase

The IContact type exposes the following members.

Properties
  NameDescription
Public propertyActiveLinks
ActiveLinks - Number of active links to documents, projects, Urls, appointments, sales, contacts, persons, selections
Public propertyActivityLinks
The ActivityLinks attached to this contact. Add or remove links on this object.
Public propertyCode exampleAssociate
Our contact - the user who 'owns' the company Our contact - the user who 'owns' the company
Public propertyCode exampleAutoSaveOnChangeIdentity
Should the model save on IdentityChanged?
Public propertyCode exampleAutoSaveOnFlush
Should the model save on flush cache?
Public propertyCode exampleBusiness
Contact Business - a list item - table enTableBusiness=61

The business that the contact is associated with. The GUI forces the user to enter a business type.

A list item - table enTableBusiness=61

Public propertyCode exampleCategory
Contact Category - a list item - table enTableCategory=64

The category that is set on the company. The GUI forces the user to enter a category type.

A list item - table enTableCategory=64

Public propertyCode exampleChanged
has record been changed since read? If the company has been modified since it was loaded, this will return false
Public propertyCode exampleCounters
Contact Counters - when was the company last contacted, how much was the most recent sale. May return an error if the Sales Intelligence license is missing.
Public propertyCode exampleCountry
The contact's country - a list item - table enTableCntry=19

The country this contact is located in. The country a contact is saved with, affects the phone number format, and the address layout.

A list item - table enTableCntry=19

Public propertyCode exampleCreatedAssociate
The user that created the object The associate that first created the contact
Public propertyCode exampleCreatedDate
The date the object was saved to the database. The date and time the contact was first created
Public propertyCode exampleDepartment
Department or section within a company
Public propertyCode exampleEmails
Email addresses Returns a collection of email objects.
Public propertyCode exampleExternalFieldChanged
have external fields been changed? New in Seven
Public propertyCode exampleForeignKey
Get ForeignKeys linked to this contact Get the foreign key values for this contact. May be used to connect a contact to an external application where you need more settings
Public propertyCode exampleFormattedAddress
returns just the address as a multi-line string according to the country's address layout Returns the name and mailing address of the contact formatted according to the national rules. Useful when generating address labels
Public propertyCode exampleFormattedLabel
returns the name + address as a multi-line string according to the country's address layout Returns the name and mailing address of the contact formatted according to the national rules. Useful when generating address labels. There is no contact person info on the formatted label
Public propertyCode exampleGroup
Primary User Group of owning associate. Set implicitly by AssociateId.
Public propertyCode exampleIdentity
The primary key on the primary table. Is zero for new objects. Is set when an object is saved. This is the internal ID of the contact
Public propertyCode exampleInterests
The active Interests collection. Returns a collection of active SOInterests objects
Public propertyCode exampleIsAvailable
is record available in db? Checks if the record is available in the database. It’s useful to check if a contact actually exists before adding new properties to it
Public propertyIsFavourite
Add/Remove this contact from my favourites
Public propertyCode exampleIsRequiredFilled
Are all the required fields filled out? Can we save the record? Checks if all properties that are required in this model is filled
Public propertyCode exampleIsValid
does the record exist? To save time, we don’t load a record into buffer before one of its properties is asked for. This checks if the requested record is available in buffer
Public propertyCode exampleMother
unused. In a multi-company corporation this is the higher-level contact. The mother property is not used in CRM 5 or SIX, but will be implemented at a later stage, so do not change it
Public propertyCode exampleName
Company Name - may throw an error if you attempt to modify the database owner company name.
Public propertyCode exampleNomailing
Can be used to filter recipients who don't want spam from a mail-merge. The No mailings field may be used if your company sends out direct mailings, and one or more of the contacts in your database does not wish to receive your mail-merges. The property is Boolean, and is shown in the GUI as a checkbox.
Public propertyCode exampleNumber1
Shown as Code in the user interface The number1 field is shown in the GUI as the code field, located just below the Category field
Public propertyCode exampleNumber2
Shown as Number in the user interface The number2 property is shown in the GUI as the number field just below the code field
Public propertyCode exampleOrgNr
The Contact's OrgNr/Tax number/VAT number The Contact's OrgNr/Tax number/VAT number
Public propertyCode examplePhones
Phone item collection Returns a collection of phone numbers that belong to the contact
Public propertyCode examplePostalAddress
PostalAddress Returns the postal address for the object. Postal address uses the same SOAddress object as StreetAddress
Public propertyCode examplePostItText
PostItText Post-It is shown on the company card as a paperclip that expands to a “Yellow sticky note”, when clicked. It contains extra information for the company card it is attached to
Public propertyCode exampleSentry
Sentry settings for this object. Lets you find out your read/write access to the object.
Public propertyCode exampleStatusMonitors
Contact Status Monitors - list of all active status monitors indexed by id. May return an error if the Sales Intelligence license is missing.
Public propertyCode exampleStreetAddress
StreetAddress Returns the StreetAddress for the object. StreetAddress uses the same SOAddress object as PostalAddress
Public propertyCode exampleUDef
The user-defined fields on the contact
Public propertyCode exampleUpdatedAssociate
The last user to modify the object The last associate that updated this contact. If the contact has never been updated, this will return 0
Public propertyCode exampleUpdatedDate
The date of the most recent update. The date and time the contact was last edited. If the contact has never been updated, this will return 0; formatted as a SuperOffice date (see the database manual), this will return 01.01.1970
Public propertyCode exampleUrls
Web addresses Returns a collection of URLs that belong to the contact
Public propertyCode exampleValidationMessage
get validation message, if empty model will think it is ok to save New in Seven.
Public propertyCode exampleXstop
Stop - shown as a big red X A red X is added over the contact card. Indicates that this contact is stopped - there could be more information under the Post-it text explaining why. This red X does not mean that you’re no longer able to edit the contact
Top
Methods
  NameDescription
Public methodCode exampleCancelChanges
Undo any changes made since the object was loaded. If you made changes to the model that you don’t want to be saved to the database, call the CancelChanges method
Public methodCode exampleChangeIdentity
Loads a different record into the object. Causes changes to the existing object to be saved first. Saves the changes made to the contact model to the database. The last thing you do to an object if you want the changes you made to be saved. The ChangeIdentity method calls the save method first
Public methodCopy
Creates a new copy of this contact, optionally with a copy of the persons belonging to it as well. New in Seven.
Public methodCode exampleDelete
Delete the object from the database. May throw an error if you are not allowed to delete the object. Deletes the specified contact model from the database. This may take some time, since this will call a cascade delete on contact persons, phones, addresses, emails, URLs and so on
Public methodGetActivityList
Public methodCode exampleGetPersons
Get the persons attached to this contact. Hidden persons are filtered out.
Public methodCode exampleGetProjects
Get the projects that this contact's persons are members of. Duplicate projects are eliminated. Get the projects that this contact's persons are members of. Duplicate projects are eliminated.
Public methodCode exampleGetRelations
Get all relations with connection to this contact
Public methodMergeTo
Merge this contact into the passed contact, together with the persons and appointments that belongs to this contact. New in Seven.
Public methodCode exampleSave
Persist the object to the database. May throw an error if you are not allowed to save changes to the object. Saves the changes you made to the contact model to the database, does not return the new data from the database
Public methodCode exampleSetDefaults
Populate the object with default values, such as setting the owner to the current user. Uses the UserPreferences table to set the predefined default settings for a contact (company). The SetDefaults method is only available for current objects in this version of SuperOfficeDB Type Library
Top
See Also