InkCanvas Class

  • Article

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Defines an area that receives and displays ink strokes.

Inheritance Hierarchy

System. . :: . .Object
  Microsoft.SPOT. . :: . .DispatcherObject
    Microsoft.SPOT.Presentation. . :: . .UIElement
      Microsoft.SPOT.Ink..::..InkCanvas

Namespace:  Microsoft.SPOT.Ink
Assembly:  Microsoft.SPOT.Ink (in Microsoft.SPOT.Ink.dll)

Syntax

'Declaration
Public Class InkCanvas _
    Inherits UIElement

public class InkCanvas : UIElement

public ref class InkCanvas : public UIElement

type InkCanvas =  
    class
        inherit UIElement
    end

public class InkCanvas extends UIElement

The InkCanvas type exposes the following members.

Constructors

  Name Description
Public method InkCanvas(Int32, Int32, Int32, Int32) Initializes a new instance of the InkCanvas class.
Public method InkCanvas(Int32, Int32, Int32, Int32, Int32) Initializes a new instance of the InkCanvas class with a border of the specified width.

Top

Properties

  Name Description
Public property ActualHeight Gets the rendered height of this element. (Inherited from UIElement.)
Public property ActualWidth Gets the rendered width of this element. (Inherited from UIElement.)
Public property DefaultDrawingAttributes Sets the default drawing attributes used to render ink on this InkCanvas.
Public property Height Gets or sets the suggested height of this element. (Inherited from UIElement.)
Public property HorizontalAlignment Gets or sets the horizontal alignment characteristics that are applied to this element when it is composed within a parent element, such as a Panel. (Inherited from UIElement.)
Protected property InstanceEventHandlersStore Gets the event-handler store for this element. (Inherited from UIElement.)
Public property IsArrangeValid Gets a value indicating whether the computed size and position of child elements in this element's layout are valid. (Inherited from UIElement.)
Public property IsEnabled Gets or sets a value indicating whether this element is enabled in the user interface (UI). (Inherited from UIElement.)
Public property IsFocused Gets a value that determines whether this element has logical focus. (Inherited from UIElement.)
Public property IsMeasureValid Gets a value indicating whether the current size returned by layout measure is valid. (Inherited from UIElement.)
Public property IsVisible Gets a value indicating whether this element is visible in the user interface (UI). (Inherited from UIElement.)
Protected property LogicalChildren Gets an enumerator for this element's logical child elements. (Inherited from UIElement.)
Public property Parent Gets the logical parent element of this element. (Inherited from UIElement.)
Public property RootUIElement Gets the logical root element of this element. (Inherited from UIElement.)
Public property VerticalAlignment Gets or sets the vertical alignment characteristics that are applied to this element when it is composed within a parent element, such as a Panel. (Inherited from UIElement.)
Public property Visibility Gets or sets the user interface (UI) visibility of this element. (Inherited from UIElement.)
Public property Width Gets or sets the suggested width of this element. (Inherited from UIElement.)

Top

Methods

  Name Description
