Click or drag to resize

IApplicationArchive Interface

IApplicationArchive Interface

Namespace:  SuperOffice.COM.Application
Assembly:  SOCRM.Interop (in SOCRM.Interop.dll) Version: 8.0.0.0
Syntax
public interface IApplicationArchive

The IApplicationArchive type exposes the following members.

Properties
  NameDescription
Public propertyActiveRows
Get active row entities as a collection of IRowEntities. This is not the same as selected/highlighted rows!
Public propertyAllRows
Get all loaded row entities as a collection of IRowEntities
Public propertyArchiveModeProtocol
Archive Mode SoProtocol
Public propertyDesiredEntities
Set desired entities. An array of entity names, a singular Entity name or a comma seperatoted list of entitiy names.
Public propertyGuiName
Gui name
Public propertyHasLiveupdateHandlers
Has live-update handlers?
Public propertyIsAsynchronous
Is provider running asynchronously?
Public propertyIsCanceled
Has the archive loading been canceled?
Public propertyIsLoading
Is archive currently loading? Can be used for waiting when caled from an external process: While archive.IsLoading Wend
Public propertyIsVisible
Is archive visible?
Public propertyLastSelectedRow
Get last selected row entity as an IRowEntity
Public propertyMainModeProtocol
Main Mode SoProtocol
Public propertyMaxRowCount
Set maximum row count limit
Public propertyMaxRowCountReason
Set the reason for the maximum row count limit
Public propertyOptionalEntities
Get optional entities. A Array of entity names. Does not include manadatory entities!
Public propertyProviderName
Provider name
Public propertyRestrictions
Read serialized restrictions. This is normally the basic binding a provider has to some primary Entity.
Public propertySelectedRows
Get selected row entities as a collection of IRowEntities
Public propertySoProtocol
SoProtocol
Public propertyUseDbSorts
Tell archive to use the database to order by
Top
Methods
  NameDescription
Public methodActivateLiveUpdate
Activate/Deactivate Live-update
Public methodCancel
Stop loading. Observe that this requires the application to idle and will therefor only work from an external process or upon return from an internal script event!
Public methodClear
Clears archive
Public methodExportToExcel
Export to Excel. Mode: 1 = Default, 2 = All, 3 = Selected. Open: Attempt to open .xls temp file. Returns full path of temp file in SOTEMP directory. Observe that temp files will get deleted when SoCrm shuts down.
Public methodReconfigure
Reconfigue. Delete user configuration and reconfigure archive to factory setting
Public methodReload
Reload archive, default asynchronous. Observe that this requires the application to idle and will therefore only work from an external process or upon return from an internal script event!Use false to force a complete load before returning.
Public methodReset
Reset archive to stored setting. This is a leightweight Reconfigue
Public methodReSort
Re-sorts archive. This is an in-memory operation for the loaded rows
Public methodSelectNextRow
Select next row. Returns the RowEntity selected. Defaults to any row type unless you specify a particular TableId
Public methodSelectPreviousRow
Select previous row. Returns the RowEntity selected. Defaults to any row type unless you specify a particular TableId
Public methodSetActiveStateOfAllRows
Set active state of all rows. This is not the same as selecting/highlighting rows!
Public methodSetActiveStateOfRow
Set active state of row. This is not the same as selecting/highlighting rows!
Public methodSetDirty
Clears archive and reloads if visible
Public methodShow
Force the archive to become visible. This change should be visible imediately when called from an external process.
Public methodToggleActiveStateOfAllRows
Toggle active state of all rows. This is not the same as selecting/highlighting rows!
Top
See Also