MprImageTool Class Members

In This Topic

The following tables list the members exposed by MprImageTool.

Public Constructors

	Name	Description
	MprImageTool	Initializes a new instance of the MprImageTool class.

Public Properties

	Name	Description
	ActionButton	Gets or sets the mouse button, which executes the action of this tool.
	ActionCursor	Gets or sets a cursor, which should be used in image viewer when visual tool executes its action. (Inherited from VisualTool)
	ActiveInteractionController	Gets an active interaction controller. (Inherited from UserInteractionVisualTool)
	AdaptiveRenderingQualityComplexityThreshold	Gets or sets the adaptive quality complexity threshold.
	AdaptiveRenderingQualityStepCount	Gets or sets the maximum steps, which can be used to downscale the quality in preview process.
	AllowNextItemSelection	Gets or sets a value indicating whether the tool allows changing focused item using the PerformNextItemSelection(Boolean) method. (Inherited from VisualTool)
	AllowRotate3D	Gets or sets a value indicating whether rotation in 3D space is allowed.
	AreAxesVisible	Gets or sets a value indicating whether the axes are visible.
	CanModifyImage	Gets a value indicating whether this visual tool can modify the image. (Inherited from VisualTool)
	ChangeFocusedItemBeforeInteraction	Gets or sets a value indicating whether focused item can be changed before interaction. (Inherited from UserInteractionVisualTool)
	Clipboard	Gets or sets the clipboard of this tool. (Inherited from UserInteractionVisualTool)
	Cursor	Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool)
	DisableContextMenu	Gets or sets a value indicating whether image viewer must disable context menu in image viewer if the right mouse button is set as an action button of the visual tool. (Inherited from VisualTool)
	Enabled	Gets or sets a value indicating whether VisualTool can respond to the user interaction. (Inherited from VisualTool)
	FocusedImageViewerColorMark	Gets or sets the color of focused image viewer mark.
	FocusedImageViewerMarkSize	Gets or sets the size, in percents of FocusedSliceColorMarkSize, of focused image viewer mark.
	FocusedSlice	Gets or sets the focused slice.
	FocusedSliceColorMarkAnchor	Gets or sets the anchor of focused slice color mark.
	FocusedSliceColorMarkSize	Gets or sets the size, in pixels, of focused slice color mark.
	FocusedSliceRenderingQualityScale	Gets the rendering quality scale of focused slice.
	FocusedSliceView	Gets or sets the focused slice view.
	ImageViewer	Gets the ImageViewer object associated with this tool. (Inherited from VisualTool)
	IsFinishInteractionOnLostFocus	Gets or sets a value indicating whether interaction should be finished when focus is lost. (Inherited from UserInteractionVisualTool)
	IsFocusedSliceColorMarkVisible	Gets or sets a value indicating whether the color mark of focused slice is visible on image viewer.
	IsMultipageModeSupported	Gets a value indicating whether this tool supports multipage mode. (Inherited from VisualTool)
	IsSliceBuilding	Gets a value indicating whether MPR slice is building.
	IsVisibleWithoutImage	Gets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from VisualTool)
	MouseOrientationForSliceBrowsing	Gets or sets the mouse move orientation for slice browsing.
	MouseSensitivity	Gets or sets the mouse sensitivity.
	MouseWheelEnabled	Gets or sets a value indicating whether the mouse wheel is enabled.
	MouseWheelSensitivity	Gets or sets the mouse wheel sensitivity.
	MprImage	Gets the MPR image.
	MprSliceViewCollection	Gets the slice collection that will be viewed and edited using the visual tool.
	Name	Gets the name of visual tool.
	RenderingInterpolationMode	Gets or sets the interpolation mode of that uses for rendering of a MPR slice.
	RenderingMaxFps	Gets or sets the maximum renderer performance, in frame per second (FPS).
	RenderSyncObject	Gets or sets the object, which is used for synchronization of image rendering.
	ScrollProperties	Gets or sets the scroll properties.
	SelectNextItemKeyCode	Gets or sets a key code that changes the selected item to the next item. (Inherited from VisualTool)
	SelectPrevItemKeyCode	Gets or sets a key code that changes the selected item to the previous item. (Inherited from VisualTool)

