Click or drag to resize

Vovin.CmcLibNet.Database Namespace

Contains all 'native' ICommenceDB database functionality, All FormOA.ICommenceConversation functionality is exposed as direct methods, there is no need to tap into GetConversation. FormOA.ICommenceCursor is implemented pretty much *as is*, with a few nifty additions.
Classes
  ClassDescription
Public classBaseCursorFilter
CursorFilter is a an abstract base class for the various Commence filters you can create. Use CursorFilters.Add to get a derived filter object that exposes properties only applicable to that filtertype. This shields you from having to use the horrible DDE syntax the ViewFilter request takes. You can still set filters the old-fashioned way via CommenceCursor.SetFilter.
Public classBaseRowSet
Abstract base class for the various *RowSet Types.
Public classCommenceAddRowSet
Represents a AddRowSet to add items to Commence.
Public classCommenceCursor
Wrapper around the Commence FormOA.ICommenceCursor interface.
Public classCommenceDatabase
.Net Wrapper around the Commence database API.

COM clients can instantiate this by using the ProgId CmcLibNet.Database.

So from VBScript you would do:
VBScript
Dim db : Set db = CreateObject("CmcLibNet.Database")
'.. do stuff ..
db.Close
Set db = Nothing

When used fom a Commence Item Detail Form or Office VBA, be sure to read up on the Close method.

Public classCommenceDeleteRowSet
Represent a rowset of items to delete. Items are not deleted until Commit is called.
Public classCommenceEditRowSet
Represents a rowset of items to edit.
Public classCommenceQueryRowSet
Represents a rowset of items to query.
Public classCursorColumns
Convenience class for setting multiple columns in a cursor. Should not be combined with the direct methods of setting columns in ICommenceCursor.
Public classCode exampleCursorFilters
Class for creating, removing and applying Cursor filters.

This is significantly different from the usual way of filtering in Commence API.

See code samples below.

Public classCursorFilterTypeCTCF
Represents a filter of type 'Connection To Category Field' (CTCF).
Public classCursorFilterTypeCTCTI
Represents a filter of type 'Connection To Connected Item' (CTCTI).
Public classCursorFilterTypeCTI
Represents a filter of type 'Item Connected To Item' (CTI).
Public classCursorFilterTypeF
Represents a filter of type 'Field' (F).
Interfaces
  InterfaceDescription
Public interfaceIBaseRowSet
Exposes methods and properties shared by all rowset types.
Public interfaceICommenceAddRowSet
Interface for CommenceAddRowSet.
Public interfaceICommenceCursor
CommenceCursor interface.
Public interfaceICommenceDatabase
Exposes all 'native' Commence API database functionality, including all functionality provided by the DDE interface (ICommenceConversation). There is no need to use DDE syntax with CmcLibNet, all DDE plumbing is hidden from the end user.

You cannot get a reference to FormOA.ICommenceConversation from CmcLibNet.

COM clients can reference this interface by using the ProgId CmcLibNet.Database.

VBScript:
VBScript
Dim db : Set db = CreateObject("CmcLibNet.Database")
'.. do stuff ..
db.Close
Set db = Nothing

When used fom a Commence Item Detail Form or Office VBA, be sure to read up on the Close method.

Public interfaceICommenceDeleteRowSet
Interface for CommenceDeleteRowSet
Public interfaceICommenceEditRowSet
interface for CommenceEditRowSet
Public interfaceICommenceQueryRowSet
Interface for CommenceQueryRowSet
Public interfaceICursorColumns
Interface for CursorColumns, allows for a convenient way of setting direct and related columns.
Public interfaceICursorFilter
Exposes members of CursorFilter, a base class for all filters.
Public interfaceICursorFilters
Exposes members of the CursorFilters class. For code examples see CursorFilters.
Public interfaceICursorFilterTypeCTCF
Interface for CursorFilterTypeCTCF.
Public interfaceICursorFilterTypeCTCTI
interface for CursorFilterTypeCTCTI.
Public interfaceICursorFilterTypeCTI
Interface for CursorFilterTypeCTI.
Public interfaceICursorFilterTypeF
Interface for CursorFilterTypeF.
Enumerations
  EnumerationDescription
Public enumerationCmcCursorBookmark
Cursor's rowpointer enum
Public enumerationCmcCursorType
Cursor flags enum; determines what type of cursor to create.
Public enumerationCmcLinkMode
Link modes used with View linking. Only used in the GetViewToFile method.
Public enumerationCmcOptionFlags
Commence option flags.
Public enumerationCommenceFieldType
Commence field types.
Public enumerationFilterQualifier
Valid qualifiers used in a Commence ViewFilter request.
Public enumerationFilterType
Filter Types that a Commence ViewFilter request can use, i.e. the filters you can apply to Commence.