Container Class

classContainer : Element

Namespace:Datalogics::PDFL

Inherits from:: Element

Detailed Description

A container class represents a group of elements on a page in a PDF file.

In the PDF file, every container has a set of Marked Content tags, starting with Begin Marked Content (BMC or BDC) and ending with End Marked Content (EMC), so each container has a BMC/EMC or BDC/EMC pair of tags. These tags can be used to define the beginning and end of metadata around objects, providing information about the text and shapes within a PDF file. Containers can be nested within other containers.

Referenced by

Container

Uses types

Clip ColorProfile Container Content Document ElementCloneFlags Matrix OptionalContentContext OptionalContentMembershipDict PDFDict Rect RenderIntent

Constructor & Destructor Documentation

Container(Containerrhs, InternalConstructsignifier)

Parameters

rhs: Container
signifier: InternalConstruct

Container()

Create a new Container.

The new Container has no tag and is not associated with a dictionary.

Container(stringmcTag)

Parameters

mcTag: string

Create a new Container with a given Marked Content Tag.

The new Container has a Marked Content tag but is not associated with a dictionary.

Container(stringmcTag, PDFDictpropertyList, boolisInline)

Parameters

mcTag: string: The tag name for the Container.
propertyList: PDFDict: The dictionary representing the Property List to associate with the Container.
isInline: bool: If true, it's part of content stream. If false, its emitted outside of the content stream and referenced by name.

Create a new Container with a given Marked Content Tag and Property list.

The new Container has a Marked Content tag and is associated with a dictionary.

Property Documentation

RectBoundingBox[get]

ClipClip[get, set]

ContentContent[get, set]

stringMarkedContentTag[get, set]

MatrixMatrix[get, set]

OptionalContentMembershipDictOptionalContentMembershipDict[get, set]

PDFDictPDFDict[get]

Member Function Documentation

new ContainerClone()

Returns:

The copied container.

Makes a copy of the container.

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

new ContainerClone(ElementCloneFlagscloneFlags)

Parameters

cloneFlags: ElementCloneFlags: Flags that modify the cloning operation.

Returns:

The copied container.

Makes a copy of the container.

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

ContainerColorConvert(Documentdocument, ColorProfileprof, RenderIntentintent, boolembed)

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 objects 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:

A new Container with the applied ICC ColorProfile.

Applies the specified ICC ColorProfile to the objects in the Container

static new static ContainerConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static Container

voidDispose()

Returns:

void

voidDisposeChildren()

Returns:

void

boolIsCurrentlyVisible(OptionalContentContextocc)

Parameters

occ: OptionalContentContext

Returns:

true if the container is currently visible.

Tests whether a container is visible in a given optional content context, considering the current ON-OFF states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy.

If the container occurs more than once within the content, this method only checks the visibility of the first occurrence of the container.

This method determines visibility without considering the visbility of the Content object that the container belongs to. To determine the visibility of a container while taking the Content's visibility into consideration, use the alternate version of this method.

boolIsCurrentlyVisible(OptionalContentContextocc, Contentcontent)

Parameters

occ: OptionalContentContext
content: Content

Returns:

true if the container is currently visible.

Tests whether a container is visible in a given optional content context and content.

If the container occurs more than once within the content, this method only checks the visibility of the first occurrence of the container.

boolMakeVisible(OptionalContentContextocc, Contentcontent)

Parameters

occ: OptionalContentContext: The optional content context in which the container is made visible.
content: Content: The content containing the container.

Returns:

true if the container is successfully made visible in the given context and content, false otherwise

Makes a container visible in a given optional content context and content by manipulating the ON-OFF states of the optional content groups.

voidRotate(doubletheta)

Parameters

theta: double

Returns:

void

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

voidScale(doublesx, doublesy)

Parameters

sx: double
sy: double

Returns:

void

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

voidTranslate(doubletx, doublety)

Parameters

tx: double
ty: double

Returns:

void

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