createCharacterStyle

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

createCharacterStyle

TRIAL / ADVANCED / PREMIUM

Creates a new Word character style.

Description

public createCharacterStyle ( string $name [, array $styleOptions = array() ])

This method allows the generation of custom character styles that may be later used in combination with, for example, the addText method.

Parameters

name

A string with the name of the Word style that you are creating.

styleOptions

This is an array including all the available styling options.

Key	Type	Description
bold	bool	If true the text will be shown in bold characters.
caps	bool	If true displays text in capital letters.
characterBorder	array	Adds a border to the character type (string): none, single, double, dashed... color (string): ffffff, ff0000... spacing (int): 0, 1, 2... width (int): in eights of a point
color	string	Hexadecimal color value: 'FF0000', '000000'...
doubleStrikeThrough	bool	If true displays text in doubleStrikeThrough.
em	string	Emphasis mark type: 'none', 'dot', 'circle', 'comma', 'underDot'
emboss	bool	Emboss style.
font	string or array	string type: font family: 'Arial', Calibri'... array type: ascii hAnsi eastAsia cs
fontSize	int	Text size in half-points: 8, 9, 10... Multiply by 2 to get the same size as using the fontSize property with addText and other methods.
hidden	bool	Hide style from user interface.
italic	bool	If true displays the text in italics.
locked	bool	Style cannot be applied.
next	string	Style for next paragraph.
noProof	bool	Ignore spelling and grammar errors.
outline	bool	Outline style.
position	int	Position value. Positive value for raised and negative value for lowered.
semiHidden	bool	Hide style from main user interface.
shadow	bool	Shadow style.
strikeThrough	bool	If true displays text in strikethrough.
subscript	bool	If true displays text in subscript.
superscript	bool	If true displays text in superscript.
underline	string	Underlines text. Possible values are: 'single', 'words', 'double', 'dotted', 'dash' and 'wave'.
unhideWhenUsed	bool	Remove semi-hidden property when style is used.
vanish	bool	Uses a vanish style.
vertAlign	string	Vertical alignment. Possible values are: 'baseline', 'subscript' and 'superscript'.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$style = array(
    'bold' => true,
    'color' => 'ff0000',
    'font' => 'Arial',
    'fontSize' => 18,
    'italic' => true,
    'position' => 6,
    'underline' => 'single',
);

$docx->createCharacterStyle('myStyle', $style);

$text = array();
$text[] =
    array(
        'text' => 'A text in red color with the character style',
        'rStyle' => 'myStyle',
);
$text[] =
    array(
        'text' => 'Other text set as bold but without the character style.',
        'bold' => true
);

$docx->addText($text);

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 16.0:
- font option allows using an array to set all font types (ascii, hAnsi, eastAsia, cs).

phpdocx 12.5:
- emboss, noProof, outline, shadow, suppressLineNumbers and vertAlign options.

phpdocx 12.0:
- hidden, semiHidden, unhideWhenUsed, locked and next options.

phpdocx 7.5:
- new method.