Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

RectangleGeometry Class

Describes a two-dimensional rectangle.

Namespace:  System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
'Declaration
Public NotInheritable Class RectangleGeometry _
	Inherits Geometry
<RectangleGeometry .../>

The RectangleGeometry type exposes the following members.

  NameDescription
Public methodRectangleGeometry Initializes a new instance of the RectangleGeometry class, and creates a rectangle with zero area.
Public methodRectangleGeometry(Rect) Initializes a new instance of the RectangleGeometry class and specifies its dimensions.
Public methodRectangleGeometry(Rect, Double, Double) Initializes a new instance of the RectangleGeometry class.
Public methodRectangleGeometry(Rect, Double, Double, Transform) Initializes a new instance of the RectangleGeometry class.
Top
  NameDescription
Public propertyBounds Gets a Rect that specifies the bounding box of a RectangleGeometry. This method does not take any pens into account. (Overrides Geometry.Bounds.)
Public propertyCanFreezeGets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public propertyDependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyHasAnimatedPropertiesGets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
Public propertyIsFrozenGets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
Public propertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public propertyRadiusXGets or sets the x-radius of the ellipse use to round the corners of the rectangle.
Public propertyRadiusYGets or sets the y-radius of the ellipse use to round the corners of the rectangle.
Public propertyRectGets or sets the dimensions of the rectangle.
Public propertyTransformGets or sets the Transform object applied to a Geometry. (Inherited from Geometry.)
Top
  NameDescription
