Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

InkPresenter Class

Implements a rectangular surface that displays ink strokes.

Namespace:  System.Windows.Controls
Assembly:  System.Windows (in System.Windows.dll)

public sealed class InkPresenter : Canvas
<InkPresenter>
  oneOrMoreUIElements
</InkPresenter>

XAML Values

oneOrMoreUIElements

One or more object elements that derives from UIElement.

The InkPresenter type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneInkPresenterInitializes a new instance of the InkPresenter class.
Top

  NameDescription
Public propertySupported by Silverlight for Windows PhoneActualHeightGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneActualWidthGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneAllowDropGets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneBackgroundGets or sets a Brush that is used to fill the panel. (Inherited from Panel.)
Public propertySupported by Silverlight for Windows PhoneCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneChildrenGets the collection of child elements of the panel. (Inherited from Panel.)
Public propertySupported by Silverlight for Windows PhoneClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneCursorGets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneDataContextGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneDesiredSizeGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyEffectGets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneFlowDirectionGets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneHeightGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneHorizontalAlignmentGets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneIsItemsHostGets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl. (Inherited from Panel.)
Public propertySupported by Silverlight for Windows PhoneLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMarginGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMaxHeightGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMaxWidthGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMinHeightGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMinWidthGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneNameGets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneOpacityGets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneOpacityMaskGets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneParentGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneProjectionGets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderSizeGets the final render size of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderTransformGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderTransformOriginGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneResourcesGets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneStrokesGets or sets the strokes that the InkPresenter displays.
Public propertySupported by Silverlight for Windows PhoneStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneTagGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneTriggersGets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneUseLayoutRoundingGets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneVerticalAlignmentGets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneVisibilityGets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneWidthGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneAddHandlerAdds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneArrangePositions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.)
Protected methodSupported by Silverlight for Windows PhoneArrangeOverrideProvides the behavior for the "arrange" pass of Silverlight layout. (Inherited from Canvas.)
Public methodSupported by Silverlight for Windows PhoneCaptureMouseSets mouse capture to a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneFindNameRetrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneGetAnimationBaseValueReturns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneGetBindingExpressionRetrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneInvalidateArrangeInvalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneInvalidateMeasureInvalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneMeasureUpdates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.)
Protected methodSupported by Silverlight for Windows PhoneMeasureOverrideProvides the behavior for the "measure" pass of Silverlight layout.  (Inherited from Canvas.)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneOnApplyTemplateWhen overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks. (Inherited from FrameworkElement.)
Protected methodSupported by Silverlight for Windows PhoneOnCreateAutomationPeerWhen implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneReleaseMouseCaptureRemoves mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneRemoveHandlerRemoves the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneSetBindingAttaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneTransformToVisualReturns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneUpdateLayoutEnsures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)
Top

  NameDescription
Public eventSupported by Silverlight for Windows PhoneBindingValidationErrorOccurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public eventDataContextChangedOccurs when the data context for this element changes. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneDoubleTapOccurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventDragEnterOccurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
Public eventDragLeaveOccurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
Public eventDragOverOccurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public eventDropOccurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneGotFocusOccurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneHoldOccurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneKeyDownOccurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneKeyUpOccurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneLayoutUpdatedOccurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneLoadedOccurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneLostFocusOccurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneLostMouseCaptureOccurs when the UIElement loses mouse capture. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationCompletedOccurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationDeltaOccurs when the input device changes position during a manipulation. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationStartedOccurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
Public eventMediaCommandOccurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseEnterOccurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseLeaveOccurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseLeftButtonDownOccurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseLeftButtonUpOccurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseMoveOccurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public eventMouseRightButtonDownOccurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public eventMouseRightButtonUpOccurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseWheelOccurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneTapOccurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextInputOccurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextInputStartOccurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextInputUpdateOccurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneUnloadedOccurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)
Top

  NameDescription
Public fieldStatic memberSupported by Silverlight for Windows PhoneStrokesPropertyIdentifies the Strokes dependency property.
Top

