About “pruning” the Master Explorer folder display
The process default is used to specify a user-defined method to be called during expansion of each Explorer folder node. The specification must be in this form: IDOName.MethodName
The purpose of this callout method is to “prune out” undesired form names from the Explorer node’s XML according to criteria that is defined by the user.
This method must be defined as an IDO extension class method and can be on an existing or new application IDO.
| Parameters | Description |
|---|---|
| UserName (input, string) | This is the username (ID) of the user logged in to the application. The framework supplies this value when the callout method is invoked. |
| OriginalExplorerXML (input, string) | This is the explorer XML for a given node that is loaded in response to the framework LoadExplorer request. The framework supplies this XML stream when the callout method is invoked. |
| PrunedExplorerXML (output, string) | This is a “pruned” version of the OriginaExplorerXML that is passed in. |
The OriginalExplorerXML string represents a serialized version of the LoadExplorerResponseData class. To massage or prune any form name specifications out of that XML, the method must deserialize that XML, manipulate the data in the resultant LoadExplorerResponseData class, and then serialize the XML again before you assign the XML to the third output parameter.
To deserialize, use LoadExplorerResponseData lxrd =
LoadExplorerResponseData.FromXml( OriginalExplorerXML ). To serialize, use
PrunedExplorerXML = lxrd.ToXml().
Implementation of the desired algorithm for pruning the Explorer folder contents must be done by the application developer. A method template is provided and the user implementation code is included between these two comments:
// Begin user implementation
// End user implementation