SelectionSet Class

In This Topic

Class providing functionality to get selected objects from a current dialog of EPLAN.

Inheritance Hierarchy

System.Object
Eplan.EplApi.HEServices.SelectionSet

Syntax

C#
C++/CLI

public class SelectionSet

public ref class SelectionSet

Remarks

The methods usually return an empty result if there is more than 1 one project open, except from SelectedProjects and GetCurrentProject(true).

Example

The following example shows how to use class SelectionSet.

SelectionSet selectionSet = new SelectionSet();
StorableObject[] storableObjects = selectionSet.Selection;
if (storableObjects.Length == 0)
{
    Console.Out.WriteLine("No current selection!");
    return;
}
else
{
    Console.Out.WriteLine("Current selection contains of:");
    foreach (StorableObject so in storableObjects)
    {
        Console.Out.WriteLine("Object type: " + so.GetType().ToString());
    }
}

SelectionSet selectionSet = new SelectionSet();
//If any selected object will be changed, LockProjectByDefault must be set to true before obtaining any object
selectionSet.LockProjectByDefault = true;
Project oProject = selectionSet.GetCurrentProject(false);
oProject.ProjectName = "new_name";

Public Constructors

	Name	Description
	SelectionSet Constructor	Default constructor.

Top

Public Properties

	Name	Description
	CurrentlyEdited	Determines Page or InstallationSpace currently edited in graphical editor.
	Document	Determines whether a document is selected. This will only return a document, when the selection is inside the graphical editor.
	IsOnlyOneObjectSelected	Determines whether exactly one object is selected.
	IsPageSelected	Determines whether a page is selected.
	LockProjectByDefault	If set to true, the objects returned and the rest objects from project by the SelectionSet method are locked. Default value is `false`.
	LockSelectionByDefault	If set to true, the objects returned by the SelectionSet methods are locked. Default value is `true`.
	OpenedInstallationSpaces	Gets installation spaces opened in GED.
	OpenedPages	Gets pages open in GED.
	ProjectMessages	Gets all selection project's messages.
	SelectedProjects	Return the selected projects of the active dialog as an array. If you select elements from different projects inside of one dialog you can determinate the selected projects.
	Selection	Gets the complete selection on the active window. Property `LockProjectByDefault` should be set to `true` before any changes on any inside elements of obtained objects.
	SelectionRecursive	Gets the complete selection on the active window. Property `LockProjectByDefault` should be set to `true` before any changes on any inside elements of obtained objects.

Top

Public Methods

	Name	Description
	_setObjectTypes	For internal use.
	GetCurrentProject	Determines the active project.
	GetSelectedObject	\Returns the first selected object.
	GetSelectedPages	Gets the selected pages.

Top

Reference

SelectionSet Members
Eplan.EplApi.HEServices Namespace

Send Feedback