DicomViewerTool Class Members

In This Topic

The following tables list the members exposed by DicomViewerTool.

Public Constructors

	Name	Description
	DicomViewerTool	Overloaded. Initializes a new instance of the class.

Public Properties

	Name	Description
	ActionButton	Gets or sets the mouse button, which executes the action of this tool. (Inherited from VisualTool)
	ActionCursor	Gets or sets a cursor, which should be used in image viewer when visual tool executes its action. (Inherited from VisualTool)
	ActiveTool	Gets or sets the active visual tool. (Inherited from CompositeVisualTool)
	AllowNextItemSelection	Gets or sets a value indicating whether the tool allows changing focused item using the PerformNextItemSelection(Boolean) method. (Inherited from CompositeVisualTool)
	AlwaysLoadVoiLutFromMetadataOfDicomFrame	Gets or sets a value indicating whether the VOI LUT must be always loaded from DICOM frame metadata when image is changed.
	BrowseHorizontalCursor	Gets or sets the mouse cursor for Vintasoft.Imaging.Dicom.UI.VisualTools.DicomViewerToolInteractionMode.Browse in horizontal orientation.
	BrowsePixelDelta	Gets or sets the mouse move delta for frame browsing.
	BrowseVerticalCursor	Gets or sets the mouse cursor for Vintasoft.Imaging.Dicom.UI.VisualTools.DicomViewerToolInteractionMode.Browse in vertical orientation.
	BrowseWheelDelta	Gets or sets the mouse wheel delta for frame browsing.
	CanModifyImage	Gets a value indicating whether visual tool can modify the image. (Inherited from CompositeVisualTool)
	Cursor	Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool)
	CycleSlideBrowsing	Gets or sets a value indicating whether tool should cycle the slide browsing, i.e. tool should go to the first slide after last slide.
	DefaultDicomImageVoiLut	Gets or sets the VOI LUT, which is loaded from DICOM image metadata, of focused DICOM image.
	DicomImageVoiLut	Gets or sets the current VOI LUT.
	DicomImageVoiLutMouseMoveDirection	Gets or sets a mouse gesture, which must be used for changing the VOI lookup table of DICOM image.
	DicomImageVoiLutMouseSensitivity	Gets or sets a mouse sensitivity, which must be used for changing VOI lookup table of DICOM image.
	DicomImageVoiLutOffset	Gets or sets the offset of DicomImageVoiLut.WindowCenter.
	DicomImageVoiLutScale	Gets or sets the scale for DicomImageVoiLut.
	DisableContextMenu	Gets or sets a value indicating whether context menu is shown when user presses the right mouse button and the right mouse button is set as an action button of the tool. (Inherited from CompositeVisualTool)
	DisplayedImage	Gets the 8-bpp grayscale image, which is displayed in viewer.
	DisplayedImageProcessing	Gets or sets the image processing command, which must be applied to the DisplayedImage.
	Enabled	Gets or sets a value indicating whether VisualTool can respond to the user interaction. (Inherited from VisualTool)
	GraphicalOverlay	Gets a collection of static graphic objects, which are displayed in viewer.
	HorizontalImageRuler	Gets graphic object that shows a horizontal ruler for DICOM image in image viewer.
	ImageViewer	Gets the ImageViewer object associated with this tool. (Inherited from VisualTool)
	IsGraphicalOverlayVisible	Gets or sets a value indicating whether the visual tool must show static graphic objects in image viewer.
	IsImageNegative	Gets or sets a value indicating whether the image must be inverted.
	IsMultipageModeSupported	Gets a value indicating whether this tool supports multipage mode. (Inherited from CompositeVisualTool)
	IsTextOverlayVisible	Gets or sets a value indicating whether the visual tool must show information with DICOM metadata on image viewer.
	IsVisibleWithoutImage	Gets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from CompositeVisualTool)
	MouseOrientationForFrameBrowsing	Gets or sets the mouse move orientation for frame browsing.
	MouseSensitivity	Gets or sets the mouse sensitivity.
	MouseWheelInteractionMode	Gets or sets the interaction mode for the mouse wheel.
	MouseWheelSensitivity	Gets or sets the mouse wheel sensitivity.
	Name	Gets the name of visual tool.
	RenderSyncObject	Gets or sets the object for image rendering synchronization.
	RulersUnitOfMeasure	Gets or sets the unit of measure for rulers.
	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)
	ShowRulers	Gets or sets a value indicating whether the visual tool must show rulers on image viewer.
	TextOverlay	Gets a collection of text overlays, which are displayed on viewer.
	VerticalImageRuler	Gets graphic object that shows a vertical ruler for DICOM image in image viewer.
	WindowLevelCursor	Gets or sets the mouse cursor for Vintasoft.Imaging.Dicom.UI.VisualTools.DicomViewerToolInteractionMode.WindowLevel.
	ZoomCursor	Gets or sets the mouse cursor for Vintasoft.Imaging.Dicom.UI.VisualTools.DicomViewerToolInteractionMode.Zoom.
	ZoomStep	Gets or sets the zoom step of the image.

