GrapeCity.Documents.Word

GrapeCity.Documents.Word.CanvasShape

Class CanvasShape

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents a canvas shape element in a body content.

public class CanvasShape : ShapeBase, IBrowsable<CanvasShape>

Inheritance: object

ContentObject

ShapeBase

CanvasShape

Implements: IBrowsable<CanvasShape>

Inherited Members: ShapeBase.AlternativeText

ShapeBase.Hidden

ShapeBase.ID

ShapeBase.Name

ShapeBase.Position

ShapeBase.Rotation

ShapeBase.Size

ShapeBase.Title

ShapeBase.WrapFormat

ShapeBase.BlackWhiteMode

ShapeBase.HyperlinkOnClick

ShapeBase.HyperlinkOnHover

ShapeBase.ParentRun

ContentObject.GetChildren<T>()

ContentObject.GetRange()

ContentObject.GetPersistentRange()

ContentObject.Delete()

ContentObject.CanAdd(Type)

ContentObject.CanAdd(Type, out Exception)

ContentObject.CanAddContentControl(ContentControlType)

ContentObject.CanAddContentControl(ContentControlType, out Exception)

ContentObject.ToString()

ContentObject.Start

ContentObject.End

ContentObject.ParentBody

ContentObject.ParentContent

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Effects

Gets the shape effects formatting properties.

public ShapeEffects Effects { get; }

Property Value

ShapeEffects

Fill

Gets the fill formatting properties.

public FillFormat Fill { get; }

Property Value

FillFormat

Line

Gets the line formatting properties.

public LineFormat Line { get; }

Property Value

LineFormat

Gets the next canvas.

public CanvasShape Next { get; }

Property Value

CanvasShape

Gets the previous canvas.

public CanvasShape Previous { get; }

Property Value

CanvasShape

Methods

AddGroupShape()

Adds a GroupShape to the end of the canvas shape.

public GroupShape AddGroupShape()

Returns

GroupShape: The added GroupShape.

AddGroupShape(float, float)

Adds a GroupShape to the end of the canvas shape.

public GroupShape AddGroupShape(float width, float height)

Parameters

width float: The group shape width, in points.
height float: The group shape height, in points.

Returns

GroupShape: The added GroupShape.

AddInkShape(XmlDocument, float, float)

Adds an InkShape to the end of the canvas shape.

public InkShape AddInkShape(XmlDocument content, float width, float height)

Parameters

content System.Xml.XmlDocument: The System.Xml.XmlDocument ink content.
width float: The ink width, in points.
height float: The ink height, in points.

Returns

InkShape: The added InkShape.

AddInkShape(XmlDocument)

Adds an InkShape> to the end of the canvas shape.

public InkShape AddInkShape(XmlDocument content)

Parameters

content System.Xml.XmlDocument: The System.Xml.XmlDocument ink content.

Returns

InkShape: The added InkShape.

AddPicture()

Adds a new Picture to the end of the canvas shape.

public Picture AddPicture()

Returns

Picture: The added Picture.

AddPicture(Image)

Adds a new Picture to the end of the canvas shape.

public Picture AddPicture(Image image)

Parameters

image GrapeCity.Documents.Drawing.Image

Returns

Picture: The added Picture. The size of the picture is set to the size of the source image.

AddPicture(byte[], string, float, float)

Adds a new Picture to the end of the canvas shape.

public Picture AddPicture(byte[] imageBytes, string contentType, float width, float height)

Parameters

imageBytes byte[]: The image data representing the picture.
contentType string: The content type of the image data.
width float: The picture's width, in points.
height float: The picture's height, in points.

Returns

Picture: The added Picture.

AddPicture(byte[], string)

Adds a new Picture to the end of the canvas shape.

public Picture AddPicture(byte[] imageBytes, string contentType)

Parameters

imageBytes byte[]: The image data representing the picture.
contentType string: The content type of the image data.

Returns

Picture: The added Picture.

AddShape()

Adds a new Rectangle 100 x 100 points Shape to the end of the canvas shape.

public Shape AddShape()

Returns

Shape: The added Shape.

AddShape(float, float, GeometryType)

Adds a new Shape with a specified size and text to the end of the canvas shape.

public Shape AddShape(float width, float height, GeometryType type)

Parameters

width float: The shape width, in points.
height float: The shape height, in points.
type GeometryType: The geometry type of the shape.

Returns

Shape: The added Shape.

AddShape(float, float, string, GeometryType)

Adds a new Shape with a specified size, text and geometry to the end of the canvas shape.

public Shape AddShape(float width, float height, string text, GeometryType type)

Parameters

width float

The shape width, in points.

height float

The shape height, in points.

text string

If not null, a TextFrame with this text is added to the shape.

Note that some geometries do not allow text frames (see TextFrameSupported(GeometryType)). If this parameter is not null and type specifies one of those geometries, an exception will be thrown.

type GeometryType

The geometry type of the shape.

Returns

Shape: The added Shape.

AddShape(float, float, string)

Adds a new Rectangle Shape with a specified size and text to the end of the canvas shape.

public Shape AddShape(float width, float height, string text = null)

Parameters

width float: The shape width, in points.
height float: The shape height, in points.
text string: If not null, a TextFrame with this text is added to the shape.

Returns

Shape: The added Shape.