Top  | Previous | Next

Day View

calendars_DayView

Description

This component displays a timeline for a single day, similar to what you might find in a personal planner/organizer. By filling in the Calendar Events dataset property, the component will display events that occur on this day. Each event can have custom text and a custom display color associated with it. The format of the dataset requires 4 columns, as demonstrated by the following dataset:

 

StartDate (Date)

EndDate (Date)

DisplayColor (String)

Display (String)

2010-01-10 8:00:00

2010-01-10 9:30:00

color(0,180,0)

Meeting

2010-01-10 13:30:00

2010-01-10 17:00:00

orange

Compressor Maint.

Properties

Appearance

Working Start Hour

The start hour of a working day

Scripting name

workingStartHour

Data type

int

Flags

bindable

Working End Hour

The end hour of a working day

Scripting name

workingEndHour

Data type

int

Flags

bindable

24 Hour Format

Whether or not to show 24 hour or 12 hour format

Scripting name

twentyFourHour

Data type

boolean

Flags

bindable

Zoom

Zooms into the specified zoom time-range

Scripting name

autoZoom

Data type

boolean

Flags

bindable

Zoomed Start Hour

The start hour zoomed in

Scripting name

autoZoomStartHour

Data type

int

Flags

bindable

Zoomed End Hour

The end hour zoomed in

Scripting name

autoZoomEndHour

Data type

int

Flags

bindable

Grid marks

Set the amount of grid lines

Scripting name

gridMarks

Data type

int

Flags

bindable

Week Day Font

The font of the week day's text.

Scripting name

weekdayFont

Data type

Font

Week Day Foreground Color

The color of the week day's text.

Scripting name

weekDaysForeground

Data type

Color

Flags

bindable

Week Day Background Color

The color of the week day's background

Scripting name

weekDaysBackground

Data type

Color

Flags

bindable

Calendar Background Color

The color of the calendar's background.

Scripting name

calendarBackground

Data type

Color

Flags

bindable

Day Outline Color

The color of the day's outline

Scripting name

boxOutline

Data type

Color

Flags

bindable

Today's Background Color

The color of the today's background

Scripting name

todayBackground

Data type

Color

Flags

bindable

Hover Background Color

The background color of the hovered time

Scripting name

hoverBackground

Data type

Color

Flags

bindable

Hour Font

The font for the hour of the day.

Scripting name

hourFont

Data type

Font

Hour Foreground Color

The foreground color for hours in a day

Scripting name

hourForeground

Data type

Color

Flags

bindable

Non-Working Hours Background Color

The background color for the non-working hours of the day

Scripting name

nonWorkingHourBackground

Data type

Color

Flags

bindable

Event Font

The font for all calendar events.

Scripting name

eventFont

Data type

Font

Styles

Contains the component's styles

Scripting name

styles

Data type

Dataset

Flags

bindable | expert

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

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

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

Year

Set the calendar's year

Scripting name

year

Data type

int

Flags

bindable

Month

Set the calendar's month

Scripting name

month

Data type

int

Flags

bindable

Day

Set the calendar's day

Scripting name

day

Data type

int

Flags

bindable

Calendar events

Contains the calendar events

Scripting name

events

Data type

Dataset

Flags

bindable

Hovered Time

The calendar's hovered time

Scripting name

hoveredTime

Data type

String

Flags

bindable

Selected Event

The calendar's selected event

Scripting name

selectedEvent

Data type

int

Flags

bindable

Hovered Event

The calendar's hovered event

Scripting name

hoveredEvent

Data type

int

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.