Shape Class

Implements the basic functionality common to line and shape controls.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.VisualBasic.PowerPacks.Shape
        Microsoft.VisualBasic.PowerPacks.LineShape
        Microsoft.VisualBasic.PowerPacks.SimpleShape

Namespace:  Microsoft.VisualBasic.PowerPacks
Assembly:  Microsoft.VisualBasic.PowerPacks.Vs (in Microsoft.VisualBasic.PowerPacks.Vs.dll)

Syntax

'Declaration
Public MustInherit Class Shape _
    Inherits Component

public abstract class Shape : Component

public ref class Shape abstract : public Component

[<AbstractClass>]
type Shape =  
    class 
        inherit Component 
    end

public abstract class Shape extends Component

The Shape type exposes the following members.

Constructors

	Name	Description
	Shape()	Initializes a new instance of the Shape class.
	Shape(ShapeContainer)	Initializes a new instance of the Shape class.

Top

Properties

	Name	Description
	AccessibilityObject	Gets the AccessibleObject that is assigned to the control.
	AccessibleDefaultActionDescription	Gets or sets the default action description of the control for use by accessibility client applications.
	AccessibleDescription	Gets or sets the description of the control that is used by accessibility client applications.
	AccessibleName	Gets or sets the name of the control that is used by accessibility client applications.
	AccessibleRole	Gets or sets the accessible role of the control.
	Anchor	Gets or sets the edges of the container to which a shape is bound, and determines how a shape is resized when its parent is resized.
	BorderColor	Gets or sets the color of the border of a shape or line control.
	BorderStyle	Gets or sets the border style for a shape or line control.
	BorderWidth	Gets or sets the width of a line or shape control's border.
	CanFocus	Gets a value indicating whether a line or shape control can receive focus.
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	CanSelect	Gets a value indicating whether a line or shape control can be selected.
	Container	Gets the IContainer that contains the Component.
	ContainsFocus	Gets a value indicating whether a line or shape control currently has the input focus.
	ContextMenu	Gets or sets the shortcut menu associated with a line or shape control.
	ContextMenuStrip	Gets or sets the ContextMenuStrip associated with a line or shape control.
	Created	Gets a value indicating whether a line or shape control has been created.
	Cursor	Gets or sets the cursor that is displayed when the mouse pointer is resting on a line or shape control.
	DefaultBorderColor	Gets the default border color for a line or shape control.
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	Disposing	Gets a value indicating whether the base Shape class is disposing.
	Enabled	Gets or sets a value indicating whether a line or shape control can respond to user interaction.
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	Focused	Gets a value indicating whether a line or shape control currently has the input focus.
	IsAccessible	Gets or sets a value indicating whether a line or shape control is available to accessibility applications.
	IsDisposed	Gets a value indicating whether a line or shape control has been disposed of.
	ModifierKeys	Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
	MouseButtons	Gets a value indicating which of the mouse buttons is in a pressed state.
	MousePosition	Gets the position of the pointer in screen coordinates.
	Name	Gets or sets the name of a line or shape control.
	Parent	Gets or sets the parent container of a line or shape control.
	Region	Gets or sets the window region associated with a line or shape control.
	SelectionColor	Gets or sets the selection color of a shape.
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)
	Tag	Gets or sets the object that contains data about a line or shape control.
	UseWaitCursor	Gets or sets a value indicating whether to use the wait cursor for the current line or shape control.
	Visible	Gets or sets a value indicating whether a line or shape control is displayed.

Top

