createTableStyle

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

createTableStyle

TRIAL / ADVANCED / PREMIUM

Creates a new Word table style.

Description

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

This method allows the generation of custom table styles that may be later used in combination with, for example, the addTable 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
border	string	Border type: none, single, double, dashed, threeDEngrave, threeDEmboss, outset, inset... This value can be overridden for each side with the use 'borderTop', 'borderRight', 'borderBottom' and 'borderLeft' properties.
borderColor	string	Hexadecimal color value: 'FF0000', '000000'... This value can be overridden for each side with the use of 'borderTopColor', 'borderRightColor', 'borderBottomColor' and 'borderLeftColor' properties.
borderSpacing	int	Border spacing in points. This value can be overridden for each side with the use of 'borderTopSpacing', 'borderRightSpacing', 'borderBottomSpacing' and 'borderLeftSpacing' properties.
borderWidth	int	Border size in eigths of a point. This value can be overridden for each side with the use of 'borderTopWidth', 'borderRightWidth', 'borderBottomWidth' and 'borderLeftWidth' properties.
cantSplit	bool	If true the rows can not split across pages.
cellBackgroundColor	string	Hexadecimal color value: 'FF0000', '000000'...
cellMargin	mixed	An integer or an array with keys: top, right, bottom and left. The values are given in twentieths of a point.
indent	int	Table indentation. The value is given in twentieths of a point.
rPrStyles	array	Character styles to be applied.
pPrStyles	array	Paragraph styles to be applied.
tableStyle	string	Id of the style this table style is based on (it may be retrieved with the parseStyles method).
tblStyleColBandSize	bool	Column banded style.
tblStyleRowBandSize	bool	Row banded style.
band1HorzStyle	array	Set odd rows styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
band1VertStyle	array	Sets odd cols styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
band2HorzStyle	array	Sets even rows styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
band2VertStyle	array	Sets even cols styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
firstColStyle	array	Sets first column styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
firstRowStyle	array	Sets first row styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
hidden	bool	Hide style from user interface.
lastColStyle	array	Sets last col styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
lastRowStyle	array	Sets last row styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
locked	bool	Style cannot be applied.
next	string	Style for next paragraph.
neCellStyle	array	Sets top right styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
nwCellStyle	array	Sets top left styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
seCellStyle	array	Sets bottom right styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
semiHidden	bool	Hide style from main user interface.
swCellStyle	array	Sets bottom left styles using border, borderColor, borderSpacing, borderWidth, backgroundColor, vAlign, rPrStyles, pPrStyles properties.
unhideWhenUsed	bool	Remove semi-hidden property when style is used.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$styleOptions = array(
    'borderColor' => '00FF00',
    'borderTopWidth' => 24,
    'borderBottomWidth' => 24,
    'borderLeftColor' => '0000FF',
    'borderRightColor' => '0000FF',
    'borderInsideH' => 'nil',
    'borderInsideV' => 'dashed',
    'borderInsideHColor' => 'FF0000',
    'borderInsideVColor' => 'FF0000',
    'cellMargin' => array('top' => 400, 'left' => 150),
);

$docx->createTableStyle('myTableStyle', $styleOptions);

$valuesTable = array(
    array(11, 12, 13, 14),
    array(21, 22, 23, 24),
    array(31, 32, 33, 34),
);

$paramsTable = array(
    'tableStyle' => 'myTableStyle',
);

$docx->addTable($valuesTable, $paramsTable);

$docx->createDocx('output');

The resulting Word document looks like:

Example #2

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

$styleOptions = array(
    'tblStyleRowBandSize' => true,
    'pPrStyles' => array('indentLeft' => 150),
    'firstRowStyle' => array(
        'backgroundColor' => '60E1DE',
        'vAlign' => 'center',
    ),
    'lastRowStyle' => array(
        'backgroundColor' => 'AEB7B7',
    ),
    'band1HorzStyle'  => array(
        'backgroundColor' => 'CBDBDA',
    ),
    'lastColStyle' => array(
        'borderLeftColor' => '2F812F',
        'borderLeftWidth' => 12,
        'backgroundColor' => '6299D4',
        'rPrStyles' => array('bold' => true),
    ),
);

$docx->createTableStyle('myTableStyle', $styleOptions);

$textFragmentA = new WordFragment($docx);
$textFragmentA->addText('A', array('textAlign' => 'center', 'color' => 'ffffff', 'bold' => true, 'fontSize' => 14));

$textFragmentB = new WordFragment($docx);
$textFragmentB->addText('B', array('textAlign' => 'center', 'color' => 'ffffff', 'bold' => true, 'fontSize' => 14));

$textFragmentC = new WordFragment($docx);
$textFragmentC->addText('C', array('textAlign' => 'center', 'color' => 'ffffff', 'bold' => true, 'fontSize' => 14));

$textFragmentD = new WordFragment($docx);
$textFragmentD->addText('D', array('textAlign' => 'center', 'color' => 'ffffff', 'bold' => true, 'fontSize' => 14));

$valuesTable = array(
    array($textFragmentA, $textFragmentB, $textFragmentC, $textFragmentD),
    array(11, 12, 13, 14),
    array(21, 22, 23, 24),
    array(31, 32, 33, 34),
    array(41, 42, 43, 44),
    array(51, 52, 53, 54),
);

$paramsTable = array(
    'tableStyle' => 'myTableStyle',
    'conditionalFormatting' => array('firstRow' => true, 'lastCol' => true, 'lastRow' => true),
);

$docx->addTable($valuesTable, $paramsTable);

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 17.0:
- apply row (trPr) styles.
- cantSplit option.

phpdocx 13.0:
- cellBackgroundColor option.

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

phpdocx 8.5:
- new method.