ig.excel.FixedDateGroup

Represents a fixed range of dates.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • ig.excel.FixedDateGroup
    Constructor

    new $.ig.excel.FixedDateGroup( type:ig.excel.FixedDateGroupType, value:ig.Date );

    Creates a new FixedDateGroup instance.

    • type
    • Type:ig.excel.FixedDateGroupType
    • The type, or precision, of the group.
    • value
    • Type:ig.Date
    • The reference date which determines range of accepted dates.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException type is not defined in the FixedDateGroupType enumeration.
    ig.ArgumentException value cannot be defined in the Excel.

    Remarks

    type indicates the precision of value, which defines the range of accepted dates in the group. For example, if the type is Hour and value is 12/19/2011 1:29:13 PM, the date range allowed by the FixedDateGroup would be 12/19/2011 1:00:00 PM to 12/19/2011 1:59:59 PM.

  • end

    .end( );

    Gets the exclusive end date of the accepted date range with a CalendarType of None.

  • equals

    .equals( obj:object );
    Return Type:
    boolean
    Return Type Description:
    True if the object is equal to this instance; False otherwise.

    Determines whether the FixedDateGroup is equal to the specified object.

    • obj
    • Type:object
    • The object to test for equality.
  • getHashCode

    .getHashCode( );
    Return Type:
    number
    Return Type Description:
    A number which can be used to hash this instance.

    Gets the hash code for the FixedDateGroup.

  • getRange

    .getRange( calendarType:ig.excel.CalendarType );
    Return Type:
    ig.excel.DateRange
    Return Type Description:
    A DateRange where the start is the inclusive start date of the accepted date range and the end is the exclusive end date.

    Gets the accepted date range based on the specified calendar type.

    • calendarType
    • Type:ig.excel.CalendarType
    • The calendar type in which to get the accepted date range.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException calendarType is not defined in the CalendarType enumeration.
  • start

    .start( );

    Gets the inclusive start date of the accepted date range with a CalendarType of None.

  • type

    .type( );
    Return Type:
    ig.excel.FixedDateGroupType
    Return Type Description:
    Returns a FixedDateGroupType.

    Gets the type, or precision, of the group.

    Remarks

    The group type indicates the precision of the FixedDateGroup.value, which defines the range of accepted dates in the group. For example, if the Type is Hour and the Value is 12/19/2011 1:29:13 PM, the date range allowed by the FixedDateGroup would be 12/19/2011 1:00:00 PM to 12/19/2011 1:59:59 PM.

  • value

    .value( );

    Gets the reference date which determines range of accepted dates.

    Remarks

    FixedDateGroup.type indicates the precision of the Value, which defines the range of accepted dates in the group. For example, if the Type is Hour and the Value is 12/19/2011 1:29:13 PM, the date range allowed by the FixedDateGroup would be 12/19/2011 1:00:00 PM to 12/19/2011 1:59:59 PM.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.