Click or drag to resize

SOScriptingEvents Interface

Scripting Events API Class All the events available to scripts running inside the Scripting Engine. This object is automatically provided to all scripts, you do not have to instanciate it.

Namespace:  SuperOffice.COM.ScriptEvents
Assembly:  Scripting.Interop (in Scripting.Interop.dll) Version: 8.0.0.0
Syntax
public interface SOScriptingEvents : IScriptingEvents

The SOScriptingEvents type exposes the following members.

Methods
  NameDescription
Public methodCode exampleOnAfterCentralUpdate
Called after central update processing is complete, but before the application starts
(Inherited from IScriptingEvents.)
Public methodCode exampleOnAfterGeneratePrototype
Called after the prototype has been generated
(Inherited from IScriptingEvents.)
Public methodCode exampleOnAfterReadReplicationFile
Called after a replication file has been read (for each file if multiple files are read in one operation); exactly the given file has been written
(Inherited from IScriptingEvents.)
Public methodCode exampleOnAfterWriteReplicationFile
Called after a replication file has been written (not if there were no data waiting)
(Inherited from IScriptingEvents.)
Public methodCode exampleOnAppointmentBeforeDelete
Identity is the id of the current object. If you need to update information in external applications based on this entity, this is the time to collect the information you (like identity, name, numbers, any user defined field and so on).
(Inherited from IScriptingEvents.)
Public methodCode exampleOnAppointmentDeleted
Identity is the id of the current object. It's to late to get any information other than the old appointment_id at this time.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnAppointmentFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.

New in Seven.

There are new methods to support notification when an entities fields have changed. Today there exists the OnCurrentXxxFieldChanged event, which is raised when on field on an entity has been altered. This has been seen as a chatty method. The new OnXxxFieldsChanged (plural) methods support a single atomic notification when an entity has changed, and gives more context to the actual change. The old methods still exist and can, but are not required to, be disabled through preferences in the SoAdmin client.

In addition to decreasing chatter, the new methods enable greater access to notification in areas there were previously inaccessible, i.e. when an appointment was accepted or rejected.

(Inherited from IScriptingEvents.)
Public methodOnArchiveRowSelected
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnBeforeGeneratePrototype
Called before a prototype is generated
(Inherited from IScriptingEvents.)
Public methodCode exampleOnBeforeLocalUpdate
Called after the user has confirmed his/her intention to go on Travel, but before anything else is done
(Inherited from IScriptingEvents.)
Public methodCode exampleOnBeforeLocalUpdateShutdown
Called after local update processing is complete, right before shutdown. Not called if the local update failed.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnBeforeReadReplicationFile
Called before an attempt is made to find/read replication files for the given traveller (called only once, even if multiple files are available); the given path will be scanned for .DWN or .UP files
(Inherited from IScriptingEvents.)
Public methodCode exampleOnBeforeWriteReplicationFile
Called before a replication file is written, even if it later turns out there are no data to be written; the given path is the destination for the file(s)
(Inherited from IScriptingEvents.)
Public methodOnChatSessionFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnContactAfterCopy
Called when a copy operation is performed to create a duplicate. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnContactAfterMerge
Called when a merge operation is performed to combine two objects. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnContactBeforeCopy
Called when a copy operation is performed to create a duplicate. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnContactBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnContactBeforeMerge
Called when a merge operation is performed to combine two objects. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnContactDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnContactFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.

New in Seven.

There are new methods to support notification when an entities fields have changed. Today there exists the OnCurrentXxxFieldChanged event, which is raised when on field on an entity has been altered. This has been seen as a chatty method. The new OnXxxFieldsChanged (plural) methods support a single atomic notification when an entity has changed, and gives more context to the actual change. The old methods still exist and can, but are not required to, be disabled through preferences in the SoAdmin client.

In addition to decreasing chatter, the new methods enable greater access to notification in areas there were previously inaccessible, i.e. when an appointment was accepted or rejected.

