IsHoliday メソッド (HolidayCollection)

指定した日付がHolidayCollectionコレクション内に存在するかどうかを示すブール値を戻します。

構文

Visual Basic (宣言)
C#

Public Overridable Function IsHoliday( _
   ByVal date As Date _
) As Boolean

public virtual bool IsHoliday( 
   DateTime date
)

パラメータ

date: 調査の対象となる日付（System.DateTime 型）

戻り値の型

値	説明
True	date 引数の日付は、休日としてHolidayCollectionに登録されています。
False	date 引数の日付は、HolidayCollectionには登録されていません。

解説

HolidayCollectionオブジェクトには、IHolidayインターフェイスを持つHoliday（休日）、 ForceHoliday（臨時休日）、ForceWorkday（臨時営業日）と、 IHolidayインターフェイスを持たないWeekdays（休業日）の４種類が含まれています。これらの中でIsHolidayメソッドがTrueを返すのは、次の３つの場合です。

臨時営業日でない休日
臨時休日
休業日

次の場合には、Falseが返されます。

臨時営業日
HolidayCollectionオブジェクトに含まれていないすべての日付

指定した日付の種類をさらに詳しく調べる場合は、GetTypeOfDayメソッドを使用します。

使用例

次のサンプルコードは、2015年11月3日が休日として設定されているかどうかを調べます。

Visual Basic
C#

Imports GrapeCity.Web.Input.IMCalendar

' HolidayStyleが少なくとも１つ設定されていることを前提にしています。
Dim aHS As HolidayStyle = GcCalendar1.HolidayStyles(GcCalendar1.ActiveHolidayStyles(0))

' 調査対象となる日付を設定します。
Dim aDate As DateTime = DateTime.Parse("2015/11/3")

' 指定した日付が休日として登録されているかどうか調べます。
Dim isHoliday As Boolean = aHS.Holidays.IsHoliday(aDate)

' 調べた結果をメッセージボックスに表示します。
If isHoliday Then
    Label1.Text = aDate.ToString("yyyy年MM月dd日") + "は休日です。"
Else
    Label1.Text = aDate.ToString("yyyy年MM月dd日") + "は休日ではありません。"
End If

using GrapeCity.Web.Input.IMCalendar;

// HolidayStyleが少なくとも１つ設定されていることを前提にしています。
HolidayStyle aHS = GcCalendar1.HolidayStyles[GcCalendar1.ActiveHolidayStyles[0]];

// 調査対象となる日付を設定します。
DateTime aDate = DateTime.Parse("2015/11/3");

// 指定した日付が休日として登録されているかどうか調べます。
bool isHoliday = aHS.Holidays.IsHoliday(aDate);

// 調べた結果をメッセージボックスに表示します。
if (isHoliday)
{
    label1.Text = aDate.ToString("yyyy年MM月dd日") + "は休日です。";
}
else
{
    label1.Text = aDate.ToString("yyyy年MM月dd日") + "は休日ではありません。";
}

参照

HolidayCollection クラス
 HolidayCollection メンバ