DiagramClientView Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Diagrams

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll

Package:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams v17.10.40171

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This is an IMS-based design surface which is capable of rendering any IMS Diagram.

public ref class DiagramClientView : System::Windows::Forms::Control

public class DiagramClientView : System.Windows.Forms.Control

type DiagramClientView = class
    inherit Control

Public Class DiagramClientView
Inherits Control

Inheritance: Control
DiagramClientView

Constructors

DiagramClientView()

Initializes a new instance of the DiagramClientView class.

Properties

ActiveMouseAction	Gets or sets the active mouse action for this DiagramClientView.
Cursor	(Note: Override the cursor in the MouseAction-derived classes or ShapeElement-derived classes instead.)
Diagram	Gets or sets the Diagram object associated with this DiagramClientView.
DpiX	Display resolution X in dots per inch. MAY BE STALE if display resolution has changed since last call to UpdateRatios (via W2D/D2W calls). It is likely not to have changed and good enough for most purposes (creation was for bump-scrolling) as it avoids creating another graphics as does GetWorldUnitsPerDeviceUnits.
DpiY	Display resolution X in dots per inch. MAY BE STALE if display resolution has changed since last call. Likely not and good enough for most purposes as it avoids creating another graphics.
DropTargetFeedback	Gets a DropTargetFeedback object which provides the drag feedback. By modifying this object, drag feedback can be altered.
HighlightedShapes	Gets the highlighted shapes for the DiagramClientView.
HorizontalScrollPosition	Gets or sets the horizontal scroll position in scroll units.
InvokeDragDropTarget	The shape that InvokeDragDrop() will drop onto, or null if there is no drop target.
MaximumHorizontalScrollRange	Gets or sets the upper limit of values of the scrollable range in scroll units. This is not the maximum scroll position.
MaximumVerticalScrollRange	Gets or sets the upper limit of values of the scrollable range in scroll units. This is not the maximum scroll position.
MaximumZoom	Gets the maximum zoom allowed.
MinimumHorizontalScrollRange	Gets the lower limit of values of the scrollable range in scroll units.
MinimumVerticalScrollRange	Gets the lower limit of values of the scrollable range in scroll units.
MinimumZoom	Gets the minimum zoom allowed.
MouseHoverDelay	Gets or sets the amount to delay the raising of the shape MouseHover event. Units are in milliseconds.
ScrollPageSize	Gets the number of scroll units to scroll for scrolling a page.
ScrollUnitsPerMouseWheel	Gets the number of scroll units to scroll for each mouse wheel event.
Selection	Gets the selection for the DiagramClientView.
ShadowBitmap	Gets the ShadowBitmap associated with this design surface.
TakeFocusOnDragOver	Gets or sets a value indicating whether this control should take the focus on a DragOver event.
VerticalScrollPosition	Gets or sets the vertical scroll position in scroll units.
ViewBounds	Gets the bounds of the viewport in world units relative to the top-left of the Diagram.
ViewLocation	Gets the top-left corner of the viewport relative to the top-left of the Diagram in world units.
ViewSize	Gets the size of the viewport in world units.
ZoomFactor	Gets the scaling factor.

Methods

