Images and shapes

Images and vector shapes are inline content: they are added to a paragraph and participate in the text flow. In fact an image is a shape - AddImage creates a shape and sets the image as its background.

Images

AddImage takes the display size in points and either a file path or a filter. The image is scaled to the requested size.

Paragraph para = doc.AddParagraph();
para.SetJustificationMode(Paragraph.TextJustification.e_center);
para.AddImage(120, 90, input_path + "butterfly.png");

Paragraph para = doc.AddParagraph();
para.SetJustificationMode(Paragraph::e_text_justify_center);
para.AddImage(120, 90, input_path + "butterfly.png");

para := doc.AddParagraph()
para.SetJustificationMode(ParagraphE_text_justify_center)
para.AddImage(120, 90, inputPath+"butterfly.png")

Paragraph para = doc.addParagraph();
para.setJustificationMode(Paragraph.TextJustification.e_text_justify_center);
para.addImage(120, 90, input_path + "butterfly.png");

const para = await doc.addParagraph();
para.setJustificationMode(PDFNet.Paragraph.TextJustification.e_text_justify_center);
await para.addImage(120, 90, inputPath + 'butterfly.png');

PTParagraph* para = [doc AddParagraph];
[para SetJustificationMode:e_ptpara_text_justify_center];
[para AddImageWithPath:120 height:90
                  path:[input_path stringByAppendingString:@"butterfly.png"]];

$para = $doc->AddParagraph();
$para->SetJustificationMode(Paragraph::e_text_justify_center);
$para->AddImage(120, 90, $input_path."butterfly.png");

para = doc.AddParagraph()
para.SetJustificationMode(Paragraph.e_text_justify_center)
para.AddImage(120, 90, input_path + "butterfly.png")

para = doc.AddParagraph()
para.SetJustificationMode(Paragraph::E_text_justify_center)
para.AddImage(120, 90, input_path + "butterfly.png")

Because images are inline, they can sit in the middle of running text - useful for logos, icons and signatures.

Paragraph para = doc.AddParagraph();
para.AddText("Images are inline content, so they sit in the text flow ");
para.AddImage(16, 16, input_path + "logo_red.png");
para.AddText(" just like any other run, and the surrounding text wraps around them.");

Paragraph para = doc.AddParagraph();
para.AddText("Images are inline content, so they sit in the text flow ");
para.AddImage(16, 16, input_path + "logo_red.png");
para.AddText(" just like any other run, and the surrounding text wraps around them.");

para := doc.AddParagraph()
para.AddText("Images are inline content, so they sit in the text flow ")
para.AddImage(16, 16, inputPath+"logo_red.png")
para.AddText(" just like any other run, and the surrounding text wraps around them.")

Paragraph para = doc.addParagraph();
para.addText("Images are inline content, so they sit in the text flow ");
para.addImage(16, 16, input_path + "logo_red.png");
para.addText(" just like any other run, and the surrounding text wraps around them.");

const para = await doc.addParagraph();
await para.addText('Images are inline content, so they sit in the text flow ');
await para.addImage(16, 16, inputPath + 'logo_red.png');
await para.addText(' just like any other run, and the surrounding text wraps around them.');

PTParagraph* para = [doc AddParagraph];
[para AddText:@"Images are inline content, so they sit in the text flow "];
[para AddImageWithPath:16 height:16
                  path:[input_path stringByAppendingString:@"logo_red.png"]];
[para AddText:@" just like any other run, and the surrounding text wraps around them."];

$para = $doc->AddParagraph();
$para->AddText("Images are inline content, so they sit in the text flow ");
$para->AddImage(16, 16, $input_path."logo_red.png");
$para->AddText(" just like any other run, and the surrounding text wraps around them.");

para = doc.AddParagraph()
para.AddText("Images are inline content, so they sit in the text flow ")
para.AddImage(16, 16, input_path + "logo_red.png")
para.AddText(" just like any other run, and the surrounding text wraps around them.")

para = doc.AddParagraph()
para.AddText("Images are inline content, so they sit in the text flow ")
para.AddImage(16, 16, input_path + "logo_red.png")
para.AddText(" just like any other run, and the surrounding text wraps around them.")

An overload of AddImage accepts a filter, so the image data can come from memory rather than disk. To place an image outside the text flow, pinned to a page position with text wrapping around it, put it in a float.

Shape types

AddShape takes a shape type and a size. Type-specific properties such as the corner radius and the arrow head size are ignored by shapes for which they do not apply.

Shape shape = para.AddShape(Shape.ShapeType.e_rectangle_rounded_corners, 60, 40);
shape.SetCornerRadius(8);
shape.SetBackgroundColor(219, 233, 248);
shape.SetOutlineColor(0, 51, 102);
shape.SetOutlineThickness(1);

Shape shape = para.AddShape(Shape::e_rectangle_rounded_corners, 60, 40);
shape.SetCornerRadius(8);
shape.SetBackgroundColor(219, 233, 248);
shape.SetOutlineColor(0, 51, 102);
shape.SetOutlineThickness(1);

