Share via


LineShape Class

 

Represents a control displayed as a horizontal, vertical, or diagonal line.

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

Inheritance Hierarchy

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

Syntax

[ToolboxBitmapAttribute(typeof(LineShape), "Microsoft.VisualBasic.PowerPacks.LineShape.bmp")]
public class LineShape : Shape
[ToolboxBitmapAttribute((LineShape^::typeid), "Microsoft.VisualBasic.PowerPacks.LineShape.bmp")]
public ref class LineShape : Shape
[<ToolboxBitmapAttribute(typeof(LineShape), "Microsoft.VisualBasic.PowerPacks.LineShape.bmp")>]
type LineShape = 
    class
        inherit Shape
    end
<ToolboxBitmapAttribute(GetType(LineShape), "Microsoft.VisualBasic.PowerPacks.LineShape.bmp")>
Public Class LineShape
    Inherits Shape

Constructors

Name Description
System_CAPS_pubmethod LineShape()

Initializes a new instance of the LineShape class.

System_CAPS_pubmethod LineShape(Int32, Int32, Int32, Int32)

Initializes a new instance of the LineShape class, specifying the coordinates for the line.

System_CAPS_pubmethod LineShape(ShapeContainer)

Initializes a new instance of the LineShape class, specifying the ShapeContainer where it will be parented.

Properties

Name Description
System_CAPS_pubproperty AccessibilityObject

Gets the AccessibleObject that is assigned to the control.(Inherited from Shape.)

System_CAPS_pubproperty AccessibleDefaultActionDescription

Gets or sets the default action description of the control for use by accessibility client applications.(Inherited from Shape.)

System_CAPS_pubproperty AccessibleDescription

Gets or sets the description of the control that is used by accessibility client applications.(Inherited from Shape.)

System_CAPS_pubproperty AccessibleName

Gets or sets the name of the control that is used by accessibility client applications.(Inherited from Shape.)

System_CAPS_pubproperty AccessibleRole

Gets or sets the accessible role of the control.(Inherited from Shape.)

System_CAPS_pubproperty 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.(Inherited from Shape.)

System_CAPS_pubproperty BorderColor

Gets or sets the color of the border of a shape or line control.(Inherited from Shape.)

System_CAPS_pubproperty BorderStyle

Gets or sets the border style for a shape or line control. (Inherited from Shape.)

System_CAPS_pubproperty BorderWidth

Gets or sets the width of a line or shape control's border.(Inherited from Shape.)

System_CAPS_pubproperty CanFocus

Gets a value indicating whether a line or shape control can receive focus.(Inherited from Shape.)

System_CAPS_protproperty CanRaiseEvents

(Inherited from Component.)

System_CAPS_pubproperty CanSelect

Gets a value indicating whether a line or shape control can be selected.(Inherited from Shape.)

System_CAPS_pubproperty Container

Gets the IContainer that contains the Component.(Inherited from Shape.)

System_CAPS_pubproperty ContainsFocus

Gets a value indicating whether a line or shape control currently has the input focus.(Inherited from Shape.)

System_CAPS_pubproperty ContextMenu

Gets or sets the shortcut menu associated with a line or shape control.(Inherited from Shape.)

System_CAPS_pubproperty ContextMenuStrip

Gets or sets the ContextMenuStrip associated with a line or shape control.(Inherited from Shape.)

System_CAPS_pubproperty Created

Gets a value indicating whether a line or shape control has been created.(Inherited from Shape.)

System_CAPS_pubproperty Cursor

Gets or sets the cursor that is displayed when the mouse pointer is resting on a line or shape control.(Inherited from Shape.)

System_CAPS_protproperty DesignMode

(Inherited from Component.)

System_CAPS_pubproperty Disposing

Gets a value indicating whether the base Shape class is disposing.(Inherited from Shape.)

System_CAPS_pubproperty Enabled

Gets or sets a value indicating whether a line or shape control can respond to user interaction.(Inherited from Shape.)

System_CAPS_pubproperty EndPoint

Gets or sets the ending coordinates of a line drawn by a LineShape control.

System_CAPS_protproperty Events

(Inherited from Component.)

System_CAPS_pubproperty Focused

Gets a value indicating whether a line or shape control currently has the input focus.(Inherited from Shape.)

System_CAPS_pubproperty IsAccessible

Gets or sets a value indicating whether a line or shape control is available to accessibility applications.(Inherited from Shape.)

System_CAPS_pubproperty IsDisposed

Gets a value indicating whether a line or shape control has been disposed of.(Inherited from Shape.)

System_CAPS_pubproperty Name

Gets or sets the name of a line or shape control.(Inherited from Shape.)

System_CAPS_pubproperty Parent

Gets or sets the parent container of a line or shape control.(Inherited from Shape.)

System_CAPS_pubproperty Region

