Skip to content

Commit 437ed90

Browse files
EvgenyB1001iText-CI
authored andcommitted
Update PdfCanvas javadocs
DEVSIX-1667 Autoported commit. Original commit hash: [1747fbafe]
1 parent 33f5ba2 commit 437ed90

File tree

2 files changed

+53
-1
lines changed

2 files changed

+53
-1
lines changed

itext/itext.kernel/itext/kernel/pdf/canvas/PdfCanvas.cs

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1627,6 +1627,11 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas EndLayer() {
16271627
}
16281628

16291629
/// <summary>Creates Image XObject from image and adds it to canvas (as Image XObject).</summary>
1630+
/// <remarks>
1631+
/// Creates Image XObject from image and adds it to canvas (as Image XObject).
1632+
/// <para />
1633+
/// The float arguments will be used in concatenating the transformation matrix as operands.
1634+
/// </remarks>
16301635
/// <param name="image">
16311636
/// the
16321637
/// <c>PdfImageXObject</c>
@@ -1639,11 +1644,17 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas EndLayer() {
16391644
/// <param name="e">an element of the transformation matrix</param>
16401645
/// <param name="f">an element of the transformation matrix</param>
16411646
/// <returns>created Image XObject.</returns>
1647+
/// <seealso cref="ConcatMatrix(double, double, double, double, double, double)"/>
16421648
public virtual PdfXObject AddImage(ImageData image, float a, float b, float c, float d, float e, float f) {
16431649
return AddImage(image, a, b, c, d, e, f, false);
16441650
}
16451651

16461652
/// <summary>Creates Image XObject from image and adds it to canvas.</summary>
1653+
/// <remarks>
1654+
/// Creates Image XObject from image and adds it to canvas.
1655+
/// <para />
1656+
/// The float arguments will be used in concatenating the transformation matrix as operands.
1657+
/// </remarks>
16471658
/// <param name="image">
16481659
/// the
16491660
/// <c>PdfImageXObject</c>
@@ -1657,6 +1668,7 @@ public virtual PdfXObject AddImage(ImageData image, float a, float b, float c, f
16571668
/// <param name="f">an element of the transformation matrix</param>
16581669
/// <param name="asInline">true if to add image as in-line.</param>
16591670
/// <returns>created Image XObject or null in case of in-line image (asInline = true).</returns>
1671+
/// <seealso cref="ConcatMatrix(double, double, double, double, double, double)"/>
16601672
public virtual PdfXObject AddImage(ImageData image, float a, float b, float c, float d, float e, float f,
16611673
bool asInline) {
16621674
if (image.GetOriginalType() == ImageType.WMF) {
@@ -1682,11 +1694,15 @@ public virtual PdfXObject AddImage(ImageData image, float a, float b, float c, f
16821694
/// <remarks>
16831695
/// Creates Image XObject from image and adds it to canvas.
16841696
/// The created image will be fit inside on the specified rectangle without preserving aspect ratio.
1697+
/// <para />
1698+
/// The x, y, width and height parameters of the rectangle will be used in concatenating
1699+
/// the transformation matrix as operands.
16851700
/// </remarks>
16861701
/// <param name="image">image from which Image XObject will be created</param>
16871702
/// <param name="rect">rectangle in which the created image will be fit</param>
16881703
/// <param name="asInline">true if to add image as in-line.</param>
16891704
/// <returns>created XObject or null in case of in-line image (asInline = true).</returns>
1705+
/// <seealso cref="ConcatMatrix(double, double, double, double, double, double)"/>
16901706
public virtual PdfXObject AddImage(ImageData image, iText.Kernel.Geom.Rectangle rect, bool asInline) {
16911707
return AddImage(image, rect.GetWidth(), 0, 0, rect.GetHeight(), rect.GetX(), rect.GetY(), asInline);
16921708
}
@@ -1719,12 +1735,18 @@ public virtual PdfXObject AddImage(ImageData image, float x, float y, bool asInl
17191735

17201736
/// <summary>Creates Image XObject from image and adds it to the specified position with specified width preserving aspect ratio.
17211737
/// </summary>
1738+
/// <remarks>
1739+
/// Creates Image XObject from image and adds it to the specified position with specified width preserving aspect ratio.
1740+
/// <para />
1741+
/// The float arguments will be used in concatenating the transformation matrix as operand.
1742+
/// </remarks>
17221743
/// <param name="image">image from which Image XObject will be created</param>
17231744
/// <param name="x">horizontal offset of the created image position</param>
17241745
/// <param name="y">vertical offset of the created image position</param>
17251746
/// <param name="width">width of the created image on the basis of which the image height will be calculated</param>
17261747
/// <param name="asInline">true if to add image as in-line.</param>
17271748
/// <returns>created XObject or null in case of in-line image (asInline = true).</returns>
1749+
/// <seealso cref="ConcatMatrix(double, double, double, double, double, double)"/>
17281750
public virtual PdfXObject AddImage(ImageData image, float x, float y, float width, bool asInline) {
17291751
if (image.GetOriginalType() == ImageType.WMF) {
17301752
WmfImageHelper wmf = new WmfImageHelper(image);
@@ -1748,6 +1770,11 @@ public virtual PdfXObject AddImage(ImageData image, float x, float y, float widt
17481770

17491771
/// <summary>Creates Image XObject from image and adds it to the specified position with specified width preserving aspect ratio.
17501772
/// </summary>
1773+
/// <remarks>
1774+
/// Creates Image XObject from image and adds it to the specified position with specified width preserving aspect ratio.
1775+
/// <para />
1776+
/// The float arguments will be used in concatenating the transformation matrix as operand.
1777+
/// </remarks>
17511778
/// <param name="image">image from which Image XObject will be created</param>
17521779
/// <param name="x">horizontal offset of the created image position</param>
17531780
/// <param name="y">vertical offset of the created image position</param>
@@ -1758,6 +1785,7 @@ public virtual PdfXObject AddImage(ImageData image, float x, float y, float widt
17581785
/// <see cref="AddImage(iText.IO.Image.ImageData, float, float, float, bool)"/>.
17591786
/// </param>
17601787
/// <returns>created XObject or null in case of in-line image (asInline = true).</returns>
1788+
/// <seealso cref="ConcatMatrix(double, double, double, double, double, double)"></seealso>
17611789
public virtual PdfXObject AddImage(ImageData image, float x, float y, float height, bool asInline, bool dummy
17621790
) {
17631791
return AddImage(image, height / image.GetHeight() * image.GetWidth(), 0, 0, height, x, y, asInline);
@@ -1768,6 +1796,13 @@ public virtual PdfXObject AddImage(ImageData image, float x, float y, float heig
17681796
/// <c>PdfXObject</c>
17691797
/// to canvas.
17701798
/// </summary>
1799+
/// <remarks>
1800+
/// Adds
1801+
/// <c>PdfXObject</c>
1802+
/// to canvas.
1803+
/// <para />
1804+
/// The float arguments will be used in concatenating the transformation matrix as operands.
1805+
/// </remarks>
17711806
/// <param name="xObject">
17721807
/// the
17731808
/// <c>PdfImageXObject</c>
@@ -1780,6 +1815,7 @@ public virtual PdfXObject AddImage(ImageData image, float x, float y, float heig
17801815
/// <param name="e">an element of the transformation matrix</param>
17811816
/// <param name="f">an element of the transformation matrix</param>
17821817
/// <returns>current canvas.</returns>
1818+
/// <seealso cref="ConcatMatrix(double, double, double, double, double, double)"></seealso>
17831819
public virtual iText.Kernel.Pdf.Canvas.PdfCanvas AddXObject(PdfXObject xObject, float a, float b, float c,
17841820
float d, float e, float f) {
17851821
if (xObject is PdfFormXObject) {
@@ -1861,11 +1897,19 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas AddXObject(PdfXObject xObject,
18611897
/// <c>PdfXObject</c>
18621898
/// to the specified position with specified width preserving aspect ratio.
18631899
/// </summary>
1900+
/// <remarks>
1901+
/// Adds
1902+
/// <c>PdfXObject</c>
1903+
/// to the specified position with specified width preserving aspect ratio.
1904+
/// <para />
1905+
/// The float arguments will be used in concatenating the transformation matrix as operand.
1906+
/// </remarks>
18641907
/// <param name="xObject">Image XObject to be added</param>
18651908
/// <param name="x">horizontal offset of the image position</param>
18661909
/// <param name="y">vertical offset of the image position</param>
18671910
/// <param name="width">width of the image on the basis of which the height will be calculated</param>
18681911
/// <returns>current canvas.</returns>
1912+
/// <seealso cref="ConcatMatrix(double, double, double, double, double, double)"/>
18691913
public virtual iText.Kernel.Pdf.Canvas.PdfCanvas AddXObject(PdfXObject xObject, float x, float y, float width
18701914
) {
18711915
if (xObject is PdfFormXObject) {
@@ -1886,6 +1930,13 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas AddXObject(PdfXObject xObject,
18861930
/// <c>PdfXObject</c>
18871931
/// to the specified position with specified height preserving aspect ratio.
18881932
/// </summary>
1933+
/// <remarks>
1934+
/// Adds
1935+
/// <c>PdfXObject</c>
1936+
/// to the specified position with specified height preserving aspect ratio.
1937+
/// <para />
1938+
/// The float arguments will be used in concatenating the transformation matrix as operand.
1939+
/// </remarks>
18891940
/// <param name="xObject">Image XObject to be added</param>
18901941
/// <param name="x">horizontal offset of the image position</param>
18911942
/// <param name="y">vertical offset of the image position</param>
@@ -1895,6 +1946,7 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas AddXObject(PdfXObject xObject,
18951946
/// <see cref="AddXObject(iText.Kernel.Pdf.Xobject.PdfXObject, float, float, float)"/>
18961947
/// </param>
18971948
/// <returns>current canvas.</returns>
1949+
/// <seealso cref="ConcatMatrix(double, double, double, double, double, double)"/>
18981950
public virtual iText.Kernel.Pdf.Canvas.PdfCanvas AddXObject(PdfXObject xObject, float x, float y, float height
18991951
, bool dummy) {
19001952
if (xObject is PdfFormXObject) {

port-hash

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
b6ddf5d33915bc7a6e4a1f67810021a4746386bd
1+
1747fbafe6582852552088346bb16fe3ef4b189c

0 commit comments

Comments
 (0)