Click or drag to resize

SuperOffice.COM.Application Namespace

The Application object is linked to the running SOCRM.EXE application.

Creating the object will start the application if it is not already running. Creating the object after the application is started will link the object to the running application.

Manipulating the object will change the user interface in the object. You can edit the objects without the application being in edit mode.

Classes
  ClassDescription
Public classSOApplicationClass
Structures
  StructureDescription
Public structuretagContextProperty
Interfaces
  InterfaceDescription
Public interfaceIActivityLinks
ActivityLink - collections of documents attached to this appointment/sale/document
Public interfaceIActivityList
A collection of activities. Each activity can be a sale, document or appointment.
Public interfaceIActivityListItem
Represents a row in an activity archive. Can be a document, appointment or sale row.
Public interfaceIAddress
Addresses can be street, postal or private.
Public interfaceIAdmin
You must have administrative permission to use this object. Allows users and roles to be created and edited.
Public interfaceIApplication
IApplication Interface v1.0
Public interfaceIApplicationArchive
IApplicationArchive Interface
Public interfaceIAppointment
Appointment object - represents to-do's, follow-ups, phone-calls.
Public interfaceIAppointments
Appointments collection.
Public interfaceIAppointments2
Appointment collection.
Public interfaceIAssociate
Associates can be internal users, resources, external users, anonymous or system users. This is a read-only object. To create or edit users, you need to use the Admin object.
Public interfaceIAssociates
Associates collection. Indexed by associate id. The Associate list can be manipulated using the Admin API.
Public interfaceIChecklist
Collection of diary checklist items for a particular user. Each item corresponds to an incomplete appointment, document, sale.
Public interfaceIChecklistItem
A checklist item is a row in the diary checklist. It represents an incomplete appointment, document or sale.
Public interfaceIConsentPerson
Represents a ConsentPerson record.
Public interfaceIConsentPersons
Collection of ConsentPersons
Public interfaceIContact
Contacts represent companies in the user interface.
Public interfaceIContacts
Collection of Contact objects. Use GetFirst/GetNext or for-each to loop through the collection.
Public interfaceIContacts2
Contact collection.
Public interfaceIContext
Public interfaceICounters
Counters keep track of the most recent activity on a company or project. Note that counters may be out-of-date with respect to the actual state of the database. May be NULL if you do not have the Sales Intelligence license
Public interfaceICredential
ICredential Interface - get/set passwords information on IUser
Public interfaceICredentials
Collection of Credentials, indexed from 0.
Public interfaceICriteria
Criteria - a collection of Criterion objects indexed by internal id. Add a new criterion using NewCriterion, then Add it to the collection.
Public interfaceICriterion
A criterion is a field, an operator and one or more values for comparison.
Public interfaceICriterionValue
A value (a number, date, list item) used by a criterion when searching.
Public interfaceICriterionValues
Collection of CriterionValues. Indexed by internal id. A criterion value tells the search system what to look for.
Public interfaceIDatabase
The Database object gives access to superoffice objects after you have logged in.
Public interfaceIDates
Collection of DATEs, indexed from 0.
Public interfaceIDiaryOwner
DiaryOwner represent associate used in application diary.
Public interfaceIDictionary
The Data Dictionary provides information about the database version, the tables installed, and the fields available on a table. You must use the SODictionarySDK to add or remove tables.
Public interfaceIDocument
Documents represent files (usually Word documents or e-mail messages). The file should be generated before it can be edited/viewed
Public interfaceIDocuments
collection of document objects
Public interfaceIEmail
Email address object
Public interfaceIEmails
Collection of e-mail objects. Indexed by internal id.
Public interfaceIEnumContextProps
Public interfaceIFind
This object has lots of function for performing simple searches. If you need more complex queries then you should use the ADO connection instead of the Find object.
Public interfaceIForeignKey
IForeignKey Interface - get/set foreign keys
Public interfaceIInterest
Interest object - represents the checkboxes in the user interface on contact or person.
Public interfaceIInterests
Collection of Interest objects on a contact or person, indexed by internal id
Public interfaceIListTextHeading
IListTextHeading Interface
Public interfaceIListTextHeadings
Collection of list headings. Indexed by heading id. Each heading contains a collection of list items.
Public interfaceIListTextItem
IListTextItem Interface
Public interfaceIListTextItems
Collection of list items. Indexed by item id. Each item has an id, text and tooltip.
Public interfaceIMapCollection
A read-only collection indexed by ids. Supports enumeration. Add/remove methods may be added by sub-classes.
Public interfaceIModelBase
IModelBase defines common operations used by the main objects like Contact, Person, Project, Sale, Appointment, Document.
Public interfaceINumbers
INumbers Interface - get/set number sequences
Public interfaceIPerson
Person object. A person is linked to a contact.
Public interfaceIPersonArchive
IPersonArchive Interface
Public interfaceIPersons
Collection of Person objects
Public interfaceIPersons2
Person collection.
Public interfaceIPhone
Phone object. Hangs off Contact and Person objects. Automatically saved when the Contact or Person object is saved.
Public interfaceIPhones
Phone object collection, indexed by internal id
Public interfaceIPreference
Read or write preference values here. Note that preferences can be set at an individual user's level, at user-group level, an database level, or system-wide level.
Public interfaceIProject
Projects can have persons as project members, with specific roles. Appointments/Sales/Documents can be linked to a project.
Public interfaceIProjectMember
IProjectMember Interface
Public interfaceIProjectMembers
ProjectMembers collection. Indexed by project member id. Add to the collection by saving new ProjectMember objects.
Public interfaceIProjects
Collection of Project items
Public interfaceIProjects2
Project collection.
Public interfaceIQuote
IQuote Interface
Public interfaceIQuoteAlternative
IQuoteAlternative Interface
Public interfaceIQuoteLine
IQuoteLine Interface
Public interfaceIQuoteVersion
IQuoteVersion Interface
Public interfaceIRecurrence
Recurrence object - contains details on how an appointment repeats. Remember to call ComputeDates if you change any information.
Public interfaceIRelation
A Relation links two records in the system. Currently used for activity links and for company/person links.
Public interfaceIRelations
Collection of Relation objects
Public interfaceIRole
Represents a role - which defines access rights to information. Can be modified if user has UserAdmin rights.
Public interfaceIRoles
Role object collection, indexed by role id. Add new roles using Admin.CreateRole.
Public interfaceIRowEntities
Collection of Row Entities
Public interfaceIRowEntity
IRowEntity Interface
Public interfaceISale
ISale Interface
Public interfaceISales
Sales collection.
Public interfaceISaleStakeholder
ISaleStakeholder Interface
Public interfaceISaleStakeholders
Salestakeholders collection. Indexed by salestakeholder_id. Add to the collection by saving new SaleStakeholder objects.
Public interfaceISelection
ISelection Interface
Public interfaceISelectionMember
ISelectionMember Interface
Public interfaceISelectionMembers
SelectionMembers collection. Add and remove members using methods on the Selection object.
Public interfaceISelections2
Selection collection.
Public interfaceISentry
Sentry returns the read/write settings for the object as a whole and for individual fields.
Public interfaceISettings
Database Settings - does not require a login before use
Public interfaceIShipmentTypeReservation
Represents a ShipmentTypeReservation record.
Public interfaceIShipmentTypeReservations
Collection of ShipmentTypeReservations
Public interfaceISoContext
Manages the GUI panels and dialogs
Public interfaceISOPicture
ISOPicture Interface - person, project or status monitor picture
Public interfaceIStatusMonitor
Status Monitors tell you whether a given company or project matches a set of criteria. Note that status monitors may be out-of-date with respect to the actual state of the database. May be NULL if you do not have the Sales Intelligence license. May be read-onl
Public interfaceIStatusMonitors
Collection of Status Monitors indexed by monitor id. May be inaccessible if you do not have the Sales Intelligence license
Public interfaceIStatusMonitorValue
The status monitor value tells you how up to date a status monitor is with respect to the Contact or Project it is attached to..
Public interfaceIStatusMonitorValues
Collection of Status Monitor values indexed by monitor definition id. May be inaccessible if you do not have the Sales Intelligence license
Public interfaceIStringResources
String Resource manager. Converts string ids into translated strings.
Public interfaceISuggestedAppointment
Suggested appointment object
Public interfaceISuggestedAppointments
SuggestedAppointments collection. Indexed by suggestedAppointment_id.
Public interfaceISuggestedDocument
Suggested document object
Public interfaceISuggestedDocuments
SuggestedDocuments collection. Indexed by suggestedDocument_id.
Public interfaceITimeZoneItem
ITimeZoneItem interface
Public interfaceITimeZoneItems
Collection of ITimeZone items
Public interfaceITimeZones
ITimeZones Interface to the TimeZone manager
Public interfaceITravelInfo
TravelInfo - contains status of communications with a given traveller.
Public interfaceITravelInterface
ITravelInterface Interface
Public interfaceITravellers
Collection of traveller info objects. Gives status on all travellers.
Public interfaceIUDefField
A User-defined field - contains layout and database storage information, as well as value of field.
Public interfaceIUDefFields
Collection of user-defined fields. You can retrieve fields by name or by field id.
Public interfaceIUrl
Url - web addresses. Contacts, persons, projects can all have web addresses
Public interfaceIUrlLinkItem
IUrlLinkItem interface
Public interfaceIUrlLinkItems
Collection of IUrlLinkItem items
Public interfaceIUrls
Collection of web addresses, indexed by internal id
Public interfaceIUser
The administration view of associate. Unlike Associate objects, users can be modified and saved.
Public interfaceIUtils
Utilities. These may have reduced functionality in a release target
Public interfaceSOApplication
SuperOffice Application Class for SOCRM.EXE
Public interfaceSOApplicationArchive
Application Archive Class
Public interfaceSOContext
Context Class
Public interfaceSOPersonArchive
PersonArchive Class
Enumerations
  EnumerationDescription