Methods

	Name	Description
	BringToFront	Brings a line or shape control to the front of the z-order.
	CreateAccessibilityInstance	Creates a new accessibility object for a line or shape control.
	CreateObjRef	Security Critical. 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 the unmanaged resources used by a line or shape control and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)
	DrawToBitmap	Supports rendering to the specified bitmap.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	FindForm	Retrieves the form that a line or shape control is on.
	Focus	Sets input focus to a line or shape control.
	GetContainerControl	Returns the next ContainerControl up in a line or shape control's chain of parent controls.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLifetimeService	Security Critical. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	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.)
	Hide	Conceals a line or shape control from the user.
	HitTest	Gets information about a line or shape control at the specified position on the screen.
	InitializeLifetimeService	Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	Invalidate	Invalidates a specific region of a line or shape control and causes a paint message to be sent to the control.
	IsKeyLocked	Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect.
	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.)
	OnClick	Raises the Click event.
	OnContextMenuChanged	Raises the ContextMenuChanged event.
	OnContextMenuStripChanged	Raises the ContextMenuStripChanged event.
	OnCursorChanged	Raises the CursorChanged event.
	OnDoubleClick	Raises the DoubleClick event.
	OnEnabledChanged	Raises the EnabledChanged event.
	OnEnter	Raises the Enter event.
	OnGotFocus	Raises the GotFocus event.
	OnInvalidated	Raises the Invalidated event.
	OnKeyDown	Raises the KeyDown event.
	OnKeyPress	Raises the KeyPress event.
	OnKeyUp	Raises the KeyUp event.
	OnLeave	Raises the Leave event.
	OnLostFocus	Raises the LostFocus event.
	OnMouseClick	Raises the MouseClick event.
	OnMouseDoubleClick	Raises the MouseDoubleClick event.
	OnMouseDown	Raises the MouseDown event.
	OnMouseEnter	Raises the MouseEnter event.
	OnMouseHover	Raises the MouseHover event.
	OnMouseLeave	Raises the MouseLeave event.
	OnMouseMove	Raises the MouseMove event.
	OnMouseUp	Raises the MouseUp event.
	OnMouseWheel	Raises the MouseWheel event.
	OnMove	Raises the Move event.
	OnPaint	Raises the Paint event.
	OnParentChanged	Raises the ParentChanged event.
	OnPreviewKeyDown	Raises the PreviewKeyDown event.
	OnQueryAccessibilityHelp	Raises the QueryAccessibilityHelp event.
	OnRegionChanged	Raises the RegionChanged event.
	OnVisibleChanged	Raises the VisibleChanged event.
	PointToClient	Computes the location of the specified screen point into client coordinates.
	PointToScreen	Computes the location of the specified client point into screen coordinates.
	RectangleToClient	Computes the size and location of the specified screen rectangle in client coordinates.
	RectangleToScreen	Computes the size and location of the specified client rectangle in screen coordinates.
	Refresh	Forces a control to invalidate its client area and immediately redraw itself and any child controls.
	ResumePaint	Resumes usual painting logic, optionally forcing an immediate layout of pending paint requests.
	Scale	Scales a shape by the specified scaling factor.
	Select	Enables a control.
	SendToBack	Sends a line or shape control to the back of the z-order.
	Show	Displays a shape to the user.
	SuspendPaint	Suspends the painting logic for a shape.
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
	Update	Causes the control to redraw the invalidated regions within its client area.

Top

Events

	Name	Description
	ChangeUICues	Occurs when the focus or keyboard user interface (UI) cues change.
	Click	Occurs when the shape is clicked.
	ContextMenuChanged	Occurs when the value of the ContextMenu property changes.
	ContextMenuStripChanged	Occurs when the value of the ContextMenuStrip property changes.
	CursorChanged	Occurs when the value of the Cursor property changes.
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
	DoubleClick	Occurs when the shape is double-clicked.
	EnabledChanged	Occurs when the Enabled property value has changed.
	Enter	Occurs when the shape is entered.
	GotFocus	Occurs when the shape receives focus.
	Invalidated	Occurs when a shape's display requires redrawing.
	KeyDown	Occurs when a key is pressed and the shape has focus.
	KeyPress	Occurs when a key is pressed and the shape has focus.
	KeyUp	Occurs when a key is released and the shape has focus.
	Leave	Occurs when the input focus leaves the shape.
	LostFocus	Occurs when the shape loses focus.
	MouseClick	Occurs when the shape is clicked by the mouse.
	MouseDoubleClick	Occurs when the shape is double-clicked by the mouse.
	MouseDown	Occurs when the mouse pointer is over the shape and a mouse button is pressed.
	MouseEnter	Occurs when the mouse pointer enters the shape.
	MouseHover	Occurs when the mouse pointer rests on the shape.
	MouseLeave	Occurs when the mouse pointer leaves the shape.
	MouseMove	Occurs when the mouse pointer is moved over the shape.
	MouseUp	Occurs when the mouse pointer is over the shape and a mouse button is released.
	MouseWheel	Occurs when the mouse wheel moves and the shape has focus.
	Move	Occurs when the shape is moved.
	Paint	Occurs when the shape is redrawn.
	ParentChanged	Occurs when the Parent property value changes.
	PreviewKeyDown	Occurs before the KeyDown event when a key is pressed and focus is on the shape.
	QueryAccessibilityHelp	Occurs when an AccessibleObject is providing Help to accessibility applications.
	RegionChanged	Occurs when the value of the Region property changes.
	VisibleChanged	Occurs when the Visible property value changes.

Top

Remarks

You do not typically inherit from Shape. To create your own line or shape class, inherit from the LineShape or the SimpleShape class.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualBasic.PowerPacks Namespace

LineShape

OvalShape

RectangleShape

SimpleShape

Other Resources

How to: Draw Lines with the LineShape Control (Visual Studio)

How to: Draw Shapes with the OvalShape and RectangleShape Controls (Visual Studio)

Introduction to the Line and Shape Controls (Visual Studio)