Most methods for both the menu bar menus and the shortcut menus are configured in the example development layer.
The following methods are related to the IDEVAdminDoc interface:
|
Name |
Display as |
API name |
|---|---|---|
|
DEVAdminDocCopy |
Copy (DEV) |
CopyObj |
|
DEVAdminDocDelete |
Delete (DEV) |
DeleteObj |
|
DEVAdminDocEditRels |
Edit Relationships (DEV) |
EditAllRels |
|
DEVAdminDocTerminate |
Terminate (DEV) |
TerminateObj |
|
DEVAttachFileToObject |
Attach File (DEV) |
RegisterAndCheckIn |
|
DEVChangeOwningGroup |
Change Owning Group (DEV) |
ChangeOwningGroup |
|
DEVUpdate |
Update (DEV) |
EditObj |
The Create and Query methods for the menu items and a copy method listed in the table above are complex to configure because the administration document has been configured as a classified document. See How to Configure Classification Trees and Classified Objects for more information, but the basic details of each method are given here.
|
DEVAdminDocCreate |
On menu item DEVAdminDocCreate |
|---|---|
|
Client API |
CreateClassObj |
|
RelDef to navigate to the Class Definition |
SPFDesignDocClassAdminDocClassDef |
|
Allow classification tree drilldown |
True |
|
Name of top classification |
DC_Non-versioned_Documents_3 |
|
Classification tree filtering |
|
|
Title |
Admin Document (DEV) |
|
File attachment configuration |
SPFDesignFile~SPFFileComposition~PROMPT |
The file class being attached must have a relationship specified and must also know
what to do if the specified file cannot be found. PROMPT indicates to ask the user
if they want to continue or abort.
This is a menu item command that presents the class tree in the first page of the wizard.
|
DEVAdminDocCreateFromClass |
On ISPFDesignDocClass interface |
|---|---|
|
Client API |
CreateClassObjFromClass |
|
RelDef to navigate to the Class Definition. |
SPFDesignDocClassAdminDocClassDef |
|
Allow classification tree drilldown |
True |
|
Classification tree filtering |
|
|
Title |
Admin Document (DEV) |
|
File attachment configuration |
SPFDesignFile~SPFFileComposition~PROMPT |
|
DEVAdminDocCopy |
On IDEVAdminDoc interface |
|
Client API |
CopyObj |
|
Copy Files |
True |
|
Show Hidden Files |
True |
|
File attachment configuration |
SPFDesignFile~SPFFileComposition~PROMPT |
|
DEVAdminDocQFind |
On DEVAdminDocQFind menu item |
|---|---|
|
Client API |
QFindObject |
|
Interface name to query by |
IDEVAdminDoc |
|
Title |
AdminDocs |
|
DEVAdminDocQuery |
On DEVAdminDocQuery menu item |
|---|---|
|
Client API |
QueryClassObj |
|
RelDef to navigate to the Class Definition |
SPFDesignDocClassAdminDocClassDef |
|
Allow classification tree drilldown |
True |
|
Name of top classification |
Non-versioned Documents |
|
Classification tree filtering |
ISPFDesignDocClass |
The classification filter is to limit the availability of the method to only class
tree nodes with this interface. This is a menu item command that presents the class
tree in the first page of the wizard.
|
DEVAdminDocQueryFromClass |
On ISPFDesignDocClass interface |
|---|---|
|
Client API |
QueryClassObjFromClass |
|
RelDef to navigate to the Class Definition |
SPFDesignDocClassAdminDocClassDef |
|
Allow classification tree drilldown |
False |
|
Title |
Admin Document (DEV) |
Attaching files to admin documents
The relevant attach file method needs to be attached to one of the interfaces of the class.
The ISPFFileComposition interface provides the model support, but because there are two possible file classes (SPFTemplateFile and SPFDesignFile), the relevant methods need to be attached to an interface of the administration document class.
DEVAttachFileToObject is attached to IDEVAdminDoc (detail the arguments in a method) - we cannot use the standard AttachDesignFileToVersion method because this has a different condition associated with it.