Skip to main content

ISearchPane

Represents the area reserved for the Search component and is a property of IShellFrame

Properties

NameTypeDescription
AvailablebooleanResolves if the bar is available.Receives true if the side bar is available.
EventsIEventsReturns the event registering interface for theISearchPane interface.
SearchWithinViewOptionVisibleboolean

Methods

NameDescription
GetOptionsGets the list of options to show in a specific section of the search UI.
GetSearchCriteriaGet search criteria as Search conditions.
IsSearchViewIs user is in search View.
SetOptionStateSets the state of the specified option.

Events

Started

Sent when the object turns to started state.

MFiles.Event.Started

Event has no arguments

Example Code

const eventHandle = await searchPane.Events.Register(
MFiles.Event.Started,
() => {
// Handle event
},
);

// Later unregister the event
searchPane.Events.Unregister(eventHandle);

Stop

Sent before the object is stopped.

MFiles.Event.Stop

Event has no arguments

Example Code

const eventHandle = await searchPane.Events.Register(MFiles.Event.Stop, () => {
// Handle event
});

// Later unregister the event
searchPane.Events.Unregister(eventHandle);