|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ISymbologyControlEvents
Provides access to events that occur with interaction to the SymbologyControl.
This is the main events interface for the SymbologyControl. Generally there is no need to explicitly set event handlers, as most development environments will automatically provide event handlers.
| Method Summary | |
|---|---|
void |
onDoubleClick(ISymbologyControlEventsOnDoubleClickEvent theEvent)
Fires when the user presses and releases the mouse button twice in quick succession. |
void |
onItemSelected(ISymbologyControlEventsOnItemSelectedEvent theEvent)
Fires when an item is selected in the SymbologyControl. |
void |
onKeyDown(ISymbologyControlEventsOnKeyDownEvent theEvent)
Fires after a key is pressed on the keyboard. |
void |
onKeyUp(ISymbologyControlEventsOnKeyUpEvent theEvent)
Fires after a pressed key is released. |
void |
onMouseDown(ISymbologyControlEventsOnMouseDownEvent theEvent)
Fires when the user presses any mouse button while over the SymbologyControl. |
void |
onMouseMove(ISymbologyControlEventsOnMouseMoveEvent theEvent)
Fires when the user moves the mouse pointer over the SymbologyControl. |
void |
onMouseUp(ISymbologyControlEventsOnMouseUpEvent theEvent)
Fires when the user releases a mouse button while over the SymbologyControl. |
void |
onStyleClassChanged(ISymbologyControlEventsOnStyleClassChangedEvent theEvent)
Fires when the style class changes. |
| Method Detail |
|---|
void onMouseDown(ISymbologyControlEventsOnMouseDownEvent theEvent)
throws IOException,
AutomationException
The OnMouseDown event is triggered when the user presses a mouse button on the SymbologyControl . Use the event to specify actions that will occur when a given mouse button is pressed.
button specifies which mouse button was pressed. 1 for the left mouse button, 2 for the right mouse button, and 4 for the middle mouse button.
shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.
x is the X coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the SymbologyControl (the top left hand corner).
y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the SymbologyControl (the top left hand corner).
Use the win32 SetCapture function to continue receiving mouse events (until the mouse is released) when the mouse is moved outside the control's display area. The win32 ReleaseCapture function releases the mouse.
theEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void onMouseUp(ISymbologyControlEventsOnMouseUpEvent theEvent)
throws IOException,
AutomationException
The OnMouseUp event is triggered when the user releases a mouse button on the SymbologyControl . Use the event to specify actions that will occur when a given mouse button is released.
button specifies which mouse button was pressed. 1 for the left mouse button, 2 for the right mouse button, and 4 for the middle mouse button.
shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.
x is the X coordinate, in device units, where the mouse button was pressed referenced against the origin (0, 0) of the SymbologyControl (the top left hand corner).
y is the Y coordinate, in device units, where the mouse button was pressed referenced against the origin (0, 0) of the SymbologyControl (the top left hand corner).
Use the win32 SetCapture function to continue receiving mouse events (until the mouse is released) when the mouse is moved outside the control's display area. The win32 ReleaseCapture function releases the mouse.
theEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void onMouseMove(ISymbologyControlEventsOnMouseMoveEvent theEvent)
throws IOException,
AutomationException
The OnMouseMove event is triggered continually as the mouse moves over the SymbologyControl .
button specifies which mouse button was pressed. 1 for the left mouse button, 2 for the right mouse button, and 4 for the middle mouse button.
shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.
x is the X coordinate, in device units, where the mouse button was pressed referenced against the origin (0, 0) of the SymbologyControl (the top left hand corner).
y is the Y coordinate, in device units, where the mouse button was pressed referenced against the origin (0, 0) of the SymbologyControl (the top left hand corner).
theEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void onDoubleClick(ISymbologyControlEventsOnDoubleClickEvent theEvent)
throws IOException,
AutomationException
button specifies which mouse button was pressed. 1 for the left mouse button, 2 for the right mouse button, and 4 for the middle mouse button.
shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.
x is the X coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the SymbologyControl (the top left hand corner).
y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the SymbologyControl (the top left hand corner).
The OnDoubleClick event is triggered when the user releases and presses a mouse button and then presses and releases it again on the SymbologyControl. If the double click does not occur within the system's double click time limit, the SymbologyControlwill recognise another OnMouseDown event. Otherwise the event sequence is as follows:
OnMouseDown
OnMouseUp
OnDoubleClick
OnMouseUp
theEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void onKeyDown(ISymbologyControlEventsOnKeyDownEvent theEvent)
throws IOException,
AutomationException
The OnKeyDown event is triggered when the user presses a key whilst the SymbologyControl has focus.
keyCode specifies a virtual key code value of the key pressed on the keyboard. For alpha-numeric keys this corresponds to the ASCII value, for example "A" key returns 65 which is the ASCII value for capital A. Other key codes are F1 to F12 are 112 to 123 respectively.
Shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.
Some development environments will filter out keystrokes. Typically the arrow keys are used to change control focus and will not fire the OnKeyDown event. To intercept these keys use the KeyIntercept property.
theEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void onKeyUp(ISymbologyControlEventsOnKeyUpEvent theEvent)
throws IOException,
AutomationException
The OnKeyUp event is triggered when when the user releases a key whilst the SymbologyControl has focus.
keyCode specifies a virtual key code value of the key pressed on the keyboard. For alpha-numeric keys this corresponds to the ASCII value, for example "A" key returns 65 which is the ASCII value for capital A. Other key codes are F1 to F12 are 112 to 123 respectively.
Shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.
Some development environments will filter out keystrokes. Typically the arrow keys are used to change control focus and will not fire the OnKeyUp event. To intercept these keys use the KeyIntercept property.
theEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void onStyleClassChanged(ISymbologyControlEventsOnStyleClassChangedEvent theEvent)
throws IOException,
AutomationException
The OnStyleClassChanged event is triggered whenever the SymbologyStyleClass displayed by the control is changed, either by programmatically setting the ISymbologyControl::StyleClass or by the end user interacting with the 'Style Class' context menu.
The end user can display the 'Style Class' context menu by right clicking on the SymbologyControl when the control has focus when ISymbologyControl::ShowContextMenu is true.
theEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void onItemSelected(ISymbologyControlEventsOnItemSelectedEvent theEvent)
throws IOException,
AutomationException
The OnItemSelected event is triggered whenever an item is selected within a SymbologyStyleClass, either interactivly by the end user clicking on an item in the SymbologyControl or programmatically when using the ISymbologyStyleClass::SelectItem method on the current ISymbologyControl::StyleClass.
theEvent - The event
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||