Public method AddHandler Adds a routed-event handler for a specified routed event, adding the handler to the current element's event handler collection. (Inherited from UIElement.)
Public method AddToEventRoute Adds handlers to the specified event route for the current element's event handler collection. (Inherited from UIElement.)
Public method Arrange Positions child elements in a particular region on the screen. (Inherited from UIElement.)
Protected method ArrangeOverride Positions child elements and determines a size for a UIElement-derived class when implemented in a derived class. (Inherited from UIElement.)
Public method CheckAccess Determines whether the calling thread has access to the current DispatcherObject object. (Inherited from DispatcherObject.)
Public method ChildElementFromPoint Returns the most recently created child control that is located at a specified point on the display. (Inherited from UIElement.)
Public method Clear Clears the rectangle of this InkCanvas.
Public method ContainsPoint Determines whether a specified point is contained by this UIElement. (Inherited from UIElement.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Performs cleanup operations. (Overrides Object. . :: . .Finalize() () () ().)
Public method GetDesiredSize Gets the current element's size, as computed during the measure pass of the layout process. (Inherited from UIElement.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLayoutOffset Gets the current element's offset, relative to the upper-left corner of the screen. (Inherited from UIElement.)
Public method GetMargin Gets the width of the current element's margins. (Inherited from UIElement.)
Public method GetPointerTarget Returns the visible child of this UIElement that contains a specified screen point. (Inherited from UIElement.)
Public method GetRenderSize Gets the final render size of the current element. (Inherited from UIElement.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUnclippedSize Returns the unclipped size of this element. (Inherited from UIElement.)
Protected method Init Initializes an existing instance of the InkCanvas class, with a border of the specified width.
Public method Invalidate Invalidates the rendering of the current element and forces a complete new layout pass. (Inherited from UIElement.)
Public method InvalidateArrange Invalidates the arrange state of the current element's layout. (Inherited from UIElement.)
Public method InvalidateMeasure Invalidates the measurement state of the current element's layout. (Inherited from UIElement.)
Public method InvalidateRect Invalidates the specified rectangle. (Inherited from UIElement.)
Public method Measure Determines the size requirements for the layout of a child element. (Inherited from UIElement.)
Protected method MeasureOverride Determines the size that this InkCanvas will need in layout, based on the width and height available to it. (Overrides UIElement. . :: . .MeasureOverride(Int32, Int32, Int32%, Int32%).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnButtonDown Adds class handling for an unhandled ButtonDownEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class. (Inherited from UIElement.)
Protected method OnButtonUp Adds class handling for an unhandled ButtonUpEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class. (Inherited from UIElement.)
Protected method OnChildDesiredSizeChanged Supports the layout system when a child element is resized. (Inherited from UIElement.)
Protected method OnChildrenChanged Called when the UIElementCollection of this UIElement is edited. (Inherited from UIElement.)
Protected method OnGenericEvent Called when this UIElement generates a generic event. (Inherited from UIElement.)
Protected method OnGotFocus Adds class handling for an unhandled GotFocusEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class. (Inherited from UIElement.)
Protected method OnLostFocus Adds class handling for an unhandled LostFocusEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class. (Inherited from UIElement.)
Protected method OnPreviewButtonDown Adds class handling for an unhandled PreviewButtonDownEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class. (Inherited from UIElement.)
Protected method OnPreviewButtonUp Adds class handling for an unhandled PreviewButtonUpEvent attached event when that event reaches, by way of its route, an element that is derived from the UIElement class. (Inherited from UIElement.)
Public method OnRender Uses a specified DrawingContext to draw the Bitmap in _bitmap, if any. (Overrides UIElement. . :: . .OnRender(DrawingContext).)
Protected method OnTouchDown Handles a touch down (or stylus down) event. (Overrides UIElement. . :: . .OnTouchDown(TouchEventArgs).)
Protected method OnTouchGestureChanged Handles a TouchGestureChanged event. (Inherited from UIElement.)
Protected method OnTouchGestureEnded Handles a TouchGestureEnd event. (Inherited from UIElement.)
Protected method OnTouchGestureStarted Handles a TouchGestureStart event. (Inherited from UIElement.)
Protected method OnTouchMove Invoked when an unhandled TouchMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event. (Inherited from UIElement.)
Protected method OnTouchUp Invalidates the InkCanvas rectangle. (Overrides UIElement. . :: . .OnTouchUp(TouchEventArgs).)
Public method PointToClient Returns the client UIElement that is the top-level ancestor of this UIElement object, and expresses the given point in the coordinate space of that ancestor. (Inherited from UIElement.)
Public method PointToScreen Converts a point expressed in the coordinate space of this UIElement into screen coordinates. (Inherited from UIElement.)
Public method RaiseEvent Raises a specific routed event. (Inherited from UIElement.)
Protected method RenderRecursive Renders this element and all its child elements. (Inherited from UIElement.)
Public method SetMargin(Int32) Sets the size of the current element's margin, using the same (specified) width for each of the four sides of the element. (Inherited from UIElement.)
Public method SetMargin(Int32, Int32, Int32, Int32) Sets the size of the current element's margin, using a specified width for each of the four sides of the element. (Inherited from UIElement.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateLayout Ensures that all visual child elements of the current element are properly updated for layout. (Inherited from UIElement.)
Public method VerifyAccess Determines whether the calling thread has access to the current DispatcherObject object. (Inherited from DispatcherObject.)

Top

Events

  Name Description
Public event IsEnabledChanged Occurs when the value of the IsEnabled property changes for the current element. (Inherited from UIElement.)
Public event IsVisibleChanged Occurs when the value of the IsVisible property changes for the current element. (Inherited from UIElement.)
Public event TouchDown Occurs when the user initially touches the tablet screen or puts the tip of the stylus onto the tablet screen. (Inherited from UIElement.)
Public event TouchGestureChanged Indicates that a touch or stylus gesture changed. (Inherited from UIElement.)
Public event TouchGestureEnd Indicates that a touch or stylus gesture ended. (Inherited from UIElement.)
Public event TouchGestureStart Indicates that a touch or stylus gesture started. (Inherited from UIElement.)
Public event TouchMove Occurs when the user's finger or stylus moves while it is touching the tablet. (Inherited from UIElement.)
Public event TouchUp Occurs when the user raises their finger or stylus from the touch screen. (Inherited from UIElement.)

Top

Fields

  Name Description
Protected field _bitmap A Bitmap object used to draw the InkCanvas background rectangle.
Protected field _defaultDrawingAttributes The default attributes applied to ink when it is drawn.
Protected field _horizontalAlignment Specifies the horizontal alignment characteristics that are applied to the current element when it is composed within a parent element, such as a Panel object. (Inherited from UIElement.)
Protected field _verticalAlignment Specifies the vertical alignment characteristics that are applied to the current element when it is composed within a parent element, such as a Panel object. (Inherited from UIElement.)
Public field Dispatcher Contains the Dispatcher object that the current DispatcherObject object is associated with. (Inherited from DispatcherObject.)

Top

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.SPOT.Ink Namespace