Gets or sets the window region associated with a line or shape control.(Inherited from Shape.)

System_CAPS_pubproperty SelectionColor

Gets or sets the selection color of a shape.(Inherited from Shape.)

System_CAPS_pubproperty Site

(Inherited from Component.)

System_CAPS_pubproperty StartPoint

Gets or sets the starting coordinates of a line drawn by a LineShape control.

System_CAPS_pubproperty Tag

Gets or sets the object that contains data about a line or shape control.(Inherited from Shape.)

System_CAPS_pubproperty UseWaitCursor

Gets or sets a value indicating whether to use the wait cursor for the current line or shape control.(Inherited from Shape.)

System_CAPS_pubproperty Visible

Gets or sets a value indicating whether a line or shape control is displayed.(Inherited from Shape.)

System_CAPS_pubproperty X1

Gets or sets the X coordinate of the starting point of a line drawn by a LineShape control.

System_CAPS_pubproperty X2

Gets or sets the X coordinate of the ending point of a line drawn by a LineShape control.

System_CAPS_pubproperty Y1

Gets or sets the Y coordinate of the starting point of a line drawn by a LineShape control.

System_CAPS_pubproperty Y2

Gets or sets the Y coordinate of the ending point of a line drawn by a LineShape control.

Methods

Name Description
System_CAPS_pubmethod BringToFront()

Brings a line or shape control to the front of the z-order.(Inherited from Shape.)

System_CAPS_protmethod CreateAccessibilityInstance()

Creates an object to provide information that accessibility applications use to adjust an application's user interface (UI) for users who have disabilities.(Overrides Shape.CreateAccessibilityInstance().)

System_CAPS_pubmethod CreateObjRef(Type)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Dispose()

(Inherited from Component.)

System_CAPS_protmethod Dispose(Boolean)

Releases the unmanaged resources used by a line or shape control and optionally releases the managed resources.(Inherited from Shape.)

System_CAPS_pubmethod DrawToBitmap(Bitmap, Rectangle)

Supports drawing to the specified bitmap.(Overrides Shape.DrawToBitmap(Bitmap, Rectangle).)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Component.)

System_CAPS_pubmethod FindForm()

Retrieves the form that a line or shape control is on.(Inherited from Shape.)

System_CAPS_pubmethod Focus()

Sets input focus to a line or shape control.(Inherited from Shape.)

System_CAPS_pubmethod GetContainerControl()

Returns the next ContainerControl up in a line or shape control's chain of parent controls.(Inherited from Shape.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod GetService(Type)

