Skip to content

Commit

Permalink
Merged PR 3546: Update ReceiptPrintJob based on customer feedback
Browse files Browse the repository at this point in the history
Updated receiptprintjob_drawruledline_1309666666.md
  • Loading branch information
muhsinking committed Oct 3, 2017
1 parent 7166730 commit f5ce986
Showing 1 changed file with 24 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Adds an instruction to the print job to print a drawn, ruled line on the paper o

## -parameters
### -param positionList
The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line.
The position parameters for the ruled line. The character string for *positionList* differs depending on whether *lineDirection* specifies a horizontal ruled line or a vertical ruled line (see remarks).

### -param lineDirection
The direction in which to print the ruled line.
Expand All @@ -30,6 +30,29 @@ The appearance of the ruled line, such as whether it is solid or broken, or sing
The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the [ClaimedReceiptPrinter.ColorCartridge](claimedreceiptprinter_colorcartridge.md) property. If an unsupported value is specified, the printing results may be unpredictable.

## -remarks
The *positionList* argument varies depending on whether a horizontal or vertical ruled line is being drawn.

For horizontal ruled lines, *positionList* consists of comma delimited numbers (units of measure are defined by the **MapMode** property), which denote the starting position and length of each line. Each pair is followed by a semicolon if multiple ruled lines are specified. The pattern is repeated for all additional horizontal ruled lines. Consider this example:

```csharp
positionList = "0,500"
```

This *positionList* would result in a ruled line starting at MapMode unit position "0" continuing for 500 MapMode units of length. Here is another example demonstrating multiple horizontal lines:

```csharp
positionList = "0,200;300,100"
```

This *positionList* would result in a ruled line starting at unit position "0" and continuing for 200 units in length. Then, another line would begin at position 300 and continue for 100 units in length.

For vertical ruled lines, *positionList* consists of comma delimited numbers (units of measure are defined by the **MapMode** property) which denote the positions for the vertical drawn rules line(s). A continue vertical ruled line will be drawn from each position for the print lines that follow, until the vertical rules lines are changed or terminated by a call to **DrawRuledLine** or a ruled line escape sequence. An empty string in the *positionLine* argument causes the vertical ruled lines to be terminated. Consider this example:

```csharp
positionList = "0,100,400,500"
```

This *positionList* results in four drawn ruled lines starting at unit positions "0", "100", "400", and "500" when each line of data is printed.

## -examples

Expand Down

0 comments on commit f5ce986

Please sign in to comment.