ISearchProvider interface

No description yet.

public interface ISearchProvider

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
AddImageTo	int
Done	void
ExtractData	void
Init	void
JumpTo	void
Search	void

AddImageTo

No description yet.

int AddImageTo(string argImageId, UIntPtr argImageListHandle);
int AddImageTo(string argImageId, object argImageListHandle);

Parameter	Type	Passing
argImageId	string	value
argImageListHandle	UIntPtr	value

Returns: int

The first overload is an extension method of ISearchProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

Done

No description yet.

void Done();

Returns: nothing (void)

ExtractData

No description yet.

void ExtractData(string argItemid, out string argDisplayString, out string argImageId);

Parameter	Type	Passing
argItemid	string	value
argDisplayString	string	out
argImageId	string	out

Returns: nothing (void)

Init

No description yet.

void Init();

Returns: nothing (void)

JumpTo

No description yet.

void JumpTo(string argItemid);

Parameter	Type	Passing
argItemid	string	value

Returns: nothing (void)

Search

No description yet.

void Search(string argQuery, ISearchResults argResults);
void Search(string argQuery, object argResults);

Parameter	Type	Passing
argQuery	string	value
argResults	ISearchResults	value

Returns: nothing (void)

The first overload is an extension method of ISearchProviderHelper (using DXP;) with typed parameters; the second is declared by the interface.

Accepted by

ISearchManager.RegisterProvider, ISearchManager.UnRegisterProvider