Group Class Documentation

class Group : Element

Namespace:Datalogics::PDFL

Inherits from:
Element

Detailed Description

A set of elements to be used within a PDF document.

A Group represents objects in a content object, but it resides in memory.

Therefore the group has no state and is not represented in any way in a PDF content stream. When used in a Clip, a group is used to associate Text objects into a single clipping object.

Referenced by

Constructor & Destructor Documentation

Group

Group()

Create a new Group.

Group

Group(Content content)

Parameters

content: Content

The new Content of the group.

Create a Group with the given Content.

Property Documentation

BoundingBox

Rect BoundingBox[get]

The bounding box for this element.

The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself.

Clip

Clip Clip[get, set]

Gets the current Clip for an Element.

Content

Content Content[get, set]

Obtain the content of a Group.

Matrix

Matrix Matrix[get, set]

The transformation matrix for the element.

Member Function Documentation

Clone

new Group Clone()

Returns:

new Group

The copied group.

Makes a copy of the group.

Make a copy of an group to obtain a new group that has a distinct set of attributes.

Clone

new Group Clone(ElementCloneFlags cloneFlags)

Parameters

cloneFlags: ElementCloneFlags

Flags that modify the cloning operation.

Returns:

new Group

The copied group.

Makes a copy of the group.

Make a copy of an group to obtain a new group that has a distinct set of attributes.

ColorConvert

Group ColorConvert(Document document, ColorProfile prof, RenderIntent intent, bool embed)

Parameters

document: Document

The document the element belongs to.

prof: ColorProfile

The ICC ColorProfile to be applied.

intent: RenderIntent

The ICC Rendering Intent for the ColorProfile

embed: bool

If true, embed the color space and make the object calibrated. If it is false and the target profile is CMYK, RGB, or Gray, the colors space of the resulting objects, after conversion, will be DeviceCMYK, DeviceRGB, or DeviceGray, respectively.

Returns:

Group

A new Group object with the applied ICC ColorProfile.

Applies the specified ICC ColorProfile to the elements in the Group object

Dispose

void Dispose()

Returns:

void

Rotate

void Rotate(double theta)

Parameters

theta: double

The rotation angle in degrees.

Returns:

void

Rotate an element by theta degrees counterclockwise using the matrix [ cos T sin T -sin T cos T 0 0 ].

Scale

void Scale(double sx, double sy)

Parameters

sx: double

The horizontal scale factor.

sy: double

The vertical scale factor.

Returns:

void

Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].

Translate

void Translate(double tx, double ty)

Parameters

tx: double

The horizontal translation distance in user space units.

ty: double

The vertical translation distance in user space units.

Returns:

void

Translate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].