Description

Adds a command to the server registered by this object.

Return Type

A Boolean value.   A Boolean with value True.
Failure Returns False.

Failure conditions

Syntax

object.AddCommandSorted (eCommand, sDisplayName, eContentType, sContent, [bContentDefaultRequest], [bUIDefaultRequest], [bUIHide], [sMacro], [sLocalizedDisplayName], [lSortOrder], [lVersion], [sLocalizedMenuParents], [lUIDisplayNameSortOrder])

The AddCommandSorted Method syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McDataSource.
eCommandRequired. A mcDataUICommands enumeration, as described in settings. McDataNodes command to be added.
sDisplayNameRequired. A String value. McDataNodes Localized command name (multiple instance of a command must have unique names).
eContentTypeRequired. A mcDataSourceContent enumeration, as described in settings. Type of content for which the eCommand will be applied.
sContentRequired. A String value. Content identifier for which the eCommand will be applied.
bContentDefaultRequestOptional. A Boolean value.
bUIDefaultRequestOptional. A Boolean value.
bUIHideOptional. A Boolean value.
sMacroOptional. A String value.
sLocalizedDisplayNameOptional. A String value.
lSortOrderOptional. A Long value. Used to set the order of execution when multiple servers implement the same command (eCommand, sDisplayName, eContentType, sContent, lVersion). Lower values are execute prior to higher values.
lVersionOptional. A Long value. Specifies a version of the implementation. This feature is not used yet.
sLocalizedMenuParentsOptional. A String value. Specifies the localized captions for parent menu items to be displayed by a UI. Multiple captions may be delimited by a \ character.
lUIDisplayNameSortOrderOptional. A Long value. Used to set a menu order of display when multiple Displayname implementation exist for the the same command (eCommand, eContentType, sContent). menu items with lower values are to be displayed above higher values.

Settings

The settings for eCommand are:

ConstantValueDescription
 mcdatnc_NotACommand0

Not Initialize - invalid state.

 mcdatnc_AddClipboard1
 Current
mcdatnc_StoreToNode        ' Save to a Database Node
 mcdatnc_AddDataObject2

Drop Special New - UI will Not show value but a value is required to enable.

 mcdatnc_AddFile3

Open Common Dialog prompt using DataSource's file extensions.

 mcdatnc_AddFolder4

Open (Browse) Folder shell dialog and recursive Add File with no prompting.

 mcdatnc_AddObject5

Add ACTIVEObject (McDataHandler.ObjectGetActive is required)

 mcdatnc_Import6

Many uniquely named Import commands are allowed

 mcdatnc_StoreToFile7

Save As Common Dialog prompt

 mcdatnc_ClipboardCopy8
Cop

Will Not show in UI; but a value is required to enable.

 mcdatnc_StoreToDataObject9
Dra

Will Not show in UI; but a value is required to enable.

 mcdatnc_GetActiveObject10

returns the activeobject for a registered command

 mcdatnc_Open100

Selection

 mcdatnc_ObjectToJournal101

Sets the Object's Related Node to be the ActiveDataNode.

 mcdatnc_StoreToFolder102

Open (Browse) Folder shell dialog and then recursive Add File with no prompting.

 mcdatnc_Custom103

Many uniquely named Custom commands are allowed.

 mcdatnc_Macro104

Many uniquely named Macro commands are allowed.

 mcdatnc_Export105

Many uniquely named Export commands are allowed.

 mcdatnc_GetValue1000

newer than IQbase1.0

The settings for eContentType are:

ConstantValueDescription
 mcdatSC_UnInit0

Not Initialize - invalid state.

 mcdatSC_DBNode1

McDBNode Content

 mcdatSC_Object2

COM Object Content

 mcdatSC_File3

File Content

 mcdatSC_ClipboardData4

Clipboard / DataObject Content