Protected Properties

	Name	Description
	CanBeginInteractionAfterSetFocusedItem	Gets or sets a value indicating whether the interaction can be started right after the interactive object is selected. (Inherited from UserInteractionVisualTool)
	CanUserSetFocusedItem	Gets or sets a value indicating whether user can set the focused interactive object. (Inherited from UserInteractionVisualTool)
	EnableViewerInvalidate	Gets or sets a value indicating whether viewer must be invalidated when InvalidateViewer method is executed. (Inherited from VisualTool)
	FocusedItem	Gets or sets a focused item. (Inherited from UserInteractionVisualTool)
	InvokeRequired	Gets a value indicating whether the caller must call an invoke method when making method calls to the VisualTool because the caller is on a different thread than the one the VisualTool was created on. (Inherited from VisualTool)
	Items	Gets a collection of IInteractiveObject. (Inherited from UserInteractionVisualTool)
	MouseClickCount	Gets the count of mouse clicks in series of clicks. (Inherited from VisualTool)
	MouseClicksDelta	Gets or sets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from VisualTool)
	UseActionButtonToInteractionController	Gets a value indicating whether interaction controller should use ActionButton of visual tool.

Public Methods

	Name	Description
	AddAndBuildSlice	Overloaded. Adds slice to the slice collection of focused slice and starts building of slice.
	CancelActiveInteraction	Cancels an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool)
	CancelSliceBuilding	Cancels building of slice.
	Dispose	Overloaded. Releases all resources used by the object. (Inherited from VisualTool)
	FindSliceView	Overloaded. Finds a slice view for the specified slice.
	FindVisualTool<T>	Finds the specified visual tool of specified type in visual tool. (Inherited from VisualTool)
	FinishActiveInteraction	Finishes an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool)
	FinishSliceBuilding	Finishes building of slice.
	FitScene	Calculates the FocusedSlice location and ImageViewer zoom for optimal viewing of FocusedSlice in the viewer.
	GetActiveInteractionController	Overloaded. Returns the active interaction controller of specified visual tool. (Inherited from UserInteractionVisualTool)
	GetInteractionMode	Returns the interaction mode for specified mouse button.
	GetSupportedUIActions	Returns the supported UI actions. (Inherited from UserInteractionVisualTool)
	InvalidateFocusedItem	Invalidates a drawing box of focused interactive object. (Inherited from UserInteractionVisualTool)
	InvalidateItem	Invalidates a drawing box of specified interactive object. (Inherited from UserInteractionVisualTool)
	PerformNextItemSelection	Selects the next available item and makes it as the active item. (Inherited from UserInteractionVisualTool)
	ScrollToFocusedItem	Scrolls the viewer to the focused item. (Inherited from UserInteractionVisualTool)
	SetInteractionMode	Changes the interaction mode for specified mouse button.
	SetProperties	Sets the properties of specified MprImageTool.
	ToString	Returns the string representation of this object. (Inherited from VisualTool)

Protected Methods

	Name	Description
	BeginInteraction	Begins an active interaction. (Inherited from UserInteractionVisualTool)
	CanChangeFocusedItem	Determines that focused item can be changed. (Inherited from UserInteractionVisualTool)
	CanSelectNextItem	Returns a value indicating whether next item can be selected. (Inherited from UserInteractionVisualTool)
	CheckIsPointOnUnfocusedImage	Returns a value indicating whether the point is located on unfocused image. (Inherited from UserInteractionVisualTool)
	DrawItem	Draws an interactive object on specified graphics. (Inherited from UserInteractionVisualTool)
	FindInteractionArea	Finds the interaction area at the specified location, in viewer space. (Inherited from UserInteractionVisualTool)
	FindInteractiveObject	Finds an interactive object at specified point on image viewer.
	FinishInteraction	Finishes an active interaction.
	GetItemDrawingBox	Returns the item drawing box. (Inherited from UserInteractionVisualTool)
	GetPointsTransform	Returns a point transformation of specified interactive object. (Inherited from UserInteractionVisualTool)
	InvalidateViewer	Overloaded. Invalidates the specified region of the , and causes a paint message to be sent to the . (Inherited from VisualTool)
	Invoke	Overloaded. Executes the specified delegate on the thread that owns the 's underlying . (Inherited from VisualTool)
	IsActionButtonContains	Determines whether the ActionButton contains the button. (Inherited from VisualTool)
	NeedProcessMouseEvent	Returns a value indicating whether the visual tool will process the mouse event. (Inherited from UserInteractionVisualTool)
	OnActivated	Raises the Activated event.
	OnActivating	Raises the Activating event. (Inherited from VisualTool)
	OnActiveInteractionControllerChanged	Raises the ActiveInteractionControllerChanged event. (Inherited from UserInteractionVisualTool)
	OnDeactivated	Raises the Deactivated event.
	OnDeactivating	Raises the Deactivating event. (Inherited from VisualTool)
	OnEnabledChanged	Raises the EnabledChanged event. (Inherited from VisualTool)
	OnFocusedItemChanged	Occurs when focused item is changed. (Inherited from UserInteractionVisualTool)
	OnFocusedItemChanging	Occurs when focused item is changing. (Inherited from UserInteractionVisualTool)
	OnImageChanged	Raises the ImageChanged event. (Inherited from VisualTool)
	OnImageChanging	Raises the ImageChanging event. (Inherited from VisualTool)
	OnImageLoadingException	Raises the ImageLoadingException event. (Inherited from VisualTool)
	OnInteraction	Raises the interaction event for specified interactive object. (Inherited from UserInteractionVisualTool)
	OnItemCollectionChanged	Called when item collection is changed. (Inherited from UserInteractionVisualTool)
	OnItemStateChanged	Occurs when state of interactive object is changed. (Inherited from UserInteractionVisualTool)
	OnKeyDown	Raises the KeyDown event. (Inherited from UserInteractionVisualTool)
	OnKeyUp	Raises the KeyUp event. (Inherited from UserInteractionVisualTool)
	OnLostFocus	Occurs when visual tool loses the focus. (Inherited from UserInteractionVisualTool)
	OnMouseClick	Raises the MouseClick event.
	OnMouseDoubleClick	Raises the MouseDoubleClick event. (Inherited from VisualTool)
	OnMouseDown	Raises the MouseDown event.
	OnMouseEnter	Raises the MouseEnter event. (Inherited from VisualTool)
	OnMouseLeave	Raises the MouseLeave event.
	OnMouseMove	Raises the MouseMove event.
	OnMouseUp	Raises the MouseUp event.
	OnMouseWheel	Raises the MouseWheel event.
	OnPaint	Overloaded. Paints content of visual tool.
	OnPreviewKeyDown	Raises the PreviewKeyDown event. (Inherited from VisualTool)
	PointToInteractiveObject	Transforms a point from the viewer space to the interactive object space. (Inherited from UserInteractionVisualTool)
	ProcessImeMessages	Processes the IME Windows messages. (Inherited from UserInteractionVisualTool)
	Reset	Resets this tool. (Inherited from VisualTool)
	ScrollToItem	Scrolls the viewer to the specified item. (Inherited from UserInteractionVisualTool)
	SetInteractionControllerProperties	Sets properties to the specified interaction controller.
	TryFinishInteraction	Tries to finish the current interaction. (Inherited from UserInteractionVisualTool)

