Click or drag to resize

SOApplicationArchive Interface

Application Archive Class

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

The SOApplicationArchive 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!
(Inherited from IApplicationArchive.)
Public propertyAllRows
Get all loaded row entities as a collection of IRowEntities
(Inherited from IApplicationArchive.)
Public propertyArchiveModeProtocol
Archive Mode SoProtocol
(Inherited from IApplicationArchive.)
Public propertyDesiredEntities
Set desired entities. An array of entity names, a singular Entity name or a comma seperatoted list of entitiy names.
(Inherited from IApplicationArchive.)
Public propertyGuiName
Gui name
(Inherited from IApplicationArchive.)
Public propertyHasLiveupdateHandlers
Has live-update handlers?
(Inherited from IApplicationArchive.)
Public propertyIsAsynchronous
Is provider running asynchronously?
(Inherited from IApplicationArchive.)
Public propertyIsCanceled
Has the archive loading been canceled?
(Inherited from IApplicationArchive.)
Public propertyIsLoading
Is archive currently loading? Can be used for waiting when caled from an external process: While archive.IsLoading Wend
(Inherited from IApplicationArchive.)
Public propertyIsVisible
Is archive visible?
(Inherited from IApplicationArchive.)
Public propertyLastSelectedRow
Get last selected row entity as an IRowEntity
(Inherited from IApplicationArchive.)
Public propertyMainModeProtocol
Main Mode SoProtocol
(Inherited from IApplicationArchive.)
Public propertyMaxRowCount
Set maximum row count limit
(Inherited from IApplicationArchive.)
Public propertyMaxRowCountReason
Set the reason for the maximum row count limit
(Inherited from IApplicationArchive.)
Public propertyOptionalEntities
Get optional entities. A Array of entity names. Does not include manadatory entities!
(Inherited from IApplicationArchive.)
Public propertyProviderName
Provider name
(Inherited from IApplicationArchive.)
Public propertyRestrictions
Read serialized restrictions. This is normally the basic binding a provider has to some primary Entity.
(Inherited from IApplicationArchive.)
Public propertySelectedRows
Get selected row entities as a collection of IRowEntities
(Inherited from IApplicationArchive.)
Public propertySoProtocol
SoProtocol
(Inherited from IApplicationArchive.)
Public propertyUseDbSorts
Tell archive to use the database to order by
(Inherited from IApplicationArchive.)
Top
Methods
  NameDescription
Public methodActivateLiveUpdate
Activate/Deactivate Live-update
(Inherited from IApplicationArchive.)
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!
(Inherited from IApplicationArchive.)
Public methodClear
Clears archive
(Inherited from IApplicationArchive.)
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.
(Inherited from IApplicationArchive.)
Public methodReconfigure
Reconfigue. Delete user configuration and reconfigure archive to factory setting
(Inherited from IApplicationArchive.)
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.
(Inherited from IApplicationArchive.)
Public methodReset
Reset archive to stored setting. This is a leightweight Reconfigue
(Inherited from IApplicationArchive.)
Public methodReSort
Re-sorts archive. This is an in-memory operation for the loaded rows
(Inherited from IApplicationArchive.)
Public methodSelectNextRow
Select next row. Returns the RowEntity selected. Defaults to any row type unless you specify a particular TableId
(Inherited from IApplicationArchive.)
Public methodSelectPreviousRow
Select previous row. Returns the RowEntity selected. Defaults to any row type unless you specify a particular TableId
(Inherited from IApplicationArchive.)
Public methodSetActiveStateOfAllRows
Set active state of all rows. This is not the same as selecting/highlighting rows!
(Inherited from IApplicationArchive.)
Public methodSetActiveStateOfRow
Set active state of row. This is not the same as selecting/highlighting rows!
(Inherited from IApplicationArchive.)
Public methodSetDirty
Clears archive and reloads if visible
(Inherited from IApplicationArchive.)
Public methodShow
Force the archive to become visible. This change should be visible imediately when called from an external process.
(Inherited from IApplicationArchive.)
Public methodToggleActiveStateOfAllRows
Toggle active state of all rows. This is not the same as selecting/highlighting rows!
(Inherited from IApplicationArchive.)
Top
See Also