TopLeft

The top-left corner - where a "pinned" marker usually goes.

TopRight

The top-right corner.

BottomLeft

The bottom-left corner.

BottomRight

The bottom-right corner - where a "where it came from" marker usually goes.

OnHoverBeforeIcon

A checkbox in its own column before the icon, revealed while the result is hovered.

OnHoverOverIcon

A checkbox over the icon tile, revealed - and covering the icon - while the result is hovered.

AlwaysBeforeIcon

A checkbox in its own column before the icon, always visible.

ReplacingIcon

A checkbox in place of the icon tile, which is not drawn at all.

RightClickOnly

Right-clicking the result, and nothing else - no button is drawn.

ButtonOnHover

Right-clicking the result, or a [...] button revealed while it is hovered.

ButtonAlwaysVisible

Right-clicking the result, or a [...] button that is always visible.

OnHover

Revealed while the result is hovered (or focused).

AlwaysVisible

Always visible.

public OmniResult(T result, string title = null)

Initializes a new instance of this class standing for the given result.

public T Result { get; }

Gets the result this card stands for - the search hit, document, record or row it was built from.

public string Title { get ; set ; }

Gets or sets the title of the result.

public string Id { get ; set ; }

Gets or sets the identifier shown before the title - an issue number, a ticket key, a row number - followed by a chevron pointing at the title. A null or empty value drops both.

public string Text { get ; set ; }

Gets or sets the excerpt shown under the title, or null when the result has none. Plain text: the only markup it gets is the highlighting of Highlight.

public bool IsSelectionEnabled

Returns a value indicating whether the result can be selected.

public bool IsSelected { get ; set ; }

Gets or sets whether the result is selected. Setting it runs the OnSelectionChanged handlers, so a host list can keep its own selection in step whether the change came from the user or from code.

public bool IsActive { get ; set ; }

Gets or sets whether the result is the active one - the row a keyboard-driven list has moved to. It is styled like a hovered row, and reveals whatever the row reveals on hover.

public PagesStack Pages

Gets the PagesStack preview shown at the end of the row, or null when it has none.

public ContributionBar Contribution

Gets the ContributionBar shown under the footer, or null when it has none.

public MouseEvent CommandsEvent

Gets the pointer event that last asked for this result's commands - the right-click, or the click on the [...] button - or null when they were asked for from the keyboard. A host that shows its own command surface (rather than a ContextMenu through ShowMenu) reads this to place it where the user asked.

public bool HasModalContent

Gets a value indicating whether the result has content to open as a modal (see ToModal).

public IReadOnlyList<OmniResultOpenAction<T>> OpenActions

Gets the ways this result can be opened where it actually lives, in the order they were added - the first one is the primary, and the rest hang off the arrow beside it.

public bool CanOpenInSource

Gets a value indicating whether the result can be opened at its source.

public bool HasModalHeader

Gets a value indicating whether a header of the host's own was set with SetModalHeader - so a caller applying a default one can tell whether anyone got there first.

public Modal CurrentModal

Gets the modal ToModal last built for this result, or null when it has not built one yet - what a host reaches for to close, resize or otherwise get at the surface it opened.

public override HTMLElement Render()

Renders the component's root HTML element.

public OmniResult<T> SetId(string id)

Sets the identifier shown before the title - an issue number, a ticket key, a row number - drawn in the quiet way an identifier reads and followed by a chevron pointing at the title. A null or empty value drops the identifier and the chevron with it.

public OmniResult<T> SetText(string text)

Sets the excerpt shown under the title. It is plain text, not a component: whatever the search returned as the matching passage, ellipsized to the two lines the row gives it, with the terms of Highlight marked in it. A null or empty value drops the line entirely.

public OmniResult<T> TextLines(int lines)

Caps how many lines of the excerpt are shown before it is ellipsized. Two by default.

public OmniResult<T> SetContent(IComponent content)

