PosPrinterBase.RotatePrint Method (POS for .NET v1.14 SDK Documentation)

  • Article

3/2/2014

Enters or exits rotated print mode.

Namespace: Microsoft.PointOfService.BaseServiceObjects
Assembly: Microsoft.PointOfService.ControlBase (in microsoft.pointofservice.controlbase.dll)

Syntax

'Declaration
Public Overrides Sub RotatePrint ( _
    station As PrinterStation, _
    rotation As PrintRotation _
)

public override void RotatePrint (
    PrinterStation station,
    PrintRotation rotation
)

public:
virtual void RotatePrint (
    PrinterStation station, 
    PrintRotation rotation
) override

public void RotatePrint (
    PrinterStation station, 
    PrintRotation rotation
)

public override function RotatePrint (
    station : PrinterStation, 
    rotation : PrintRotation
)

Parameters

  • station
    The PrinterStation
  • rotation
    The type of rotation requested.

Remarks

The PosPrinterBase class verifies that the application has the device opened, claimed, and enabled. PosPrinterBase validates the parameters and device state, and may throw PosControlException exceptions with the following values:

Value

Meaning

Other values

A physical condition exists that would preclude the operation—for example, the cover is open, the paper is removed, and so on. A full list of these exceptions is provided under PosPrinter.RotatePrint.

Busy

The State property is set to ControlState.Busy (applies only if the AsyncMode property has been set to false).

Illegal

a) the requested printer station must be either PrinterStation.Receipt or PrinterStation.Slip; b) the requested rotation isn’t supported for the requested station; or c) the requested printer station doesn’t exist (that is, the value of the CapRecPresent, or CapSlpPresent property is false).

If no exception is thrown, the PosPrinterBase class either starts a new rotation transaction or ends the current transaction based on the value of the rotation parameter. When a rotation transaction is started, subsequent print calls are added to a collection and the entire collection is passed to the RotatePrintImpl method when the transaction is ended.

RotatePrintImpl is performed synchronously if AsyncMode is false, and asynchronously if AsyncMode is true.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

PosPrinterBase Class
PosPrinterBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
PosPrinter.RotatePrint Method
RotatePrintImpl