DrawingAttributes Class

July 28, 2014

Specifies drawing attributes that are used to draw a Stroke.

System.Object
  System.Windows.DependencyObject
    System.Windows.Ink.DrawingAttributes

Namespace:  System.Windows.Ink
Assembly:  System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

public sealed class DrawingAttributes : DependencyObject
<DrawingAttributes .../>

The DrawingAttributes type exposes the following members.

  NameDescription
Public methodDrawingAttributesInitializes a new instance of the DrawingAttributes class.
Top

  NameDescription
Public propertyColorGets or sets the color that is used to draw a Stroke.
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyHeightGets or sets the height of the stylus that is used to draw a Stroke.
Public propertyOutlineColorGets or sets the outline color that is used to draw a Stroke.
Public propertyWidthGets or sets the width of the stylus that is used to draw a Stroke.
Top

  NameDescription
Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The DrawingAttributes class allows you to specify drawing attributes, such as height, width, color, and outline color. To apply the drawing attributes to a stroke, you set the Stroke.DrawingAttributes property on a Stroke to a DrawingAttributes object.

For a list of default property values for an instance of the DrawingAttributes class, see the DrawingAttributes constructor.

The following code example simulates three different stylus types (pen, marker, and highlighter) by setting the Height, Width, Color, and OutlineColor properties of a DrawingAttributes object. The example creates a DrawingAttributes object and then applies it to a Stroke object. When the user clicks a stylus type button, the example updates the DrawingAttributes properties. The BtEraser_Click method clears all the strokes from the InkPresenter control.



//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));
    MyStroke = new Stroke(MyStylusPointCollection);
    MyStroke.DrawingAttributes = CloneDrawingAttributes(MyDA);
    MyIP.Strokes.Add(MyStroke);
}

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

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

private DrawingAttributes CloneDrawingAttributes(DrawingAttributes attributes)
{
    if (attributes == null)
        return attributes;

    DrawingAttributes cloneAttribute = new DrawingAttributes();
    cloneAttribute.Color = attributes.Color;
    cloneAttribute.Height = attributes.Height;
    cloneAttribute.OutlineColor = attributes.OutlineColor;
    cloneAttribute.Width = attributes.Width;
    return cloneAttribute;
}

//Set drawing attributes to simulate a pen
private void BtPen_Click(object sender, EventArgs e)
{
    MyDA.Width = 1;
    MyDA.Height = Double.Epsilon - 1;
    MyDA.Color = Colors.Gray;
    MyDA.OutlineColor = Colors.Gray;
}

//Set drawing attributes to simulate a marker
private void BtMarker_Click(object sender, EventArgs e)
{
    MyDA.Width = 10;
    MyDA.Height = 4;
    MyDA.Color = Colors.Blue;
    MyDA.OutlineColor = Colors.Blue;
}

//Set drawing attributes to simulate a highlighter
private void BtHighlighter_Click(object sender, EventArgs e)
{
    MyDA.Width = 25;
    MyDA.Height = 5;
    MyDA.Color = Colors.Yellow;
    MyDA.OutlineColor = Colors.Yellow;
}

//Clear the strokes from the inkpresenter control
private void BtEraser_Click(object sender, EventArgs e)
{
    MyIP.Strokes.Clear();
}

private void SetBoundary()
{
    RectangleGeometry MyRectangleGeometry = new RectangleGeometry();
    MyRectangleGeometry.Rect = new Rect(0, 0, MyIP.ActualHeight, MyIP.ActualWidth);
    MyIP.Clip = MyRectangleGeometry;
}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

Show:
© 2014 Microsoft