Public Events

	Name	Description
	Activated	Occurs when the visual tool is activated in the image viewer. (Inherited from VisualTool)
	Activating	Occurs when the visual tool is activating in the image viewer. (Inherited from VisualTool)
	ActiveInteractionControllerChanged	Occurs when the ActiveInteractionController property is changed. (Inherited from UserInteractionVisualTool)
	ColorMarkPainting	Occurs when the color mark is painting.
	Deactivated	Occurs when the visual tool is deactivated in the image viewer. (Inherited from VisualTool)
	Deactivating	Occurs when the visual tool is deactivating in the image viewer. (Inherited from VisualTool)
	EnabledChanged	Occurs when value of Enabled property is changed. (Inherited from VisualTool)
	FocusedSliceChanged	Occurs when the focused slice is changed.
	FocusedSliceDrawn	Occurs when the focused slice is drawn.
	ImageChanged	Occurs when the image is changed. (Inherited from VisualTool)
	ImageChanging	Occurs when the image is changing. (Inherited from VisualTool)
	ImageLoadingException	Occurs when the image is not loaded because of error. (Inherited from VisualTool)
	KeyDown	Occurs when a key is pressed while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	KeyUp	Occurs when a key is released while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	MouseClick	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is clicked. (Inherited from VisualTool)
	MouseDoubleClick	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is double clicked. (Inherited from VisualTool)
	MouseDown	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed. (Inherited from VisualTool)
	MouseEnter	Occurs when the mouse enters an area of visual tool. (Inherited from VisualTool)
	MouseLeave	Occurs when the mouse leaves an area of visual tool. (Inherited from VisualTool)
	MouseMove	Occurs when the mouse pointer is moved over the image viewer and this tool is enabled. (Inherited from VisualTool)
	MouseUp	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is released. (Inherited from VisualTool)
	MouseWheel	Occurs when the mouse wheel moves while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	PreviewKeyDown	Occurs before the KeyDown event when a key is pressed while focus is on this visual tool. (Inherited from VisualTool)
	SliceBuildingCanceled	Occurs when the slice building is canceled.
	SliceBuildingCanceling	Occurs when the slice building is canceling.
	SliceBuildingFinished	Occurs when the slice building is finished.
	SliceBuildingStarted	Occurs when the slice building is started.
	SliceBuildingStarting	Occurs when the slice building is starting.

Reference

MprImageTool Class
Vintasoft.Imaging.Dicom.Mpr.UI.VisualTools Namespace

Send Feedback