addDropCap

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

addDropCap

TRIAL / ADVANCED / PREMIUM

Inserts a drop cap into the Word document.

Description

public addDropCap ([string $letter [, array $options = array(), array $optionsParagraph = array()]])

This method allows to insert a drop cap into the Word document.

Parameters

letter

The letter to be used as drop cap.

options

Options to apply to the drop cap. Default values:

'position' => -2
'fontSize' => 92

For more information about the available options, please check the addText method.

optionsParagraph

Options to apply to the paragraph containing the drop cap. Default values:

'keepNext' => true
'framePr' => dropCap ('drop'), hAnchor ('text'), lines (3), vAnchor ('text'), wrap ('around')
'spacing' => spacingBottom (0), lineSpacing (1498), spacingLineRule ('exact')
'vAlign' => 'baseline'

For more information about the available options, please check the addText method.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.';

// text without drop cap
$docx->addText($text);

// drop cap with default options
$docx->addDropCap('L');
$docx->addText(substr($text, 1));

// drop cap with custom options
$docx->addDropCap('L', array(), array('framePr' => array('hSpace' => 400)));
$docx->addText(substr($text, 1), array('textAlign' => 'both'));

// drop cap with custom options
$docx->addDropCap('L', array('italic' => true, 'bold' => true, 'fontSize' => 100), array('framePr' => array('dropCap' => 'margin', 'hAnchor' => 'page', 'hSpace' => 400, 'lines' => 5)));
$docx->addText(substr($text, 1), array('textAlign' => 'both'));

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 18.0:
- new method.