Puts a component under the excerpt, in the text column: the rich preview a result has of its own - a thumbnail, a quoted message, a table of the fields that matched - for everything a plain excerpt can't say. Pass null to take it away. Cap how tall it is allowed to be with ContentMaxHeight, which fades the overflow out rather than cutting it off.

public OmniResult<T> ContentMaxHeight(UnitSize maxHeight)

Caps how tall the SetContent preview is allowed to grow, fading whatever runs past it out instead of cutting it off. Pass null to un-cap it.

public OmniResult<T> SetIconBadge(IComponent badge, OmniResultBadgeCorner corner = OmniResultBadgeCorner.BottomRight)

Pins a badge to a corner of the icon tile - where a result came from, that it is pinned - drawn over the tile's corner and outside its clipping. Pass null to clear that corner.

public OmniResult<T> HighlightWords(params string[] words)

Marks every occurrence of the given words in the excerpt, case-insensitively - the convenience form of Highlight for a host that has the query terms rather than a pattern.

public OmniResult<T> OnSourceClick(Action<OmniResult<T>> onClick)

Registers what clicking the source in the footer does - scope the search to it, open it, filter by it - and marks the source as clickable. Clicking it does not also count as opening the result. Pass null to make the source plain text again.

public OmniResult<T> AddFooterEntry(IComponent entry)

Adds one more entry to the end of the footer line, as a component of the host's own rather than an InlineLabel - a badge, a chip, a small control a label cannot be. It gets the same box and the same separating dot as every other entry.

public OmniResult<T> Selectable(OmniResultSelectionMode mode = OmniResultSelectionMode.OnHoverBeforeIcon)

Makes the result selectable, with its checkbox shown as the given mode says. The checkbox toggles the selection on click; ctrl-clicking the row does the same, and shift-clicking it asks for a range (see OnRangeSelectionRequested).

public OmniResult<T> NotSelectable()

Takes the checkbox away again, unselecting the result if it was selected.

public OmniResult<T> Selected(bool value = true)

Selects (or unselects) the result. Does nothing on a result that isn't selectable.

public OmniResult<T> OnSelectionChanged(Action<OmniResult<T>, bool> onSelectionChanged)

Registers a callback invoked whenever the result is selected or unselected, by the user or by code, with the new state.

public OmniResult<T> OnRangeSelectionRequested(Action<OmniResult<T>> onRangeSelectionRequested)

Registers a callback invoked when the user shift-clicks the result, i.e. asks for everything between the last result they selected and this one. A single card knows nothing about its siblings, so the host list owns what "between" means - and selects them itself.

public OmniResult<T> CommandsMode(OmniResultCommandsMode mode)

Changes how the commands registered with OnContextMenu are reached, without touching the handler itself.

public OmniResult<T> SetContributionBar(ContributionBar bar)

Puts a ContributionBar under the footer, spanning the text column: what the result's score is made of - a title match, a content match, recency, popularity - as one stacked bar. Pass null to take it away. A bar with many segments is worth collapsing (Collapsable), so a list of results reads as one line each until the breakdown is asked for.

public OmniResult<T> SetPages(PagesStack pages)

Pins the given PagesStack preview to the end of the row, in a rail wide enough for it to fan into. Pass null to take it away.

public OmniResult<T> PagesFanOnHover(bool value = true)

Configures whether the PagesStack fans while the row is hovered, rather than only while the pointer is over the pages themselves. On by default.

public OmniResult<T> NoOpenInSource()

Takes every way of opening the result at its source away again.

public OmniResult<T> Open(bool inNewTab = false)

Opens the result at its source the way the primary action says to, as pressing the button (or Ctrl+Enter in the modal) would. Does nothing on a result that has no such action.

public OmniResult<T> ModalCommands(Action<OmniResult<T>> onCommands)

Registers what the [...] button in the modal's header opens - the same commands the row's own [...] opens, usually. Read CommandsEvent in the handler to place a command surface of the host's own where the user clicked. Pass null to leave the button out.

public OmniResult<T> ModalFullScreen(Action<OmniResult<T>> onFullScreen)