shape := para.AddShape(ShapeE_rectangle_rounded_corners, 60, 40)
shape.SetCornerRadius(8)
shape.SetBackgroundColor(219, 233, 248)
shape.SetOutlineColor(0, 51, 102)
shape.SetOutlineThickness(1)

Shape shape = para.addShape(Shape.ShapeType.e_rectangle_rounded_corners, 60, 40);
shape.setCornerRadius(8);
shape.setBackgroundColor(219, 233, 248);
shape.setOutlineColor(0, 51, 102);
shape.setOutlineThickness(1);

const shape = await para.addShape(PDFNet.Shape.Type.e_rectangle_rounded_corners, 60, 40);
shape.setCornerRadius(8);
shape.setBackgroundColor(219, 233, 248);
shape.setOutlineColor(0, 51, 102);
shape.setOutlineThickness(1);

PTShape* shape = [para AddShape:e_ptshape_rectangle_rounded_corners
                          width:60 height:40];
[shape SetCornerRadius:8];
[shape SetBackgroundColor:219 green:233 blue:248];
[shape SetOutlineColor:0 green:51 blue:102];
[shape SetOutlineThickness:1];

$shape = $para->AddShape(Shape::e_rectangle_rounded_corners, 60, 40);
$shape->SetCornerRadius(8);
$shape->SetBackgroundColor(219, 233, 248);
$shape->SetOutlineColor(0, 51, 102);
$shape->SetOutlineThickness(1);

shape = para.AddShape(Shape.e_rectangle_rounded_corners, 60, 40)
shape.SetCornerRadius(8)
shape.SetBackgroundColor(219, 233, 248)
shape.SetOutlineColor(0, 51, 102)
shape.SetOutlineThickness(1)

shape = para.AddShape(Shape::E_rectangle_rounded_corners, 60, 40)
shape.SetCornerRadius(8)
shape.SetBackgroundColor(219, 233, 248)
shape.SetOutlineColor(0, 51, 102)
shape.SetOutlineThickness(1)

Examples of shapes like a square, oval, and arrow.

Shape values include:

Value

Shape

e_line

Plain line

e_line_arrow

Line with an arrow head at one end

e_line_double_arrow

Line with arrow heads at both ends

e_rectangle

Rectangle

e_rectangle_rounded_corners

Rectangle with rounded corners

e_oval

Ellipse

e_arrow

Solid arrow

Shape text boxes

Every shape exposes a ContentContainer through GetTextBox. Anything you can put in a document can go inside a shape, which is how mastheads, callouts, and pull quotes are built.

Shape box = para.AddShape(Shape.ShapeType.e_rectangle_rounded_corners, 260, 70);
box.SetCornerRadius(10);
box.SetBackgroundColor(0, 51, 102);

ContentContainer text = box.GetTextBox();

Paragraph title = text.AddParagraph("The Monthly Dispatch");
title.SetJustificationMode(Paragraph.TextJustification.e_center);

TextStyledElement titleStyle = title.GetTextStyledElement();
titleStyle.SetFontSize(18);
titleStyle.SetBold(true);
titleStyle.SetTextColor(255, 255, 255);

Shape box = para.AddShape(Shape::e_rectangle_rounded_corners, 260, 70);
box.SetCornerRadius(10);
box.SetBackgroundColor(0, 51, 102);

ContentContainer text = box.GetTextBox();

Paragraph title = text.AddParagraph("The Monthly Dispatch");
title.SetJustificationMode(Paragraph::e_text_justify_center);

TextStyledElement title_style = title.GetTextStyledElement();
title_style.SetFontSize(18);
title_style.SetBold(true);
title_style.SetTextColor(255, 255, 255);

box := para.AddShape(ShapeE_rectangle_rounded_corners, 260, 70)
box.SetCornerRadius(10)
box.SetBackgroundColor(0, 51, 102)

text := box.GetTextBox()

title := text.AddParagraph("The Monthly Dispatch")
title.SetJustificationMode(ParagraphE_text_justify_center)

titleStyle := title.GetTextStyledElement()
titleStyle.SetFontSize(18)
titleStyle.SetBold(true)
titleStyle.SetTextColor(255, 255, 255)

Shape box = para.addShape(Shape.ShapeType.e_rectangle_rounded_corners, 260, 70);
box.setCornerRadius(10);
box.setBackgroundColor(0, 51, 102);

ContentContainer text = box.getTextBox();

Paragraph title = text.addParagraph("The Monthly Dispatch");
title.setJustificationMode(Paragraph.TextJustification.e_text_justify_center);

TextStyledElement titleStyle = title.getTextStyledElement();
titleStyle.setFontSize(18);
titleStyle.setBold(true);
titleStyle.setTextColor(255, 255, 255);

const box = await para.addShape(PDFNet.Shape.Type.e_rectangle_rounded_corners, 260, 70);
box.setCornerRadius(10);
box.setBackgroundColor(0, 51, 102);

