uicalendar

Graphical calendar

Syntax

uicalendar(Name,Value)

Description

uicalendar(Name,Value) supports a customizable graphical calendar that interfaces with one or more uicontrol. uicalendar populates one or more uicontrol with user-selected dates.

Note

As an alternative to uicalendar, you can use uidatepicker.

Examples

Use uicalendar with an uicontrol

Create an uicontrol:

textH1 = uicontrol('style', 'edit', 'position', [10 10 100 20]) 

textH1 = 

  UIControl with properties:

              Style: 'edit'
             String: ''
    BackgroundColor: [0.9400 0.9400 0.9400]
           Callback: ''
              Value: 0
           Position: [10 10 100 20]
              Units: 'pixels'

Call UICalendar:

uicalendar('DestinationUI', {textH1, 'string'})

Select a date and click OK.

Alternatively, you can use datetime arrays for InitDate and Holiday.

uicalendar('InitDate',datetime('15-Mar-2015','Locale','en_US'),'Holiday',datetime('16-Mar-2015','Locale','en_US'))

Select a date and click OK. For more information on using uicalendar with an application, see Example of Using UICalendar with an Application.

Input Arguments

Name-Value Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: uicalendar('InitDate',datetime('15-Mar-2015','Locale','en_US'),'Holiday',datetime('16-Mar-2015','Locale','en_US'))

BusDays — Flag to indicate nonbusiness days

0 (Standard calendar without nonbusiness day indicators) (default) | numeric values of 0 or 1

Flag to indicate nonbusiness days, specified using numeric values of 0 or 1. The values are:

• 0 — (Default) Standard calendar without nonbusiness day indicators.

• 1 — Marks NYSE nonbusiness days in red.

Data Types: logical

BusDaySelect — Flag to indicate whether business and nonbusiness days

1 (Allows selections of business and nonbusiness days) (default) | numeric values of 0 or 1

Flag to indicate whether business and nonbusiness days, specified using numeric values of 0 or 1. The values are:

• 0 — Only allow selection of business days. Nonbusiness days are determined from the following parameters:

  • 'BusDays'

  • 'Holiday'

  • 'Weekend'

• 1 — (Default) Allows selections of business and nonbusiness days.

Data Types: logical

DateBoxColor — Color of date squares

[date R G B]

Color of date squares, specified using [date R G B], where [R G B] is the color.

Data Types: double

DateStrColor — Color of numeric date number in the date square

[date R G B]

Color of numeric date number in the date square, specified using [date R G B], where [R G B] is the color.

Data Types: double

DestinationUI — Destination object's handles

'string' (default UI property populated with dates) (default) | values are H or {H, {Prop}}

Destination object's handles, specified with values H or {H, {Prop}}. The values are:

• H — Scalar or vector of the destination object's handles. The default UI property that is populated with the dates is a character vector.

• {H, {Prop}} — Cell array of handles and the destination object's UI properties. H must be a scalar or vector and Prop must be a single property character vector or a cell array of property character vectors.

Data Types: char | cell

Holiday — Holiday dates in calendar

serial date numbers | datetime arrays

Holiday dates in calendar, specified using a scalar or vector of serial date numbers or datetime arrays. The corresponding date character vector of the holiday appears Red.

Data Types: double | datetime

InitDate — Initial start date when calendar is initialized

TODAY (default) | serial date number | datetime array | date character vector

Initial start date when calendar is initialized, specified with date values using a serial date number, datetime array, or date character vector. The values are:

• Datenum — Numeric or datetime array date value specifying the initial start date when the calendar is initialized. The default date is TODAY.

• Datestr — Date character vector value specifying the initial start date when the calendar is initialized. Datestr must include a Year, Month, and Day (for example, 01-Jan-2006).

Data Types: double | char | datetime

InputDateFormat — Format of initial start date

character vector

Format of initial start date (InitDate), specified using a character vector. Seedatestr for date format values.

Data Types: double | datetime

OutputDateFormat — Format of output date

character vector

Format of output date, specified using a character vector. Seedatestr for date format values.

Data Types: double | datetime

OutputDateStyle — Style for output date

0 (default) | numeric value of 0, 1, 2, or 3

Style for output date, specified using a value of 0, 1, 2, or 3. The values are:

• 0 — (Default) Returns a single date character vector or a cell array (row) of date character vectors. For example, {'01-Jan-2001, 02-Jan-2001, ...'}.

• 1 — Returns a single date character vector or a cell (column) array of date character vectors. For example, {'01-Jan-2001; 02-Jan-2001; ...'}.

• 2 — Returns a character vector representation of a row vector of datenums. For example, '[732758, 732759, 732760, 732761]'.

• 3 — Returns a character vector representation of a column vector of datenums. For example, '[732758; 732759; 732760; 732761]'.

Data Types: double

SelectionType — Flag for date selection

1 (default) | numeric value of 0 or 1

Flag for date selection, specified with using a value of 0 or 1. The values are:

• 0 — Allows multiple date selections.

• 1 — (Default) Allows only a single date selection.

Data Types: logical

Weekend — Define weekend days

1 (default) | numeric values of 1 through 7

Define weekend days, specified using a value of 1 through 7. Weekend days are marked in red. DayOfWeek can be a vector containing the following numeric values:

• 1 — Sunday

• 2 — Monday

• 3 — Tuesday

• 4 — Wednesday

• 5 — Thursday

• 6 — Friday

• 7 — Saturday

Also this value can be a vector of length 7 containing 0's and 1's. The value 1 indicates a weekend day. The first element of this vector corresponds to Sunday. For example, when Saturday and Sunday are weekend days then WEEKEND = [1 0 0 0 0 0 1].

Data Types: double

WindowStyle — Window figure properties

Normal (default) | character vector with value of Normal or Modal

Window figure properties, specified with using a character vector with a value of Normal or Modal. The values are:

• Normal — (Default) Standard figure properties.

• Modal — Modal figures remain stacked above all normal figures and the MATLAB^® Command Window.

Data Types: char