(Inherited from Component.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod Hide()

Conceals a line or shape control from the user.(Inherited from Shape.)

System_CAPS_pubmethod HitTest(Int32, Int32)

Gets information about the LineShape control at the specified point on the screen.(Overrides Shape.HitTest(Int32, Int32).)

System_CAPS_pubmethod InitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Invalidate()

Invalidates a specific region of a line or shape control and causes a paint message to be sent to the control.(Inherited from Shape.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone(Boolean)

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod OnClick(EventArgs)

Raises the Click event.(Inherited from Shape.)

System_CAPS_protmethod OnContextMenuChanged(EventArgs)

Raises the ContextMenuChanged event.(Inherited from Shape.)

System_CAPS_protmethod OnContextMenuStripChanged(EventArgs)

Raises the ContextMenuStripChanged event.(Inherited from Shape.)

System_CAPS_protmethod OnCursorChanged(EventArgs)

Raises the CursorChanged event.(Inherited from Shape.)

System_CAPS_protmethod OnDoubleClick(EventArgs)

Raises the DoubleClick event.(Inherited from Shape.)

System_CAPS_protmethod OnEnabledChanged(EventArgs)

Raises the EnabledChanged event.(Inherited from Shape.)

System_CAPS_protmethod OnEndPointChanged(EventArgs)

Raises the EndPointChanged event.

System_CAPS_protmethod OnEnter(EventArgs)

Raises the Enter event.(Inherited from Shape.)

System_CAPS_protmethod OnGotFocus(EventArgs)

Raises the GotFocus event.(Inherited from Shape.)

System_CAPS_protmethod OnInvalidated(InvalidateEventArgs)

Raises the Invalidated event.(Inherited from Shape.)

System_CAPS_protmethod OnKeyDown(KeyEventArgs)

Raises the KeyDown event.(Inherited from Shape.)

System_CAPS_protmethod OnKeyPress(KeyPressEventArgs)

Raises the KeyPress event.(Inherited from Shape.)

System_CAPS_protmethod OnKeyUp(KeyEventArgs)

Raises the KeyUp event.(Inherited from Shape.)

System_CAPS_protmethod OnLeave(EventArgs)

Raises the Leave event.(Inherited from Shape.)

System_CAPS_protmethod OnLostFocus(EventArgs)

Raises the LostFocus event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseClick(MouseEventArgs)

Raises the MouseClick event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseDoubleClick(MouseEventArgs)

Raises the MouseDoubleClick event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseDown(MouseEventArgs)

Raises the MouseDown event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseEnter(EventArgs)

Raises the MouseEnter event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseHover(EventArgs)

Raises the MouseHover event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseLeave(EventArgs)

Raises the MouseLeave event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseMove(MouseEventArgs)

Raises the MouseMove event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseUp(MouseEventArgs)

Raises the MouseUp event.(Inherited from Shape.)

System_CAPS_protmethod OnMouseWheel(MouseEventArgs)

Raises the MouseWheel event.(Inherited from Shape.)

System_CAPS_protmethod OnMove(EventArgs)

Raises the Move event.(Inherited from Shape.)

System_CAPS_protmethod OnPaint(PaintEventArgs)

Raises the Paint event.(Overrides Shape.OnPaint(PaintEventArgs).)

System_CAPS_protmethod OnParentChanged(EventArgs)

Raises the ParentChanged event.(Inherited from Shape.)

System_CAPS_protmethod OnPreviewKeyDown(PreviewKeyDownEventArgs)

Raises the PreviewKeyDown event.(Inherited from Shape.)

System_CAPS_protmethod OnQueryAccessibilityHelp(QueryAccessibilityHelpEventArgs)

Raises the QueryAccessibilityHelp event.(Inherited from Shape.)

System_CAPS_protmethod OnRegionChanged(EventArgs)

Raises the RegionChanged event.(Inherited from Shape.)

System_CAPS_protmethod OnStartPointChanged(EventArgs)

Raises the StartPointChanged event.

System_CAPS_protmethod OnVisibleChanged(EventArgs)

Raises the VisibleChanged event.(Inherited from Shape.)

System_CAPS_pubmethod PointToClient(Point)

Computes the location of the specified screen point into client coordinates.(Inherited from Shape.)

System_CAPS_pubmethod PointToScreen(Point)

Computes the location of the specified client point into screen coordinates.(Inherited from Shape.)

System_CAPS_pubmethod RectangleToClient(Rectangle)

Computes the size and location of the specified screen rectangle in client coordinates.(Inherited from Shape.)

System_CAPS_pubmethod RectangleToScreen(Rectangle)

Computes the size and location of the specified client rectangle in screen coordinates.(Inherited from Shape.)

System_CAPS_pubmethod Refresh()

Forces a control to invalidate its client area and immediately redraw itself and any child controls.(Inherited from Shape.)

System_CAPS_pubmethod ResumePaint(Boolean)

Resumes usual painting logic, optionally forcing an immediate layout of pending paint requests.(Inherited from Shape.)

System_CAPS_pubmethod Scale(SizeF)

Resizes the LineShape control by the specified scaling factor.(Overrides Shape.Scale(SizeF).)

System_CAPS_pubmethod Select()

Enables a control.(Inherited from Shape.)

System_CAPS_pubmethod SendToBack()

Sends a line or shape control to the back of the z-order.(Inherited from Shape.)

System_CAPS_pubmethod Show()

Displays a shape to the user.(Inherited from Shape.)

System_CAPS_pubmethod SuspendPaint()

Suspends the painting logic for a shape.(Inherited from Shape.)

System_CAPS_pubmethod ToString()

(Inherited from Component.)

System_CAPS_pubmethod Update()

Causes the control to redraw the invalidated regions within its client area.(Inherited from Shape.)

Events

Name Description
System_CAPS_pubevent ChangeUICues

Occurs when the focus or keyboard user interface (UI) cues change.(Inherited from Shape.)

System_CAPS_pubevent Click

Occurs when the shape is clicked.(Inherited from Shape.)

System_CAPS_pubevent ContextMenuChanged

Occurs when the value of the ContextMenu property changes.(Inherited from Shape.)

System_CAPS_pubevent ContextMenuStripChanged

Occurs when the value of the ContextMenuStrip property changes.(Inherited from Shape.)

System_CAPS_pubevent CursorChanged

Occurs when the value of the Cursor property changes.(Inherited from Shape.)

System_CAPS_pubevent Disposed

(Inherited from Component.)

System_CAPS_pubevent DoubleClick

Occurs when the shape is double-clicked.(Inherited from Shape.)

System_CAPS_pubevent EnabledChanged

Occurs when the Enabled property value has changed.(Inherited from Shape.)

System_CAPS_pubevent EndPointChanged

Occurs when the EndPoint property value changes.

System_CAPS_pubevent Enter

Occurs when the shape is entered.(Inherited from Shape.)

System_CAPS_pubevent GotFocus

Occurs when the shape receives focus.(Inherited from Shape.)

System_CAPS_pubevent Invalidated

Occurs when a shape's display requires redrawing.(Inherited from Shape.)

System_CAPS_pubevent KeyDown

Occurs when a key is pressed and the shape has focus.(Inherited from Shape.)

System_CAPS_pubevent KeyPress

Occurs when a key is pressed and the shape has focus.(Inherited from Shape.)

System_CAPS_pubevent KeyUp

Occurs when a key is released and the shape has focus.(Inherited from Shape.)

System_CAPS_pubevent Leave

Occurs when the input focus leaves the shape.(Inherited from Shape.)

System_CAPS_pubevent LostFocus

Occurs when the shape loses focus.(Inherited from Shape.)

System_CAPS_pubevent MouseClick

Occurs when the shape is clicked by the mouse.(Inherited from Shape.)

System_CAPS_pubevent MouseDoubleClick

Occurs when the shape is double-clicked by the mouse.(Inherited from Shape.)

System_CAPS_pubevent MouseDown

Occurs when the mouse pointer is over the shape and a mouse button is pressed.(Inherited from Shape.)

System_CAPS_pubevent MouseEnter

Occurs when the mouse pointer enters the shape.(Inherited from Shape.)

System_CAPS_pubevent MouseHover

Occurs when the mouse pointer rests on the shape.(Inherited from Shape.)

System_CAPS_pubevent MouseLeave

Occurs when the mouse pointer leaves the shape. (Inherited from Shape.)

System_CAPS_pubevent MouseMove

Occurs when the mouse pointer is moved over the shape.(Inherited from Shape.)

System_CAPS_pubevent MouseUp

Occurs when the mouse pointer is over the shape and a mouse button is released.(Inherited from Shape.)

System_CAPS_pubevent MouseWheel

Occurs when the mouse wheel moves and the shape has focus.(Inherited from Shape.)

System_CAPS_pubevent Move

Occurs when the shape is moved.(Inherited from Shape.)

System_CAPS_pubevent Paint

Occurs when the shape is redrawn.(Inherited from Shape.)

System_CAPS_pubevent ParentChanged

Occurs when the Parent property value changes.(Inherited from Shape.)

System_CAPS_pubevent PreviewKeyDown

Occurs before the KeyDown event when a key is pressed and focus is on the shape.(Inherited from Shape.)

System_CAPS_pubevent QueryAccessibilityHelp

Occurs when an AccessibleObject is providing Help to accessibility applications. (Inherited from Shape.)

System_CAPS_pubevent RegionChanged

Occurs when the value of the Region property changes.(Inherited from Shape.)

System_CAPS_pubevent StartPointChanged

Occurs when the StartPoint property value changes.

System_CAPS_pubevent VisibleChanged

Occurs when the Visible property value changes.(Inherited from Shape.)

Remarks

The LineShape control enables you to draw lines on a form or container at design time or run time.

When you add a Line or Shape control to a form or container, an invisible ShapeContainer object is created. The ShapeContainer acts as a drawing surface for the shapes within each container control; each ShapeContainer has a corresponding ShapeCollection that enables you to iterate through the Line and Shape controls.

When you create a LineShape control at run time, you must also create a ShapeContainer and set the Parent property of the LineShape to the ShapeContainer.

Examples

The following example creates a ShapeContainer and a LineShape, adds them to a form, and displays a vertical line from the top to the bottom of the form.

Microsoft.VisualBasic.PowerPacks.ShapeContainer canvas = 
    new Microsoft.VisualBasic.PowerPacks.ShapeContainer();
Microsoft.VisualBasic.PowerPacks.LineShape line1 = 
    new Microsoft.VisualBasic.PowerPacks.LineShape();
// Set the form as the parent of the ShapeContainer.
canvas.Parent = this;
// Set the ShapeContainer as the parent of the LineShape.
line1.Parent = canvas;
// Set the starting and ending coordinates for the line.
line1.StartPoint = new System.Drawing.Point(this.Width / 2, 0);
line1.EndPoint = new System.Drawing.Point(this.Width / 2, this.Height);
Dim canvas As New Microsoft.VisualBasic.PowerPacks.ShapeContainer
Dim line1 As New Microsoft.VisualBasic.PowerPacks.LineShape
' Set the form as the parent of the ShapeContainer.
canvas.Parent = Me
' Set the ShapeContainer as the parent of the LineShape.
line1.Parent = canvas
' Set the starting and ending coordinates for the line.
line1.StartPoint = New System.Drawing.Point(Me.Width / 2, 0)
line1.EndPoint = New System.Drawing.Point(Me.Width / 2, Me.Height)

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

ShapeContainer
Shape
Microsoft.VisualBasic.PowerPacks Namespace
How to: Draw Shapes with the OvalShape and RectangleShape Controls (Visual Studio)
How to: Draw Lines with the LineShape Control (Visual Studio)
Introduction to the Line and Shape Controls (Visual Studio)

Return to top