Element Class |
Element is the abstract interface used to access graphical elements used to build the
display list.
Just like many other classes in PDFNet (e.g. ColorSpace, Font, Annot, etc), Element
class follows the composite design pattern. This means that all Elements are
accessed through the same interface, but depending on the Element type (that can be
obtained using GetType()), only methods related to that type can be called.
For example, if GetType() returns e_image, it is illegal to call a method specific to
another Element type (i.e. a call to a text specific GetTextData() will throw an
Exception).
Inheritance HierarchyNamespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255
Syntaxpublic sealed class Element
The Element type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Equals | (Inherited from Object.) |
| GetBBox | Obtains the bounding box for a graphical element.
Calculates the bounding box for a graphical element (i.e. an Element that belongs
to one of following types: e_path, e_text, e_image, e_inline_image, e_shading e_form).
The returned bounding box is guaranteed to encompass the Element, but is not guaranteed
to be the smallest box that could contain the element. For example, for Bezier curves
the bounding box will enclose all control points, not just the curve itself.
|
| GetBitsPerComponent | Gets the bits per component.
|
| GetCharIterator | Gets the Char iterator.
|
| GetComponentNum | Gets the component number.
|
| GetCTM | Gets the cTM.
|
| GetDecodeArray | Gets the decode Array.
|
| GetGState | Gets the g state.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetImageColorSpace | Gets Bitmap
|
| GetImageData | Gets the image data.
|
| GetImageDataSize | Gets the image data size.
|
| GetImageHeight | Gets the image height.
|
| GetImageRenderingIntent | Gets the image rendering intent.
|
| GetImageWidth | Gets the image width.
|
| GetMask | Gets the mask.
|
| GetMCPropertyDict | Gets the mC property dict.
|
| GetMCTag | Gets the mC tag.
|
| GetNewTextLineOffset | Gets the offset (out_x, out_y) to the start of the current line relative to
the beginning of the previous line.
out_x and out_y are numbers expressed in unscaled text space units.
The returned numbers correspond to the arguments of 'Td' operator.
|
| GetPathData | Get the PathData stored by the path element.
|
| GetPosAdjustment | Gets the pos adjustment.
|
| GetShading | Gets the shading.
|
| GetStructMCID | Gets the parent logical structure element
|
| GetTextData | Gets the text data.
|
| GetTextDataSize | Gets the size of the internal text buffer returned in GetTextData().
|
| GetTextLength | Gets the text length.
|
| GetTextMatrix | Gets the text matrix.
|
| GetTextString | Gets the text string.
|
| GetType | Gets the type.
|
| GetXObject | Gets the x object.
|
| HasTextMatrix | Checks for text matrix.
|
| IsClippingPath | Checks if is clipping path.
|
| IsClipWindingFill | Checks if is clip winding fill.
|
| IsFilled | Checks if is filled.
|
| IsImageInterpolate | Checks if is image interpolate.
|
| IsImageMask | Checks if is image mask.
|
| IsOCVisible | Checks if is oC visible.
|
| IsStroked | Checks if is stroked.
|
| IsWindingFill | Checks if is winding fill.
|
| SetClipWindingFill | Sets clipping path's fill rule.
|
| SetNewTextLineOffset | Sets the offset (dx, dy) to the start of the current line relative to the beginning
of the previous line.
|
| SetPathClip | Indicate whether the path is a clipping path or non-clipping path.
|
| SetPathData | Set the PathData of this element. The PathData contains the Array of points
stored by the element and the Array of path segment types.
|
| SetPathFill | Indicate whether the path should be filled.
|
| SetPathStroke | Indicate whether the path should be stroked.
|
| SetPosAdjustment | Sets the pos adjustment.
|
| SetTextData | GetTextString() maps the raw text directly into Unicode (as specified by Adobe
Glyph List (AGL)). Even if you would prefer to decode text yourself it is more
convenient to use CharIterators returned by CharBegin()/CharEnd() and
PDF::Font code mapping methods.
|
| SetTextMatrix(Matrix2D) | Sets the text matrix for a text element.
|
| SetTextMatrix(Double, Double, Double, Double, Double, Double) | Sets the text matrix for a text element. This method accepts text
transformation matrix components directly.
A transformation matrix in PDF is specified by six numbers, usually
in the form of an Array containing six elements. In its most general
form, this Array is denoted [a b c d h v]; it can represent any linear
transformation from one coordinate system to another. For more
information about PDF matrices please refer to section 4.2.2 'Common
Transformations' in PDF Reference Manual, and to documentation for
Matrix2D class.
|
| SetWindingFill | Sets path's fill rule.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateTextMetrics | Recompute the Character positioning information (i.e. CharIterator-s) and
text length.
Element objects caches text length and Character positioning information.
If the user modifies the text data or graphics state the cached information
is not correct. UpdateTextMetrics() can be used to recalculate the correct
positioning and length information.
|
See Also