MonthCalendar control

A MonthCalendar control provides a calendar-like user interface that makes it easy for users to enter or select dates.

Properties

MonthCalendar property

Datatype

Description

Accelerator

Integer

Specifies the ASCII value of the key you want to assign as the accelerator key for a control.

AccessibleDescription

String

A description of the control and/or its purpose for use by accessibility tools such as readers for visually impaired users.

AccessibleName

String

A label that briefly describes the control, such as the text in a button or the name of a menu item.

AccessibleRole

AccessibleRole (enumerated)

Describes what kind of user interface element the control is.

AutoSize

Boolean

Specifies whether the calendar is sized automatically to hold a single month. Values are:

TRUE -- The calendar sizes to hold a single month (default).

FALSE -- The calendar does not size to hold a single month.

BackColor

Long

Specifies the numeric value of the background color of the control: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

Border

Boolean

Specifies whether the control has a border. Values are:

TRUE -- Control has a border.

FALSE -- Control does not have a border.

BorderStyle

BorderStyle (enumerated)

Specifies the style of the border of the control. Values are:

StyleBox!

StyleLowered!

StyleRaised!

StyleShadowBox!

BringToTop

Boolean

Specifies whether PowerBuilder moves the control to the top of the front-to-back order in the window. Values are:

TRUE -- Control moved to top.

FALSE -- Control not moved to top.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

DragAuto

Boolean

Specifies whether PowerBuilder puts the control automatically into Drag mode. Values are:

TRUE  -- When the control is clicked, the control is automatically in Drag mode.

FALSE  -- When the control is clicked, the control is not automatically in Drag mode. You have to put the control into Drag mode manually by using the Drag function.

DragIcon

String

Specifies the name of the stock icon or the file containing the icon you want to display when the user drags the control (the ICO file). The default icon is a box the size of the control.

When the user drags the control, the icon displays when the control is over an area in which the control can be dropped (a valid drop area). When the control is over an area that is not a valid drop area, the No-Drop icon displays.

Enabled

Boolean

Specifies whether the control is enabled (can be selected). Values are:

TRUE -- Control can be selected.

FALSE -- Control cannot be selected.

FaceName

String

Specifies the name of the typeface in which the text of the control displays (for example, arial or courier).

This property does not work on the Windows 7/8.1/10 operating system.

FirstDayOfWeek

WeekDay (enumerated)

Specifies which day of the week displays on the left in the calendar.

FontCharSet

FontCharSet (enumerated)

Specifies the font character set used for the text in the control. For a complete list of possible values, see the list of properties for the FontCharSet variable on the Enumerated tab page of the Browser.

FontFamily

FontFamily (enumerated)

Specifies the font family (type style) used for the text in the control. Values are:

AnyFont!

Decorative!

Modern!

Roman!

Script!

Swiss!

FontPitch

FontPitch (enumerated)

Specifies the pitch (spacing) of the font used for the text in the control. Values are:

Default!

Fixed!

Variable!

Height

Integer

Specifies the height of the control, in PowerBuilder units.

Italic

Boolean

Specifies whether the text in the control is italic. Values are:

TRUE -- Text is italic.

FALSE -- Text is not italic.

This property does not work on the Windows 7/8.1/10 operating system.

MaxSelectCount

Integer

Specifies the maximum number of days the user can select from the calendar. The default is 1.

MonthBackColor

Long

Specifies the numeric value of the background color of a month: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

This property does not work on the Windows 7/8.1/10 operating system.

Pointer

String

Specifies the name of the stock pointer or the file containing the pointer used for the control.

RightToLeft

Boolean

Specifies that characters should be displayed in right-to-left order.

ScrollRate

Integer

Specifies the number of months the calendar scrolls when the user clicks a scroll button.

TabOrder

Integer

