Article: KB-DXS_OBJ

Module: DoxShop.exe

Build: 9.2.xxx (And Later)

To allow for client and third party applications to access DoxShop functions, the main DoxShop ActiveX executable (DoxShop.exe) offers the following exposed Properties and Methods.

The DoxShop ActiveX

The main DoxShop executable is an ActiveX whose primary public class object can be accessed as the object:

"DoxShop.DXS_Call"

As an example, a VBA object is instanced in the following code:

The "Sig" Function (Long)

Most of the useful features for DoxShop are handled through the multipurpose "Sig" function which has the following parameters:

Object.Sig(ModeTrigger, [ Param1], [Param2]) as Long

ModeTrigger (Integer)

ModeTrigger may be one of the following:

MS Word Open = 100
MS Word OpenCopy = 110
MS Word Save = 120
MS Word SaveAs = 130
MS Word Close = 140
WordPerfect Open = 200
WordPerfect OpenCopy = 210
WordPerfect Save = 220
WordPerfect SaveAs = 230
WordPerfect Close = 240
Outlook Open = 300
Outlook OpenCopy = 310
Outlook Save = 321
Outlook SaveAs = 331
Outlook SaveAtchmnt = 333
Outlook Attach = 341
Full Text Search = 400
MS Excel Open = 500
MS Excel OpenCopy = 510
MS Excel Save = 520
MS Excel SaveAs = 530
MS Excel Close = 540
Generic Open = 9000
Generic OpenCopy = 9010
Generic Save = 9020
Generic SaveAs = 9030
Convert Document WP > WRD = 5001
Convert Document WRD > WP = 5002
Convert Document WRD > PDF = 5003
Convert Document WP > TXT = 5004
Convert Document WRD > TXT = 5005
Convert Document WP > PDF = 5006
Convert Document XL > PDF = 5007

Query for Current Mode = 999

Parameter1 and Parameter2 (Text String)

Typically these parameters are used to refine the functions above.

For example, when saving an email, the Subject of the current active message may be passed as Parameter1, and thus appear as the description in the profile.

oDXS.Sig(321, "Email Subject Line")

Client/Matter
Another example is to enhance any of the OPEN functions with a "Client/Matter" option. Doing so will call the DoxShop Worklist in "Special" mode restricted to documents of that Client and/or Matter.

As an example, Generic Open (into associated application) with the client "0039856" and matter "089"

oDXS.Sig(9000, "0039856", "089")

Document Number . Version
To enhance any of the OPEN functions forcing it to open a specific document by number, Parameter1 must contain a period, and Parameter2 must have a 0 (zero) length.

As an example, Generic Open (into associated application) the document 55687 version 2:

oDXS.Sig(9000, "55687.2", "")

If the version of the document is unknown, it may be opened with the following, which will force the user to select the version:

oDXS.Sig(9000, "55687.", "")

The "Version" Function (String)

The Version function returns the current release version of the DoxShop ActiveX. It also returns the restriction level and password (if any) for users (and WordTricks administrators) to use Native File Access. (Or to bypass the DMS.)

VersionString = oDXS.Version()

The typical return is like: "9.2.1389/2/trixter"

The second element /2/ refers to the users' native file access as follows:

0 = Fully Restricted
1 = Administrators Only (With Password)
2 = Administrators Only (Unrestricted)
4 = All Users And Administrators With Password
6 = Admin Unrestricted, Users with Password
8 = Fully Unrestricted

The third element /trixter refers to the password required for access.

Note: This function is used in the Word, Outlook, Excel and WordPerfect Add-In modules to launch DoxShop (if it is closed) and to set the application menus based on Native Access restrictions.