SelectObjects Method (message, requiredClass, selectionRoot, diverseSelection, multipleSelection)

[This is preliminary documentation and is subject to change.]

Displays an object selection modal form to allow the user to choose one or more objects.

Declaration Syntax

public abstract List<Persistent> SelectObjects(
	string message,
	ObjectClass requiredClass,
	IClassified selectionRoot,
	bool diverseSelection,
	bool multipleSelection
)

Parameters

message (String): The prompt to display to inform the user the purpose of the choice.

requiredClass (ObjectClass): The class of object(s) that the user must choose.

selectionRoot (IClassified): The root object or collection from which the selection takes place. The user can browse the persistent tree under this root.

diverseSelection (Boolean): If true, the user can select objects of the required class or any class derived from it.

multipleSelection (Boolean): If true, the user can select more than one object.

Return Value

A list containing the object(s) selected by the user, or null if the user did not select any objects.

Remarks

This allows the user to browse through the persistent tree. Persistate will show only those nodes with the required class, or which contain the required class at some level below it, are shown. Where many collections are shown, the appropriate lookup form will be displayed to allow the user to search for and select objects. The user will be able to accumulate selected objects if multipleSelection is specified.

Assembly: Persistate (Module: Persistate) Version: 0.6.1.20 (0.6.1.20)