InkPresenter is derived from Canvas and can display one or more UIElement objects and a StrokeCollection.

InkPresenter inherits two properties that relate to presentation: Background and Children.

The Background value for an InkPresenter object is applied behind any strokes that are presented on the surface.

Children values for an InkPresenter render on the InkPresenter surface just as they do on a Canvas. However, the collection of strokes is stored separately in the Strokes property.

Children is the content property for InkPresenter, which is why it is referenced as the oneOrMoreUIElements placeholder in the XAML syntax above. Because the primary purpose of InkPresenter is to display strokes, it is more common to set Children for a Canvas object rather than to specify Children UI elements for an InkPresenter.

All Children items draw over the Background. All Strokes draw over both Children and Background, and you cannot adjust Strokes with Canvas.ZIndex. Therefore, if you want any content to always remain on top of strokes, you should declare that content in a separate Canvas that overlays the InkPresenter, rather than setting the Children property of the InkPresenter in code or as direct element content in XAML.

NoteNote:

If you want to contain the ink within the InkPresenter control, use the Clip property on the InkPresenter.

You can accomplish the following InkPresenter-related tasks with the example code at the specified location.

Task

Example location

Use the InkPresenter element.

InkPresenter

Erase ink in an InkPresenter.

How to: Erase Ink in an InkPresenter

Specify drawing attributes, such as height, width, color, and outline color.

DrawingAttributes

Iterate through the stylus points and manipulate the stroke collection.

StylusPoints

Use the properties of a stylus point, such as X coordinate, Y coordinate, and pressure.

StylusPoint

Retrieve the bounding box for a stroke.

Stroke.GetBounds

Retrieve the bounding box for a stroke collection.

StrokeCollection.GetBounds

Determine whether stroke objects intersect.

Stroke.HitTest

Determine whether stroke collections intersect.

StrokeCollection.HitTest

The following code example shows basic techniques for capturing input on an InkPresenter surface and using the input to create strokes for display.

Run this sample


<Canvas>
    <TextBlock Text="InkPresenter Control" FontWeight="Bold" Margin="50,30,0,0" />
    <Rectangle Height="500" Width="500" Margin="50,50,0,0" Stroke="Black" />
    <InkPresenter x:Name="MyIP" Height="500" Width="500"
              Margin="50,50,0,0"
              MouseLeftButtonDown="MyIP_MouseLeftButtonDown" 
              LostMouseCapture="MyIP_LostMouseCapture" 
              MouseMove="MyIP_MouseMove" 
              Background="Transparent" Opacity="1" />
</Canvas>



public Page()
{
    InitializeComponent();
    SetBoundary();
}
Stroke NewStroke;

//A new stroke object named MyStroke is created. MyStroke is added to the StrokeCollection of the InkPresenter named MyIP
private void MyIP_MouseLeftButtonDown(object sender, MouseEventArgs e)
{
    MyIP.CaptureMouse();
    StylusPointCollection MyStylusPointCollection = new StylusPointCollection();
    MyStylusPointCollection.Add(e.StylusDevice.GetStylusPoints(MyIP));
    NewStroke = new Stroke(MyStylusPointCollection);
    MyIP.Strokes.Add(NewStroke);
}

//StylusPoint objects are collected from the MouseEventArgs and added to MyStroke. 
private void MyIP_MouseMove(object sender, MouseEventArgs e)
{
    if (NewStroke != null)
        NewStroke.StylusPoints.Add(e.StylusDevice.GetStylusPoints(MyIP));
}

//MyStroke is completed
private void MyIP_LostMouseCapture(object sender, MouseEventArgs e)
{
    NewStroke = null;

}

//Set the Clip property of the inkpresenter so that the strokes
//are contained within the boundary of the inkpresenter
private void SetBoundary()
{
    RectangleGeometry MyRectangleGeometry = new RectangleGeometry();
    MyRectangleGeometry.Rect = new Rect(0, 0, MyIP.ActualWidth, MyIP.ActualHeight);
    MyIP.Clip = MyRectangleGeometry;
}


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft