Search Class

In This Topic

Class providing functionality to search within a project. The following example shows how to use class Search.

Search oSearch = new Search(); // Set settings which will influence the search result oSearch[Search.Settings.CaseSensitive] = false; oSearch[Search.Settings.Texts] = false; oSearch[Search.Settings.DeviceTag] = true; oSearch[Search.Settings.AllProperties] = false; oSearch[Search.Settings.Texts] = false; oSearch[Search.Settings.PageData] = false; oSearch[Search.Settings.ProjectData] = false; oSearch[Search.Settings.GraphicPages] = false; oSearch[Search.Settings.EvalutionPages] = false; oSearch[Search.Settings.NotPlaced] = false; oSearch[Search.Settings.LogicPages] = true; Project oProject = new ProjectManager().OpenProject("$(MD_PROJECTS)\\ESS_Sample_Project.elk"); //clear active search result list oSearch.ClearSearchDB(oProject); string textToFind = "EB3*"; //Search the project oSearch.Project(oProject, textToFind); //Get search results StorableObject[] arrObjects = oSearch.GetAllSearchDBEntries(oProject);

Inheritance Hierarchy

System.Object
Eplan.EplApi.HEServices.Search

Syntax

C#
C++/CLI

[DefaultMember("Setting")]
public class Search

[DefaultMember("Setting")]
public ref class Search

Example

The following example shows how to use class Search.

Search oSearch = new Search();

// Set settings which will influence the search result
oSearch[Search.Settings.CaseSensitive] = false;
oSearch[Search.Settings.Texts] = false;
oSearch[Search.Settings.DeviceTag] = true;
oSearch[Search.Settings.AllProperties] = false;
oSearch[Search.Settings.Texts] = false;
oSearch[Search.Settings.PageData] = false;
oSearch[Search.Settings.ProjectData] = false;
oSearch[Search.Settings.GraphicPages] = false;
oSearch[Search.Settings.EvalutionPages] = false;
oSearch[Search.Settings.NotPlaced] = false;
oSearch[Search.Settings.LogicPages] = true;

Project oProject = new ProjectManager().OpenProject("$(MD_PROJECTS)\\ESS_Sample_Project.elk");

//clear active search result list
oSearch.ClearSearchDB(oProject);

string textToFind = "EB3*";
//Search the project
oSearch.Project(oProject, textToFind);		

//Get search results
StorableObject[] arrObjects = oSearch.GetAllSearchDBEntries(oProject);

Public Constructors

	Name	Description
	Search Constructor	Default constructor

Top

Public Properties

	Name	Description
	Setting	Gets/Sets whether the specified setting of a search is enabled

Top

Public Methods

	Name	Description
	AddRelatedObjectsToGotoDB	Adds cross-referenced objects to the goto results list.
	AddToSearchDB	Overloaded. Adds objects to the currently active list of search results.
	ClearSearchDB	Clears the list of search results.
	Dispose	Destructor
	GetAllSearchDBEntries	\Returns all objects in a list of search results.
	GetSearchDBEntries	Returns objects from a list of search results.
	Page	Overloaded. Searches on the specified page for a search string. The search settings will influence the result. The found object will be written to the active list of results.
	Project	Overloaded. Searches on the specified project for a search string. The search settings will influence the result. The found object will be written to the active list of results.

Top

Reference

Search Members
Eplan.EplApi.HEServices Namespace

Send Feedback