RectangleRubberband Class

A rectangular rubber-band that can be positioned with the mouse on a viewport control.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      Atalasoft.Imaging.WinControlsRubberband
        Atalasoft.Imaging.WinControlsRectangleRubberband

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 class RectangleRubberband : Rubberband

Public Class RectangleRubberband
	Inherits Rubberband

The RectangleRubberband type exposes the following members.

Constructors

	Name	Description
	RectangleRubberband	Initializes a new instance of RectangleRubberband.
	RectangleRubberband(Viewport)	Initializes a new instance of RectangleRubberband specifying the parent Viewport.

Top

Properties

	Name	Description
	Active	Gets or sets a value indicating if the rubberband is active in the parent Viewport control. (Inherited from Rubberband.)
	ActiveButtons	Gets or sets a value indicating which mouse buttons are used to draw the rubberband. (Inherited from Rubberband.)
	AspectRatio	Gets or sets the aspect ratio which the rubberband will be constrained to. (Inherited from Rubberband.)
	BackgroundColor	Gets or sets the background color of a dashed line. (Inherited from Rubberband.)
	Bounds	Gets or sets the rectangular area occupied by the rubberband in image pixel coordinates. (Inherited from Rubberband.)
	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. (Inherited from Rubberband.)
	ConstrainPosition	Gets or sets a value indicating if the RubberBand can be drawn outside the image area. (Inherited from Rubberband.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	CornerRadius	Gets or sets the rounding radius of each corner in pixels.
	Cursor	Gets or sets the cursor which is displayed in the parent Viewport when active. (Inherited from Rubberband.)
	CursorPad	Gets or sets the amount of padding for the cursor to change and to allow adjusting the existing selection. (Inherited from Rubberband.)
	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. (Inherited from Rubberband.)
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	Fill	Gets or sets a Fill that is used to fill the inside of the rectangle.
	Inverted	Gets or sets a value indicating if the rubberband is drawn inverted. (Inherited from Rubberband.)
	IsDragging	Gets or sets a value indicating whether the Rubberband is being dragged. (Inherited from Rubberband.)
	MoveCursor	Gets or sets the cursor used when moving the rubberband. (Inherited from Rubberband.)
	MoveWhenInside	Gets or sets a value indicating if the rubberband can be moved with the mouse. (Inherited from Rubberband.)
	Parent	Gets or sets the parent ViewPort control. (Inherited from Rubberband.)
	Pen	Gets or sets a value of the pen which is used to draw the rubberband. (Inherited from Rubberband.)
	Persist	Gets or sets a value indicating if the rubberband continues to display after the mouse button is released. (Inherited from Rubberband.)
	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. (Inherited from Rubberband.)
	StartPoint	Gets or sets the starting point of the Rubberband. Normally this is the top-left corner. (Inherited from Rubberband.)
	Visible	Gets or sets a value indicating if the rubberband is currently visible. (Inherited from Rubberband.)

Top

Methods

	Name	Description
	Cancel	Cancels dragging a new rubberband. (Inherited from 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. (Inherited from Rubberband.)
	DrawRegion	Called when a region needs to be drawn. (Inherited from Rubberband.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	EraseRegion	Call this method to erase the current region. (Inherited from Rubberband.)
	Finalize	(Inherited from Rubberband.)
	GetConstrainedPoint	Returns a point that is within the image bounds and snap to the pixel grid. (Inherited from Rubberband.)
	GetDisplayBounds	Returns a Rectangle representing the rectangular rubberband boundary in Viewport display coordinates. (Inherited from Rubberband.)
	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	Returns the rectangular region occupied by this rubberband. (Overrides RubberbandGetRegion.)
	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. (Inherited from Rubberband.)
	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. (Inherited from Rubberband.)
	OnActiveChanged	Called when the Active property has changed and raises the ActiveChanged event. (Inherited from Rubberband.)
	OnAspectRatioChanged	Called when the AspectRatio property has changed and raises the AspectRatioChanged event. (Inherited from Rubberband.)
	OnBackgroundColorChanged	Called when the BackgroundColor property has changed and raises the BackgroundColorChanged event. (Inherited from Rubberband.)
	OnChanged	Called when the Rubberband has changed. (Inherited from Rubberband.)
	OnChanging	Called when the Rubberband is in the process of changing. (Inherited from Rubberband.)
	OnClickLockChanged	Called when the ClickLock property has changed and raises the ClickLockChanged event. (Inherited from Rubberband.)
	OnConstrainPositionChanged	Called when the ConstrainPosition property has changed and raises the ConstrainPositionChanged event. (Inherited from Rubberband.)
	OnCursorChanged	Called when the Cursor property has changed and raises the CursorChanged event. (Inherited from Rubberband.)
	OnDrawRubberband	(Overrides RubberbandOnDrawRubberband(Canvas, AtalaPen).)
	OnInvertedChanged	Called when the Inverted property has changed and raises the InvertedChanged event. (Inherited from Rubberband.)
	OnMouseDown	Called when a mouse button is pressed over the Rubberband. (Inherited from Rubberband.)
	OnMouseMove	Called when the mouse is moved over the Rubberband. (Inherited from Rubberband.)
	OnMouseUp	Called when a mouse button is released over the Rubberband. (Inherited from Rubberband.)
	OnMoveCursorChanged	Called when the MoveCursor property has changed and raises the MoveCursorChanged event. (Inherited from Rubberband.)
	OnMoveWhenInsideChanged	Called when the MoveWhenInside property has changed and raises the MoveWhenInsideChanged event. (Inherited from Rubberband.)
	OnPaint	Called when the Rubberband needs to be painted. (Inherited from Rubberband.)
	OnParentChanged	Called when the Parent property has changed and raises the ParentChanged event. (Inherited from Rubberband.)
	OnPenChanged	Called when the Pen property has changed and raises the PenChanged event. (Inherited from Rubberband.)
	OnPersistChanged	Called when the Persist property has changed and raises the PersistChanged event. (Inherited from Rubberband.)
	OnSnapToPixelGridChanged	Called when the SnapToPixelGrid property has changed and raises the SnapToPixelGridChanged event. (Inherited from Rubberband.)
	OnVisibleChanged	Called when the Visible property has changed and raises the VisibleChanged event. (Inherited from Rubberband.)
	PixelPointFromDisplayPoint	Returns the pixel position from the specified display position. (Inherited from Rubberband.)
	PixelPointToDisplayPoint	Returns the display position from a pixel position. (Inherited from Rubberband.)
	SetDisplayBounds	Sets the rectangular boundary of the rubberband by using Viewport coordinates. (Inherited from Rubberband.)
	Start	Programmatically starts a new rubberband without user interaction. (Inherited from Rubberband.)
	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. (Inherited from Rubberband.)
	ActiveChanged	Occurs when Active changes. (Inherited from Rubberband.)
	AspectRatioChanged	Occurs when AspectRatio changes. (Inherited from Rubberband.)
	BackgroundColorChanged	Occurs when BackgroundColor changes. (Inherited from Rubberband.)
	Changed	Occurs when the rubber band changes size (occurs on the MouseUp Event). (Inherited from Rubberband.)
	Changing	Occurs when the rubber band is changing size (occurs on the MouseMove Event). (Inherited from Rubberband.)
	ClickLockChanged	Occurs when ClickLock changes. (Inherited from Rubberband.)
	ConstrainPositionChanged	Occurs when ConstrainPosition changes. (Inherited from Rubberband.)
	CursorChanged	Occurs when %Cursor% changes. (Inherited from Rubberband.)
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
	InvertedChanged	Occurs when Inverted changes. (Inherited from Rubberband.)
	MoveCursorChanged	Occurs when %MoveCursor% changes. (Inherited from Rubberband.)
	MoveWhenInsideChanged	Occurs when MoveWhenInside changes. (Inherited from Rubberband.)
	ParentChanged	Occurs when %Parent% changes. (Inherited from Rubberband.)
	PenChanged	Occurs when Pen changes. (Inherited from Rubberband.)
	PersistChanged	Occurs when Persist changes. (Inherited from Rubberband.)
	SnapToPixelGridChanged	Occurs when SnapToPixelGrid changes. (Inherited from Rubberband.)
	VisibleChanged	Occurs when Visible changes. (Inherited from Rubberband.)

Top

Remarks

This object is used to select a rectangular region in an image for cropping, zooming, and applying a command on a rectangular region as well as drawing rectangles onto an image.

Can be used as a component in the toolbox or instantiated directly.

See RectangleSelection for an object deriving from RectangleRubberBand that can be resized once created.

Reference

Atalasoft.Imaging.WinControls Namespace

Atalasoft.Imaging.WinControlsRectangleSelection