Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/WritePro/commands-legacy/4d-write-pro-attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ List attributes are used to configure your lists and set different list item fon
| wk list style image | Specifies an image reference as the list item marker in an unordered list. Possible values:<br/><ul><li>wk none (default): list item marker is not defined by an image</li><li>any valid image such as a 4D picture variable or expression</li></ul><ul><li>Value returned ([WP GET ATTRIBUTES](../commands/wp-get-attributes)): If the image was defined through a network URL, the target image is returned if it was already loaded, otherwise an empty image is returned. </li></ul>Use wk list style image url if you want to handle pictures through URLs or local URIs. |
| wk list style image height | Sets height of image used as list item marker. Possible values:<br/><ul><li>wk auto (default): height is based upon image size</li><li>Defined size: size expressed using real or string value:<br/>Real: Size in wk layout unit.String: CSS string with value and unit concatenated. (*e.g.*: "12pt" for 12 points, or "1.5cm" for 1.5 centimeters) Minimum value: 0pt, maximum value: 10,000pt.</li></ul> |
| wk list style image url | Image as the list item marker in an unordered list, defined through a URL (string). Possible values:<br/><ul><li>wk none (default): list item marker is not defined by an image</li><li>a network URL or a data URI, absolute or relative to the structure file</li></ul><ul><li>Value returned ([WP GET ATTRIBUTES](../commands/wp-get-attributes)): Network URL or data URI. It may not be equal to the initial URL for an image not referenced with the network URL (only network URLs are kept). For local file URLs, the image stream itself is kept in the document and thus the URL returned is a data URI with the image stream encoded in base64.</li></ul>Use wk list style image if you want to handle list item marker images as picture expressions. |
| wk list style type | Specifies type of ordered or unordered list item marker. Possible values are:<br/><ul><li>wk disc (default)</li><li>wk circle</li><li>wk square</li><li>wk decimal: 1 2 3</li><li>wk decimal leading zero: 01 02 03</li><li>wk lower latin: a b c</li><li>wk lower roman: i ii iii iv</li><li>wk upper latin: A B C</li><li>wk upper roman: I II III IV</li><li>wk lower greek: alpha, beta, gamma, etc.</li><li>wk armenian </li><li>wk georgian</li><li>wk hebrew</li><li>wk hiragana</li><li>wk katakana</li><li>wk cjk ideographic</li><li>wk hollow square</li><li>wk diamond</li><li>wk club</li><li>wk decimal greek</li><li>wk custom: unordered list with "-" as default list item marker; this is a convenience style used in order to customize a list item marker with wk list string format LTR or wk list string format RTL without modifying standard list item markers </li><li>wk none</li></ul> |
| wk list style type | Specifies type of ordered or unordered list item marker. Possible values are:<br/><ul><li>wk disc (default)</li><li>wk circle</li><li>wk square</li><li>wk decimal: 1 2 3</li><li>wk decimal leading zero: 01 02 03</li><li>wk lower latin: a b c</li><li>wk lower roman: i ii iii iv</li><li>wk upper latin: A B C</li><li>wk upper roman: I II III IV</li><li>wk lower greek: alpha, beta, gamma, etc.</li><li>wk armenian </li><li>wk georgian</li><li>wk hebrew</li><li>wk hiragana</li><li>wk katakana</li><li>wk cjk ideographic</li><li>wk hollow square</li><li>wk diamond</li><li>wk club</li><li>wk decimal greek</li><li>wk custom: unordered list with "-" as default list item marker; this is a convenience style used in order to customize a list item marker with wk list string format LTR or wk list string format RTL without modifying standard list item markers </li><li>wk none (non-hierarchical)</li></ul> |

### Margins

Expand Down Expand Up @@ -456,6 +456,10 @@ Style sheet attributes are used to apply existing style sheet objects to the fol

