Top  | Previous | Next

Calendar

calendars_Calendar

Description

Displays a calendar and time input directly embedded in your window. Most commonly used by including one of the two date properties (immediate or latched) from the calendar in dynamic SQL Query Bindings.

Properties

Appearance

Font

Font of text of this component

Scripting name

font

Data type

Font

Foreground Color

The foreground color of the component.

Scripting name

foreground

Data type

Color

Background Color

The background color of the component.

Scripting name

background

Data type

Color

Today Foreground

Foreground color for the today indicator.

Scripting name

todayForeground

Data type

Color

Today Background

Background color for the today indicator.

Scripting name

todayBackground

Data type

Color

Weekend Foreground

Foreground color for the weekend indicators.

Scripting name

weekendForeground

Data type

Color

Weekend Background

Background color for the weekend indicators.

Scripting name

weekendBackground

Data type

Color

Selected Border

The border for the selected day indicator.

Scripting name

selectedBorder

Data type

Border

Title Background

The background of the title bar

Scripting name

titleBackground

Data type

Color

Antialias

Draw with antialias on? Makes text smoother

Scripting name

antialias

Data type

boolean

Flags

expert

Styles

Contains the component's styles

Scripting name

styles

Data type

Dataset

Flags

bindable | expert

Behavior

Time Style

Select how this calendar should treat the time portion of the date.

Scripting name

timeStyle

Data type

int

Values

0

User Selectable

1

Start of Day

2

End of Day

Show Navigation

Turn this off if you don't want to show the year and month navigation buttons.

Scripting name

showNavigation

Data type

boolean

Show OK Button

Turn this off if you don't want to show the OK button. The latched date and the immediate date will be equivalent.

Scripting name

showOkButton

Data type

boolean

Show Time

Turn this off if you don't want to show the time panel.

Scripting name

showTime

Data type

boolean

Time Display Format

The format for displaying time in the panel

Scripting name

timeDisplayFormat

Data type

int

Values

0

12 Hour

1

24 Hour

Format String

The date formatting pattern used to format the string versions of the dates.

Scripting name

format

Data type

String

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Enabled

If disabled, a component cannot be used.

Scripting name

componentEnabled

Data type

boolean

Visible

If disabled, the component will be hidden.

Scripting name

visible

Data type

boolean

Flags

bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name

border

Data type

Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name

toolTipText

Data type

String

Opaque

If false, backgrounds are not drawn. If true, backgrounds are drawn.

Scripting name

opaque

Data type

boolean

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0

Default

1

Crosshair

2

Text

3

Wait

12

Hand

13

Move

4

SW Resize

5

SE Resize

6

NW Resize

7

NE Resize

8

N Resize

9

S Resize

10

W Resize

11

E Resize

Data

Date (immediate)

The date as it is selected right now.

Scripting name

date

Data type

Date

Flags

bindable

Date (latched)

The date the last time "OK" was pressed.

Scripting name

latchedDate

Data type

Date

Flags

bindable

Formatted Date

The date property, as formatted by the format string.

Scripting name

formattedDate

Data type

String

Flags

bindable

Formatted Latched Date

The latched date property, as formatted by the format string.

Scripting name

formattedLatchedDate

Data type

String

Flags

bindable

Data Quality

The data quality code for any tag bindings on this component.

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

mouse
mouseMotion
propertyChange

 

Scripting Functions

This component has no special scripting functions.