[]
        
(Showing Draft Content)

GrapeCity.Documents.Word.GroupShape

Class GroupShape

Namespace
GrapeCity.Documents.Word
Assembly
GcDocs.Word.dll

Represents a group shape element in a body content.

public class GroupShape : ShapeBase, IBrowsable<GroupShape>
Inheritance
object
GroupShape
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()

Properties

ChildrenOffset

Gets or sets the location of the child extents rectangle used for calculations of grouping, scaling, and rotation behavior of shapes placed within a group, in points.

public PointF ChildrenOffset { get; set; }

Property Value

System.Drawing.PointF

ChildrenSize

Gets or sets the size dimensions of the child extents rectangle used for calculations of grouping, scaling, and rotation behavior of shapes placed within a group, in points.

public SizeF ChildrenSize { get; set; }

Property Value

System.Drawing.SizeF

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

Next

Gets the next group shape.

public GroupShape Next { get; }

Property Value

GroupShape

Previous

Gets the previous group shape.

public GroupShape Previous { get; }

Property Value

GroupShape

Methods

AddGroupShape()

Adds a GroupShape to the end of the group shape.

public GroupShape AddGroupShape()

Returns

GroupShape

The added GroupShape.

AddGroupShape(float, float)

Adds a GroupShape to the end of the group 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 group 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 group 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 group shape.

public Picture AddPicture()

Returns

Picture

The added Picture.

AddPicture(Image)

Adds a new Picture to the end of the group 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 group 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 group 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 Shape (100 x 100 points) to the end of the group 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 group 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 group 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 group 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.

ApplyEffectsPreset(ShapeEffectsPreset)

public void ApplyEffectsPreset(ShapeEffectsPreset preset)

Parameters

preset ShapeEffectsPreset

ApplyGroupFill()

Applies the group fill to all shape and canvas children.

public void ApplyGroupFill()

Unbind()

Ungroups the nested shapes.

public void Unbind()