Registers what the full-screen button in the modal's header does - open the result on a page of its own, usually. Without one the button is still there and simply grows the modal to fill the window (and back), which is what "full screen" means to a modal that has nowhere else to go.

public OmniResult<T> NoModalFullScreen()

Leaves the full-screen button out of the modal's header.

public OmniResult<T> ModalNavigation(Action<OmniResult<T>> onPrevious, Action<OmniResult<T>> onNext, int position = 0, int count = 0)

Puts the previous/next arrows in the modal's header, so a result opened out of a list can be stepped through without going back to it. A null handler greys its arrow out - that is how the first and the last result say so. Passing a position and a count (both 1-based, the count being how many results there are) draws "3 of 27" between the arrows.

public OmniResult<T> ModalShortcuts(bool value = true)

Configures whether the modal shows the keyboard shortcuts it answers along its bottom edge - what closes it, what steps through the results, what opens the result at its source. On by default.

public Task<IComponent> GetModalContentAsync()

Builds the modal content on its own, for a host that shows it somewhere other than in a modal - a side panel, a page, a pane of its own. Returns null when the result has no modal content.

public OmniResult<T> SetModalHeader(Func<OmniResult<T>, IComponent> header)

Replaces the modal's header - by default the same identifier, title and badge the row shows - with one built from the result. Pass null to go back to the default header.

public OmniResult<T> ModalSize(UnitSize width, UnitSize height)

Sets the size the modal of ToModal opens at. Auto by default, which lets the modal size itself to its content (and to whatever bounds the caller sets on it afterwards).

public OmniResult<T> ModalKeepsIcon(bool value = true)

Keeps the icon tile in the modal's header, before the identifier and the title - so an opened result still shows what kind of thing it is, and the row and the modal read as one thing rather than two. Whatever the tile carries comes with it: the glyph or the thumbnail, the color it is tinted with, and any corner badges. Off by default.

public OmniResult<T> ModalKeepsFooter(bool value = true)

Keeps the footer - the source and the metadata beside it - as a second line under the title in the modal's header, so where a result came from is still said once it is open. The source stays clickable when the row's is. Off by default.

public Modal ToModal()

Builds a Modal showing this result: the row's identifier, title and badge as the header, and whatever SetModalContent was given as the body, at the size ModalSize asked for. Everything else - commands, dismissal, bounds, how it is shown - is left to the caller to chain on the returned modal. Returns null when the result has no modal content, so a caller can treat "this result has no preview" as one check.

public IComponent[] ModalHeaderCommands()

The commands ToModal puts at the end of the modal's header: the way to open the result at its source, the arrows stepping through the results, the [...] commands, the full-screen button and the close button - whichever of them this result was configured for. Useful to a caller building a header of its own around them.

public IComponent ModalShortcutsBar()

The keyboard shortcuts ToModal lists along the bottom of the modal - only the ones this result actually answers, so a modal that can't be stepped through never says it can.

public IComponent ModalTitle()

The header ToModal uses by default: the identifier and the title, drawn the way the row draws them, plus whatever ModalKeepsIcon and ModalKeepsFooter asked to keep. Useful to a caller building its own header around it.

public OmniResult<T> ShowMenu(ContextMenu menu)

Shows the given menu where the commands were asked for: at the pointer when the row was right-clicked, and under the [...] button when it was pressed. This is what a OnContextMenu handler uses to put its menu in the right place without tracking the event itself.

public string Name { get; }

Gets what this way of opening the result is called.

public Func<IComponent> Icon { get; }

Gets what draws the mark shown before the name, or null when it has none. It is a factory rather than a component so that showing the action twice never moves one element between two places.

public Uri UrlFor(OmniResult<T> result)

Gets the address this action opens for the given result, or null when it isn't an address at all but something the host does itself.

public void Invoke(OmniResult<T> result, bool inNewTab = false)

Opens the given result this way. An address is always opened in a new tab, whatever was asked for: replacing the page with somewhere else entirely would lose the user's place.