NShape Reference
CaptionedShapeBase Class

<< Click to Display Table of Contents >>

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

NShape Reference
CaptionedShapeBase Class

Previous pageReturn to chapter overviewNext page

Base class for most of the shapes containing text in the standard libraries and custom libraries.

Syntax

public abstract class CaptionedShapeBase : PathBasedPlanarShapeICaptionedShape

Description

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

ICaptionedShape implementation for one caption

(Re-)Calculating, transforming and drawing text

Public Properties

Name

Description

CaptionCount

Specifies the number of captions of the shape.

CharacterStyle

Specifies the character style of the shape's text.

ParagraphStyle

Specifies the paragraph style of the shape's text.

Text

Specifies the shape's text.

Public Methods

Name

Description

CopyFrom

Copies as many properties as possible from the source shape.

FindCaptionFromPoint

Returns the index of the caption under the given point.

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.

GetPropertyDefinitions

Implementation of the IEntity.GetPropertyDefinitions pseudo member.

MakePreview

Transforms the shape into a preview shape.

NotifyStyleChanged

Notifies the shape that the given style has changed.

SetCaptionCharacterStyle

Sets the character style of the indicated caption.

SetCaptionParagraphStyle

Sets the paragraph style of the indicated caption.

SetCaptionText

Sets the indicated caption's text.

Protected Methods

Name

Description

CalcCaptionBounds

Calculates the untransformed area in which the caption's text is layouted.

CalculateBoundingRectangle

Calculates the axis aligned bounding rectangle of the shape.

CalculatePath

Implementation of calculating a GraphicsPath for the shape's text.

Constructors

Construct a new shape.

DrawCaption

Draws the shape's text.

InitializeToDefault

Initializes the shape with default values.

LoadFieldsCore

Implementation of IEntity.LoadFields.

ProcessExecModelPropertyChange

Implementation of reacting to model property changes

SaveFieldsCore

Implementation of IEntity.SaveFields.

TransformDrawCache

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

Derived Classes

Derived classes are:

RectangleBase

DiameterShapeBase

Requirements

Namespace: Dataweb.NShape.Advanced

Assembly: Dataweb.NShape