Specifies the tab value of the control within the window (0 means the user cannot tab to the control.

Tag

String

Specifies the tag value assigned to the control.

TextColor

Long

Specifies the numeric value of the color used for text within a month: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

This property does not work on the Windows 7/8.1/10 operating system.

TextSize

Integer

Specifies the size of the text in the control, in points. For backward compatibility, the size is stored as a negative number; for example, 10-point text size is stored as -10.

This property does not work on the Windows 7/8.1/10 operating system.

TitleBackColor

Long

Specifies the numeric value of the background color of the calendar's title: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

This property does not work on the Windows 7/8.1/10 operating system.

TitleTextColor

Long

Specifies the numeric value of the color used for text in the calendar's title: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

This property does not work on the Windows 7/8.1/10 operating system.

TodayCircle

Boolean

Specifies whether the border of today's date on the calendar displays in red. Values are:

TRUE -- The Today circle is displayed (default).

FALSE -- The Today circle is not displayed.

TodaySection

Boolean

Specifies whether the label "Today:" followed by the current date displays at the bottom of the calendar. Values are:

TRUE -- The Today section is displayed (default).

FALSE -- The Today section is not displayed.

This property does not work correctly on the Windows 7/8.1/10 operating system.

TrailingTextColor

Long

Specifies the numeric value of the color used for leading and trailing days in the calendar: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

This property does not work on the Windows 7/8.1/10 operating system.

Underline

Boolean

Specifies whether text is underlined.

This property does not work in MonthCalendar controls on the Windows 7/8.1/10 operating system.

Visible

Boolean

Specifies whether the control is visible. Values are:

TRUE -- Control is visible.

FALSE -- Control is not visible.

WeekNumbers

Boolean

Specifies whether a number representing the number of the week in the year displays to the left of each row in the calendar. Values are:

TRUE -- Week numbers are displayed.

FALSE -- Week numbers are not displayed (default).

Weight

Integer

This property is not relevant in MonthCalendar controls.

Width

Integer

Specifies the width of the control, in PowerBuilder units.

X

Integer

Specifies the X position (the distance from the left edge of the window), in PowerBuilder units.

Y

Integer

Specifies the Y position (the distance from the top of the window), in PowerBuilder units.


Events

MonthCalendar event

Occurs

Clicked in PowerScript Reference

When the control is clicked (selected) with the left mouse button

Constructor in PowerScript Reference

Immediately before the Open event occurs in the window

DateChanged in PowerScript Reference

Immediately after a date is selected

Destructor in PowerScript Reference

Immediately after the Close event occurs in the window

DoubleClicked in PowerScript Reference

When the control is clicked twice with the left mouse button

DragDrop in PowerScript Reference

When a dragged control is dropped on the control

DragEnter in PowerScript Reference

When a dragged control enters the control

DragLeave in PowerScript Reference

When a dragged control leaves the control

DragWithin in PowerScript Reference

When a dragged control is within the control

GetFocus in PowerScript Reference

Just before the control receives focus (before it is selected and becomes active)

Help in PowerScript Reference

When the user presses the F1 key or drags the context help button (question mark) from the title bar to a menu item or control

LoseFocus in PowerScript Reference

When the control loses focus (becomes inactive)

Other in PowerScript Reference

When a Controls message occurs that is not a PowerBuilder event

RButtonDown in PowerScript Reference

When the right mouse button is pressed on the control


Functions

MonthCalendar function

Datatype returned

Description

ClassName in PowerScript Reference

String

Returns the name assigned to the control

ClearBoldDates in PowerScript Reference

Integer

Clears bold format of dates in calendar

Drag in PowerScript Reference

Integer

Starts or ends the dragging of the control

GetContextService in PowerScript Reference

Integer

Creates a reference to a context-specific instance of the specified service

GetDateLimits in PowerScript Reference

Integer

Retrieves the maximum and minimum date limits specified for the calendar

GetDisplayRange in PowerScript Reference

Integer

Retrieves the date range of displayed months and returns the number of displayed months

GetParent in PowerScript Reference

PowerObject

Returns a reference to the name of the parent object

GetSelectedDate in PowerScript Reference

Integer

Retrieves the selected date

GetSelectedRange in PowerScript Reference

Integer

Retrieves the range of selected dates

GetToday in PowerScript Reference

Date

Returns the date that the calendar uses as today's date

Hide in PowerScript Reference

Integer

Makes the control invisible

Move in PowerScript Reference

Integer

Moves the control to a specified location

PointerX in PowerScript Reference

Integer

Returns the distance of the pointer from the left edge of the control

PointerY in PowerScript Reference

Integer

Returns the distance of the pointer from the top of the control

PostEvent in PowerScript Reference

Boolean

Adds the specified event to the end of the event queue for the specified object

Print in PowerScript Reference

Integer

Prints the control

Resize in PowerScript Reference

Integer

Changes the size of the control

SetBoldDate in PowerScript Reference

Integer

Displays the specified date in bold

SetDateLimits in PowerScript Reference

Integer

Sets the maximum and minimum date limits for the calendar

SetFocus in PowerScript Reference

Integer

Sets focus to the specified control

SetPosition in PowerScript Reference

Integer

Specifies the position of the control in the front-to-back order of the window

SetRedraw in PowerScript Reference

Integer

Controls automatic redrawing of the control after each change in its properties

SetSelectedDate in PowerScript Reference

Integer

Selects a specified date

SetSelectedRange in PowerScript Reference

Integer

Sets the range of selected dates

SetToday in PowerScript Reference

Integer

Sets the value that is used by the calendar as today's date

Show in PowerScript Reference

Integer

Makes the control visible

TriggerEvent in PowerScript Reference

Integer

Triggers a specified event in the control and executes the script for the event

TypeOf in PowerScript Reference

Object

Returns the type of the control