PdfContentGroup Class

Namespace:
GemBox.Pdf.Content
Assembly:
GemBox.Pdf.dll

Represents a group of PDF content elements that are independent from the rest of the surrounding elements.

public class PdfContentGroup : PdfVisualContentElement
Public Class PdfContentGroup
    Inherits PdfVisualContentElement
Inheritance:
PdfContentGroup
Derived
PdfContent

Properties

Bounds

Gets the upright bounds of the PdfContentGroup.

public override PdfQuad Bounds { get; }
Public Overrides ReadOnly Property Bounds As PdfQuad
Property Value
PdfQuad

The upright bounds of the PdfContentGroup.

Overrides
Remarks

This member, although exposed as a property for easier debugging, performs complex calculations, so instead of accessing it frequently, cache its result instead.

Elements

Gets the content elements such as text, paths and external objects (images and forms) contained directly in this group.

public PdfContentElementCollection Elements { get; }
Public ReadOnly Property Elements As PdfContentElementCollection
Property Value
PdfContentElementCollection

The content elements such as text, paths and external objects (images and forms) contained directly in this group.

ElementType

Gets the Group value.

public override PdfContentElementType ElementType { get; }
Public Overrides ReadOnly Property ElementType As PdfContentElementType
Property Value
PdfContentElementType

The Group value.

Overrides

Methods

DrawImage(PdfImage, PdfMatrix)

Draws image with the specified transformation.

public void DrawImage(PdfImage image, PdfMatrix transform)
Public Sub DrawImage(image As PdfImage, transform As PdfMatrix)
Parameters
image
PdfImage

The image to be drawn.

transform
PdfMatrix

The transformation from the new (transformed) coordinate system to the original (untransformed) coordinate system.

Exceptions
ArgumentNullException

image is null.

DrawImage(PdfImage, PdfPoint)

Draws image at the specified location.

public void DrawImage(PdfImage image, PdfPoint origin)
Public Sub DrawImage(image As PdfImage, origin As PdfPoint)
Parameters
image
PdfImage

The image to be drawn.

origin
PdfPoint

The location of the bottom-left corner of the PdfImage.

Exceptions
ArgumentNullException

image is null.

DrawImage(PdfImage, PdfPoint, PdfSize)

Draws image at the specified location and of the specified size.

public void DrawImage(PdfImage image, PdfPoint origin, PdfSize size)
Public Sub DrawImage(image As PdfImage, origin As PdfPoint, size As PdfSize)
Parameters
image
PdfImage

The image to be drawn.

origin
PdfPoint

The location of the bottom-left corner of the PdfImage.

size
PdfSize

The size of the PdfImage.

Exceptions
ArgumentNullException

image is null.

DrawText(PdfFormattedText, PdfMatrix)

Draws formatted text with the specified transformation.

public void DrawText(PdfFormattedText formattedText, PdfMatrix transform)
Public Sub DrawText(formattedText As PdfFormattedText, transform As PdfMatrix)
Parameters
formattedText
PdfFormattedText

The formatted text to be drawn.

transform
PdfMatrix

The transformation from the new (transformed) coordinate system to the original (untransformed) coordinate system.

Exceptions
ArgumentNullException

formattedText is null.

DrawText(PdfFormattedText, PdfPoint)

Draws formatted text at the specified location.

public void DrawText(PdfFormattedText formattedText, PdfPoint origin)
Public Sub DrawText(formattedText As PdfFormattedText, origin As PdfPoint)
Parameters
formattedText
PdfFormattedText

The formatted text to be drawn.

origin
PdfPoint

The location of the bottom-left corner of the PdfFormattedText.

Exceptions
ArgumentNullException

formattedText is null.

DrawText(PdfFormattedTextLine, PdfPoint)

Draws formatted text line at the specified location.

public void DrawText(PdfFormattedTextLine formattedTextLine, PdfPoint origin)
Public Sub DrawText(formattedTextLine As PdfFormattedTextLine, origin As PdfPoint)
Parameters
formattedTextLine
PdfFormattedTextLine

The formatted text line to be drawn.

origin
PdfPoint

The location of the bottom-left corner of the PdfFormattedTextLine.

Exceptions
ArgumentNullException

formattedTextLine is null.

ToString()

Returns a Unicode text contained in this PdfContentGroup.

public override string ToString()
Public Overrides Function ToString As String
Returns
String

A Unicode text contained in this PdfContentGroup.

Overrides

Inherited Properties

Collection

Gets the PdfContentElementCollection that the PdfContentElement belongs to.

(Inherited from PdfContentElement)

Format

Gets or sets the formatting properties applied to the PdfVisualContentElement.

(Inherited from PdfVisualContentElement)

Next

Gets the next PdfContentElement in the Collection.

(Inherited from PdfContentElement)

Previous

Gets the previous PdfContentElement in the Collection.

(Inherited from PdfContentElement)

Transform

Gets or sets the transformation from the new (transformed) coordinate system to the original (untransformed) coordinate system.

All coordinates used after the transformation are expressed in the transformed coordinate system.

tip

Before setting the Transform, move PdfVisualContentElement into its own PdfContentGroup so that the transformation is confined to that PdfContentGroup and doesn't have any effect on PdfContentElements outside that PdfContentGroup.

(Inherited from PdfVisualContentElement)

Examples

See Also