DataSourcePicker

Inherits from

System.Object

Description

The DataSourcePicker class provides a dialog that can be used to select objects from the DataSource.

Users may customize the size of the dialog, the position of the splitter between the Folder and Object panels, and the order and width of the columns displayed for each type of object. Columns may also be hidden by right-clicking on the column header and unchecking them.

Folders

On the left hand side of the dialog is the Folders pane.  This list is a typical Windows Explorer style tree view that will organize which ever type of object you are browsing into folders.  To explore the subfolders of a folder, click the plus sign to the left to see folders listed underneath.  To see the entries at any particular level of folder, click the folder itself.

The Folders pane contains some special folders, called "All", "Recent", and "Search History", which appear under the object type folders.  When the "All" folder is selected, the Details Pane will show all definitions of the specified object type.  When the "Recent" folder is selected, the Details Pane will show some recently used objects of the specified object type.  The "Search History" folder can be expanded to view the results of recent search queries.  It is not possible to rename or delete these special folders, nor is it possible to create folders under these special folders.

With a folder selected, the pane to the right will list the individual objects within the folder.

Several actions can be performed by right-clicking on this tree and using the resulting context menu.  With the context menu, it is possible to clear the recent items history and the search history.

Objects

As we browse the available objects under a given folder, entries that are read-only and will default to being shown in black text and will have a lock icon beside them, while editable objects will be shown in blue and will not have a lock icon beside them.

The individual objects can be selected and the parameters of those objects viewed by double-clicking the object in the right hand pane.  

Objects that are not currently usable for some reason (i.e. objects that rely on grid files not currently available) will be marked with a red exclamation point. These will be viewable but the user will not be able to select them to return from the picker. In the case of objects that rely on grid shift files, if the user right-clicks on the object they will be presented with an option to download and install the missing files automatically via FTP.

Objects that have been deprecated will be marked with a yellow warning sign.

Several actions can be performed by right-clicking on an object and using the resulting context menu.

Searching for Objects

To enable Searching you must have a folder selected that is not All, Recent or Search History. This will activate the Search fields at the bottom of the dialog. To perform a search, first select the column to search in (for example, Name). If the search has a set list of possible values (for example, Projection Types) you may then select the one you are searching for from a drop-down list. Otherwise, type in the string to search for. Click the Search button to initiate the search. If matches are found, they will be displayed under a new folder named after the search conditions, under the main Search History folder. If you wish to re-run the search at a later time simply click on the appropriate Search folder. Only the five most recent searches will be displayed in this folder.

If you wish to clear out your search history, you may right-click on the main Search History folder and select "Clear Search History".

Recently Used Objects

The master folder for each object type includes a special folder that contains the most recently used objects of that type. If you pick a particular object for use it will be added to the Recent list (if it is not already there).

If you wish to clear out your recent object history, you may right-click on the main Recent folder and select "Clear Recent Object History".

Buttons

The OK button closes the dialog and returns the currently selected object.  The return value from the Show method will be eDialogStateSuccess.

The Cancel button closes the dialog box without selecting an object.  The return value from the Show method will be eDialogStateCancel.

The Info... button opens an ObjectEditor dialog that can be used to view the details of the selected object.

More information about the usage and functionality of the DataSourcePicker dialog can be found in the Getting Started Guide.

Constructors

Properties

Methods