Vcl.ComCtrls.TCommonCalendar.MsgSetRange

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function MsgSetRange(Flags: Integer; SysTime: TSystemTimeRangeArray): Boolean; overload; virtual; abstract;
function MsgSetRange(Flags: Integer; SysTime: PSystemTime; Unused: Integer = 0): Boolean; overload; virtual; deprecated; abstract;

C++

virtual bool __fastcall MsgSetRange(int Flags, const Winapi::Commctrl::TSystemTimeRangeArray &SysTime) = 0 /* overload */;
virtual bool __fastcall MsgSetRange _DEPRECATED_ATTRIBUTE0 (int Flags, Winapi::Windows::PSystemTime SysTime, int Unused = 0x0) = 0 /* overload */;

Properties

Type Visibility Source Unit Parent
function protected
Vcl.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls TCommonCalendar

Description

Implements the MinDate and MaxDate properties.

MsgSetRange implements the MinDate and MaxDate properties by sending a message to the calendar window handle. MsgSetRange is an abstract method, and must be overridden in descendant objects to send the appropriate message.

The Flags parameter indicates what type of information is included in the SysTime array. It includes the GDTR_MIN flag if a minimum date is supplied and GDTR_MAX if a maximum date is supplied.

The SysTime parameter is a two-element array containing the minimum date as the first element and the maximum date as the second element. These values can be obtained from the MinDate and MaxDate properties by calling DateTimeToSystemTime.

MsgSetRange returns true if the range is set by the method.

See Also