Protected Properties

	Name	Description
	EnableViewerInvalidate	Gets or sets a value indicating whether viewer must be invalidated when InvalidateViewer method is executed. (Inherited from VisualTool)
	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)
	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)
	VisualTools	Gets or sets an array of visual tools. (Inherited from CompositeVisualTool)

Public Methods

	Name	Description
	Contains	Determines that visual tool is a child tool of the CompositeVisualTool. (Inherited from CompositeVisualTool)
	CreateApplyDicomImageVoiLutCommand	Creates the DicomImageVoiLookupTable.
	Dispose	Overloaded. Releases all resources used by the object. (Inherited from VisualTool)
	FindVisualTool	Overloaded. Finds the specified visual tool of specified type in composite visual tool. (Inherited from CompositeVisualTool)
	GetDisplayedImage	Returns a copy of 8-bpp grayscale image, which is displayed in image viewer.
	GetEnumerator	Returns an enumerator that iterates through a visual tool. (Inherited from CompositeVisualTool)
	GetInteractionMode	Returns the interaction mode for specified mouse button.
	GetSupportedUIActions	Returns the supported UI actions. (Inherited from CompositeVisualTool)
	PerformNextItemSelection	Selects the next available item and makes it as the active item. (Inherited from CompositeVisualTool)
	Refresh	Refreshes the visual tool.
	SetInteractionMode	Changes the interaction mode for specified mouse button.
	SetProperties	Sets the properties of specified DicomViewerTool.
	ToArray	Converts items of this composite visual tool to an array. (Inherited from CompositeVisualTool)
	ToString	Returns the string representation of this object. (Inherited from VisualTool)
	UpdateDisplayedImage	Updates the 8-bpp grayscale image, which is displayed in image viewer.
	UpdateImage	Updates the source image.

Protected Methods

	Name	Description
	CalcualteVoiLutChangeAmount	Calculates the VOI LUT change amount by specified length.
	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.
	OnActivated	Raises the Activated event.
	OnActivating	Raises the Activating event. (Inherited from VisualTool)
	OnDeactivated	Raises the Deactivated event.
	OnDeactivating	Raises the Deactivating event. (Inherited from VisualTool)
	OnDicomImageVoiLutChanged	Raises the DicomImageVoiLutChanged event.
	OnEnabledChanged	Raises the EnabledChanged event. (Inherited from VisualTool)
	OnImageChanged	Raises the ImageChanged event. (Inherited from VisualTool)
	OnImageChanging	Raises the ImageChanging event. (Inherited from VisualTool)
	OnImageLoadingException	Raises the ImageLoadingException event. (Inherited from VisualTool)
	OnKeyDown	Raises the KeyDown event. (Inherited from CompositeVisualTool)
	OnKeyUp	Raises the KeyUp event. (Inherited from CompositeVisualTool)
	OnLostFocus	Occurs when visual tool loses the focus. (Inherited from CompositeVisualTool)
	OnMouseClick	Raises the MouseClick event. (Inherited from CompositeVisualTool)
	OnMouseDoubleClick	Raises the MouseDoubleClick event. (Inherited from CompositeVisualTool)
	OnMouseDown	Raises the MouseDown event.
	OnMouseEnter	Raises the MouseEnter event. (Inherited from CompositeVisualTool)
	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 on specified image. (Inherited from CompositeVisualTool)
	OnPreviewKeyDown	Raises the PreviewKeyDown event. (Inherited from CompositeVisualTool)
	ProcessImeMessages	Processes IME Windows messages. (Inherited from CompositeVisualTool)
	Reset	Resets the tool. (Inherited from CompositeVisualTool)

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)
	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)
	DicomImageVoiLutChanged	Occurs when the VOI LUT is changed.
	EnabledChanged	Occurs when value of Enabled property is changed. (Inherited from VisualTool)
	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)

Reference

DicomViewerTool Class
Vintasoft.Imaging.Dicom.UI.VisualTools Namespace

Send Feedback