Rubberband Class

A base class which all rubber bands inherit from.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Atalasoft.Imaging.WinControls.Rubberband
        Atalasoft.Imaging.WinControls.EllipseRubberband
        Atalasoft.Imaging.WinControls.LineRubberband
        Atalasoft.Imaging.WinControls.RectangleRubberband
        Atalasoft.Imaging.WinControls.RectangleSelection

Namespace: Atalasoft.Imaging.WinControls
Assembly: Atalasoft.dotImage.WinControls (in Atalasoft.dotImage.WinControls.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public abstract class Rubberband : Component

Public MustInherit Class Rubberband
	Inherits Component

The Rubberband type exposes the following members.

Constructors

	Name	Description
	Rubberband()	Initializes a new instance of the Rubberband class
	Rubberband(Viewport)	Initializes a new instance of the Rubberband class

Top

Properties

	Name	Description
	Active	Gets or sets a value indicating if the rubberband is active in the parent Viewport control.
	ActiveButtons	Gets or sets a value indicating which mouse buttons are used to draw the rubberband.
	AspectRatio	Gets or sets the aspect ratio which the rubberband will be constrained to.
	BackgroundColor	Gets or sets the background color of a dashed line.
	Bounds	Gets or sets the rectangular area occupied by the rubberband in image pixel coordinates.
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	ClickLock	Gets or sets a value indicating if clicking on the Viewport without moving the mouse starts or finishes a rubberband.
	ConstrainPosition	Gets or sets a value indicating if the RubberBand can be drawn outside the image area.
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	Cursor	Gets or sets the cursor which is displayed in the parent Viewport when active.
	CursorPad	Gets or sets the amount of padding for the cursor to change and to allow adjusting the existing selection.
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	EndPoint	Gets or sets the end point of the Rubberband. Normally this is the bottom-right corner.
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	Inverted	Gets or sets a value indicating if the rubberband is drawn inverted.
	IsDragging	Gets or sets a value indicating whether the Rubberband is being dragged.
	MoveCursor	Gets or sets the cursor used when moving the rubberband.
	MoveWhenInside	Gets or sets a value indicating if the rubberband can be moved with the mouse.
	Parent	Gets or sets the parent ViewPort control.
	Pen	Gets or sets a value of the pen which is used to draw the rubberband.
	Persist	Gets or sets a value indicating if the rubberband continues to display after the mouse button is released.
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)
	SnapToPixelGrid	Gets or sets a value indicating if the rubberband snaps to a grid occupied by one image pixel.
	StartPoint	Gets or sets the starting point of the Rubberband. Normally this is the top-left corner.
	Visible	Gets or sets a value indicating if the rubberband is currently visible.

Top

Methods

	Name	Description
	Cancel	Cancels dragging a new rubberband.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Dispose()	Releases all resources used by the Component. (Inherited from Component.)
	Dispose(Boolean)	Releases resources held by the object back to the system. (Overrides Component.Dispose(Boolean).)
	DrawRegion	Called when a region needs to be drawn.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	EraseRegion	Call this method to erase the current region.
	Finalize	(Overrides Component.Finalize().)
	GetConstrainedPoint	Returns a point that is within the image bounds and snap to the pixel grid.
	GetDisplayBounds	Returns a Rectangle representing the rectangular rubberband boundary in Viewport display coordinates.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetRegion	Inheriting classes must implement this method and return the region occupied by the rubber band.
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HitTest	Returns a value indicating if the position is within the RubberBand boundary.
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnActiveButtonsChanged	Called when the ActiveButtons property changes and raises the ActiveButtonsChanged event.
	OnActiveChanged	Called when the Active property has changed and raises the ActiveChanged event.
	OnAspectRatioChanged	Called when the AspectRatio property has changed and raises the AspectRatioChanged event.
	OnBackgroundColorChanged	Called when the BackgroundColor property has changed and raises the BackgroundColorChanged event.
	OnChanged	Called when the Rubberband has changed.
	OnChanging	Called when the Rubberband is in the process of changing.
	OnClickLockChanged	Called when the ClickLock property has changed and raises the ClickLockChanged event.
	OnConstrainPositionChanged	Called when the ConstrainPosition property has changed and raises the ConstrainPositionChanged event.
	OnCursorChanged	Called when the Cursor property has changed and raises the CursorChanged event.
	OnDrawRubberband	Draws the Rubberband using the provided Canvas and pen.
	OnInvertedChanged	Called when the Inverted property has changed and raises the InvertedChanged event.
	OnMouseDown	Called when a mouse button is pressed over the Rubberband.
	OnMouseMove	Called when the mouse is moved over the Rubberband.
	OnMouseUp	Called when a mouse button is released over the Rubberband.
	OnMoveCursorChanged	Called when the MoveCursor property has changed and raises the MoveCursorChanged event.
	OnMoveWhenInsideChanged	Called when the MoveWhenInside property has changed and raises the MoveWhenInsideChanged event.
	OnPaint	Called when the Rubberband needs to be painted.
	OnParentChanged	Called when the Parent property has changed and raises the ParentChanged event.
	OnPenChanged	Called when the Pen property has changed and raises the PenChanged event.
	OnPersistChanged	Called when the Persist property has changed and raises the PersistChanged event.
	OnSnapToPixelGridChanged	Called when the SnapToPixelGrid property has changed and raises the SnapToPixelGridChanged event.
	OnVisibleChanged	Called when the Visible property has changed and raises the VisibleChanged event.
	PixelPointFromDisplayPoint	Returns the pixel position from the specified display position.
	PixelPointToDisplayPoint	Returns the display position from a pixel position.
	SetDisplayBounds	Sets the rectangular boundary of the rubberband by using Viewport coordinates.
	Start	Programmatically starts a new rubberband without user interaction.
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Events

	Name	Description
	ActiveButtonsChanged	Occurs when ActiveButtons changes.
	ActiveChanged	Occurs when Active changes.
	AspectRatioChanged	Occurs when AspectRatio changes.
	BackgroundColorChanged	Occurs when BackgroundColor changes.
	Changed	Occurs when the rubber band changes size (occurs on the MouseUp Event).
	Changing	Occurs when the rubber band is changing size (occurs on the MouseMove Event).
	ClickLockChanged	Occurs when ClickLock changes.
	ConstrainPositionChanged	Occurs when ConstrainPosition changes.
	CursorChanged	Occurs when %Cursor% changes.
	Disposed	Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component.)
	InvertedChanged	Occurs when Inverted changes.
	MoveCursorChanged	Occurs when %MoveCursor% changes.
	MoveWhenInsideChanged	Occurs when MoveWhenInside changes.
	ParentChanged	Occurs when %Parent% changes.
	PenChanged	Occurs when Pen changes.
	PersistChanged	Occurs when Persist changes.
	SnapToPixelGridChanged	Occurs when SnapToPixelGrid changes.
	VisibleChanged	Occurs when Visible changes.

Top

Remarks

Allows entities to be drawn onto a Viewport by clicking and dragging with the mouse. Derived classes can draw lines, rectangles, and ellipses and be used to draw primitives and make region selections.

Reference

Atalasoft.Imaging.WinControls Namespace