const text = await box.getTextBox();

const title = await text.addParagraphWithText('The Monthly Dispatch');
title.setJustificationMode(PDFNet.Paragraph.TextJustification.e_text_justify_center);

const titleStyle = await title.getTextStyledElement();
titleStyle.setFontSize(18);
titleStyle.setBold(true);
titleStyle.setTextColor(255, 255, 255);

PTShape* box = [para AddShape:e_ptshape_rectangle_rounded_corners
                        width:260 height:70];
[box SetCornerRadius:10];
[box SetBackgroundColor:0 green:51 blue:102];

PTContentContainer* text = [box GetTextBox];

PTParagraph* title = [text AddParagraphWithText:@"The Monthly Dispatch"];
[title SetJustificationMode:e_ptpara_text_justify_center];

PTTextStyledElement* title_style = [title GetTextStyledElement];
[title_style SetFontSize:18];
[title_style SetBold:YES];
[title_style SetTextColor:255 green:255 blue:255];

$box = $para->AddShape(Shape::e_rectangle_rounded_corners, 260, 70);
$box->SetCornerRadius(10);
$box->SetBackgroundColor(0, 51, 102);

$text = $box->GetTextBox();

$title = $text->AddParagraph("The Monthly Dispatch");
$title->SetJustificationMode(Paragraph::e_text_justify_center);

$title_style = $title->GetTextStyledElement();
$title_style->SetFontSize(18);
$title_style->SetBold(true);
$title_style->SetTextColor(255, 255, 255);

box = para.AddShape(Shape.e_rectangle_rounded_corners, 260, 70)
box.SetCornerRadius(10)
box.SetBackgroundColor(0, 51, 102)

text = box.GetTextBox()

title = text.AddParagraph("The Monthly Dispatch")
title.SetJustificationMode(Paragraph.e_text_justify_center)

title_style = title.GetTextStyledElement()
title_style.SetFontSize(18)
title_style.SetBold(True)
title_style.SetTextColor(255, 255, 255)

box = para.AddShape(Shape::E_rectangle_rounded_corners, 260, 70)
box.SetCornerRadius(10)
box.SetBackgroundColor(0, 51, 102)

text = box.GetTextBox()

title = text.AddParagraph("The Monthly Dispatch")
title.SetJustificationMode(Paragraph::E_text_justify_center)

title_style = title.GetTextStyledElement()
title_style.SetFontSize(18)
title_style.SetBold(true)
title_style.SetTextColor(255, 255, 255)

Blue container with The Monthly Dispatch written in white.

Info

A shape does not grow to fit its text box. Size the shape for the content you expect, or keep the text short.

Rotation and flipping

SetRotation rotates a shape, together with its text box and background image, around its center. SetFlipHorizontal and SetFlipVertical mirror it.

Shape shape = para.AddShape(Shape.ShapeType.e_arrow, 70, 40);
shape.SetRotation(30);              // degrees
shape.SetArrowHeadSize(16);
shape.SetBackgroundColor(0, 153, 102);

Shape shape = para.AddShape(Shape::e_arrow, 70, 40);
shape.SetRotation(30);              // degrees
shape.SetArrowHeadSize(16);
shape.SetBackgroundColor(0, 153, 102);

shape := para.AddShape(ShapeE_arrow, 70, 40)
shape.SetRotation(30)              // degrees
shape.SetArrowHeadSize(16)
shape.SetBackgroundColor(0, 153, 102)

Shape shape = para.addShape(Shape.ShapeType.e_arrow, 70, 40);
shape.setRotation(30);              // degrees
shape.setArrowHeadSize(16);
shape.setBackgroundColor(0, 153, 102);

const shape = await para.addShape(PDFNet.Shape.Type.e_arrow, 70, 40);
shape.setRotation(30);              // degrees
shape.setArrowHeadSize(16);
shape.setBackgroundColor(0, 153, 102);

PTShape* shape = [para AddShape:e_ptshape_arrow width:70 height:40];
[shape SetRotation:30];              // degrees
[shape SetArrowHeadSize:16];
[shape SetBackgroundColor:0 green:153 blue:102];

$shape = $para->AddShape(Shape::e_arrow, 70, 40);
$shape->SetRotation(30);              // degrees
$shape->SetArrowHeadSize(16);
$shape->SetBackgroundColor(0, 153, 102);

shape = para.AddShape(Shape.e_arrow, 70, 40)
shape.SetRotation(30)              # degrees
shape.SetArrowHeadSize(16)
shape.SetBackgroundColor(0, 153, 102)

shape = para.AddShape(Shape::E_arrow, 70, 40)
shape.SetRotation(30)              # degrees
shape.SetArrowHeadSize(16)
shape.SetBackgroundColor(0, 153, 102)

Green arrows that are rotated, pointing in different directions.

Images

Shape types

Shape text boxes

Rotation and flipping

Further Reading