Vcl.Controls.CursorToString

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function CursorToString(Cursor: TCursor): string;

C++

extern DELPHI_PACKAGE System::UnicodeString __fastcall CursorToString(System::Uitypes::TCursor Cursor);

Properties

Type Visibility Source Unit Parent
function public
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls Vcl.Controls

Description

Returns the AnsiString representation of a cursor.

Use CursorToString to convert the cursor used by a control or one of the cursors made available by the global screen variable into a string that can be displayed to the user. Pass the cursor value as the Cursor parameter. If there is a predefined constant for the cursor, CursorToString returns the constant name. If the cursor does not have an associated constant (for example, a custom cursor), CursorToString returns a string representation of the cursor's numeric value.

To obtain a string representation of the cursor only if there is a built-in cursor constant, use CursorToIdent.

See Also