iText 8.0.2 API
|
A layout element that represents an image for inclusion in the document model. More...
Public Member Functions |
|
Image (PdfImageXObject xObject) | |
Creates an Image from an image XObject, the representation of an image in PDF syntax. More... |
|
Image (PdfFormXObject xObject) | |
Creates an Image from a form XObject, the representation of a form in PDF syntax. More... |
|
Image (PdfImageXObject xObject, float width) | |
Creates an Image from an image XObject, the representation of an image in PDF syntax, with a custom width. More... |
|
Image (PdfImageXObject xObject, float left, float bottom, float width) | |
Creates an Image from an image XObject, the representation of an image in PDF syntax, with a custom width and on a fixed position. More... |
|
Image (PdfImageXObject xObject, float left, float bottom) | |
Creates an Image from an image XObject, the representation of an image in PDF syntax, on a fixed position. More... |
|
Image (PdfFormXObject xObject, float left, float bottom) | |
Creates an Image from a form XObject, the representation of a form in PDF syntax. More... |
|
Image (ImageData img) | |
Creates an Image from an image resource, read in from a file with the iText I/O module. More... |
|
Image (ImageData img, float left, float bottom) | |
Creates an Image from an image resource, read in from a file with the iText I/O module, on a fixed position. More... |
|
Image (ImageData img, float left, float bottom, float width) | |
Creates an Image from an image resource, read in from a file with the iText I/O module, with a custom width and on a fixed position. More... |
|
virtual PdfXObject | GetXObject () |
Gets the XObject contained in this image object More... |
|
virtual iText.Layout.Element.Image | SetRotationAngle (double radAngle) |
Sets the rotation radAngle. More... |
|
virtual UnitValue | GetMarginLeft () |
Gets the current left margin width of the element. More... |
|
virtual iText.Layout.Element.Image | SetMarginLeft (float value) |
Sets the left margin width of the element. More... |
|
virtual UnitValue | GetMarginRight () |
Gets the current right margin width of the image. More... |
|
virtual iText.Layout.Element.Image | SetMarginRight (float value) |
Sets the right margin width of the image. More... |
|
virtual UnitValue | GetMarginTop () |
Gets the current top margin width of the image. More... |
|
virtual iText.Layout.Element.Image | SetMarginTop (float value) |
Sets the top margin width of the image. More... |
|
virtual UnitValue | GetMarginBottom () |
Gets the current bottom margin width of the image. More... |
|
virtual iText.Layout.Element.Image | SetMarginBottom (float value) |
Sets the bottom margin width of the image. More... |
|
virtual iText.Layout.Element.Image | SetMargins (float marginTop, float marginRight, float marginBottom, float marginLeft) |
Sets the margins around the image to a series of new widths. More... |
|
virtual UnitValue | GetPaddingLeft () |
Gets the current left padding width of the image. More... |
|
virtual iText.Layout.Element.Image | SetPaddingLeft (float value) |
Sets the left padding width of the image. More... |
|
virtual UnitValue | GetPaddingRight () |
Gets the current right padding width of the image. More... |
|
virtual iText.Layout.Element.Image | SetPaddingRight (float value) |
Sets the right padding width of the image. More... |
|
virtual UnitValue | GetPaddingTop () |
Gets the current top padding width of the image. More... |
|
virtual iText.Layout.Element.Image | SetPaddingTop (float value) |
Sets the top padding width of the image. More... |
|
virtual UnitValue | GetPaddingBottom () |
Gets the current bottom padding width of the image. More... |
|
virtual iText.Layout.Element.Image | SetPaddingBottom (float value) |
Sets the bottom padding width of the image. More... |
|
virtual iText.Layout.Element.Image | SetPadding (float commonPadding) |
Sets all paddings around the image to the same width. More... |
|
virtual iText.Layout.Element.Image | SetPaddings (float paddingTop, float paddingRight, float paddingBottom, float paddingLeft) |
Sets the paddings around the image to a series of new widths. More... |
|
virtual iText.Layout.Element.Image | Scale (float horizontalScaling, float verticalScaling) |
Scale the image relative to its default size. More... |
|
virtual iText.Layout.Element.Image | ScaleToFit (float fitWidth, float fitHeight) |
Scale the image to an absolute size. More... |
|
virtual iText.Layout.Element.Image | ScaleAbsolute (float fitWidth, float fitHeight) |
Scale the image to an absolute size. More... |
|
virtual iText.Layout.Element.Image | SetAutoScale (bool autoScale) |
Sets the autoscale property for both width and height. More... |
|
virtual iText.Layout.Element.Image | SetAutoScaleHeight (bool autoScale) |
Sets the autoscale property for the height of the image. More... |
|
virtual iText.Layout.Element.Image | SetAutoScaleWidth (bool autoScale) |
Sets the autoscale property for the width of the image. More... |
|
virtual iText.Layout.Element.Image | SetFixedPosition (float left, float bottom) |
Sets values for a absolute repositioning of the Element. More... |
|
virtual iText.Layout.Element.Image | SetFixedPosition (int pageNumber, float left, float bottom) |
Sets values for a absolute repositioning of the Element, on a specific page. More... |
|
virtual float | GetImageWidth () |
Gets width of the image. More... |
|
virtual float | GetImageHeight () |
Gets height of the image. More... |
|
virtual iText.Layout.Element.Image | SetHeight (float height) |
Sets the height property of the image, measured in points. More... |
|
virtual iText.Layout.Element.Image | SetHeight (UnitValue height) |
Sets the height property of the image with a iText.Layout.Properties.UnitValue. More... |
|
virtual iText.Layout.Element.Image | SetMaxHeight (float maxHeight) |
Sets the max-height property of the image, measured in points. More... |
|
virtual iText.Layout.Element.Image | SetMaxHeight (UnitValue maxHeight) |
Sets the max-height property of the image with a iText.Layout.Properties.UnitValue. More... |
|
virtual iText.Layout.Element.Image | SetMinHeight (float minHeight) |
Sets the min-height property of the image, measured in points. More... |
|
virtual iText.Layout.Element.Image | SetMinHeight (UnitValue minHeight) |
Sets the min-height property of the image with a iText.Layout.Properties.UnitValue. More... |
|
virtual iText.Layout.Element.Image | SetMaxWidth (float maxWidth) |
Sets the max-width property of the image, measured in points. More... |
|
virtual iText.Layout.Element.Image | SetMaxWidth (UnitValue maxWidth) |
Sets the max-width property of the image with a iText.Layout.Properties.UnitValue. More... |
|
virtual iText.Layout.Element.Image | SetMinWidth (float minWidth) |
Sets the min-width property of the image, measured in points. More... |
|
virtual iText.Layout.Element.Image | SetMinWidth (UnitValue minWidth) |
Sets the min-width property of the image with a iText.Layout.Properties.UnitValue. More... |
|
virtual iText.Layout.Element.Image | SetWidth (float width) |
Sets the width property of the image, measured in points. More... |
|
virtual iText.Layout.Element.Image | SetWidth (UnitValue width) |
Sets the width property of the image with a iText.Layout.Properties.UnitValue. More... |
|
virtual UnitValue | GetWidth () |
Gets the width property of the image. More... |
|
virtual float | GetImageScaledWidth () |
Gets scaled width of the image. More... |
|
virtual float | GetImageScaledHeight () |
Gets scaled height of the image. More... |
|
virtual iText.Layout.Element.Image | SetObjectFit (ObjectFit objectFit) |
Sets an object-fit mode for the image. More... |
|
virtual ObjectFit | GetObjectFit () |
Retrieves the iText.Layout.Properties.ObjectFit mode for the image. More... |
|
virtual AccessibilityProperties | GetAccessibilityProperties () |
Gets the accessibility properties. More... |
|
virtual iText.Layout.Element.Image | SetNeutralRole () |
Give this element a neutral role. More... |
|
Public Member Functions inherited from iText.Layout.Element.AbstractElement< iText.Layout.Element.Image > | |
virtual IRenderer | GetRenderer () |
Gets a renderer for this element. More... |
|
virtual void | SetNextRenderer (IRenderer renderer) |
Overrides the iText.Layout.Renderer.IRenderer instance which will be returned by the next call to the GetRenderer(). More... |
|
virtual IRenderer | CreateRendererSubTree () |
Creates a renderer subtree with root in the current element. More... |
|
override bool | HasProperty (int property) |
Checks if this entity has the specified property. More... |
|
override T1 | GetProperty< T1 > (int property) |
Gets the property from this entity. More... |
|
virtual T | AddStyle (Style style) |
Add a new style to this element. More... |
|
virtual IList< IElement > | GetChildren () |
Gets the child elements of this elements More... |
|
virtual bool | IsEmpty () |
Returns true if this list contains no elements. More... |
|
virtual T | SetAction (PdfAction action) |
Sets an action on this Element. More... |
|
virtual T | SetPageNumber (int pageNumber) |
Explicitly sets the page number this element should be put on. More... |
|
Public Member Functions inherited from iText.Layout.Element.IElement | |
void | SetNextRenderer (IRenderer renderer) |
Overrides the iText.Layout.Renderer.IRenderer instance which will be returned by the next call to the GetRenderer(). More... |
|
IRenderer | GetRenderer () |
Gets a renderer for this element. More... |
|
IRenderer | CreateRendererSubTree () |
Creates a renderer subtree with root in the current element. More... |
|
Public Member Functions inherited from iText.Layout.IPropertyContainer | |
bool | HasProperty (int property) |
Checks if this entity has the specified property. More... |
|
bool | HasOwnProperty (int property) |
Checks if this entity has the specified property, i.e. if it was set to this very element earlier More... |
|
T1 | GetProperty< T1 > (int property) |
Gets the property from this entity. More... |
|
T1 | GetOwnProperty< T1 > (int property) |
Gets own property from this entity. More... |
|
T1 | GetDefaultProperty< T1 > (int property) |
Gets the default property from this entity. More... |
|
void | SetProperty (int property, Object value) |
Sets a property for this entity. More... |
|
void | DeleteOwnProperty (int property) |
Deletes the own property of this entity. More... |
|
A layout element that represents an image for inclusion in the document model.
|
inline |
Creates an Image from an image XObject, the representation of an image in PDF syntax.
xObject | an internal iText.Kernel.Pdf.Xobject.PdfImageXObject |
|
inline |
Creates an Image from a form XObject, the representation of a form in PDF syntax.
xObject | an internal iText.Kernel.Pdf.Xobject.PdfFormXObject |
|
inline |
Creates an Image from an image XObject, the representation of an image in PDF syntax, with a custom width.
xObject | an internal iText.Kernel.Pdf.Xobject.PdfImageXObject |
width | a float value |
|
inline |
Creates an Image from an image XObject, the representation of an image in PDF syntax, with a custom width and on a fixed position.
xObject | an internal iText.Kernel.Pdf.Xobject.PdfImageXObject |
left | a float value representing the horizontal offset of the lower left corner of the image |
bottom | a float value representing the vertical offset of the lower left corner of the image |
width | a float value |
|
inline |
Creates an Image from an image XObject, the representation of an image in PDF syntax, on a fixed position.
xObject | an internal iText.Kernel.Pdf.Xobject.PdfImageXObject |
left | a float value representing the horizontal offset of the lower left corner of the image |
bottom | a float value representing the vertical offset of the lower left corner of the image |
|
inline |
Creates an Image from a form XObject, the representation of a form in PDF syntax.
xObject | an internal iText.Kernel.Pdf.Xobject.PdfFormXObject |
left | a float value representing the horizontal offset of the lower left corner of the form |
bottom | a float value representing the vertical offset of the lower left corner of the form |
|
inline |
Creates an Image from an image resource, read in from a file with the iText I/O module.
img | an internal representation of the image resource |
|
inline |
Creates an Image from an image resource, read in from a file with the iText I/O module, on a fixed position.
img | an internal representation of the image resource |
left | a float value representing the horizontal offset of the lower left corner of the image |
bottom | a float value representing the vertical offset of the lower left corner of the image |
|
inline |
Creates an Image from an image resource, read in from a file with the iText I/O module, with a custom width and on a fixed position.
img | an internal representation of the image resource |
left | a float value representing the horizontal offset of the lower left corner of the image |
bottom | a float value representing the vertical offset of the lower left corner of the image |
width | a float value |
|
inlinevirtual |
Gets the accessibility properties.
Gets the accessibility properties . See also IAccessibleElement.
Implements iText.Layout.Tagging.IAccessibleElement.
|
inlinevirtual |
Gets height of the image.
Gets height of the image. It returns height of image or form XObject, not the height set by one of the #setHeight methods
|
inlinevirtual |
Gets scaled height of the image.
|
inlinevirtual |
Gets scaled width of the image.
|
inlinevirtual |
Gets width of the image.
Gets width of the image. It returns width of image or form XObject, not the width set by one of the #setWidth methods
|
inlinevirtual |
Gets the current bottom margin width of the image.
|
inlinevirtual |
Gets the current left margin width of the element.
|
inlinevirtual |
Gets the current right margin width of the image.
|
inlinevirtual |
Gets the current top margin width of the image.
|
inlinevirtual |
Retrieves the iText.Layout.Properties.ObjectFit mode for the image.
|
inlinevirtual |
Gets the current bottom padding width of the image.
|
inlinevirtual |
Gets the current left padding width of the image.
|
inlinevirtual |
Gets the current right padding width of the image.
|
inlinevirtual |
Gets the current top padding width of the image.
|
inlinevirtual |
Gets the width property of the image.
|
inlinevirtual |
Gets the XObject contained in this image object
|
inlinevirtual |
Scale the image relative to its default size.
horizontalScaling | the horizontal scaling coefficient. default value 1 = 100% |
verticalScaling | the vertical scaling coefficient. default value 1 = 100% |
|
inlinevirtual |
Scale the image to an absolute size.
Scale the image to an absolute size. This method will not preserve the width-height ratio of the image.
fitWidth | the new absolute width of the image |
fitHeight | the new absolute height of the image |
|
inlinevirtual |
Scale the image to an absolute size.
Scale the image to an absolute size. This method will preserve the width-height ratio of the image.
fitWidth | the new maximum width of the image |
fitHeight | the new maximum height of the image |
|
inlinevirtual |
Sets the autoscale property for both width and height.
autoScale | whether or not to let the image resize automatically |
|
inlinevirtual |
Sets the autoscale property for the height of the image.
Sets the autoscale property for the height of the image. Is currently bugged and will not work as expected.
autoScale | whether or not to let the image height resize automatically |
|
inlinevirtual |
Sets the autoscale property for the width of the image.
autoScale | whether or not to let the image width resize automatically |
|
inlinevirtual |
Sets values for a absolute repositioning of the Element.
Sets values for a absolute repositioning of the Element. Also has as a side effect that the Element's iText.Layout.Properties.Property.POSITION is changed to fixed.
left | horizontal position on the page |
bottom | vertical position on the page |
|
inlinevirtual |
Sets values for a absolute repositioning of the Element, on a specific page.
Sets values for a absolute repositioning of the Element, on a specific page. Also has as a side effect that the Element's iText.Layout.Properties.Property.POSITION is changed to fixed.
pageNumber | the page where the element must be positioned |
left | horizontal position on the page |
bottom | vertical position on the page |
|
inlinevirtual |
Sets the height property of the image, measured in points.
height | a value measured in points. |
|
inlinevirtual |
Sets the height property of the image with a iText.Layout.Properties.UnitValue.
height | a value measured in points. |
|
inlinevirtual |
Sets the bottom margin width of the image.
value | the new bottom margin width |
|
inlinevirtual |
Sets the left margin width of the element.
value | the new left margin width |
|
inlinevirtual |
Sets the right margin width of the image.
value | the new right margin width |
|
inlinevirtual |
Sets the margins around the image to a series of new widths.
marginTop | the new margin top width |
marginRight | the new margin right width |
marginBottom | the new margin bottom width |
marginLeft | the new margin left width |
|
inlinevirtual |
Sets the top margin width of the image.
value | the new top margin width |
|
inlinevirtual |
Sets the max-height property of the image, measured in points.
maxHeight | a value measured in points. |
|
inlinevirtual |
Sets the max-height property of the image with a iText.Layout.Properties.UnitValue.
maxHeight | a value measured in points. |
|
inlinevirtual |
Sets the max-width property of the image, measured in points.
maxWidth | a value measured in points. |
|
inlinevirtual |
Sets the max-width property of the image with a iText.Layout.Properties.UnitValue.
maxWidth | a value measured in points. |
|
inlinevirtual |
Sets the min-height property of the image, measured in points.
minHeight | a value measured in points. |
|
inlinevirtual |
Sets the min-height property of the image with a iText.Layout.Properties.UnitValue.
minHeight | a value measured in points. |
|
inlinevirtual |
Sets the min-width property of the image, measured in points.
minWidth | a value measured in points. |
|
inlinevirtual |
Sets the min-width property of the image with a iText.Layout.Properties.UnitValue.
minWidth | a value measured in points. |
|
inlinevirtual |
Give this element a neutral role.
Give this element a neutral role. See also iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetRole(System.String).
|
inlinevirtual |
Sets an object-fit mode for the image.
objectFit | is the iText.Layout.Properties.ObjectFit mode |
|
inlinevirtual |
Sets all paddings around the image to the same width.
commonPadding | the new padding width |
|
inlinevirtual |
Sets the bottom padding width of the image.
value | the new bottom padding width |
|
inlinevirtual |
Sets the left padding width of the image.
value | the new left padding width |
|
inlinevirtual |
Sets the right padding width of the image.
value | the new right padding width |
|
inlinevirtual |
Sets the paddings around the image to a series of new widths.
paddingTop | the new padding top width |
paddingRight | the new padding right width |
paddingBottom | the new padding bottom width |
paddingLeft | the new padding left width |
|
inlinevirtual |
Sets the top padding width of the image.
value | the new top padding width |
|
inlinevirtual |
Sets the rotation radAngle.
radAngle | a value in radians |
|
inlinevirtual |
Sets the width property of the image, measured in points.
width | a value measured in points. |
|
inlinevirtual |
Sets the width property of the image with a iText.Layout.Properties.UnitValue.
width | a iText.Layout.Properties.UnitValue object |