DrawingAttributes Class

Reference

Definition

Namespace:: System.Windows.Ink

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies the appearance of a Stroke.

public ref class DrawingAttributes : System::ComponentModel::INotifyPropertyChanged

public class DrawingAttributes : System.ComponentModel.INotifyPropertyChanged

type DrawingAttributes = class
    interface INotifyPropertyChanged

Public Class DrawingAttributes
Implements INotifyPropertyChanged

Inheritance: Object
DrawingAttributes

Implements: INotifyPropertyChanged

Examples

The following example demonstrates how to use two DrawingAttributes objects to simulate using a pen and a highlighter on the same InkCanvas. The example assumes the root element in the XAML file is a DockPanel called root. It also assumes that there is a Button called switchHighlighter and that the Click event is connected to the event handler defined in this example.

InkCanvas inkCanvas1 = new InkCanvas();
DrawingAttributes inkDA;
DrawingAttributes highlighterDA;
bool useHighlighter = false;

// Add an InkCanvas to the window, and allow the user to 
// switch between using a green pen and a purple highlighter 
// on the InkCanvas.
private void WindowLoaded(object sender, EventArgs e)
{
    inkCanvas1.Background = Brushes.DarkSlateBlue;
    inkCanvas1.DefaultDrawingAttributes.Color = Colors.SpringGreen;

    root.Children.Add(inkCanvas1);

    // Set up the DrawingAttributes for the pen.
    inkDA = new DrawingAttributes();
    inkDA.Color = Colors.SpringGreen;
    inkDA.Height = 5;
    inkDA.Width = 5;
    inkDA.FitToCurve = false;

    // Set up the DrawingAttributes for the highlighter.
    highlighterDA = new DrawingAttributes();
    highlighterDA.Color = Colors.Orchid;
    highlighterDA.IsHighlighter = true;
    highlighterDA.IgnorePressure = true;
    highlighterDA.StylusTip = StylusTip.Rectangle;
    highlighterDA.Height = 30;
    highlighterDA.Width = 10;

    inkCanvas1.DefaultDrawingAttributes = inkDA;
}

// Create a button called switchHighlighter and use 
// SwitchHighlighter_Click to handle the Click event.  
// The useHighlighter variable is a boolean that indicates
// whether the InkCanvas renders ink as a highlighter.

// Switch between using the 'pen' DrawingAttributes and the 
// 'highlighter' DrawingAttributes.
void SwitchHighlighter_Click(Object sender, RoutedEventArgs e)
{
    useHighlighter = !useHighlighter;
    
    if (useHighlighter)
    {
        switchHighlighter.Content = "Use Pen";
        inkCanvas1.DefaultDrawingAttributes = highlighterDA;
    }
    else
    {
        switchHighlighter.Content = "Use Highlighter";
        inkCanvas1.DefaultDrawingAttributes = inkDA;
    }
}

Private WithEvents inkCanvas1 As New InkCanvas()
Private inkDA As DrawingAttributes
Private highlighterDA As DrawingAttributes
Private useHighlighter As Boolean = False

' Add an InkCanvas to the window, and allow the user to 
' switch between using a green pen and a purple highlighter 
' on the InkCanvas.
Private Sub WindowLoaded(ByVal sender As Object, ByVal e As RoutedEventArgs)

    inkCanvas1.Background = Brushes.DarkSlateBlue
    inkCanvas1.DefaultDrawingAttributes.Color = Colors.SpringGreen

    ' Add the InkCanvas to the DockPanel, named root.
    root.Children.Add(inkCanvas1)

    ' Set up the DrawingAttributes for the pen.
    inkDA = New DrawingAttributes()
    With inkDA
        .Color = Colors.SpringGreen
        .Height = 5
        .Width = 5
        .FitToCurve = True
    End With

    ' Set up the DrawingAttributes for the highlighter.
    highlighterDA = New DrawingAttributes()
    With highlighterDA
        .Color = Colors.Orchid
        .IsHighlighter = True
        .IgnorePressure = True
        .StylusTip = StylusTip.Rectangle
        .Height = 30
        .Width = 10
    End With

    inkCanvas1.DefaultDrawingAttributes = inkDA