CanTranslateToCommand(Keys)	Returns a value indicating whether the key translates to a command.
CreateAccessibilityInstance()	Creates a new accessibility object for this control.
DeviceToWorld(Point)	Converts a point in device units to world units using the view's current zoom factor. The device units are relative to the DiagramClientView's top-left. The world units are relative to the diagram's top-left.
DeviceToWorld(Rectangle)	Converts a rectangle in device units to world units using the view's current zoom factor. The device units are relative to the DiagramClientView's top-left. The world units are relative to the diagram's top-left.
DeviceToWorld(Size, Single)	Converts a size in device units to world units using the specified zoom factor.
DeviceToWorld(Size)	Converts a size in device units to world units using the view's current zoom factor.
DisableBumpScrolling()	Disables bump scrolling.
Dispose(Boolean)	Releases all resources, managed and unmanaged, related to this class.
EnableBumpScrolling(Int32)	Enables bump scrolling after the specified initial delay in milliseconds.
EnsureVisible(ICollection<ShapeElement>)	Ensures that the specified shapes are visible in the view. This may require changes to the scroll positions and to the zoom.
EnsureVisible(RectangleD, DiagramClientView+EnsureVisiblePreferences)	Ensures that the specified rectangle is visible in the view. This may require changes to the scroll positions and to the zoom.
EnsureVisible(RectangleD)	Ensures that the specified rectangle is visible in the view. Based on VisiblePreference setting for the Diagram, the RectangleD will be brought into view. ZoomOut may be used to fit the RectangleD iff MinimalScrollWithNoZoom VisiblePreference is not selected for this Diagram. Scrolling may be used to fit the RectangleD and depending on the VisiblePreference setting selected for the diagram, either the center of the Rectangle will be brought into view center or minimal scrolling that is required to bring the Rectangle into view will be done.
GetNudgeHorizontalDelta(Double)	The horizontal amount (in world units) by which a nudge operation can move a shape.
GetNudgeVerticalDelta(Double)	The vertical amount (in world units) by which a nudge operation can move a shape.
GetPotentialMouseAction(MouseButtons, PointD, DiagramHitTestInfo)	Retrieves the potential mouse action that should be made active on the very next MouseDown event if the MouseDown event occurs at the specified point.
InvalidateRectangle(RectangleD)	Invalidates the specified rectangle in world units.
InvokeDragDrop(DragEventArgs)	Invokes a DragDrop of the supplied DragEventArgs onto the currently selected Shape.
IsInputKey(Keys)	Determines whether the specified key is a regular input key or a special key that requires preprocessing.
ManuallyRouteSelection(LinkShape, LineSegment, PointD, PointD)	ManuallyRoute the line segment of the primary LinkShape in the selection.
Nudge(SizeD)	Repositions the selected shapes by the specified delta in world units.
NudgeDown()	Moves the selection down.
NudgeLeft()	Moves the selection left.
NudgeRight()	Moves the selection right.
NudgeUp()	Moves the selection up.
OnClick(EventArgs)	Dispatches the Click event to the appropriate diagram objects.
OnContextMenuRequested(MouseEventArgs)	Raises the ContextMenuRequested event.
OnDoubleClick(EventArgs)	Dispatches the DoubleClick event to the appropriate diagram objects.
OnDragDrop(DragEventArgs)	Dispatches the DragDrop event to the appropriate diagram objects.
OnDragDropCancelled(EventArgs)	Reset the toolbox on dragdrop cancel
OnDragDropCommon(DragEventArgs, Boolean, ShapeElement)	Called on a DragDrop.
OnDragEnter(DragEventArgs)
OnDragLeave(EventArgs)	Dispatches the DragLeave event to the appropriate diagram objects.
OnDragOver(DragEventArgs)	Dispatches the DragOver event to the appropriate diagram objects.
OnElementEventsEnded(ElementEventsEndedEventArgs)	Called when element events have ended.
OnElementEventsEnding(ElementEventsEndedEventArgs)	Called when element events are ending.
OnGiveFeedback(GiveFeedbackEventArgs)	The GiveFeedback event allows the source of a drag event to modify the appearance of the mouse pointer in order to give the user visual feedback during a drag-and-drop operation.
OnGotFocus(EventArgs)	Overridden.
OnKeyDown(KeyEventArgs)	Dispatches the KeyDown event to the appropriate diagram objects.
OnKeyPress(KeyPressEventArgs)	Dispatches the KeyDown event to the appropriate diagram objects.
OnKeyUp(KeyEventArgs)	Dispatches the KeyUp event to the appropriate diagram objects.
OnLostFocus(EventArgs)	Overridden.
OnMouseDown(MouseEventArgs)	Dispatches the MouseDown event to the appropriate diagram objects.
OnMouseEnter(EventArgs)	Dispatches the MouseEnter event to the appropriate diagram objects.
OnMouseLeave(EventArgs)	Dispatches the MouseLeave event to the appropriate diagram objects.
OnMouseMove(MouseEventArgs)	Dispatches the MouseMove event to the appropriate diagram objects.
OnMouseUp(MouseEventArgs)	Dispatches the MouseUp event to the appropriate diagram objects.
OnMouseWheel(MouseEventArgs)	Dispatches the MouseWheel event to the appropriate diagram objects.
OnPaint(PaintEventArgs)	Paints the control.
OnResize(EventArgs)	Raises the resize event. Resets the diagram's ShadowBitmap.
PreProcessMessage(Message)	Catch a couple of messages before translation.
ResizeDown()	Resizes the selected shapes by increasing its height.
ResizeLeft()	Resizes the selected shapes by decreasing its width.
ResizeRight()	Resizes the selected shapes by increasing its width.
ResizeSelection(GrabHandle+ShapeSide, PointD)	Resizes the shapes in the selection
ResizeUp()	Resizes the selected shapes by decreasing its height.
ScrollDown()	Scrolls the view down.
ScrollHorizontally(Int32)	Scrolls horizontally by the number of scroll units specified.
ScrollLeft()	Scrolls the view left.
ScrollRight()	Scrolls the view right.
ScrollTo(PointD)	Scrolls such that the specified point of the diagram becomes the top-left point of the view. The point is in world units relative to the top-left of the diagram.
ScrollUp()	Scrolls the view up.
ScrollVertically(Int32)	Scrolls vertically by the number of scroll units specified.
SetZoomFactor(Single, PointD, Boolean)	Zooms in or out around a specified point in the diagram. The coordinates are in world units and relative to the diagram's top-left. Optionally, the view center can be moved to the zoom center.
ShowError(String)	Displays the specified error message.
ShowToolTip()	Shows the tooltip of the currently focused item, if any.
TranslateToCommand(DiagramKeyEventArgs)	Invokes a command
WndProc(Message)	Processes Windows messages
WorldToDevice(PointD)	Converts a point in world units to device units using the view's current zoom factor. The point returned is relative to the DiagramClientView's top-left.
WorldToDevice(RectangleD)	Converts a rectangle in world units to device units using the view's current zoom factor. The rectangle returned is relative to the DiagramClientView's top-left.
WorldToDevice(SizeD, Single)	Converts a size in world units to device units using the specified zoom factor.
WorldToDevice(SizeD)	Converts a size in world units to device units using the view's current zoom factor.
ZoomAtViewCenter(Single)	Zooms in or out around the center point of the current view.
ZoomIn()	Increases the ZoomFactor.
ZoomInAt(PointD)	Zooms in, keeping the specified point at the same device coordinates after zoom.
ZoomOut()	Decreases the ZoomFactor.
ZoomOutAt(PointD)	Zooms out, keeping the specified point at the same device coordinates after zoom.
ZoomToFit()	Zooms in or out to show the entire diagram as large as possible.
ZoomToFit(RectangleD)	Zooms to show the portion of the diagram given by the specified rectangle.

Events

ContextMenuRequested	Occurs when the control's context menu has been requested.
DiagramAssociated	Event fired after a diagram is associated with the client view
DiagramDisassociating	Event fired before a diagram is disassociated with the client view
ScrollPositionChanged	Occurs when the value of either the HorizontalScrollPosition property or VerticalScrollPosition property changes.
ScrollRangeChanged	Occurs when the value of either the MaximumHorizontalScrollRange property or MaximumVerticalScrollRange property changes.
ZoomChanged	Occurs when the the value of the ZoomFactor property changes.

Applies to

Freigeben über