Vcl.Controls.StringToCursor

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function StringToCursor(const S: string): TCursor;

C++

extern DELPHI_PACKAGE System::Uitypes::TCursor __fastcall StringToCursor(const System::UnicodeString S);

Properties

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

Description

Returns a TCursor value given its string representation.

Call StringToCursor to reverse the translation performed by CursorToString. This method is useful for converting the strings entered by the user into useable TCursor values.

The S parameter can be either the name of a built-in cursor constant such as "crHelp", or the string representation of a valid TCursor value such as "10". StringToCursor returns the TCursor value that corresponds to the S parameter.

Note: The value returned by StringToCursor is not guaranteed to be a valid cursor. If the Cursors property of the global Screen variable does not include a corresponding entry, the value returned by StringToCursor can not be used to set the Cursor property of a control.

See Also