Public methodApplyAnimationClock(DependencyProperty, AnimationClock)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
Public methodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
Public methodBeginAnimation(DependencyProperty, AnimationTimeline)Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
Public methodBeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public methodCloneCreates a modifiable clone of this RectangleGeometry, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
Public methodCloneCurrentValueCreates a modifiable clone of this RectangleGeometry object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.
Public methodCoerceValueCoerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Public methodFillContains(Geometry)Indicates whether the current geometry completely contains the specified Geometry. (Inherited from Geometry.)
Public methodFillContains(Point)Indicates whether the geometry contains the specified Point. (Inherited from Geometry.)
Public methodFillContains(Geometry, Double, ToleranceType)Indicates whether the current geometry contains the specified Geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodFillContains(Point, Double, ToleranceType)Indicates whether the geometry contains the specified Point, given the specified margin of error. (Inherited from Geometry.)
Public methodFillContainsWithDetail(Geometry)Returns a value that describes the intersection between the current geometry and the specified geometry. (Inherited from Geometry.)
Public methodFillContainsWithDetail(Geometry, Double, ToleranceType)Returns a value that describes the intersection between the current geometry and the specified geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodFreezeMakes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Public methodGetAnimationBaseValueReturns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
Public methodGetAreaGets the area of the filled region of the Geometry object. (Inherited from Geometry.)
Public methodGetArea(Double, ToleranceType) Gets the area of the filled region of this RectangleGeometry object. (Overrides Geometry.GetArea(Double, ToleranceType).)
Public methodGetAsFrozenCreates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
Public methodGetCurrentValueAsFrozenCreates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
Public methodGetFlattenedPathGeometryGets a PathGeometry that is a polygonal approximation of the Geometry object. (Inherited from Geometry.)
Public methodGetFlattenedPathGeometry(Double, ToleranceType)Gets a PathGeometry, within the specified tolerance, that is a polygonal approximation of the Geometry object. (Inherited from Geometry.)
Public methodGetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public methodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public methodGetOutlinedPathGeometryGets a PathGeometry that is a simplified outline of the filled region of the Geometry. (Inherited from Geometry.)
Public methodGetOutlinedPathGeometry(Double, ToleranceType)Gets a PathGeometry, within the specified tolerance, that is a simplified outline of the filled region of the Geometry. (Inherited from Geometry.)
Public methodGetRenderBounds(Pen)Returns an axis-aligned rectangle that is exactly large enough to contain the geometry after it has been outlined with the specified Pen. (Inherited from Geometry.)
Public methodGetRenderBounds(Pen, Double, ToleranceType)Returns an axis-aligned rectangle that is exactly large enough to contain the geometry after it has been outlined with the specified Pen, given the specified tolerance factor. (Inherited from Geometry.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public methodGetWidenedPathGeometry(Pen)Gets a PathGeometry that is the shape defined by the stroke on the Geometry produced by the specified Pen. (Inherited from Geometry.)
Public methodGetWidenedPathGeometry(Pen, Double, ToleranceType)Gets a PathGeometry that is the shape defined by the stroke on the Geometry produced by the specified Pen, given the specified tolerance factor. (Inherited from Geometry.)
Public methodInvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Public methodIsEmpty Determines whether this RectangleGeometry object is empty. (Overrides Geometry.IsEmpty.)
Public methodMayHaveCurves Determines whether this RectangleGeometry object may have curved segments. (Overrides Geometry.MayHaveCurves.)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public methodSetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Protected methodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public methodShouldSerializeTransformGets a value that indicates whether the value of the Transform property should be serialized. (Inherited from Geometry.)
Public methodStrokeContains(Pen, Point)Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry. (Inherited from Geometry.)
Public methodStrokeContains(Pen, Point, Double, ToleranceType)Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodStrokeContainsWithDetail(Pen, Geometry)Returns a value that describes the intersection between the specified Geometry and the stroke created by applying the specified Pen to the current geometry. (Inherited from Geometry.)
Public methodStrokeContainsWithDetail(Pen, Geometry, Double, ToleranceType)Gets a value that describes the intersection between the specified Geometry and the stroke created by applying the specified Pen to the current geometry, given the specified margin of error. (Inherited from Geometry.)
Public methodToStringCreates a string representation of the object based on the current culture. (Inherited from Geometry.)
Public methodToString(IFormatProvider)Creates a string representation of the object using the specified culture-specific formatting information. (Inherited from Geometry.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
  NameDescription
Public eventChangedOccurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
Top
  NameDescription
Public fieldStatic memberRadiusXProperty Identifies the RadiusX dependency property.
Public fieldStatic memberRadiusYProperty Identifies the RadiusY dependency property.
Public fieldStatic memberRectProperty Identifies the Rect dependency property.
Top
  NameDescription
Explicit interface implemetationPrivate methodIFormattable.ToStringFormats the value of the current instance using the specified format. (Inherited from Geometry.)
Top

This example describes how to use the RectangleGeometry class to describe a rectangle.

The following example shows how to create and render a RectangleGeometry. The relative position and the dimensions of the rectangle are defined by a Rect structure. The relative position is 50,50 and the height and the width are both 25 creating a square. The rectangle's interior is painted with a LemonChiffon brush and its outline is painted with a Black stroke with a thickness of 1.

<Path Fill="LemonChiffon" Stroke="Black" StrokeThickness="1">
  <Path.Data>
    <RectangleGeometry Rect="50,50,25,25" />
  </Path.Data>
</Path>
			Dim myRectangleGeometry As New RectangleGeometry()
			myRectangleGeometry.Rect = New Rect(50,50,25,25)

			Dim myPath As New Path()
			myPath.Fill = Brushes.LemonChiffon
			myPath.Stroke = Brushes.Black
			myPath.StrokeThickness = 1
			myPath.Data = myRectangleGeometry
RectangleGeometry

A RectangleGeometry

Although this example used a Path element to render the RectangleGeometry, there are many other ways to use RectangleGeometry objects. For example, a RectangleGeometry can be used to specify the Clip of a UIElement or the Geometry of a GeometryDrawing.

Other simple geometry classes include LineGeometry and EllipseGeometry. These geometries, as well as more complex ones, can also be created using a PathGeometry or StreamGeometry.

More Code

How to: Round the Corners of a RectangleGeometryTo round the corners of a RectangleGeometry, set its RadiusX and RadiusY properties to a value greater than zero. The larger the values, the rounder the rectangle's corners.
How to: Animate a Rectangle Geometry by Using Key FramesThis example shows how to animate the Rect property of a RectangleGeometry by using key frames.
How to: Create a Composite Shape This example shows how to create composite shapes using Geometry objects and display them using a Path element. In the following example, a LineGeometry, EllipseGeometry, and a RectangleGeometry are used with a GeometryGroup to create a composite shape. The geometries are then drawn using a Path element.
How to: Create a Shape by Using a PathGeometryThis example shows how to create a shape using the PathGeometry class. PathGeometry objects are composed of one or more PathFigure objects; each PathFigure represents a different "figure" or shape. Each PathFigure is itself composed of one or more PathSegment objects, each representing a connected portion of the figure or shape. Segment types include LineSegment, ArcSegment, and BezierSegment.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.