| Constant | Comment |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| wk list concat string format | Specifies whether the numbering marker of the current level is concatenated with the marker of the previous level. <br/><br/>When set to:<br/><ul><li><b>True</b>: the marker includes the numbering of the previous level (e.g., “1.1”, “1.1.1”).</li><li><b>False</b>: only the numbering of the current level is displayed (e.g., “1”, “1”, “1”).</li></ul> |
| wk list level count | **For hierarchical style sheets:** (Read-only for sub-level style sheet) Total number of levels in the hierarchy. Possible values:<br/><ul><li>From 1 to 9</li></ul><br/> **For non-hierarchical style sheets:** (Read-only) Possible value: 0|
| wk list level index | **For hierarchical style sheets:** (Read-only) Level of the style sheet in the hierarchy. Possible values:<br/><ul><li>From 1 to 9</li></ul><br/> **For non-hierarchical style sheets:** (Read-only) Possible value: 0 <br/> **For paragraphs or paragraph ranges:** Level of the hierarchical style sheet applied. Possible values:<br/><ul><li>From 1 to 9</li></ul>|
| wk list root style | (Read-only) Name of the root-level style sheet to which the current style sheet is related. Possible values:<br/><ul><li>sub-level style sheet: name of the related root-level style sheet</li><li> root-level style sheet: empty string</li></ul>|
| wk new line style sheet | Specifies style sheet to use when adding a new line in the paragraph. Possible values:<br/><ul><li>existing style sheet name or empty string (default) to use the same style for a new line</li><li>style sheet object (must belong to the same document)</li></ul> |
| wk style sheet | Specifies current style sheet for the selected element(s). Possible values:<br/><ul><li>style sheet object (must belong to the same document)</li><li>existing style sheet name</li></ul> |

Expand Down Expand Up @@ -515,5 +519,3 @@ Text box attributes are used to handle text boxes inserted or added in the area.
| wk style sheet | Specifies current style sheet for the selected element(s). Possible values:<br/><ul><li>style sheet object (must belong to the same document)</li><li>existing style sheet name</li></ul> |
| wk type | Type of 4D Write Pro object. Possible values: <ul> <li>wk type default: Range or section with not defined type</li> <li>wk type character: Character type</li> <li>wk type paragraph: Paragraph type range</li> <li>wk type image: Image (anchored and inline)</li> <li>wk type container: Header or footer, for instance</li> <li>wk type table: Table reference</li> <li>wk type text box: Text box</li> </ul> For ranges of cells, columns and rows only: <ul> <li>wk type table row: Table row reference</li> <li>wk type table cell: Table cell reference</li> <li>wk type table column: Table column reference</li> </ul> For subsections only: <ul> <li>wk first page: First page subsection</li> <li>wk right page: Right page subsection</li> <li>wk left page: Left page subsection</li> </ul> For tabs only, value used in the object for wk tab default or the objects of the collection for wk tabs: <ul> <li>wk left: Aligns tab to the left</li> <li>wk right: Aligns tab to the right</li> <li>wk center: Aligns tab to the center</li> <li>wk decimal: Aligns tab on the decimal</li> <li>wk bar: Inserts vertical bar at tab position</li> </ul> |
| wk vertical align | Sets vertical alignment of an element. Can be used with characters, paragraphs, pictures, text boxes, tables, table rows, and table columns/cells. Cannot be used with sections or subsections. Possible values: <ul> <li>wk baseline: aligns baseline of element with baseline of parent element</li> <li>wk top: aligns top of element with top of tallest element on the line</li> <li>wk bottom: aligns bottom of element with lowest element on the line</li> <li>wk middle: element is placed in middle of parent element</li> <li>wk superscript: aligns element as if it were superscript</li> <li>wk subscript: aligns element as if it were subscript</li> </ul> For characters, wk top and wk bottom have the same effect as wk baseline. <br/> <br/>For paragraphs, wk baseline, wk superscript and wk subscript have the same effect as wk top. <br/> <br/>For tables, table rows, and table columns/cells, only wk top, wk bottom and wk middle values are supported. |


20 changes: 10 additions & 10 deletions docs/WritePro/commands/command-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: 4D Write Pro Commands

<a id="A"><b>A</b></a>

[`WP Add picture`](wp-add-picture.md) ***Modified 4D 20 R8***
[`WP Add picture`](../commands/wp-add-picture) ***Modified 4D 20 R8***

<a id="B"><b>B</b></a>

