View

The TOKOPEN_VIEW object defines the properties, criteria and results of a search against the TokOpen document database. Each view can optionally be made visible so that it appears in the TokOpen user interface or left invisible for API access only.

The TOKOPEN_VIEW also supports basic methods for creating documents and folders.

TOKOPEN_VIEW

Clear
     Resets all the TOKOPEN_VIEW properties ready for a new Search.

  ViewName As String
     The name given to the View window title if it is made visible. i.e. 'Explore Drawers'

Environment as TOKOPEN_ENVIRONMENT
     A reference to the overall Environment object.

Criteria as TOKOPEN_CRITERIALIST
     The search criteria for the View, i.e. list of fields to be searched against.

Fields as TOKOPEN_FIELDLIST
     The fields which are to be retrieved as the search results.

Documents as TOKOPEN_DOCLIST
     The documents / folders resulting from the search.

Active As Boolean
     TRUE if the View is visible and the currently selected topmost view.

ViewType as TOKOPEN_VIEWTYPE
     Folder Search / Document Search / Explorer view etc...

TextSearch as TOKOPEN_TEXTSEARCH
     Criteria for performing any document content (text) based search.

  DBnum As Long
     Returns the current TokOpen database number.

  NoDocuments As Long
     Indicates the number of documents found in the search.

  NoFolders As Long
     Indicates the number of folders found in the search.

  NoSubFolders As Long
     Indicates the number of sub-folders found in the search.

  DrawerId As Long
     Sets the Drawer number to be searched in.

  FolderId As Long
     0 for multiple folders, or the Folder Id is a single folder search.

WriteUserAudit (AnEvent as String)
     Records an event in the audit table for the current user.

WriteLicenseAudit (FeatureName as String)
     Records a licensed use of a Feature in the audit table for the current user.

DoSearch(Optional MaxResults As Long = 0) As Long
     Executes the search, paging results in chunks of MaxResults. Result is no.of records.

  Visible As Boolean
     Set to TRUE makes the View object visible in the user interface, FALSE is hidden.

Kill_Public_Instance
     Deletes TokOpens reference to the View object. YOU MUST DO THIS.

Action_AddDocument
     Allows documents to be created in a single Folder view.

Login( username as String, password as String, Optional Showdblist as Boolean,Optional Database as Long) as Boolean
     Authenticates a login for a user name and password and sets the current TokOpen user.

  LoggedIn As Boolean
     TRUE if there is a current user logged in to TokOpen.

Parse_Command( cmdline as String ) as String
     Specify search criteria as a string, i.e. '%draw=INVOICES %folder1=2423

Add_Folderfields
     Add all Folder fields for the current drawerid to the Fields collection.

Add_Docfields
     Add all Document fields for the current drawerid to the Fields collection.

Import_Docfile
     Import a single document file with user interface profiling of the folder/document.

ImportLine
     Create Folder/Document with Comma Separated list of fields.

MakeMediaRef
     Create a new Storage Location

AddNewDocType
     Create a new Document Type