Custom OpenCmd Class, SelectedNRTDocuments & DeskSite's "My Favorites"

Hey Guys,

I have an issue which I dont believe was documented in SDK material. Basically I an using a custom OpenCmd which is written following the examples from the SDK.

As part of the OpenCmd's Execute implementation I access the ContextItem Collection, specifically the "SelectNRTDocuments" item. Now for opening actual document objects (e.g. in the users worklist) this works fine, however when opening shortcuts (e.g documents from the user's "my favorites") the application generates the following error:

"Unable to process open command

Manage32: Value does not fall within the expected range."

I have cross checked the cause of the error by isolating the issue to when attempting to access the "SelectNRTDocuments" in the ContextItem Collection, after choosing to open a document shortcut (i.e. a document in "my favorites" list).

Now what I feel this points out is that when trying to access document objects in the "my favorites" list, the selected documents are no longer represented by the "SelectedNRTDocuments" context item. My question is, is this because the items in "my favorites" are actuallys shortcut objects? If so how am I expected to utilise the shortcut objects to access the actual document objects?

More fundamentally, is this even documented in the sdk?:eek: I have taken a look through all pdf's from the sdk and not a single mention that opening a document from the "my favorites" list needs to be handled differently! What's going on?

Find more posts tagged with

Comments

jny

Which WorkSite Client as well as version is this? FileSite and DeskSite at times use different contextitems.

matt_woodward

Hey jny,

I have incorporated the client type and version as well as current assembly versions in my signature for reference. Thanks.

jny

SelectedIManObjects is the contextitem which returns both documents and document shortcuts selected by the user. The value is returned as an array of Variant/Object. You may extract the elements out of the array to check its actual WorkSite object type. If it's a shortcut, you may resolve it to get the actual document. Like so:

[VB]

Private Sub ICommand_Execute()

...

Dim selectedObjects() As Object
Dim selectedObject As IManObject
Dim docShortcut As IManContentShortcut
Dim doc As IManDocument

Dim i, ct As Integer

selectedObjects = mContext("SelectedIManObjects")

If Not IsEmpty(selectedObjects) Then
ct = UBound(selectedObjects) - (LBound(selectedObjects) - 1) For i = 0 To ct - 1 Set selectedObject = selectedObjects(i) Select Case selectedObject.ObjectType.ObjectType
Case imTypeContentShortcut
' Resolve shortcut
Set docShortcut = selectedObject
Set doc = docShortcut.Resolve
Case imTypeDocument
Set doc = selectedObject
Case Else
'Check the returned object type
End Select
Next i
End If
...

End Sub

======================================================

[C#]

public void Execute()
{
try
{

...

Array selectedObjects = (Array)mContext.Item("SelectedIManObjects");
int ct = selectedObjects.Length;

if (ct > 0)
{
for (int i = 0; i <= (ct - 1); i++)
{
IManObject selectedObject = (IManObject)selectedObjects.GetValue(i);
IManDocument doc = null;

switch(selectedObject.ObjectType.ObjectType)
{
case imObjectType.imTypeContentShortcut:

//Cast to shortcut
IManContentShortcut shortcut = (IManContentShortcut)selectedObject;
//Resolve shortcut
doc = (IManDocument)shortcut.Resolve();

break;

case imObjectType.imTypeDocument:

//Get document
doc = (IManDocument)selectedObject;

break;

default:
// TODO: check the returned objecttype.
break;

...

}
}
}
}
catch(Exception ex)
{
// Error handling code could go here. The error handling code should not // explicitly raise any errors.
string sError = ex.Message;
}
}

Now based on your problem description, I am not clear whether or not you are invoking an instance of the OpenCmd Object inside an ICommand_Execute. If so, then you should be able to just pass the mContext, the global varaible which holds a handle to the contextitems collection passed in by ICommand_Context, to the OpenCmd.Initialize Method. There shouldn't be any need to create your own instance of the ContextItems Collection Object, then add individually required values to it.

To specifically answer your question in regards to the shortcuts under My Favorites, they are indeed not returned through SelectedNRTDocuments ContextItem because they are not documents. They are returned through SelectedIManObjects as demonstrated in the above code examples.

matt_woodward

To conclude the post the context item "SelectedIManObjects" can be used to work with selected document or shortcuts (as in the "My Favorites" list).

When working with shortcuts, you will need to resolve the document object first by calling Shortcut.Resolve as mentioned in jny's post above.

Thanks jny for the info, even if its not in the documentation!

jny

Oh dear!

I'll try to document this in a technical article as soon as I have down time.