NShape Reference
ImageBasedShape Class

<< Click to Display Table of Contents >>

Navigation:  Class Reference > Namespace Dataweb.NShape.Advanced >

NShape Reference
ImageBasedShape Class

Previous pageReturn to chapter overviewNext page

Base class for shapes represented by an image.

Syntax

public abstract class ImageBasedShape : ShapeBaseIPlanarShapeICaptionedShape

Description

ImageBasedShape can but need not be used as a base class for custom shapes. It provides support for the following areas:

(Re-)Calculating, transforming and drawing the shape's image.

IPlanarShape implementation (Angle and FillStyle)

Public Properties

Name

Description

Angle

Specifies the rotation angle of the shape in tenths of degrees.

CaptionCount

Number of captions in the shape.

CharacterStyle

The character style of the shape's text.

FillStyle

Implementation of IPlanarShape.FillStyle.

ParagraphStyle

The paragraph style of the shape's text.

Text

Text of the shape's caption.

X

X coordinate of the shape.

Y

Y coordinate of the shape.

Public Methods

Name

Description

CalculateAbsolutePosition

Calculates coordinates from the given RelativePosition.

CalculateConnectionFoot

A simple base implementation of calculating the foot of a point-to-shape connection based on the bounding rectangle.

CalculateNormalVector

Calculates the normal vector for the given point.

CalculateRelativePosition

Calculate a RelativePosition from the given coordinates.

Clone

Creates an exact copy of the shape.

CopyFrom

Copies as many properties as possible from the source shape.

Draw

Draws the shape.

DrawOutline

Implementation of drawing the shape's outline.

FindCaptionFromPoint

Returns the caption located at the given coordinates.

Fit

Fits the shape into the given bounds.

GetCaptionBounds

Gets the maximum area the indicated caption's text can occupy.

GetCaptionCharacterStyle

Gets the character style of the indicated caption.

GetCaptionParagraphStyle

Gets the paragraph style of the indicated caption.

GetCaptionText

Gets the indicated caption's text.

GetCaptionTextBounds

Gets the indicated caption's text bounds.

GetControlPointPosition

Retrieves the position of the given control point.

GetPropertyDefinitions

Implementation of the IEntity.GetPropertyDefinitions pseudo member.

HasControlPointCapability

Tests, whether a control point has at least one of a set of given capabilities.

Invalidate

Invalidates the shape.

MakePreview

Transforms the shape into a preview shape.

NotifyStyleChanged

Notifies the shape that the given style has changed.

SetCaptionCharacterStyle

Sets the caption's character style.

SetCaptionParagraphStyle

Sets the caption's paragraph style

SetCaptionText

Sets the caption's text.

Protected Properties and Fields

Name

Description

angle

The angle of the shape.

caption

A caption instance for managing the shape's text.

captionUpdated

Stores wether the caption was updated.

ControlPointCount

The number of control points.

ch

Height of the caption

h

The height of the shape

image

The shape's image.

resourceAssembly

The assembly where the shape's image is embedded in.

resourceName

The resource name of the shape's image.

w

The width of the shape

x

X coordinate of the shape's center.

y

Y coordinate of the shape's center.

Protected Methods

Name

Description

CalculateBoundingRectangle

Calculates the axis aligned bounding rectangle of the shape.

Constructors

Constructs a new shape.

ContainsPointCore

Base implementation of ContainsPoint using the transformed GraphicsPath.

DeleteCore

Implementation of IEntity.Delete.

GetControlPointId

Returns the ControlPointId of the control point with the given index.

IntersectsWithCore

Checks wether the shape intersects with the given rectangle.

InitializeToDefault

Initializes the shape with default values.

InvalidateDrawCache

Clears all objects and buffers needed for drawing the shape so that they will be recalculated the next time.

LoadFieldsCore

Implementation of IEntity.LoadFields.

MoveByCore

Implementation of Shape.MoveBy.

MovePointByCore

Implementation of Shape.MoveControlPointBy.

RecalcDrawCache

Recalculates all objects and buffers needed to draw this shape.

RotateCore

Implementation of Shape.Rotate.

SaveFieldsCore

Implementation of IEntity.SaveFields.

TransformDrawCache

Transforms all objects and buffers to the current position and angle.

UpdateDrawCache

Checks if any objects and buffers needed to draw the shape are invalid and calls RecalcDrawCache in this case.

Derived Classes

Derived classes are:

CustomizableMetaFile

Requirements

Namespace: Dataweb.NShape.Advanced

Assembly: Dataweb.NShape