Expand All @@ -27,13 +27,13 @@ title: 4D Write Pro Commands
[`WP DELETE PICTURE`](../commands/wp-delete-picture)<br/>
[`WP DELETE SECTION`](../commands/wp-delete-section) ***New 4D 20 R7***<br/>
[`WP DELETE STYLE SHEET`](../commands/wp-delete-style-sheet) ***Modified 4D 21 R3***<br/>
[`WP DELETE SUBSECTION`](wp-delete-subsection.md) ***Modified 4D 20 R7***<br/>
[`WP DELETE SUBSECTION`](../commands/wp-delete-subsection) ***Modified 4D 20 R7***<br/>
[`WP DELETE TEXT BOX`](../commands/wp-delete-text-box)

<a id="E"><b>E</b></a>

[`WP EXPORT DOCUMENT`](wp-export-document.md) **Modified 4D 20 R9**<br/>
[`WP EXPORT VARIABLE`](wp-export-variable.md) **Modified 4D 20 R9**
[`WP EXPORT DOCUMENT`](../commands/wp-export-document) **Modified 4D 20 R9**<br/>
[`WP EXPORT VARIABLE`](../commands/wp-export-variable) **Modified 4D 20 R9**

<a id="F"><b>F</b></a>

Expand All @@ -44,7 +44,7 @@ title: 4D Write Pro Commands

<a id="G"><b>G</b></a>

[`WP GET ATTRIBUTES`](wp-get-attributes.md) ***Modified 4D 20 R8***<br/>
[`WP GET ATTRIBUTES`](../commands/wp-get-attributes) ***Modified 4D 20 R8***<br/>
[`WP Get body`](../commands/wp-get-body)<br/>
[`WP GET BOOKMARKS`](../commands/wp-get-bookmarks)<br/>
[`WP Get breaks`](../commands/wp-get-breaks)<br/>
Expand All @@ -68,12 +68,12 @@ title: 4D Write Pro Commands

<a id="I"><b>I</b></a>

[`WP Import document`](wp-import-document.md) ***Modified 4D 20 R8***<br/>
[`WP Import document`](../commands/wp-import-document) ***Modified 4D 20 R8***<br/>
[`WP IMPORT STYLE SHEETS`](../commands/wp-import-style-sheets)<br/>
[`WP INSERT BREAK`](wp-insert-break.md) ***Modified 4D 20 R8***<br/>
[`WP Insert document body`](wp-insert-document-body.md) ***Modified 4D 20 R8***<br/>
[`WP INSERT FORMULA`](wp-insert-formula.md) ***Modified 4D 20 R8***<br/>
[`WP INSERT PICTURE`](wp-insert-picture.md) ***Modified 4D 20 R8***<br/>
[`WP INSERT BREAK`](../commands/wp-insert-break) ***Modified 4D 20 R8***<br/>
[`WP Insert document body`](../commands/wp-insert-document-body) ***Modified 4D 20 R8***<br/>
[`WP INSERT FORMULA`](../commands/wp-insert-formula) ***Modified 4D 20 R8***<br/>
[`WP INSERT PICTURE`](../commands/wp-insert-picture) ***Modified 4D 20 R8***<br/>
[`WP Insert table`](../commands/wp-insert-table)<br/>
[`WP Is font style supported`](../commands/wp-is-font-style-supported)

Expand Down
13 changes: 11 additions & 2 deletions docs/WritePro/commands/wp-delete-style-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ displayed_sidebar: docs

|Release|Changes|
|---|---|
|4D 18|Created|
|4D 21 R3|*listLevelIndex* parameter added|
|4D 18|Created|

</details>
</div>
Expand Down Expand Up @@ -54,7 +54,16 @@ The command performs no action if the specified level does not exist, or if the

**Note**: The default ("Normal") style sheet can not be deleted.

## Example
## Example 1

To delete a character style sheet "MyCharStyle":

```4d
WP DELETE STYLE SHEET(wpArea; "MyCharStyle")
```


## Example 2

The following example deletes the second level of a hierarchical list style sheet:

Expand Down
6 changes: 3 additions & 3 deletions docs/WritePro/commands/wp-get-style-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ displayed_sidebar: docs

|Release|Changes|
|---|---|
|4D 18|Created|
|4D 21 R3|*listLevelIndex* parameter added|
|4D 18|Created|

