LineDisplay.CursorType Property (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

Gets or sets the cursor type for the active window. Possible values are defined by the DisplayCursors enumeration.

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

Syntax

'Declaration
Public MustOverride Property CursorType As DisplayCursors

public abstract DisplayCursors CursorType { get; set; }

public:
virtual property DisplayCursors CursorType {
    DisplayCursors get () abstract;
    void set (DisplayCursors value) abstract;
}

/** @property */
public abstract DisplayCursors get_CursorType ()

/** @property */
public abstract void set_CursorType (DisplayCursors value)

public abstract function get CursorType () : DisplayCursors

public abstract function set CursorType (value : DisplayCursors)

Remarks

CursorType cannot be set if the CapCursorType property is set to either None or Fixed. Otherwise, CursorType can be set to one of the cursor types that are specified by CapCursorType. If supported, the setting of Blink can be logically combined with that cursor type to display a blinking cursor.

CursorType is maintained for each window. Setting CursorType affects only the active window, because only the active window has a displayable cursor.

The Open and CreateWindow methods initialize CursorType to None, or if CapCursorType is set to Fixed, the appropriate cursor type. CursorType is updated when the CurrentWindow property is set or the DestroyWindow method is called.

Accessing CursorType may cause a PosControlException to be thrown with the following ErrorCode.

Value

Meaning

Illegal

One of the following conditions has occurred:

  • The CapCursorType property is set to either None or Fixed. Therefore, CursorType should not be set.

  • CursorType was set to a value other than None but does not match the setting for CapCursorType.

  • CursorType was set to Blink, but blinking is not supported.

  • CursorType was set to a value other than Blink which is not defined in the DisplayCursors enumeration.

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

LineDisplay Class
LineDisplay Members
Microsoft.PointOfService Namespace
LineDisplay.CapCursorType Property
DisplayCursors Enumeration