Skip to content

Commit 25348c6

Browse files
authored
Merge pull request #1504 from gimler/patch-1
[Doc] add/align possible values from class constant
2 parents 49eb9d1 + 768a070 commit 25348c6

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/styles.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Available Section style options:
2929
- ``marginRight``. Page margin right in *twip*.
3030
- ``marginBottom``. Page margin bottom in *twip*.
3131
- ``orientation``. Page orientation (``portrait``, which is default, or ``landscape``).
32+
See ``\PhpOffice\PhpWord\Style\Section::ORIENTATION_...`` class constants for possible values
3233
- ``pageSizeH``. Page height in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged.
3334
- ``pageSizeW``. Page width in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged.
3435

@@ -45,7 +46,7 @@ Available Font style options:
4546
- ``color``. Font color, e.g. *FF0000*.
4647
- ``doubleStrikethrough``. Double strikethrough, *true* or *false*.
4748
- ``fgColor``. Font highlight color, e.g. *yellow*, *green*, *blue*.
48-
See ``\PhpOffice\PhpWord\Style\Font::FGCOLOR_...`` constants for more values
49+
See ``\PhpOffice\PhpWord\Style\Font::FGCOLOR_...`` class constants for possible values
4950
- ``hint``. Font content type, *default*, *eastAsia*, or *cs*.
5051
- ``italic``. Italic, *true* or *false*.
5152
- ``name``. Font name, e.g. *Arial*.
@@ -56,7 +57,7 @@ Available Font style options:
5657
- ``subScript``. Subscript, *true* or *false*.
5758
- ``superScript``. Superscript, *true* or *false*.
5859
- ``underline``. Underline, *single*, *dash*, *dotted*, etc.
59-
See ``\PhpOffice\PhpWord\Style\Font::UNDERLINE_...`` constants for more values
60+
See ``\PhpOffice\PhpWord\Style\Font::UNDERLINE_...`` class constants for possible values
6061
- ``lang``. Language, either a language code like *en-US*, *fr-BE*, etc. or an object (or as an array) if you need to set eastAsian or bidirectional languages
6162
See ``\PhpOffice\PhpWord\Style\Language`` class for some language codes.
6263
- ``position``. The text position, raised or lowered, in half points
@@ -69,7 +70,7 @@ Paragraph
6970
Available Paragraph style options:
7071

7172
- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
72-
See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
73+
See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values.
7374
- ``basedOn``. Parent style.
7475
- ``hanging``. Hanging in *twip*.
7576
- ``indent``. Indent in *twip*.
@@ -82,14 +83,15 @@ Available Paragraph style options:
8283
- ``spaceAfter``. Space after paragraph in *twip*.
8384
- ``spacing``. Space between lines.
8485
- ``spacingLineRule``. Line Spacing Rule. *auto*, *exact*, *atLeast*
86+
See ``\PhpOffice\PhpWord\SimpleType\LineSpacingRule`` class constants for possible values.
8587
- ``suppressAutoHyphens``. Hyphenation for paragraph, *true* or *false*.
8688
- ``tabs``. Set of custom tab stops.
8789
- ``widowControl``. Allow first/last line to display on a separate page, *true* or *false*.
8890
- ``contextualSpacing``. Ignore Spacing Above and Below When Using Identical Styles, *true* or *false*.
8991
- ``bidi``. Right to Left Paragraph Layout, *true* or *false*.
9092
- ``shading``. Paragraph Shading.
9193
- ``textAlignment``. Vertical Character Alignment on Line.
92-
See ``\PhpOffice\PhpWord\SimpleType\TextAlignment`` class for possible values.
94+
See ``\PhpOffice\PhpWord\SimpleType\TextAlignment`` class constants for possible values.
9395

9496
.. _table-style:
9597

@@ -99,7 +101,7 @@ Table
99101
Available Table style options:
100102

101103
- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
102-
See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` classes for the details.
104+
See ``\PhpOffice\PhpWord\SimpleType\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values.
103105
- ``bgColor``. Background color, e.g. '9966CC'.
104106
- ``border(Top|Right|Bottom|Left)Color``. Border color, e.g. '9966CC'.
105107
- ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*.
@@ -168,7 +170,7 @@ Numbering level
168170
Available NumberingLevel style options:
169171

170172
- ``alignment``. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012.
171-
See ``\PhpOffice\PhpWord\SimpleType\Jc`` class for the details.
173+
See ``\PhpOffice\PhpWord\SimpleType\Jc`` class constants for possible values.
172174
- ``font``. Font name.
173175
- ``format``. Numbering format bullet\|decimal\|upperRoman\|lowerRoman\|upperLetter\|lowerLetter.
174176
- ``hanging``. See paragraph style.

0 commit comments

Comments
 (0)