</details>
</div>
Expand All @@ -37,9 +37,9 @@ In *wpDoc*, pass the 4D Write Pro document that contains the style sheet.

The *styleSheetName* parameter allows you to specify the name of the style sheet to return. If the style sheet name does not exist in *wpDoc*, an null object is returned.

If the style sheet is part of a hierarchical list style sheet, you can optionally specify the *listLevelIndex* parameter to retrieve a specific level of the hierarchy.
If the *styleSheetName* is the root-level name of a hierarchical list style sheet, you can optionally specify the *listLevelIndex* parameter to retrieve a specific level of the hierarchy.

* *listLevelIndex* represents the level of the style sheet in the hierarchy (1 = root level, 2 = first sub-level, etc.).
* *listLevelIndex* represents the level of the style sheet in the hierarchy (1 = root-level, 2 = first sub-level, etc.).
* If the parameter is omitted and the style sheet is hierarchical, the root-level style sheet is returned.
* If the requested level does not exist, a null object is returned.
* If the style sheet is not a hierarchical list style sheet and *listLevelIndex* is greater than 1, a null object is returned.
Expand Down
7 changes: 4 additions & 3 deletions docs/WritePro/commands/wp-new-style-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ The following predefined values are applied:
* `wk list style type` is set to `wk decimal`
* `wk list level index` is automatically assigned (1 for the root level, incremented for sub-levels)
* `wk list level count` is set to the specified value for all levels
* `wk margin left` is automatically calculated (0.75 cm × level index)
* `wk margin left` is automatically calculated (0.75 cm × level index or 0.25 inches * level index, depending on current layout unit): so offset may be different depending if layout unit is metric or inches (for better alignment on default with current Write ruler graduations)


If the parameter is omitted or set to 0, a standard (non-list) paragraph style sheet is created.

Expand Down Expand Up @@ -126,5 +127,5 @@ Result:
[Style sheets](../user-legacy/stylesheets.md)
[WP DELETE STYLE SHEET](../WritePro/commands/wp-delete-style-sheet)
[WP Get style sheet](../WritePro/commands/wp-get-style-sheet)
[WP Get style sheets](../commands/wp-get-style-sheets)
[WP IMPORT STYLE SHEETS](../commands/wp-import-style-sheets.md)
[WP Get style sheets](../WritePro/commands/wp-get-style-sheets)
[WP IMPORT STYLE SHEETS](../WritePro/commands/wp-import-style-sheets)
4 changes: 2 additions & 2 deletions docs/WritePro/user-legacy/standard-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ The following standard actions are available with 4D Write Pro areas.
| keepWithNext | keepWithNext | Paragraph | Links a paragraph with the next so that they cannot be separated by automatic page or column breaks. If applied to the last paragraph of the last cell in a table, the last row of the table is linked to the following paragraph. |
| lineHeight | lineHeight?value={<Css_length> \| <Css_percentage>} | Paragraph, Submenu | Paragraph line height. Ex: lineHeight?value=120% |
| layer | {image \| textBox}/layer | Submenu | Default submenu with layering actions for images or text boxes |
| listConcatString | listConcatStringFormat | Paragraph | Determines whether the numbering marker of the current level should be concatenated with the one of the previous level or not.|
| listLevelAppend | listLevelDec | Paragraph | Creates a new hierarchical list style sheet of a next level and applies it to the selected paragraph.|
| listConcatStringFormat | listConcatStringFormat | Paragraph | Determines whether the numbering marker of the current level should be concatenated with the one of the previous level or not.|
| listLevelAppend | listLevelAppend | Paragraph | Creates a new hierarchical list style sheet of a next level and applies it to the selected paragraph.|
| listLevelDec | listLevelDec | Paragraph | Applies the hierarchical list style sheet of the previous level to the selected paragraph.|
| listLevelInc | listLevelInc | Paragraph | Applies the hierarchical list style sheet of the next level to the selected paragraph.|
| listNumberFormat | listNumberFormat?value=endDot\|endParenthesis\|doubleParenthesis | Paragraph, Submenu | Determines which delimiter to add to the numbering marker: an ending dot, an ending parenthesis, or double parenthesis (“1.”, “1)”, “(1)” |
Expand Down
Loading
Loading