Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Description

Excerpt

The Shape class allows the appearance and behavior of drawing object to be manipulated. On its own, Shape represents a simple auto shape, such as a line, rectangle, or oval. A shape may also represent the display area of a Comment or the size, position, and formatting of a Picture.

Signature
C#C#
Wiki Markup
{description}
{excerpt}The [Shape|Shape] class allows the appearance and behavior of drawing object to be manipulated. On its own, {{Shape}} represents a simple auto shape, such as a line, rectangle, or oval. A shape may also represent the display area of a [Comment|Comment] or the size, position, and formatting of a [Picture|Picture].{excerpt}
{signature:C#}
 public class Shape
Signature
{signature}{signature:vb.net
vb.net
}
Public Class Shape
Remarks

Once a Shape is created with a particular ShapeType, the type may not be changed. Instead, delete the shape and create a new one with the appropriate type.

To create a Shape object, call Shapes.CreateShape.

Properties

...

Name

...

Description

...

FillColor

...

FillTransparency

...

FitToText

...

Height

...

HorizontalAlignment

...

LineColor

...

LockAspectRatio

...

Name

...

ObjectPositioning

...

Position

...

Rotation

...

Text

...

Type

...

VerticalAlignment

...

Width

...

Methods

...

Name

...

Description

...

ClearRichTextFormatting()

...

GetCharacters(Int32)

...

GetCharacters(Int32, Int32)

...

SetCustomFillColor(Int32, Int32, Int32)

...

SetCustomLineColor(Int32, Int32, Int32)

...

{signature}
{remarks}Once a {{Shape}} is created with a particular [ShapeType|ShapeType], the type may not be changed. Instead, delete the shape and create a new one with the appropriate type.

To create a {{Shape}} object, call [Shapes.CreateShape|Shapes.CreateShape(ShapeType, Anchor)].

{remarks}
{properties}
||Name||Description||
|[FillColor|Shape.FillColor]|{excerpt-include:Shape.FillColor|nopanel=true}|
|[FillTransparency|Shape.FillTransparency]|{excerpt-include:Shape.FillTransparency|nopanel=true}|
|[FitToText|Shape.FitToText]|{excerpt-include:Shape.FitToText|nopanel=true}|
|[Height|Shape.Height]|{excerpt-include:Shape.Height|nopanel=true}|
|[HorizontalAlignment|Shape.HorizontalAlignment]|{excerpt-include:Shape.HorizontalAlignment|nopanel=true}|
|[LineColor|Shape.LineColor]|{excerpt-include:Shape.LineColor|nopanel=true}|
|[LockAspectRatio|Shape.LockAspectRatio]|{excerpt-include:Shape.LockAspectRatio|nopanel=true}|
|[Name|Shape.Name]|{excerpt-include:Shape.Name|nopanel=true}|
|[ObjectPositioning|Shape.ObjectPositioning]|{excerpt-include:Shape.ObjectPositioning|nopanel=true}|
|[Position|Shape.Position]|{excerpt-include:Shape.Position|nopanel=true}|
|[Rotation|Shape.Rotation]|{excerpt-include:Shape.Rotation|nopanel=true}|
|[Text|Shape.Text]|{excerpt-include:Shape.Text|nopanel=true}|
|[Type|Shape.Type]|{excerpt-include:Shape.Type|nopanel=true}|
|[VerticalAlignment|Shape.VerticalAlignment]|{excerpt-include:Shape.VerticalAlignment|nopanel=true}|
|[Width|Shape.Width]|{excerpt-include:Shape.Width|nopanel=true}|
{methods}
||Name||Description||
|[ClearRichTextFormatting()|Shape.ClearRichTextFormatting()]|{excerpt-include:Shape.ClearRichTextFormatting()|nopanel=true}|
|[GetCharacters(Int32)|Shape.GetCharacters(Int32)]|{excerpt-include:Shape.GetCharacters(Int32)|nopanel=true}|
|[GetCharacters(Int32, Int32)|Shape.GetCharacters(Int32, Int32)]|{excerpt-include:Shape.GetCharacters(Int32, Int32)|nopanel=true}|
|[SetCustomFillColor(Int32, Int32, Int32)|Shape.SetCustomFillColor(Int32, Int32, Int32)]|{excerpt-include:Shape.SetCustomFillColor(Int32, Int32, Int32)|nopanel=true}|
|[SetCustomLineColor(Int32, Int32, Int32)|Shape.SetCustomLineColor(Int32, Int32, Int32)]|{excerpt-include:Shape.SetCustomLineColor(Int32, Int32, Int32)|nopanel=true}|