HighlightSearchOptionsKit

class HPS.HighlightSearchOptionsKit : HPS.Kit

The HighlightSearchOptionsKit class is a user space object. It is used to filter highlight queries via HighlightControl.ShowHighlightState, HighlightControl.ShowHighlightStates, and WindowKey.FindHighlights.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this HighlightSearchOptionsKit has any values set on it.

Return:true if no values are set on this HighlightSearchOptionsKit, false otherwise.

bool Equals (HPS.HighlightSearchOptionsKit in_kit)

Check if the source HighlightSearchOptionsKit is equivalent to this HighlightSearchOptionsKit.

Param in_kit:The source HighlightSearchOptionsKit to compare to this HighlightSearchOptionsKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

HighlightSearchOptionsKit ()

The default constructor creates an empty HighlightSearchOptionsKit object.

HighlightSearchOptionsKit (HPS.HighlightSearchOptionsKit in_kit)

The copy constructor creates a new HighlightSearchOptionsKit object that contains the same settings as the source HighlightSearchOptionsKit.

Param in_kit:The source HighlightSearchOptionsKit to copy.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.HighlightSearchOptionsKit in_kit)

Copies the source HighlightSearchOptionsKit into this HighlightSearchOptionsKit.

Param in_kit:The source HighlightSearchOptionsKit to copy.

HPS.HighlightSearchOptionsKit SetOverlay (HPS.Drawing.Overlay in_overlay)

Sets the overlay type to look for when querying highlights. Only highlights using this overlay type will be returned by highlight queries.

Param in_overlay:  Overlay type. Return:A reference to this object.

HPS.HighlightSearchOptionsKit SetOverlays (HPS.Drawing.Overlay[] in_overlays)

Sets the overlay types to look for when querying highlights. Only highlights using any overlay types in the array will be returned by highlight queries.

Param in_overlays:  Overlay types. Return:A reference to this object.

HPS.HighlightSearchOptionsKit SetStyleName (string in_style_name)

Sets the name of the style to look for when querying highlights. Only highlights using this style will be returned by highlight queries.

Param in_style_name:  UTF8-encoded style name. Return:A reference to this HighlightSearchOptionsKit.

HPS.HighlightSearchOptionsKit SetStyleNames (string[] in_style_names)

void Show (out HPS.HighlightSearchOptionsKit out_kit)

Copies this HighlightSearchOptionsKit into the given HighlightSearchOptionsKit.

Param out_kit:The HighlightSearchOptionsKit to populate with the contents of this HighlightSearchOptionsKit.

bool ShowOverlays (out HPS.Drawing.Overlay[] out_overlays)

Shows the overlay types to look for when querying highlights.

Param out_overlays:  Overlay types. Return:true if the setting is valid, false otherwise.

bool ShowStyleNames (out string[] out_style_names)

HPS.HighlightSearchOptionsKit UnsetEverything ()

Removes all settings from this HighlightSearchOptionsKit.

Return:A reference to this HighlightSearchOptionsKit.

HPS.HighlightSearchOptionsKit UnsetOverlays ()

Removes all overlay filters.

Return:A reference to this object.

HPS.HighlightSearchOptionsKit UnsetStyleNames ()

Removes all style filters.

Return:A reference to this HighlightSearchOptionsKit.

Public Static Functions

HPS.HighlightSearchOptionsKit GetDefault ()

Creates a HighlightSearchOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return:A HighlightSearchOptionsKit with the default settings.

bool operator!= (HPS.HighlightSearchOptionsKit a, HPS.HighlightSearchOptionsKit b)

bool operator== (HPS.HighlightSearchOptionsKit a, HPS.HighlightSearchOptionsKit b)