End Sub


' Create a button called switchHighlighter and use 
' SwitchHighlighter_Click to handle the Click event.  
' The useHighlighter variable is a boolean that indicates
' whether the InkCanvas renders ink as a highlighter.

' Switch between using the 'pen' DrawingAttributes and the 
' 'highlighter' DrawingAttributes when the user clicks on .
Private Sub SwitchHighlighter_Click(ByVal sender As [Object], ByVal e As RoutedEventArgs)

    useHighlighter = Not useHighlighter

    If useHighlighter Then
        switchHighlighter.Content = "Use Pen"
        inkCanvas1.DefaultDrawingAttributes = highlighterDA
    Else

        switchHighlighter.Content = "Use Highlighter"
        inkCanvas1.DefaultDrawingAttributes = inkDA
    End If

End Sub

Remarks

Use the DrawingAttributes property to specify settings such as color, width, transparency, and the shape of the stylus tip for a Stroke.

Use the DefaultDrawingAttributes property to specify the drawing attributes for the strokes added to an InkCanvas. Only strokes that are added after the DefaultDrawingAttributes undergo change show the updated attributes. The appearance of the strokes that are already on the InkCanvas does not change.

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

XAML Text Usage

This class is not typically used in XAML.

Constructors

DrawingAttributes()

Initializes a new instance of the DrawingAttributes class.

Fields

MaxHeight	Specifies the largest value allowed for the Height property.
MaxWidth	Specifies the largest value allowed for the Width property.
MinHeight	Specifies the smallest value allowed for the Height property.
MinWidth	Specifies the smallest value allowed for the Width property.

Properties

Color	Gets or sets the color of a Stroke.
FitToCurve	Gets or sets a value that indicates whether Bezier smoothing is used to render the Stroke.
Height	Gets or sets the height of the stylus used to draw the Stroke.
IgnorePressure	Gets or sets a value that indicates whether the thickness of a rendered Stroke changes according the amount of pressure applied.
IsHighlighter	Gets or sets a value that indicates whether the Stroke looks like a highlighter.
StylusTip	Gets or sets the shape of the stylus used to draw the Stroke.
StylusTipTransform	Gets or sets the Matrix that specifies the transformation to perform on the stylus' tip.
Width	Gets or sets the width of the stylus used to draw the Stroke.

Methods

AddPropertyData(Guid, Object)	Adds a custom property to the DrawingAttributes object.
Clone()	Copies the DrawingAttributes object.
ContainsPropertyData(Guid)	Returns a value that indicates whether the specified property data identifier is in the DrawingAttributes object.
Equals(Object)	Determines whether the specified DrawingAttributes object is equal to the current DrawingAttributes object.
GetHashCode()	Serves as a hash function for a particular type.
GetPropertyData(Guid)	Gets the value of the custom property associated with the specified Guid.
GetPropertyDataIds()	Returns the GUIDs of any custom properties associated with the StrokeCollection.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAttributeChanged(PropertyDataChangedEventArgs)	Raises the AttributeChanged event.
OnPropertyChanged(PropertyChangedEventArgs)	Occurs when any DrawingAttributes property changes.
OnPropertyDataChanged(PropertyDataChangedEventArgs)	Raises the PropertyDataChanged event.
RemovePropertyData(Guid)	Removes the custom property associated with the specified Guid.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Operators

Equality(DrawingAttributes, DrawingAttributes)	Determines whether the specified DrawingAttributes objects are equal.
Inequality(DrawingAttributes, DrawingAttributes)	Determines whether the specified DrawingAttributes objects are not equal.

Events

AttributeChanged	Occurs when a property in the DrawingAttributes object changes.
PropertyDataChanged	Occurs when property data is added or removed from the StrokeCollection.

Explicit Interface Implementations

INotifyPropertyChanged.PropertyChanged

This API supports the product infrastructure and is not intended to be used directly from your code.

Occurs when the value of any DrawingAttributes property has changed.

Applies to

Deila með