Class
ShapeBase

Base type for drawable shapes that track size, transforms, outline, and fill used in documents.

Definition

Namespace:Telerik.Windows.Documents.Model.Drawing.Shapes

Assembly:Telerik.Windows.Documents.Core.dll

Syntax:

cs-api-definition
public abstract class ShapeBase

Inheritance: objectShapeBase

Derived Classes: Image

Constructors

ShapeBase(ShapeBase)

Initializes a new instance of the ShapeBase class by copying an Image instance.

Declaration

cs-api-definition
protected ShapeBase(ShapeBase other)

Parameters

other

ShapeBase

The other image.

Properties

Description

Gets or sets the alternative text describing the shape for accessibility.

Declaration

cs-api-definition
public string Description { get; set; }

Property Value

string

The description (alternative text).

Fill

Gets or sets the fill applied to the interior of the shape.

Declaration

cs-api-definition
public Fill Fill { get; set; }

Property Value

Fill

Height

Gets or sets the shape height in document units.

Declaration

cs-api-definition
public double Height { get; set; }

Property Value

double

The height.

IsHorizontallyFlipped

Gets or sets whether the shape is horizontally flipped (mirrored along the Y-axis).

Declaration

cs-api-definition
public bool IsHorizontallyFlipped { get; set; }

Property Value

bool

The value indicating if the shape is horizontally flipped.

IsVerticallyFlipped

Gets or sets whether the shape is vertically flipped (mirrored along the X-axis).

Declaration

cs-api-definition
public bool IsVerticallyFlipped { get; set; }

Property Value

bool

The value indicating if the shape is vertically flipped.

Gets the hyperlink target associated with the shape, if any.

Declaration

cs-api-definition
public string Link { get; }

Property Value

string

LockAspectRatio

Gets or sets whether the width-to-height ratio is preserved during resize operations.

Declaration

cs-api-definition
public bool LockAspectRatio { get; set; }

Property Value

bool

The value indicating whether the aspect ratio between the width and height should remain constant.

Name

Gets or sets the user-defined name for this shape, useful for identification.

Declaration

cs-api-definition
public string Name { get; set; }

Property Value

string

The name.

Outline

Gets the outline (stroke) applied to the shape’s border.

Declaration

cs-api-definition
public Outline Outline { get; }

Property Value

Outline

RotationAngle

Gets or sets the rotation angle applied to the shape in degrees.

Declaration

cs-api-definition
public double RotationAngle { get; set; }

Property Value

double

The rotation angle.

Size

Gets or sets the shape size; when not set, it may be auto-initialized.

Declaration

cs-api-definition
public Size Size { get; set; }

Property Value

Size

The size.

Title

Gets or sets the title (caption) displayed for the shape in some viewers.

Declaration

cs-api-definition
public string Title { get; set; }

Property Value

string

The title (caption).

Width

Gets or sets the shape width in document units.

Declaration

cs-api-definition
public double Width { get; set; }

Property Value

double

The width.

Methods

InitializeSize()

Initializes the size.

Declaration

cs-api-definition
protected virtual void InitializeSize()

SetHeight(bool, double)

Set the height and optionally adjust width to respect the current aspect ratio.

Declaration

cs-api-definition
public void SetHeight(bool respectLockAspectRatio, double height)

Parameters

respectLockAspectRatio

bool

A value indicating whether the aspect ratio lock should be respected.

height

double

The new height.

SetWidth(bool, double)

Set the width and optionally adjust height to respect the current aspect ratio.

Declaration

cs-api-definition
public void SetWidth(bool respectLockAspectRatio, double width)

Parameters

respectLockAspectRatio

bool

A value indicating whether the aspect ratio lock should be respected.

width

double

The new width.