ReceiptPrintJob.DrawRuledLine Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Adds an instruction to the print job to print a drawn, ruled line on the paper of the receipt printer station.
public:
virtual void DrawRuledLine(Platform::String ^ positionList, PosPrinterLineDirection lineDirection, unsigned int lineWidth, PosPrinterLineStyle lineStyle, unsigned int lineColor) = DrawRuledLine;void DrawRuledLine(winrt::hstring const& positionList, PosPrinterLineDirection const& lineDirection, uint32_t const& lineWidth, PosPrinterLineStyle const& lineStyle, uint32_t const& lineColor);public void DrawRuledLine(string positionList, PosPrinterLineDirection lineDirection, uint lineWidth, PosPrinterLineStyle lineStyle, uint lineColor);function drawRuledLine(positionList, lineDirection, lineWidth, lineStyle, lineColor)Public Sub DrawRuledLine (positionList As String, lineDirection As PosPrinterLineDirection, lineWidth As UInteger, lineStyle As PosPrinterLineStyle, lineColor As UInteger)Parameters
- positionList
-
String
Platform::String
winrt::hstring
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).
- lineDirection
- PosPrinterLineDirection
The direction in which to print the ruled line.
- lineWidth
-
UInt32
unsigned int
uint32_t
The width of the ruled line that the print should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer is used.
- lineStyle
- PosPrinterLineStyle
The appearance of the ruled line, such as whether it is solid or broken, or single or double.
- lineColor
-
UInt32
unsigned int
uint32_t
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 property. If an unsupported value is specified, the printing results may be unpredictable.
Implements
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:
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:
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:
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.