ISearchPane

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

Properties

Name	Type	Description
Available	boolean	Resolves if the bar is available.Receives true if the side bar is available.
Events	IEvents	Returns the event registering interface for theISearchPane interface.
SearchWithinViewOptionVisible	boolean

Methods

Name	Description
GetOptions	Gets the list of options to show in a specific section of the search UI.
GetSearchCriteria	Get search criteria as Search conditions.
IsSearchView	Is user is in search View.
SetOptionState	Sets 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);