Public enumeration__MIDL___MIDL_itf_SOCOMApplication_0000_0000_0001
Defines various dialogs and main panels in the user interface.
Public enumeration__MIDL___MIDL_itf_SOCOMApplication_0000_0000_0002
Defines sub-views in the various panels.
Public enumeration__MIDL___MIDL_itf_SOCOMApplication_0000_0000_0003
Public enumeration__MIDL___MIDL_itf_SOCOMApplication_0000_0000_0004
Public enumerationEActivityListType
Bitflag. What sort of information is loaded in activity list
Public enumerationEAssocType
Public enumerationEChecklistMode
Bitflag. What sort of information is loaded in diary check list / activity list
Public enumerationEDBType
Type of underlying database in use. Database vendor and version
Public enumerationEDBVariant
The database variant: central or travel database
Public enumerationEDictFieldType
Database field types
Public enumerationEEncryptionVariant
How should travel info be encrypted during transfer?
Public enumerationEFullNameFormatStyle
First name first or last?
Public enumerationEnAppointType
Type of appointment/document (meeting/document/phone/fax/mail)
Public enumerationEnAssocRoleType
Role types
Public enumerationEnCautionWarning
Enum for Caution warning on appointment
Public enumerationEnCriterionLinkType
Different criteria can be combined using AND or OR operators. Only AND is supported at the moment.
Public enumerationEnCriterionOperator
All types of criterion search operators
Public enumerationEnDirection
Direction of appointment/document (unknown/in/out)
Public enumerationEnFindOperator
Find operators for counter values - simplified subset of the full set of operators
Public enumerationEnFreeBusy
Determines whether an appointment causes conflicts in the diary or not
Public enumerationEnMoveActivitiesAction
Enum for the different choices when moving activities
Public enumerationEnParticipantType
Type of participant in a booking - determines how should the invitation be handled
Public enumerationEnPublishType
Publish an appointment/project/document to the extra-net
Public enumerationEnQuoteStatus
Enum for the state of a quote-alternative or line
Public enumerationEnQuoteVersionState
Enum for current state of a Quote version
Public enumerationEnRecurrencePattern
The main recurrence pattern - determines how frequently appointments recur
Public enumerationEnRecurrenceSubPattern
Variations on the main recurrence pattern. Not all patterns have sub-variations.
Public enumerationEnRecurrenceUpdateMode
Determines how changes to an appointment should be copied to the rest of a recurrence series
Public enumerationEnRelationshipToOwner
Role defines datarights using these relationships between objects
Public enumerationEnResponse
User's response to an invitation: accept or reject the appointment
Public enumerationEnSaleStatus
Status of sale (open/sold/lost)
Public enumerationEnUDefType
What thing is the user defined field attached to?
Public enumerationEnUrlEncoding
Enum for the possible URL encodings of a string
Public enumerationEnValueOverride
Enum indicating if has a pre-calculated value been overriden in a QuoteAlternative or QuoteLine, and in that case what & how?
Public enumerationEPrefLevel
at what level of specificity is the preference stored?
Public enumerationEPrivacyLevel
Visible for settings. Private to group means that the PrivateToGroup property can be used to select the group.
Public enumerationESelectionType
What kind of selection: static, dynamic or combined
Public enumerationEUDefFieldType
Type of edit field used when editing the value in the user-interface
Public enumerationSOAddEmailAction
Public enumerationSOArchiveTab
Public enumerationSOContexts
Defines various dialogs and main panels in the user interface.
Public enumerationSOSubContexts
Defines sub-views in the various panels.
Public enumerationSOTableId
SuperOffice Database tables are identified by a number.