ComponentHighlightEvent

class HPS.ComponentHighlightEvent : HPS.Event

The ComponentHighlightEvent class is the event that will be triggered for each highlight or unhighlight call.

Public Types

enum Action

Values:

None

Highlight

Unhighlight

Public Functions

override string ClassName ()

override HPS.Event Clone ()

Allocates and returns a copy of this ComponentHighlightEvent.

Return:A copy of this ComponentHighlightEvent.

ComponentHighlightEvent ()

The default constructor creates an empty ComponentHighlightEvent object.

ComponentHighlightEvent (HPS.ComponentHighlightEvent in_that)

ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.Canvas in_canvas)

ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.Canvas in_canvas, ulong in_layer)

ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.Canvas in_canvas, ulong in_layer, HPS.ComponentPath in_path)

ComponentHighlightEvent (HPS.ComponentHighlightEvent.Action in_action, HPS.Canvas in_canvas, ulong in_layer, HPS.ComponentPath in_path, HPS.HighlightOptionsKit in_options)

ComponentHighlightEvent (HPS.Event in_event)

This constructor converts an Event Object to a ComponentHighlightEvent object.

Param in_event:The Event Object to be converted.

override void Dispose ()

Properties

HPS.ComponentHighlightEvent.Action action { get; set; }

HPS.Canvas canvas { get; set; }

ulong layer { get; set; }

HPS.HighlightOptionsKit options { get; set; }

HPS.ComponentPath path { get; set; }