(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentAppointmentBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentAppointmentCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentAppointmentCompletedChanged
Called when the appointment is about to be saved, and the completed checkbox has changed value since the object was loaded.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentAppointmentCreated
Called when a new object is saved for the first time.
(Inherited from IScriptingEvents.)
Public methodOnCurrentAppointmentDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentAppointmentFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentAppointmentIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentAppointmentParticipantListChanged
Called when participants are added or removed from the current appointment. The list of participants is available from the current appointment
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentAppointmentSaved
Called when an existing object is saved after having been changed.
(Inherited from IScriptingEvents.)
Public methodOnCurrentChatSessionFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodOnCurrentChatSessionIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnCurrentContactAssociateChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentContactBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentContactBusinessChanged
Called when the contact is about to be saved, and the business field has changed value since the object was loaded.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentContactCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentContactCategoryChanged
Called when the contact is about to be saved, and the category field has changed value since the object was loaded.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentContactCreated
Called when a new object is saved for the first time.
(Inherited from IScriptingEvents.)
Public methodOnCurrentContactDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentContactFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentContactIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentContactSaved
Called when an existing object is saved after having been changed.
(Inherited from IScriptingEvents.)
Public methodOnCurrentDiaryOwnerFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodOnCurrentDiaryOwnerIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentDocumentBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentDocumentCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentDocumentCompletedChanged
Called when the document is about to be saved, and the completed checkbox has changed value since the object was loaded.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentDocumentCreated
Called when a new object is saved for the first time.
(Inherited from IScriptingEvents.)
Public methodOnCurrentDocumentDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentDocumentFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentDocumentIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentDocumentSaved
Called when an existing object is saved after having been changed.
(Inherited from IScriptingEvents.)
Public methodOnCurrentFormFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodOnCurrentFormIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnCurrentFormSubmissionFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodOnCurrentFormSubmissionIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentPersonBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentPersonCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentPersonCreated
Called when a new object is saved for the first time.
(Inherited from IScriptingEvents.)
Public methodOnCurrentPersonDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentPersonFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentPersonIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentPersonSaved
Called when an existing object is saved after having been changed.
(Inherited from IScriptingEvents.)
Public methodOnCurrentPricelistIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnCurrentProductIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentProjectBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentProjectCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentProjectCreated
Called when a new object is saved for the first time.
(Inherited from IScriptingEvents.)
Public methodOnCurrentProjectDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentProjectFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentProjectIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnCurrentProjectMemberDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentProjectMemberIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentProjectSaved
Called when an existing object is saved after having been changed.
(Inherited from IScriptingEvents.)
Public methodOnCurrentQuoteAlternativeIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnCurrentQuoteIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnCurrentQuoteLineIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnCurrentQuoteVersionIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentRelationBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentRelationCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentRelationCreated
Called when a new object is saved for the first time.
(Inherited from IScriptingEvents.)
Public methodOnCurrentRelationDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentRelationFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentRelationIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentRelationSaved
Called when an existing object is saved after having been changed.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleCompletedChanged
Called when the sale is about to be saved, and the completed checkbox has changed value since the object was loaded.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleCreated
Called when a new object is saved for the first time.
(Inherited from IScriptingEvents.)
Public methodOnCurrentSaleDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleSaved
Called when an existing object is saved after having been changed.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleStageChanged
Called when the sale is about to be saved, and the sale stage field has changed values since the object was loaded New in Seven.
(Inherited from IScriptingEvents.)
Public methodOnCurrentSaleStakeholderDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleStakeholderIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly. New in 7.1
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleStatusChanged
Called when the sale is about to be saved, and the open/sold/lost status has changed value since the object was loaded.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSaleTypeChanged
Called when the sale is about to be saved, and the saletype field has changed values since the object was loaded New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSelectionBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSelectionCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSelectionCreated
Called when a new object is saved for the first time.
(Inherited from IScriptingEvents.)
Public methodOnCurrentSelectionDefaults
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSelectionFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSelectionIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentSelectionSaved
Called when an existing object is saved after having been changed.
(Inherited from IScriptingEvents.)
Public methodOnCurrentShipmentFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodOnCurrentShipmentIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnCurrentTicketFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnCurrentTicketIdentityChanged
Called when a new object is selected by the user. Changes may happen indirectly.
(Inherited from IScriptingEvents.)
Public methodOnDiaryOwnerFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnDocumentBeforeDelete
Identity is the id of the current object. If you need to update information in external applications based on this entity, this is the time to collect the information you (like identity, name, numbers, any user defined field and so on).
(Inherited from IScriptingEvents.)
Public methodCode exampleOnDocumentDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnDocumentEdit
Document is being opened for editing. Word or Excel or something is about to be launched.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnDocumentFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.

New in Seven.

There are new methods to support notification when an entities fields have changed. Today there exists the OnCurrentXxxFieldChanged event, which is raised when on field on an entity has been altered. This has been seen as a chatty method. The new OnXxxFieldsChanged (plural) methods support a single atomic notification when an entity has changed, and gives more context to the actual change. The old methods still exist and can, but are not required to, be disabled through preferences in the SoAdmin client.

In addition to decreasing chatter, the new methods enable greater access to notification in areas there were previously inaccessible, i.e. when an appointment was accepted or rejected.

(Inherited from IScriptingEvents.)
Public methodCode exampleOnDocumentOpen
Document is being opened for viewing. Word or Excel or something is about to be launched.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnDocumentPrint
Document is being printed. Word or Excel or something is about to be launched to print the document.
(Inherited from IScriptingEvents.)
Public methodOnEditAppointmentClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodOnEditAppointmentComplete
Called when edit mode is completed or cancelled.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnEditContactClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnEditContactComplete
Called when the contact panel reverts to view mode, whether by OK or CANCEL
(Inherited from IScriptingEvents.)
Public methodOnEditDocumentClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodOnEditDocumentComplete
Called when edit mode is completed or cancelled.
(Inherited from IScriptingEvents.)
Public methodOnEditPersonClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodOnEditPersonComplete
Called when the contact panel reverts to view mode, whether by OK or CANCEL
(Inherited from IScriptingEvents.)
Public methodCode exampleOnEditProjectClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnEditProjectComplete
Called when the project panel reverts to view mode, whether by OK or CANCEL
(Inherited from IScriptingEvents.)
Public methodOnEditSaleClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodOnEditSaleComplete
Called when the project panel reverts to view mode, whether by OK or CANCEL
(Inherited from IScriptingEvents.)
Public methodCode exampleOnEditSelectionClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnEditSelectionComplete
Called when the selection panel reverts to view mode, whether by OK or CANCEL
(Inherited from IScriptingEvents.)
Public methodCode exampleOnExternalUserCreated
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnExternalUserSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnFontSizeChanged (Inherited from IScriptingEvents.)
Public methodOnFormFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnFormSubmissionBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnFormSubmissionDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnFormSubmissionFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnLoggedOn
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodOnLoggingOff
Logout is about to start.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnPersonAfterMerge
Called when a merge operation is performed to combine two objects. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnPersonAfterMove
Called when a move operation is performed to relocate an object. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnPersonBeforeDelete
Identity is the id of the current object. If you need to update information in external applications based on this entity, this is the time to collect the information you (like identity, name, numbers, any user defined field and so on).
(Inherited from IScriptingEvents.)
Public methodCode exampleOnPersonBeforeMerge
Called when a merge operation is performed to combine two objects. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnPersonBeforeMove
Called when a move operation is performed to relocate an object. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnPersonDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnPersonFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.

New in Seven.

There are new methods to support notification when an entities fields have changed. Today there exists the OnCurrentXxxFieldChanged event, which is raised when on field on an entity has been altered. This has been seen as a chatty method. The new OnXxxFieldsChanged (plural) methods support a single atomic notification when an entity has changed, and gives more context to the actual change. The old methods still exist and can, but are not required to, be disabled through preferences in the SoAdmin client.

In addition to decreasing chatter, the new methods enable greater access to notification in areas there were previously inaccessible, i.e. when an appointment was accepted or rejected.

(Inherited from IScriptingEvents.)
Public methodOnPhoneDialed
Called when a phone number *has been* dialed.
(Inherited from IScriptingEvents.)
Public methodOnPhysicalDocumentOpened
Document is being opened for viewing. Word or Excel or something is about to be launched.
(Inherited from IScriptingEvents.)
Public methodOnPricelistBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnPricelistBeforeSave
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnPricelistCanceled
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnPricelistCreated
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnPricelistDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnPricelistFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnPricelistSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnProductBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnProductBeforeSave
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnProductCanceled
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnProductCreated
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnProductDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnProductFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnProductSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectAfterMerge
Called when a merge operation is performed to combine two objects. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectBeforeDelete
Identity is the id of the current object. If you need to update information in external applications based on this entity, this is the time to collect the information you (like identity, name, numbers, any user defined field and so on).
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectBeforeMerge
Called when a merge operation is performed to combine two objects. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.

New in Seven.

There are new methods to support notification when an entities fields have changed. Today there exists the OnCurrentXxxFieldChanged event, which is raised when on field on an entity has been altered. This has been seen as a chatty method. The new OnXxxFieldsChanged (plural) methods support a single atomic notification when an entity has changed, and gives more context to the actual change. The old methods still exist and can, but are not required to, be disabled through preferences in the SoAdmin client.

In addition to decreasing chatter, the new methods enable greater access to notification in areas there were previously inaccessible, i.e. when an appointment was accepted or rejected.

(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMailmergeTaskClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMemberBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMemberBeforeSave
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMemberCanceled
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMemberCreated
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMemberFieldChanged
FieldName is name of the field being changed. e.g.: 'contact.name' or 'address.city'
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMemberFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMemberRemoved
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnProjectMemberSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnQuoteAlternativeBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteAlternativeBeforeSave
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteAlternativeCanceled
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteAlternativeCreated
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnQuoteAlternativeDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteAlternativeFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnQuoteAlternativeSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnQuoteBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteBeforeSave
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteCanceled
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteCreated
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnQuoteDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnQuoteLineBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteLineBeforeSave
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteLineCanceled
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteLineCreated
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnQuoteLineDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteLineFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnQuoteLineSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnQuoteSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnQuoteVersionBeforeDelete
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteVersionBeforeSave
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteVersionCanceled
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteVersionCreated
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodOnQuoteVersionDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodOnQuoteVersionFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnQuoteVersionSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnRelationBeforeDelete
Identity is the id of the current object. If you need to update information in external applications based on this entity, this is the time to collect the information you (like identity, name, numbers, any user defined field and so on).
(Inherited from IScriptingEvents.)
Public methodCode exampleOnRelationDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnRelationFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.

New in Seven.

There are new methods to support notification when an entities fields have changed. Today there exists the OnCurrentXxxFieldChanged event, which is raised when on field on an entity has been altered. This has been seen as a chatty method. The new OnXxxFieldsChanged (plural) methods support a single atomic notification when an entity has changed, and gives more context to the actual change. The old methods still exist and can, but are not required to, be disabled through preferences in the SoAdmin client.

In addition to decreasing chatter, the new methods enable greater access to notification in areas there were previously inaccessible, i.e. when an appointment was accepted or rejected.

(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleBeforeDelete
Identity is the id of the current object. If you need to update information in external applications based on this entity, this is the time to collect the information you (like identity, name, numbers, any user defined field and so on).
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed. New in Seven.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleStakeholderBeforeDelete
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleStakeholderBeforeSave
Called when Save has been triggered, but before anything is saved to the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleStakeholderCanceled
Called when changes to an object are discarded. Values are reset to what is stored in the database.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleStakeholderCreated
Called after the object has been saved. <!--EndFragment-->
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleStakeholderDeleted
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleStakeholderFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSaleStakeholderSaved
Called after the object has been saved.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionAddClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionAddOneMember
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionBeforeDelete
Identity is the id of the current object. If you need to update information in external applications based on this entity, this is the time to collect the information you (like identity, name, numbers, any user defined field and so on).
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionDeleted
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionEmailTaskClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.

New in Seven.

There are new methods to support notification when an entities fields have changed. Today there exists the OnCurrentXxxFieldChanged event, which is raised when on field on an entity has been altered. This has been seen as a chatty method. The new OnXxxFieldsChanged (plural) methods support a single atomic notification when an entity has changed, and gives more context to the actual change. The old methods still exist and can, but are not required to, be disabled through preferences in the SoAdmin client.

In addition to decreasing chatter, the new methods enable greater access to notification in areas there were previously inaccessible, i.e. when an appointment was accepted or rejected.

(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionInterestTaskClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionMailMergeDocument
Called for each document created during a mail-merge.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionMailMergeEnd
Called when a merge operation is performed to combine two objects.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionMailMergeStart
Identity is the id of the current object.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionMailmergeTaskClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionRemoveClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionRemoveOneMember
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionTodoTaskClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSelectionUserTaskClicked
Called when button is clicked.
(Inherited from IScriptingEvents.)
Public methodOnShipmentFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnShutdown
Logout is about to start. Called when SuperOffice is closing but before log-off. Specifies what should happen immediately prior to SuperOffice shuts down.
(Inherited from IScriptingEvents.)
Public methodOnSkinChanged (Inherited from IScriptingEvents.)
Public methodCode exampleOnStartup
Fired once login is complete and the SuperOffice GUI is visible.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSuggestedAppointmentCompleted
Identity is the id of the current object. New in Seven. Suggested document in a guided sale.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSuggestedAppointmentCreateClicked
Called when button is clicked. New in Seven. Suggested appointment in a guided sale.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSuggestedDocumentCompleted
Identity is the id of the current object. New in Seven. Suggested document in a guided sale.
(Inherited from IScriptingEvents.)
Public methodCode exampleOnSuggestedDocumentCreateClicked
Called when button is clicked. New in Seven. Suggested document in a guided sale.
(Inherited from IScriptingEvents.)
Public methodOnTicketFieldsChanged
Is passed the old and new values for the field. Is called before the save is performed.
(Inherited from IScriptingEvents.)
Public methodOnUsageStatAdded
Called when event occurs.
(Inherited from IScriptingEvents.)
Public methodOnViewHidden (Inherited from IScriptingEvents.)
Public methodOnViewPreHide (Inherited from IScriptingEvents.)
Public methodOnViewPreShow (Inherited from IScriptingEvents.)
Public methodOnViewShown (Inherited from IScriptingEvents.)
Top
Examples

Shutdown event

Sub OnShutdown()
    SOMessageBox "Have a nice day"
End Sub
See Also